1. Home
  2. Docs
  3. Admin Documentation
  4. New Entity Type Registration
  5. Register masterdata via Excel

Register masterdata via Excel

 

It is possible to register openBIS masterdata using an Excel template from the admin UI.

 

This can be done from the Import menu under the Tools sections, as shown below. Three options can be chosen for the import:

 

  1. fail if exists: if a type or a property already exists in the database, the upload will fail.
  2. ignore if exists: if a type or a property already exists in the database, the upload will ignore this.
  3. update is exists: if a type or a property already exists in the database, the upload will update existing values.

 

 

 

An example template of an Excel masterdata file can be found here: masterdata-template

Please note that in the template we used separate spreadsheets for each type (Sample, Experiment, Dataset), but it is also possible to have everything in one single spreadsheet.

 

Modifying existing types

If you wish to add a new property to an existing Collection/Object/Dataset type, you need to:

1. add the property in the file

2. increase the version number of the Collection/Object/Dataset type

 

3. use Ignore if exists as upload method. In this case, only the new property is added to the type.

 

The import on the admin UI allows to register entities in addition to masterdata. An example template file for this can be found here: masterdata-metadata

 

More extensive documentation on the XLS format for masterdata and metadata registration can be found here.