openBIS defines as "Master data" all metadata configurations needed before the import of the real raw data. Master data includes experiment/sample/data set/property/file types, vocabularies and property assignments.
Similarly to the Jython Dropbox API the script can access a global variable named
service, which can be used to create transactions.
The transactions are a focal API concept offering to create new types (e.g.
createNewDataSetType) and new property assignments (e.g.
The complete Javadoc for the API is available at
The global service variable
The public API of the transaction objects
Javadocs for the complete API package
Command line tools
Executing master data scripts
Make sure openBIS AS is up and running prior script execution. Go to the openBIS AS installation folder. Assuming your script is
/local/master-data-script.py and openBIS AS is started on the URL
execute the command
You will be prompted for username/password before the script execution. Please note that the second 'openbis' is needed in the server address, so that you connect via the API.
Exporting master data
You can export the master data from a running openBIS system as script by running the command
This command will create a folder
exported-master-data-DATE which will contain the exported master data script -