Child pages
  • Quick Start Up Guide
Skip to end of metadata
Go to start of metadata

1. Register Users

First you need to add a user and then you assign a role to the user (available roles are explained here: openBIS Roles). Without a role, the user will not be able to log into openBIS.

Go in Admin -> Authorization -> Users. This opens a new tab, at the bottom of which there is an "Add Person" button. By clicking this, a pop-up window will allow you to enter the username of the user you want to register.

 

To assign a role, go in Admin -> Authorization -> Roles. This opens a new tab, at the bottom of which there is an "Assign Role" button. You can then choose a role and the person you want to assign to that role. 

2. Create a Space

Go in Admin -> Spaces. This opens a new tab: click the "Add Space" button at the bottom of the page to create a space.

 

3. Create a Project

Go in New -> Project. Enter the name of the Project in the Code field and assign it to a Space. Please note that only letters, numbers, "-", "_", ".",  are allowed in the code. The Description field is optional.

 

4. Create an Experiment Type with Properties

Go in Admin -> Types -> Experiment Types. This opens a new tab, at the bottom of which there is an "Add" button.

 

Click the "Add" button and you can now enter the code of your experiment type. Please note that only letters, numbers, "-", "_", ".",  are allowed in the code. 

If you want to add properties to this experiment type, click the "Add" button at the bottom of this page.

 

A pop-up window will appear, where you can choose if you want to add an already existing property or you want to create a new property.

 

If you create a new property, you need to provide the code. Please note that only letters, numbers, "-", "_", ".",  are allowed in the code. If you want to have a name with spaces and/or special characters, enter this in the "Label" field. All fields marked with "*" are mandatory. For Data Types, please have a look here: 

https://wiki-bsse.ethz.ch/display/openBISDoc1304/openBIS+User+Documentation#openBISUserDocumentation-PropertiesandPropertyTypes


For ELN users only: always add the property Name to any new experiment type you create. For comments logs, add the Comments List property.

 

5. Create a Controlled Vocabulary

A Controlled Vocabulary allows you to create finite lists of values/terms to choose from with a drop-down menu.

Go in Admin -> Vocabularies. This opens a new tab, at the bottom of which there is an "Add Vocabulary" button. 

 

To create a vocabulary, you need to provide a code (=name) for the vocabulary and enter the list of terms which should go in the vocabulary. You can also load terms from a .txt file. 

6. Create a Sample Type

Go in Admin -> Types -> Sample Types. Then follow the same steps described above for the creation of Experiment Types.

In most cases, the default checked boxes are fine.

Note: always provide a meaningful Generated Code Prefix.

For ELN users only: always add the properties Name and Annotations state to any new sample type you create. For comments logs, add the Comments List property.

7. Create a Data Set Type

Go in Admin -> Types -> Data Set Types. Then follow the same steps described above for the creation of Experiment Types.

For ELN users only: always add the property Name to any new data set type you create. For comments logs, add the Comments List property.


8. Experiment registration

Go in New -> Experiment. This opens a tab where, first of all, you have to choose the Experiment Type. Fill in the form and save.

9. Sample registration

Go in New -> Sample. This opens a tab where, first of all, you have to choose the Sample Type. Fill in the form and save.

10. Data Set registration

Select a sample or an experiment where you want to attach a dataset and click on the DataSet Uploader tab. Choose the dataset type, then browse for your files, or drag&drop them. Finally click on "Create DataSet". You can upload single files or zipped folders.

 

 

 

  • No labels