diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..e130e916fc2ad30a4de07affcea52d7783e842df --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,9 @@ +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] +html_logo = "img/openBIS.png" +html_theme_options = { + 'logo_only': True, + 'display_version': False, +} +extensions = ['myst_parser'] +source_suffix = ['.rst', '.md'] diff --git a/docs/img/openBIS.png b/docs/img/openBIS.png new file mode 100644 index 0000000000000000000000000000000000000000..a2e0631f0a502f3f3aa60b74192e54951e1d918d Binary files /dev/null and b/docs/img/openBIS.png differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..51fb97348c132827fb8883ed7141053dbe9b2169 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,34 @@ +##################### +OpenBIS Documentation +##################### + +The complete solution for managing your research data. + +.. toctree:: + :maxdepth: 4 + :hidden: + :caption: User Documentation + + General Users </user-documentation/general-users/index> + General Admin Users </user-documentation/general-admin-users/index> + +User Documentation +^^^^^^^^^^^^^^^^^^ + - :doc:`General Users </user-documentation/general-users/index>` + - :doc:`General Admin Users </user-documentation/general-admin-users/index>` + - Advanced Features + - Legacy Advance Features + +Software Developer Documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + - Development Environment + - APIS + - Server-side Extensions + - Client-side Extensions + - Legacy Server-side Extensions + +System Admin Documentation +^^^^^^^^^^^^^^^^^^^^^^^^^^ + - Installation + - Docker Installation + - Advanced Features diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..ea132ee9ccba3793faea29a6831c06c94ff46ebe --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +myst_parser==0.15.2 diff --git a/docs/user-documentation/advance-features/index.rst b/docs/user-documentation/advance-features/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/associate-file-types-to-dataset-types.md b/docs/user-documentation/general-admin-users/admins-documentation/associate-file-types-to-dataset-types.md new file mode 100644 index 0000000000000000000000000000000000000000..e4d1511f698a8bf6c586964a839a39cee9d586e9 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/associate-file-types-to-dataset-types.md @@ -0,0 +1,28 @@ +# Associate File Types to Dataset Types + +[](# "Print this article") + + +It is possible to associate given file types to given *Dataset* *types*. +In this way when a file of this type is uploaded, the *Dataset* *type* +is automatically selected. This option can be found in **Settings**. + +For example, a Jupyter notebook, which has extension **.ipynb** can +always be associated with the *Dataset* *type* **Analysis Notebook**. + + + +1. Go to **Settings** +2. Click **Edit** +3. Scroll down to the **Dataset types for filenames** section +4. Enter the file extension (e.g. ipynb) in the **Filename extension** + field +5. Select the D**ataset type** with which you always want to associate + this file type (e.g. Analysis Notebook) +6. **Save** + + + + + +Updated on November 30, 2022 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/create-templates-for-objects.md b/docs/user-documentation/general-admin-users/admins-documentation/create-templates-for-objects.md new file mode 100644 index 0000000000000000000000000000000000000000..898e0360769cbec50562e13bdb08497b2cb7421e --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/create-templates-for-objects.md @@ -0,0 +1,47 @@ +# Create Templates for Objects + +[](# "Print this article") + + +It is possible to create templates for *Objects*. Templates are useful +when one has to register repetitive *Experimental steps* or +*measurements* where some fields should always be pre-defined. + +For each *Object* type several templates can be created. This can be +done by the lab manager, who should have admin rights for editing the +**Settings**. It is not necessary to be *Instance admin* for this. In a +multi-group set up, this can be done by the *group admin*. + + +Procedure: + + +1. Go to the **Settings**, under **Utilities** +2. Scroll down to the **Templates** section +3. From the **New Template** tab select select the *Object type* for + which you want to have a template. + + + + + + + + + +1. Fill in the fields as desired. +2. **Save.** + + +Your templates will be show in the table in the **Templates** section, +as shown below + + + + + +See [Use template for Experimental +Steps](https://openbis.ch/index.php/docs/user-documentation/lab-notebook/use-templates-for-experimental-steps/) +for more info on how to use templates. + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/customise-inventory-of-materials-and-samples.md b/docs/user-documentation/general-admin-users/admins-documentation/customise-inventory-of-materials-and-samples.md new file mode 100644 index 0000000000000000000000000000000000000000..ed5949732eef17294c399791e539b0ab488b6a55 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/customise-inventory-of-materials-and-samples.md @@ -0,0 +1,223 @@ +Customise Inventory Of Materials And Samples +==== + +## Create Collections of Materials + +[](# "Print this article") + + + +*Collections* are folders used to organise *Objects* in the +**Materials** Inventory. Such *Objects* can be different types of +samples and materials (e.g. chemicals, antibodies, batteries, +environmental samples). + + + +*Collections* need to be created inside another folder, called +*Project*, in the **Materials** inventory. + + + +For example, if we want to create a collection of raw samples, we need +to adopt the following steps: + +1. Create an *Object* *type* called Sample. This can only be done by an + *Instance admin*, from the admin interface, as explained here: [New + Entity Type + Registration](https://openbis.ch/index.php/docs/admin-documentation/new-entity-type-registration/) +2. Create a first folder called Samples inside the **Materials** folder + *(Project)* +3. Create a second folder called Raw Samples** ***(Collection)* + + + + + +To create the *Project* folder: + +> 1. Click on the **Materials** folder +> 2. Click the **+ New Project** button in the form. +> + +> 3. Provide a description, if wanted. This is not mandatory. +> 4. Enter the **Code**. This will be the name of the folder, in this +> case SAMPLES. Codes only take alphanumeric characters and no +> spaces. + + + + + + + + + +To register the *Collection* folder, inside the *Project* folder: + +> 1. Click on the *Project* folder, in this case **Samples**. +> 2. Click the **+ New** button in the main form and choose +> **Collection** from the dropdown. +> + +> 3. Replace the automatically generated **Code** with something +> pertinent to the collection (e.g RAW\_SAMPLES) +> 4. Fill in the **Name** field (e.g. Raw Samples). Note that by +> default, the navigation menu on the left shows the name. If the +> name is not provided, the code is shown. +> 5. Select the **Default object type** from the list of available +> types. This is the *Object* for which the *Collection* is used. In +> this case, **Sample**. +> 6. Select the **Default collection view** (see **[Customise +> Collection +> View](https://openbis.ch/index.php/docs/user-documentation-20-10-3/lab-notebook/customise-collection-view/))** + + + + + + + + + +Updated on April 26, 2023 + +## Delete Collections + +[](# "Print this article") + + + +To delete an existing Collection: + + + +1. Select **Edit Collection** under the **More..** dropdown menu + + + + + + + +2\. Select **Delete** under the **More..** drop down menu + + + + + +Updated on February 6, 2023 + +## Enable Storage Widget on Sample Forms + +[](# "Print this article") + + +When a new *Object type* is created by an *Instance admin (*see [New +Entity Type +Registration)](https://openbis.ch/index.php/docs/admin-documentation-openbis-19-06-4/new-entity-type-registration/)*,* +the storage widget is disabled by default. + + +If we want to track storage positions for this particular *Object type* +as described in [Allocate storage positions to +samples](https://openbis.ch/index.php/docs/user-documentation/managing-storage-of-samples/allocate-storage-to-samples/), +the **Storage** should be enabled in the **Settings**, under +**Utilities**. This can be done by a *group admin*. + +For this, follow the steps below: + + +1. Go to **Settings**, under **Utilities** +2. Click the **Edit** button +3. Scroll to the last section of the Settings: **Object Type + definitions Extension** +4. Open the *Object type* for which you want to enable the storage, + e.g. **Sample** +5. Select **Enable Storage ** +6. Save + + + + + + + + + +Updated on April 26, 2023 + +## Configure Lab Storage + +[](# "Print this article") + + +Fridges and freezers can be configured in the **Settings**, under +**Utilities**. + + + +1. Go to **Settings** +2. Click **Edit** +3. Scroll down to the **Storages** section +4. Click the **+ New Storage** button above the storage table, as shown + below. +5. Fill in the **Storage Form** as explained below + + + + +**How to fill in Storage Form:** + +> 1. **Code**. It is advisable to provide a meaningful code for the +> storage, rather than using the default, because this information +> is needed when registering storage positions in Batch mode. For +> example MINUS80\_ROOM\_A1 +> 2. **Name**. The name is what is shown in most parts of the ELN. E.g. +> Minus 80°C in Room A1 +> 3. **Number of rows**. This is the number of shelves. +> 4. **Number of columns**. This is the number of racks per shelf. +> 5. **Allowed number of boxes in a rack**. This is the maximum number +> per rack. Enter a very high number if this is not important. +> 6. **Rack space warning**. Enter space as percentage. E.g. 80, means +> that the system will give a warning when 80% of a rack is +> occupied. +> 7. **Box space warning**. Enter space as percentage. E.g. 80, means +> that the system will give a warning when 80% of a box is occupied. +> 8. **Validation level**. This is the minimum level of information +> required about the storage: +> 1. **Rack validation**. The position in the shelf and rack needs +> to be specified. +> 2. **Box validation**. In addition to **a**, a box name needs to +> be specified. +> 3. **Box position validation**. In addition to **a** and **b**, +> the position in the box needs to be specified. + +Updated on April 26, 2023 + +## Add metadata to Storage Positions + +[](# "Print this article") + + + + + +Storage positions by default have the following metadata: + +1. Storage code +2. Storage rack row +3. Storage rack column +4. Box name +5. Box size +6. Box position +7. User id + + + +It is possible to add additional information. This can be done by an +*Instance Admin* by editing the *Object* Type **STORAGE\_POSITION** in +the admin interface (see [New Entity Type +Registration](https://openbis.ch/index.php/docs/admin-documentation/new-entity-type-registration/)). + +Updated on February 6, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/customise-inventory-of-protocols.md b/docs/user-documentation/general-admin-users/admins-documentation/customise-inventory-of-protocols.md new file mode 100644 index 0000000000000000000000000000000000000000..957bb53e43893285d80bc6cb3460f0ab670f0882 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/customise-inventory-of-protocols.md @@ -0,0 +1,74 @@ +Customise Inventory Of Protocols +==== + +## Create Collections of Protocols + +[](# "Print this article") + + +*Collections* are folders used to organise *Objects* in the **Methods** +Inventory. In this case, *Objects* are protocols. + + + +*Collections* need to be created inside another folder, called +*Project*, in the **Methods** *Space* in the inventory. + + + +For example, if we want to create a collection of lab protocols for +microscopy and Mass spec, we need to adopt the following steps: + +1. Register a first *Project* folder called LAB\_PROTOCOLS in the + **Methods** *Space*. + + + +1. In the **Lab** **Protocols** folder, register two additional + Collections called Microscopy Protocols and MS Protocols + + + + + + +The steps for the registration of the folders are the same as explained +in [Create Collections of +Materials](https://openbis.ch/index.php/docs/admin-documentation-openbis-19-06-4/customise-inventory-of-materials-and-samples/create-collections-of-materials/) + + + + +Updated on April 26, 2023 + +## Enable Protocols in Settings + +[](# "Print this article") + + +If a new *Object type* for a protocol is created by an *Instance admin* +in the admin interface, it is advisable to set the *Object type* to +**Protocol** in the **Settings**, under **Utilities**. + + +For this, follow the steps below: + + +1. Go to **Settings** +2. Click **Edit** +3. Scroll to the last section of the **Settings**: **Object Type + definitions Extension** +4. Open the *Object type* corresponding to your protocol, e.g. + **General Protocol** +5. Select **Use as Protocol** +6. **Save** + + + + +This is done to be able to create local copies of protocols from the +*Inventory* inside an *Experiment* when writing *Experimental steps,* as +described in [How to use protocols in Experimental +Steps](https://openbis.ch/index.php/docs/user-documentation/lab-notebook/how-to-use-protocols-in-experimental-steps/) + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/customise-parents-and-children-sections-in-object-forms.md b/docs/user-documentation/general-admin-users/admins-documentation/customise-parents-and-children-sections-in-object-forms.md new file mode 100644 index 0000000000000000000000000000000000000000..404f6ee533c925b095ed1ab0535a55fb3091b43d --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/customise-parents-and-children-sections-in-object-forms.md @@ -0,0 +1,69 @@ +# Customise Parents and Children Sections in Object Forms + +[](# "Print this article") + + + + + +The **Parents** and **Children** sections are automatically created in +all *Object* forms. It is possible to customise or remove these +sections, from the **Settings**, under **Utilities**. + + +Let’s consider an example. The default *Experimental Step*, present in +all openBIS instances, looks like the picture below: in the **Parents** +section, **General Protocol** is predefined. If we want to add a General +Protocol to the form, we use the **Search** or **Paste** options next to +General Protocol. If we want to add another parent, for example a +**Sample**, we need to use the **Search Any** or **Paste Any** next to +Parents. See also [Add parents and children to Experimental +Steps.](https://openbis.ch/index.php/docs/user-documentation-20-10-3/lab-notebook/add-parents-and-children-to-experimental-steps/) + + + + + + + +Now let’s see how the **Parents** and **Children** sections of an +*Experimental Ste*p can be configured in the **Object Types Definition +Extension** in the **Settings.** + + + + + +1. **Section Name**. Enter an alternative name for the **Parents** or + **Children** section. If empty the default is used + (Parents/Children). +2. **Disable the section** for the *Object* type. No parents/children + can be added to this *Object* type. +3. **Disable addition of any object type**. This removes the **+** + button next to the section name, which enables to add as parent any + *Object* type. In this way only *Objects* of types pre-defined in + the form can be added. +4. To define which *Object* types should always be shown in the form of + a this *Object* type, click the **+** button. +5. Select if this is a **Parent** or **Child** from the **drop down**. +6. Enter a **Label**, which is what is shown in the *Object* form. +7. Select the *Object* type from the **drop down**. +8. Specify the **minimum** and **maximum** number of parents needed as + input for this *Object* type. This can be left empty if parents are + not mandatory for this type. If a minimum is specified, this makes + the addition of those parents mandatory. As many parents as + specified in the minimum field will have to be added in order to be + able to save the form. +9. Specify A**nnotations** (e.g. Comments) for this parent *Object* + type. +10. Click the + button on the section to add an annotation field. +11. Select the **Annotation** field from the list of available fields. +12. Specify if the **Annotation** is mandatory. + + +The figure below shows how the **Annotation** of type **Comments** looks +like in the *Experimental Step* form. + + + +Updated on November 30, 2022 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/customise-the-main-menu.md b/docs/user-documentation/general-admin-users/admins-documentation/customise-the-main-menu.md new file mode 100644 index 0000000000000000000000000000000000000000..9d0a796995f29271987ae591e0e52cc5e69aed94 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/customise-the-main-menu.md @@ -0,0 +1,128 @@ +# Customise the Main Menu + +[](# "Print this article") + + + +## Main Menu Sections + + +The main menu can be customised from the **Settings**, under +**Utilities**, to hide sections that are not needed by the lab. + + + + + + + +1. Go to **Settings.** +2. Click **Edit.** +3. Go to the **Main Menu** section. +4. Disable the parts of the menu which are not needed. +5. **Save.** + + + + + + + +1. **showLabNotebook**: if unselected, the **Lab Notebook** section of + the main menu ([Lab + Notebook)](https://openbis.ch/index.php/docs/user-documentation-20-10-3/lab-notebook/) + will be hidden. +2. **showInventory**: if unselected, the **Inventory** section of the + main menu ([Inventory of Materials and + Methods](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/)) + will be hidden. +3. **showStock**: if unselected, the **Stock** section of the main menu + ([Managing Lab Stocks and + Orders](https://openbis.ch/index.php/docs/user-documentation-20-10-3/managing-lab-stocks-and-orders-2/)) + will be hidden. +4. **showObjectBrowser**: if unselected, the **Object Browser** under + **Utilities** in the main menu ([Object + Browser)](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/browse-entries-by-type/) + will be hidden. +5. **showStorageManager**: if unselected, the **Storage Manager** under + **Utilities** in the main menu [(Storage + manager](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/overview-of-lab-storages/)) + will be hidden. +6. **showAdvancedSearch**: if unselected, the **Advanced Search** under + **Utilities** in the main menu ([Advanced + Search)](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/search/) + be hidden. +7. **showUnarchivingHelper**: if unselected, the **Unarchiving Helper** + and **Archiving Helper** under **Utilities** in the main menu ([Data + archiving)](https://openbis.ch/index.php/docs/user-documentation-20-10-3/data-archiving/) + will be hidden. +8. **showTrashcan**: if unselected, the **Traschcan** under + **Utilities** in the main menu + ([Trashcan](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/trashcan/)) + will be hidden. +9. **showVocabularyViewer:** if unselected, the **Vocabulary + Browser** under **Utilities** in the main menu ([Vocabulary + browser](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/vocabulary-browser/)) + will be hidden. +10. **showUserManager**: if unselected, the **User Manager** under + **Utilities** in the main menu ([User + Registration](https://openbis.ch/index.php/docs/admin-documentation/user-registration/)) + will be hidden. +11. **showUserProfile**: if unselected, the **User Profile** under + **Utilities** in the main menu ([User + Profile](https://openbis.ch/index.php/docs/admin-documentation-20-10-3/user-registration/user-profile/)) + will be hidden. +12. **showZenodoExportBuilder**: if unselected, the **Zenodo + Export** under **Utilities -> Exports** in the main menu + ([Export to + Zenodo](https://openbis.ch/index.php/docs/user-documentation-20-10-3/data-export/export-to-zenodo/)) + will be hidden. +13. **showBarcodes**: if unselected, the **Barcodes Generator** under + **Utilities** in the main menu + ([Barcodes)](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/barcodes/) + will be hidden. + + + +## Lab Notebook menu + + + +It is also possible to customise which entities should be shown under +*Experiments/Collections* in the main menu under the **Lab Notebook** +section. + +By default, only the *Object* types **Entry** and **Experimental Step** +are shown (see picture below). + + + + + + + + + +If you want to show additional custom *Object* types in the lab notebook +main menu, they need to be enabled by editing the **Settings**. + +Go to the **Object Type definitions Extension** section in the +**Settings**. Open the relevant *Object* type, which you would like to +see in the Main menu of the Lab Notebook and select **Show in lab +notebook main menu**, as shown below. + +By default, the Object Types **Entry** and **Experimental Step** have +this option already selected. + + + + + + + +Please note that this is only valid for the **Lab Notebook** section. In +the **Inventory** section, entries are never shown in the main menu, +because inventories can potentially have thousands of entries, which are +better visualised in tables, rather than in the main menu. + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/database-navigation-in-admin-ui.md b/docs/user-documentation/general-admin-users/admins-documentation/database-navigation-in-admin-ui.md new file mode 100644 index 0000000000000000000000000000000000000000..760e3b3f8a5521a98e72b2f42f3e24524bd70941 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/database-navigation-in-admin-ui.md @@ -0,0 +1,93 @@ +# Database navigation in admin UI + +[](# "Print this article") + + + +openBIS version 20.10.5 provides a new database navigation in the admin +UI, as shown below. + + + + + + + +This allows to navigate the openBIS hierarchy of *Spaces, Projects, +Experiments/Collections, Objects, Datasets*. + +The same navigation menu will be used in the ELN UI in an upcoming +openBIS version. + + + +## Features + + + +### Filter + +It is possible to filter the menu by code or name of the desired entity. + + + + + + + +### Navigation + +To navigate the menu, the nodes have to be opened individually. + +When you select an entry in the node, the corresponding entry page +opens. Please note that at this stage, this is only intended as a +preview for the navigation menu and the forms show the information of +the entity in json format. + +If you open several entry pages and you switch between them, by default +the navigation menu will scroll up or down to the corresponding entry in +the menu. If you do not want to have this behaviour, you can turn off +the scrolling by selecting the button on the top right corner of the +menu, as show in the picture below. + + + + + + + + + +### Sorting + +Each level of the hierarchy except for *Spaces* (*Projects, Collections, +Objects, Datasets*) can be sorted separately, using the buttons shown in +the pictures below. + +By default, the sorting is done by **Code** in alphabetical order. Other +options are: sorting by code in reverse alphabetical order; sorting by +ascending date; sorting by descending date. + + + + + + + + + + + + + + + + + + + + + + + +Updated on December 5, 2022 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/enable-archiving-to-long-term-storage.md b/docs/user-documentation/general-admin-users/admins-documentation/enable-archiving-to-long-term-storage.md new file mode 100644 index 0000000000000000000000000000000000000000..ccd47900aa2ab6a173cb6aaa945df0e13b729cf9 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/enable-archiving-to-long-term-storage.md @@ -0,0 +1,40 @@ +# Enable archiving to Long Term Storage + +[](# "Print this article") + + + + + +openBIS supports archiving of datasets to Strongbox and StronLink +([https://www.strongboxdata.com/](https://www.strongboxdata.com/)) as +described in [Datasets +Archiving](https://unlimited.ethz.ch/display/openBISDoc2010/Archiving+Datasets) + + + +This needs to be set up and configured by a *system admin*. + + + +Archiving can be manually triggered from the ELN interface. By default, +the archiving buttons are not shown, and they need to be enabled by an +*Instance admin* or even a *group admin* in the case of a multi-group +instance. This is done in the ELN Settings, as shown below. + + + + + +In addition, the Unarchiving helper tool should also be enabled in the +ELN Settings: + + + + + +More information on archiving and unarchiving datasets can be found +here: [Data +archiving](https://openbis.ch/index.php/docs/user-documentation-20-10-3/data-archiving/) + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/enable-barcodes.md b/docs/user-documentation/general-admin-users/admins-documentation/enable-barcodes.md new file mode 100644 index 0000000000000000000000000000000000000000..cc9489915bf28ad4062ca688156314e04a7c9b3e --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/enable-barcodes.md @@ -0,0 +1,40 @@ +# Enable Barcodes + +[](# "Print this article") + +In order to be able to add custom barcodes to *Objects*, an *Instance +Admin* needs to add the $BARCODE property to the object type for which +barcodes are needed. + + + +The barcode functionality is disabled by default in the ELN UI. This can +be enabled by a *lab manager* or a *group admin* with admin right to +edit the **Settings**, as shown below. + + + + + + + + + +After enabling the option, please refresh your browser. The **Barcodes +Generator** will be shown in the main menu under **Utilities** and a +barcode icon will be added above the menu. + + + + + + + + + + +Information on how to use the Barcode functionality in openBIS can be +found +here: [Barcodes](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/barcodes/) + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/enable-transfer-to-data-repositories.md b/docs/user-documentation/general-admin-users/admins-documentation/enable-transfer-to-data-repositories.md new file mode 100644 index 0000000000000000000000000000000000000000..fdd40df6bcd8ddc3eff1087af7a9fa9bfb04a4b3 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/enable-transfer-to-data-repositories.md @@ -0,0 +1,40 @@ +# Enable Transfer to Data Repositories + +[](# "Print this article") + + +Currently openBIS offers an integration with the **Zenodo** data +repository ([https://zenodo.org/). ](https://zenodo.org/) + +This enables data direct data transfer from openBIS to Zenodo. + +This feature needs to be configured by a *system admin* as explained +here: [openBIS DSS configuration +file](https://unlimited.ethz.ch/display/openBISDoc2010/Installation+and+Administrators+Guide+of+the+openBIS+Data+Store+Server#InstallationandAdministratorsGuideoftheopenBISDataStoreServer-Configurationfile). + +If this is done, the Zenodo Export needs to be made visible in the ELN +UI by a lab manager, who has should have admin rights for the +**Settings**. This can be done by a *group admin*, in case of a +multi-group instance set up. + + +Procedure: + + +1. Edit the **Settings** under **Utilities.** +2. Select **showZenodoExportBuilder** in the **Main Menu** section. +3. **Save.** + + + + + +The **Export to Zenodo** functionality becomes available under the +**Utilities** menu (a refresh of the browser page may be necessary to +see the change): + + + + + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/history-overview.md b/docs/user-documentation/general-admin-users/admins-documentation/history-overview.md new file mode 100644 index 0000000000000000000000000000000000000000..50239f8d998261bcef099e7255e86fda5cf24523 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/history-overview.md @@ -0,0 +1,69 @@ +History Overview +==== + +## History of deletions + +[](# "Print this article") + + + +When *Experiments/Collections*, *Objects* and *Datasets* in openBIS are +permanently deleted, i.e. they are removed from the trashcan, the +information of these permanently deleted entries is stored in the +database and it is visible in the admin UI. + +*Spaces* and *Projects* are directly permanently deleted, without going +to the trashcan. Their information is also shown in the table of history +of deletions in the admin UI. + + + +The table of history of deletions is under the **Tools** section, as +shown below. + + + +For each deleted entry, the table shows: + +1. **Entity type**: this can be *Space*, *Project*, *Collection, + Object, Dataset;* +2. **Entity identifier**: this is the PermID of the entity. *Spaces* do + not have PermID, so the code of the *Space* is shown instead; +3. **Entity Space**: the *Space* to which the entity belonged; +4. **Entity Project**: the *Project* to which the entity belonged; +5. **Entity Registrator**: the user who registered the entity; +6. **Entity Registration Date**: the date of registration of the + entity; +7. **Reason**: the reason of deletion of the entity; +8. **Description**: the PermID (*Collection*, *Object*), identifier + (*Space*, *Project*), dataset path (*Dataset*) of the entity; +9. **Content**: the metadata of the entity when it was deleted. This is + available for *Projects*, *Collections*, *Objects*, *Datasets*, but + not for *Spaces*; +10. **User**: the user who deleted the entity; +11. **Date**: the date and time of deletion of the entity. + + + + + +Updated on October 9, 2022 + +## History of freezing + +[](# "Print this article") + + + +In the admin UI it is possible to have an overview of all frozen entries +in openBIS. Frozen entries can no longer be modified (see [Freeze +Entities](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/freeze-entities/)). + +The table showing the history of freezing can be found under the +**Tools** section in the admin UI, as shown below. + + + + + +Updated on March 4, 2022 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Barcode-generator-1024x466.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Barcode-generator-1024x466.png new file mode 100644 index 0000000000000000000000000000000000000000..a79c2dcd0bf93403e644c8f6b423eacdaae7f693 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Barcode-generator-1024x466.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Excel-import-admin-UI-1024x634.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Excel-import-admin-UI-1024x634.png new file mode 100644 index 0000000000000000000000000000000000000000..c5a35b8f584af5a2805f2632da13e6a1d1b6bdd6 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Excel-import-admin-UI-1024x634.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.11.14-1024x708.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.11.14-1024x708.png new file mode 100644 index 0000000000000000000000000000000000000000..dab5335fd707109e61e94ca4a5ebc0b4ac79773f Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.11.14-1024x708.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.24.58-1024x338.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.24.58-1024x338.png new file mode 100644 index 0000000000000000000000000000000000000000..773b9865266ff6e6512a6d78d5ddc7fa5cdf0cc2 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.24.58-1024x338.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.53.37-1024x679.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.53.37-1024x679.png new file mode 100644 index 0000000000000000000000000000000000000000..7e8f5a78218fe42368702b148119b82c1ba8f843 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-10.53.37-1024x679.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.01.57-1024x705.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.01.57-1024x705.png new file mode 100644 index 0000000000000000000000000000000000000000..0ec2d948bf387b6c7233134cce3efab73c26f313 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.01.57-1024x705.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.19.33-1-1024x537.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.19.33-1-1024x537.png new file mode 100644 index 0000000000000000000000000000000000000000..7d4f5b3220cde2bb160f0d8dc085bad4fb34bb8a Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.19.33-1-1024x537.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.22.59-1024x705.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.22.59-1024x705.png new file mode 100644 index 0000000000000000000000000000000000000000..0e6bf03974ae080330b83379c02c6e58655cba06 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2020-02-26-at-13.22.59-1024x705.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2022-06-28-at-10.15.39.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2022-06-28-at-10.15.39.png new file mode 100644 index 0000000000000000000000000000000000000000..c4ee0a82c6652b633009468e17e49f1dbc5d8bac Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2022-06-28-at-10.15.39.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2022-11-30-at-17.25.37.png b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2022-11-30-at-17.25.37.png new file mode 100644 index 0000000000000000000000000000000000000000..aea08623ca4b2c0b8d69ba1f4cc82a1b140421c5 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/Screenshot-2022-11-30-at-17.25.37.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/barcode-scan-tablet.png b/docs/user-documentation/general-admin-users/admins-documentation/img/barcode-scan-tablet.png new file mode 100644 index 0000000000000000000000000000000000000000..1043c29b24e5fb32ff9567c5ce77bde3df6e51b9 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/barcode-scan-tablet.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/change-pwd.png b/docs/user-documentation/general-admin-users/admins-documentation/img/change-pwd.png new file mode 100644 index 0000000000000000000000000000000000000000..94d5c79d5bdc607e906ad08dbcb8f2223f6dbbec Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/change-pwd.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/comments-gneral-protocol-as-parent-1024x549.png b/docs/user-documentation/general-admin-users/admins-documentation/img/comments-gneral-protocol-as-parent-1024x549.png new file mode 100644 index 0000000000000000000000000000000000000000..aeecca7aa82aade0470ff27de8168b0a5ca422ff Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/comments-gneral-protocol-as-parent-1024x549.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-collection-lab-protocols.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-collection-lab-protocols.png new file mode 100644 index 0000000000000000000000000000000000000000..c1d22aebcc47903135797e2fb88ad0f7aa17f824 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-collection-lab-protocols.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-collection-materials-1024x403.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-collection-materials-1024x403.png new file mode 100644 index 0000000000000000000000000000000000000000..989c2cb4b18af4dd4cf1223b287a5a655c19814a Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-collection-materials-1024x403.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-project-materials-1024x286.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-project-materials-1024x286.png new file mode 100644 index 0000000000000000000000000000000000000000..a0b644cfa41987d107e28bcef84d29f6b01deb87 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-project-materials-1024x286.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-project-methods.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-project-methods.png new file mode 100644 index 0000000000000000000000000000000000000000..bdf10b301d47e6e423fadb2bd774587e674590b3 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-project-methods.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-groups-dropdown.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-groups-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..40ce0308ed0ad293492677d894d24589cdffe03d Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-groups-dropdown.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-groups-dropdown.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-groups-dropdown.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..40ce0308ed0ad293492677d894d24589cdffe03d Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-groups-dropdown.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-no-group.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-no-group.png new file mode 100644 index 0000000000000000000000000000000000000000..05fc56c81de0b3607f62b482a57bc7abe923845c Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-no-group.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-no-group.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-no-group.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..05fc56c81de0b3607f62b482a57bc7abe923845c Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space-no-group.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-space.png b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space.png new file mode 100644 index 0000000000000000000000000000000000000000..f7b4ab5f9c4d0a82142e709307ee8b74405ffe09 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/create-space.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..f7b4ab5f9c4d0a82142e709307ee8b74405ffe09 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/create-space.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/custom-widget-gen-settings-1024x293.png b/docs/user-documentation/general-admin-users/admins-documentation/img/custom-widget-gen-settings-1024x293.png new file mode 100644 index 0000000000000000000000000000000000000000..146e50a0e800fea80af927010e0856d72388fa44 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/custom-widget-gen-settings-1024x293.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/database-filter-admin-ui-1.png b/docs/user-documentation/general-admin-users/admins-documentation/img/database-filter-admin-ui-1.png new file mode 100644 index 0000000000000000000000000000000000000000..35853314bc6e4098e5d96834568ed9b1a4e00018 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/database-filter-admin-ui-1.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/database-navigation-amdin-ui.png b/docs/user-documentation/general-admin-users/admins-documentation/img/database-navigation-amdin-ui.png new file mode 100644 index 0000000000000000000000000000000000000000..47d71ebd425fb9378d73376cba8b69d9bc91786e Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/database-navigation-amdin-ui.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/database-navigation-tabs-1024x496.png b/docs/user-documentation/general-admin-users/admins-documentation/img/database-navigation-tabs-1024x496.png new file mode 100644 index 0000000000000000000000000000000000000000..22b3ff022cdf0517d271a08d6644a5f29c72646e Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/database-navigation-tabs-1024x496.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/delete-collection-1.png b/docs/user-documentation/general-admin-users/admins-documentation/img/delete-collection-1.png new file mode 100644 index 0000000000000000000000000000000000000000..20bd94ec2e1458233568e486c913e309b48f033f Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/delete-collection-1.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/delete-collection-2.png b/docs/user-documentation/general-admin-users/admins-documentation/img/delete-collection-2.png new file mode 100644 index 0000000000000000000000000000000000000000..7d715e18ab8538a05a59b1784c55c2a530a4f9b1 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/delete-collection-2.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/delete-space-1.png b/docs/user-documentation/general-admin-users/admins-documentation/img/delete-space-1.png new file mode 100644 index 0000000000000000000000000000000000000000..a780f11c9f449df42c40987d2635007bf819fa78 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/delete-space-1.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/edit-collection-1024x345.png b/docs/user-documentation/general-admin-users/admins-documentation/img/edit-collection-1024x345.png new file mode 100644 index 0000000000000000000000000000000000000000..711f089b43253dcecbb3f979284818b652004e62 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/edit-collection-1024x345.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/enable-archiving-button.png b/docs/user-documentation/general-admin-users/admins-documentation/img/enable-archiving-button.png new file mode 100644 index 0000000000000000000000000000000000000000..3d3c8131b321157a149ac02ccda2bada1895738d Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/enable-archiving-button.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/enable-unarchiving-helper-tool.png b/docs/user-documentation/general-admin-users/admins-documentation/img/enable-unarchiving-helper-tool.png new file mode 100644 index 0000000000000000000000000000000000000000..94496ba78bb87513fa33ecb64514a2f5effa69a5 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/enable-unarchiving-helper-tool.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/exp-step-parents-children-default.png b/docs/user-documentation/general-admin-users/admins-documentation/img/exp-step-parents-children-default.png new file mode 100644 index 0000000000000000000000000000000000000000..04f2b07a6b872f0edd76fc5f29545813bf7d8393 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/exp-step-parents-children-default.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/export-table-admin-ui-1024x453.png b/docs/user-documentation/general-admin-users/admins-documentation/img/export-table-admin-ui-1024x453.png new file mode 100644 index 0000000000000000000000000000000000000000..d68c714527e2552e600e822bd52fc7738770b492 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/export-table-admin-ui-1024x453.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/export-to-zenodo-1024x862.png b/docs/user-documentation/general-admin-users/admins-documentation/img/export-to-zenodo-1024x862.png new file mode 100644 index 0000000000000000000000000000000000000000..0fa1fae7388114c298f8404a1fc300e8ae2f3651 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/export-to-zenodo-1024x862.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/general-settings-1024x545.png b/docs/user-documentation/general-admin-users/admins-documentation/img/general-settings-1024x545.png new file mode 100644 index 0000000000000000000000000000000000000000..bfc2d8b4d70b10006dd24fb89975098a1dc90d3c Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/general-settings-1024x545.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/history-deletion-1024x507.png b/docs/user-documentation/general-admin-users/admins-documentation/img/history-deletion-1024x507.png new file mode 100644 index 0000000000000000000000000000000000000000..46d837defbeb8c112eacc89fb2fcd9a356952849 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/history-deletion-1024x507.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/history-freezing-1024x262.png b/docs/user-documentation/general-admin-users/admins-documentation/img/history-freezing-1024x262.png new file mode 100644 index 0000000000000000000000000000000000000000..3962ae1b0cacf6e7c07c6b7079d04dc6316468c8 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/history-freezing-1024x262.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/home-space-admin-ui-1024x359.png b/docs/user-documentation/general-admin-users/admins-documentation/img/home-space-admin-ui-1024x359.png new file mode 100644 index 0000000000000000000000000000000000000000..afd97eaeaecb5db6542d634cb5e5d042cf71a49d Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/home-space-admin-ui-1024x359.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/import-exported-masterdata-1024x476.png b/docs/user-documentation/general-admin-users/admins-documentation/img/import-exported-masterdata-1024x476.png new file mode 100644 index 0000000000000000000000000000000000000000..d28d510154b508689527e824420fdadab5174cfd Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/import-exported-masterdata-1024x476.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-materials-life-sciences-1.png b/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-materials-life-sciences-1.png new file mode 100644 index 0000000000000000000000000000000000000000..788c977369c89b749c7873270f03312a0fb7b325 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-materials-life-sciences-1.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-methods-life-sciences.png b/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-methods-life-sciences.png new file mode 100644 index 0000000000000000000000000000000000000000..07bff1850f8e485d4c7f7ef71f764914c2d2622e Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-methods-life-sciences.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-non-group-spaces-multigroup.png b/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-non-group-spaces-multigroup.png new file mode 100644 index 0000000000000000000000000000000000000000..add2b060289fb2a00f96e93330651e8c5b79a657 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/inventory-non-group-spaces-multigroup.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/labnotebook-non-group-spaces-multigroup.png b/docs/user-documentation/general-admin-users/admins-documentation/img/labnotebook-non-group-spaces-multigroup.png new file mode 100644 index 0000000000000000000000000000000000000000..f9362318c18317ac16e1b93b31792e42ee9f1ca8 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/labnotebook-non-group-spaces-multigroup.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/masterdata-type-version.png b/docs/user-documentation/general-admin-users/admins-documentation/img/masterdata-type-version.png new file mode 100644 index 0000000000000000000000000000000000000000..e59ace82a133bcf0244fd01a4644731654d97df1 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/masterdata-type-version.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/menu-my-space.png b/docs/user-documentation/general-admin-users/admins-documentation/img/menu-my-space.png new file mode 100644 index 0000000000000000000000000000000000000000..bace86ff222ebab4d91bd16044be8359cdbd4eac Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/menu-my-space.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/menu-settings-multigroup.png b/docs/user-documentation/general-admin-users/admins-documentation/img/menu-settings-multigroup.png new file mode 100644 index 0000000000000000000000000000000000000000..8ca2abc7208bd57ce5b218f5429e4123cad62204 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/menu-settings-multigroup.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/menu-settings-multigroup.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/menu-settings-multigroup.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..8ca2abc7208bd57ce5b218f5429e4123cad62204 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/menu-settings-multigroup.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/move-collection-1024x142.png b/docs/user-documentation/general-admin-users/admins-documentation/img/move-collection-1024x142.png new file mode 100644 index 0000000000000000000000000000000000000000..394ff58616bda0c873402c70eda34e3de2918730 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/move-collection-1024x142.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/move-collection-more-dropdown-1024x466.png b/docs/user-documentation/general-admin-users/admins-documentation/img/move-collection-more-dropdown-1024x466.png new file mode 100644 index 0000000000000000000000000000000000000000..712d907ae612ee5ed2d77bfd6db1920e0c5ea589 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/move-collection-more-dropdown-1024x466.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/move-space-to-inventory-1024x426.png b/docs/user-documentation/general-admin-users/admins-documentation/img/move-space-to-inventory-1024x426.png new file mode 100644 index 0000000000000000000000000000000000000000..58fdd9f198c8be38e7ff141c257c2a8b11d01c77 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/move-space-to-inventory-1024x426.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/move-space-to-inventory-1024x426.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/move-space-to-inventory-1024x426.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..58fdd9f198c8be38e7ff141c257c2a8b11d01c77 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/move-space-to-inventory-1024x426.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/navigation-menu-settings.png b/docs/user-documentation/general-admin-users/admins-documentation/img/navigation-menu-settings.png new file mode 100644 index 0000000000000000000000000000000000000000..0f52bc66dae9e51f68696518a7dfd00d61f63484 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/navigation-menu-settings.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/new-collection-form.png b/docs/user-documentation/general-admin-users/admins-documentation/img/new-collection-form.png new file mode 100644 index 0000000000000000000000000000000000000000..635bafb7aaf0a10b516fd387d57340cdc8efbce9 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/new-collection-form.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/new-inventory-space.png b/docs/user-documentation/general-admin-users/admins-documentation/img/new-inventory-space.png new file mode 100644 index 0000000000000000000000000000000000000000..effa09e8c0ebe93efcfa0139d3bbde3e7f5b756d Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/new-inventory-space.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/new-lab-notebook-space.png b/docs/user-documentation/general-admin-users/admins-documentation/img/new-lab-notebook-space.png new file mode 100644 index 0000000000000000000000000000000000000000..0e397c6693858ef75936136356d4188da55629a8 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/new-lab-notebook-space.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/new-project-form.png b/docs/user-documentation/general-admin-users/admins-documentation/img/new-project-form.png new file mode 100644 index 0000000000000000000000000000000000000000..bc33c25c0555a06f8d6061e09a885653f9df506b Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/new-project-form.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/properties-overview-admin-UI-1024x640.png b/docs/user-documentation/general-admin-users/admins-documentation/img/properties-overview-admin-UI-1024x640.png new file mode 100644 index 0000000000000000000000000000000000000000..ee269533f94c07b36f6b372038f52796198bdc17 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/properties-overview-admin-UI-1024x640.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-create-template-1-1-1024x413.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-create-template-1-1-1024x413.png new file mode 100644 index 0000000000000000000000000000000000000000..615789f2326bf7f71e5a8407f84b2fa0acceea81 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-create-template-1-1-1024x413.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-create-templates-2.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-create-templates-2.png new file mode 100644 index 0000000000000000000000000000000000000000..b0becd8b425bf7a558fc3ac6e6178f714c0f8f1e Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-create-templates-2.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-enable-protocol-1024x488.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-enable-protocol-1024x488.png new file mode 100644 index 0000000000000000000000000000000000000000..49d9d9869d0869819c30a978941fd6e4ab85557a Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-enable-protocol-1024x488.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-enable-storage-1024x509.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-enable-storage-1024x509.png new file mode 100644 index 0000000000000000000000000000000000000000..d4c00f003da9ef015a8398f76d67733306af601c Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-enable-storage-1024x509.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-menu-shown-entities-in-menu.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-menu-shown-entities-in-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..0cf1e86c41859557d4f34dd267d25cfb29a685f6 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-menu-shown-entities-in-menu.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-new-lab-storage-1024x498.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-new-lab-storage-1024x498.png new file mode 100644 index 0000000000000000000000000000000000000000..f1db0f107f33ae678dba082ee3867dd8917e53cb Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-new-lab-storage-1024x498.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-selection-multigroup.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-selection-multigroup.png new file mode 100644 index 0000000000000000000000000000000000000000..9a5f207b9665aac3325ae1d605223f7e2f814f4f Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-selection-multigroup.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-selection-multigroup.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-selection-multigroup.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..9a5f207b9665aac3325ae1d605223f7e2f814f4f Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-selection-multigroup.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/settings-show-in-labnotebook-1024x577.png b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-show-in-labnotebook-1024x577.png new file mode 100644 index 0000000000000000000000000000000000000000..cdc1563c9414d823a9826af03358efa4533d7f0c Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/settings-show-in-labnotebook-1024x577.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/spaces-admin-UI-300x158.png b/docs/user-documentation/general-admin-users/admins-documentation/img/spaces-admin-UI-300x158.png new file mode 100644 index 0000000000000000000000000000000000000000..44ab914f3661a167498bf6a5c614096d267497e8 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/spaces-admin-UI-300x158.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/spaces-admin-UI-300x158.png.1 b/docs/user-documentation/general-admin-users/admins-documentation/img/spaces-admin-UI-300x158.png.1 new file mode 100644 index 0000000000000000000000000000000000000000..44ab914f3661a167498bf6a5c614096d267497e8 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/spaces-admin-UI-300x158.png.1 differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/templates-table-3-1024x493.png b/docs/user-documentation/general-admin-users/admins-documentation/img/templates-table-3-1024x493.png new file mode 100644 index 0000000000000000000000000000000000000000..05f0adaacf34813bf0876611ab36be971c5da9f4 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/templates-table-3-1024x493.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/index.rst b/docs/user-documentation/general-admin-users/admins-documentation/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..5ba878cbf5636c45fbfb4aa2ff8a9dfa3e6a5752 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/index.rst @@ -0,0 +1,24 @@ +General Users +============= + +.. toctree:: + :maxdepth: 4 + + inventory-overview + customise-inventory-of-materials-and-samples + customise-inventory-of-protocols + move-collections-to-a-different-project + customise-parents-and-children-sections-in-object-forms + customise-the-main-menu + associate-file-types-to-dataset-types + user-registration + new-entity-type-registration + masterdata-exports-and-imports + create-templates-for-objects + enable-transfer-to-data-repositories + enable-barcodes + enable-archiving-to-long-term-storage + history-overview + space-management + multi-group-set-up + database-navigation-in-admin-ui diff --git a/docs/user-documentation/general-admin-users/admins-documentation/inventory-overview.md b/docs/user-documentation/general-admin-users/admins-documentation/inventory-overview.md new file mode 100644 index 0000000000000000000000000000000000000000..feb9932c66255ac084ac9080331b3d8294186956 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/inventory-overview.md @@ -0,0 +1,55 @@ +# Inventory overview + +[](# "Print this article") + +The default Inventory contains two +folders: **Materials** and **Methods**. + +These are used to organise respectively samples and materials of any +type and lab protocols. + +Samples, materials and protocols are modelled in openBIS as *Objects*. +In the openBIS ELN-LIMS for life sciences, the following Object types +are preconfigured in the database: + + + + Antibodies, Chemicals, Enzymes, Media, Solutions and Buffers, Plasmids, Plants, Oligos, + RNAs, Bacteria, Cell lines, Flies, Yeasts, General protocols, PCR protocols, Western blotting protocols. + + + +These *Objects* are organised in *Collections* in the **Materials** and +**Methods** sections of the Inventory . + + + + + + + + + + + +The generic openBIS ELN-LIMS only has one predefined *Object* type for +the Inventory: + + + + General Protocol + + + +Additional *Object* types and the corresponding *Collections* must be +created by the *Instance admin*, based on the needs of the lab. + + + +It is possible to add additional folders in the Inventory, for example +for **Equipment** (see **[Create new Inventory +Spaces](https://openbis.ch/index.php/docs/admin-documentation-20-10-3/space-management/create-new-inventory-spaces/))**. + + + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/masterdata-exports-and-imports.md b/docs/user-documentation/general-admin-users/admins-documentation/masterdata-exports-and-imports.md new file mode 100644 index 0000000000000000000000000000000000000000..d2b417916fa8555b94aaadc271350e3458ec0357 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/masterdata-exports-and-imports.md @@ -0,0 +1,87 @@ +# Masterdata exports and imports + +[](# "Print this article") + + + +With openBIS version 20.10.5 it is possible to export masterdata from +one openBIS instance and import it in another one via the admin UI. + + + +## Masterdata export + + + +All types tables (*Object Types, Collection Types, Dataset Types, +Vocabulary Types, Property Type*s) can be exported as shown below for +the *Object Types*. + + + + + + + +When you export you have the following options: + +1. **Import Compatible**: + 1. 1. **Yes**: in this case some columns which are incompatible + with imports (i.e. modification date) are not exported even + if selected; some columns that are required by openBIS for + imports are added to the exported file even if not selected. + 2. **No**: in this case all columns or selected columns are + exported.2. +2. **Columns**: + 1. **All (default order)**. All columns are exported, in accordance + with the selection explained above for import compatibility. + 2. **Selected (shown order)**. Selected columns are exported, in + accordance with the selection explained above for import + compatibility. +3. **Rows**: current page or all pages +4. **Include dependencies**: yes or no. If you include dependencies, + all property types, vocabularies and associated objects are also + exported. Default is “yesâ€. + + + +If the types have validation plugins or dynamic script plugins +associated with them, a zip file containing the scripts is exported from +openBIS. + + + +## Masterdata import + + + +To import the file with the relevant masterdata that was exported as +explained above: + + + +1. Go to the **Tools** section and select **Import -> All** from the + menu. +2. Upload the file you exported before using the **CHOOSE FILE** + button. +3. Select one of the 3 possible options for the Update mode: + 1. **Fail if exists**: if some entries already exist in openBIS, + the upload will fail; + 2. **Ignore if exists**: if some entries already exist in openBIS, + they will be left untouched, even if their definition in the + file is different from the existing definition in openBIS; + 3. **Update if exists**: if some entries already exist in openBIS + and their definition in the file is different from the existing + definition in openBIS, they will be updated; + + + + + + + +Since openBIS 20.10.6, the import of zip files is supported. + + + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/move-collections-to-a-different-project.md b/docs/user-documentation/general-admin-users/admins-documentation/move-collections-to-a-different-project.md new file mode 100644 index 0000000000000000000000000000000000000000..fd82b9158bdb2bab0fd3f3bb3f76e8a645bc585b --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/move-collections-to-a-different-project.md @@ -0,0 +1,50 @@ +# Move Collections to a different Project + +[](# "Print this article") + + + +It is possible to move one *Collection* with it entire content +(*Objects* + *Datasets*) from one *Project* to another. + +If *Objects* contain parent/child relationships these are preserved. + +This operation requires *Space Power User* or *Admin* rights. + + + +To move *Collections* in the Inventory: + +1. Go to the *Collection* page you want to move +2. Click on **Edit Collection** + + + + + + + +3\. Select **Move** from the **More..** dropdown + + + + + + + + + +4\. Enter the code of the *Project* where you want to move your +*Collection*. If you start typing the code, openBIS will prompt you with +a list of available options and you can select the appropriate one from +there. + + + + + + + +5\. Click **Accept** + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/multi-group-set-up.md b/docs/user-documentation/general-admin-users/admins-documentation/multi-group-set-up.md new file mode 100644 index 0000000000000000000000000000000000000000..c0881133de98d6e3df4b71bd2852317ed7a6c4c4 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/multi-group-set-up.md @@ -0,0 +1,239 @@ +Multi Group Set Up +==== + +## General ELN Settings + +[](# "Print this article") + + + +In a multi-group instance an *Instance admin* can customise the General +ELN Settings. + + + +The Settings can be access from the main menu, under **Utilities**. + + + + + + + +The General ELN Settings are Settings that are not specific to any of +the defined groups group , as shown below. + + + + + + + +The General ELN Settings consist of two parts: + + + +1. **Instance Settings**. These settings affect the whole instance, it + is not possible to customise them on a group level. +2. **Group Settings**. These settings affect all general *Spaces* that + do not belong to any group defined in the configuration file + (see [openBIS set up for multi group + instances](https://unlimited.ethz.ch/display/openBISDoc2010/User+Group+Management+for+Multi-groups+openBIS+Instances)). + This is the case, for example, if *Spaces* are manually created and + they do not belong to any group (see [Create new ELN + Spaces](https://openbis.ch/index.php/docs/admin-documentation/space-management/create-new-eln-spaces/)). + + + + + + + +Spaces that do not belong to any group do not have a group prefix. In +the example below **Publications** do not belong to any group in the +Inventory. + + + + + + + +and **Horizon**, **Snf** do not belong to any group in the Lab notebook. + + + + + + + + + +## Instance Settings + + + +1. **Custom widget**s. This section allows to enable the Rich Text + Editor or Spreadsheet component for a given field, as described + in [Enable Rich Text Editor or Spreadsheet + Widgets;](https://openbis.ch/index.php/docs/admin-documentation/new-entity-type-registration/enable-rich-text-editor-or-spreadsheet-widgets/) +2. **Forced Monospace Font**. This section allows to force the use of + monospace font (i.e. fixed width) for selected MULTILINE\_VARCHAR + properties. This is useful for example for plasmid sequences. +3. **Dataset types for filenames**. This section allows to associate + files with a given extension to a specific dataset type, as + described in [Associate File Types to Dataset + Types](https://openbis.ch/index.php/docs/admin-documentation/associate-file-types-to-dataset-types/). + + + + + +## Group Settings + + + +1. **Storages**. In this section the storages for samples to be used in + *Spaces* not belonging to any predefined group (see above), can be + created, as described in [Configure Lab + Storage;](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-materials-and-samples/configure-lab-storage/) +2. **Templates**. In this section, the templates for a given *Object + type* to be used in *Spaces* not belonging to any predefined group + (see above) can be created, as described in [Create Templates for + Objects](https://openbis.ch/index.php/docs/admin-documentation/create-templates-for-objects/); +3. **Object types definition extension**. In this section, it is + possible to: + 1. Define if one *Object type* is a protocol. If an *Object type* + is defined as a protocol, it is possible to create a local copy + of it under an Experiment, when linking to it as a parent, as + described in [Enable Protocols in + Settings;](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-protocols/enable-protocols-in-settings/) + 2. Enable the storage widget for an *Object type,* as described + in [Enable Storage Widget on Sample + Forms](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-materials-and-samples/enable-storage-widget-on-sample-forms/) + 3. Define if the *Object type* should be shown in drop downs, as + described in [Enable Objects in + dropdowns](https://openbis.ch/index.php/docs/admin-documentation/new-entity-type-registration/enable-objects-in-dropdowns/); + 4. Define if the *Object type* should be shown in the main menu + under the Lab notebook section. By default objects are not shown + in the main menu in the Inventory section. + 5. Customise the *Parents* and *Children* sections for an *Object + type* as described in [Customise Parents and Children Sections + in Object + Forms](https://openbis.ch/index.php/docs/admin-documentation/customise-parents-and-children-sections-in-object-forms/); +4. **Inventory Spaces**. It is possible to move *Spaces* from the + Inventory section to the Lab notebook section and vice-versa as + described in [Move Spaces between Lab Notebook and + Inventory](https://openbis.ch/index.php/docs/admin-documentation/space-management/move-space-between-lab-notebook-and-inventory/) +5. **Main menu**. The main menu for the *Spaces* that do not belong to + any predefined group (see above) can be customised here, as + described in [Customise the Main + Menu;](https://openbis.ch/index.php/docs/admin-documentation/customise-the-main-menu/) +6. **Miscellaneous**. In this section it is possible to: + 1. Show the dataset archiving buttons in *Spaces* that do not + belong to any predefined group. Please note that this is not + available by default, but the infrastructure for [archiving to + tapes](https://openbis.ch/index.php/docs/user-documentation/data-archiving/) + (StrongBox/StrongLink) needs to be put in place by a *system + admin ([Multi data set + archiving](https://unlimited.ethz.ch/display/openBISDoc2010/Multi+data+set+archiving))*. + 2. Hide sections by default in *Spaces* that not belong to any + predefined group. By default some sections in some forms are + hidden: + 1. Description in *Spaces* and *Projects*. + 2. Identification info in *Spaces*, *Projects*, *Experiments*, + *Objects*, *Datasets*. + +By unchecking this option, these sections will be shown by default. + + + +Updated on April 26, 2023 + +## Group ELN Settings + +[](# "Print this article") + + + +In a multi group instance a *group admin* or *Instance admin* can +customise the ELN Settings for the group. + + + +The group Settings can be selected from the **Settings** in the main +menu. + + + + + + + +The Settings for the relevant group can be selected from the available +dropdown, as shown below. + + + + + + + + + +In the group settings the following is configurable: + + + +1. **Storages**. In this section the group storages for samples can be + created, as described in [Configure Lab + Storage;](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-materials-and-samples/configure-lab-storage/) +2. **Templates**. In this section, the templates for a given *Object + type* can be created, as described in [Create Templates for + Objects](https://openbis.ch/index.php/docs/admin-documentation/create-templates-for-objects/); +3. **Object types definition extension**. In this section, it is + possible to: + 1. Define if one *Object type* is a protocol. If an *Object type* + is defined as a protocol, it is possible to create a local copy + of it under an Experiment, when linking to it as a parent, as + described in [Enable Protocols in + Settings;](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-protocols/enable-protocols-in-settings/) + 2. Enable the storage widget for an *Object type,* as described + in [Enable Storage Widget on Sample + Forms](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-materials-and-samples/enable-storage-widget-on-sample-forms/) + 3. Define if the *Object type* should be shown in drop downs, as + described in [Enable Objects in + dropdowns](https://openbis.ch/index.php/docs/admin-documentation/new-entity-type-registration/enable-objects-in-dropdowns/); + 4. Define if the *Object type* should be shown in the main menu + under the Lab notebook section. By default objects are not shown + in the main menu in the Inventory section. + 5. Customise the Parents and Children sections for an *Object type* + as described in [Customise Parents and Children Sections in + Object + Forms](https://openbis.ch/index.php/docs/admin-documentation/customise-parents-and-children-sections-in-object-forms/); +4. **Inventory Spaces**. It is possible to move Spaces from the + Inventory section to the Lab notebook section and vice-versa as + described in [Move Spaces between Lab Notebook and + Inventory](https://openbis.ch/index.php/docs/admin-documentation/space-management/move-space-between-lab-notebook-and-inventory/) +5. **Main menu**. The main menu for the group can be customised here, + as described in [Customise the Main + Menu;](https://openbis.ch/index.php/docs/admin-documentation/customise-the-main-menu/) +6. **Miscellaneous**. In this section it is possible to: + 1. Show the dataset archiving buttons for the group. Please note + that this is not available by default, but the infrastructure + for [archiving to + tapes](https://openbis.ch/index.php/docs/user-documentation/data-archiving/) + (StrongBox/StrongLink) needs to be put in place by a *system + admin ([Multi data set + archiving](https://unlimited.ethz.ch/display/openBISDoc2010/Multi+data+set+archiving))*. + 2. Hide sections by default. By default some sections in some forms + are hidden: + 1. Description in *Spaces* and *Projects*. + 2. Identification info in *Spaces*, *Projects*, *Experiments*, + *Objects*, *Datasets*. + +By unchecking this option, these sections will be shown by default. + + + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.md b/docs/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.md new file mode 100644 index 0000000000000000000000000000000000000000..251cbd307538a9323416218e0032813b195bd673 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.md @@ -0,0 +1,169 @@ +New Entity Type Registration +==== + +## Enable Rich Text Editor or Spreadsheet Widgets + +[](# "Print this article") + + +For certain fields, it is possible to enable the use of a Rich Text +Editor (RTE) or a spreadsheet component. *Instance admin* rights are +necessary for this. + + +The **RTE** can be enabled for properties of type +**MULTILINE\_VARCHAR**. The **spreadsheet component** can be enabled for +properties of type **XML**. + + +Procedure: + + +1. Properties are defined when creating new entity types (*Datasets*, + *Objects*, *Experiments/Collections*) +2. To set a property as RTE or spreadsheet go to the **Settings**, + under **Utilities** +3. Select /ELN\_SETTINGS/GENERAL\_ELN\_SETTINGS +4. Enable editing and scroll down to the **Custom Widgets** section +5. Click the + button on the same line as **Property Type** and + **Widget**, as shown below +6. A new field will appear where you can select the property type and + the widget. Choices are: **Word Processor** (=RTE) or + **Spreadsheet.** + + + +Updated on October 19, 2022 + +## Enable Objects in dropdowns + +[](# "Print this article") + + + + + +By default, no Object shows in dropdown menus. Which object types should +show in dropdown menus can be customised from the Settings. + +1. Navigate to the Object Type definitions Extension +2. Open one Object Type (e.g. Antibody) +3. Select show in drop downs +4. Save the Settings + + + + + +Updated on October 19, 2022 + +## Register masterdata via Excel + +[](# "Print this article") + + + +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](https://openbis.ch/wp-content/uploads/2022/02/masterdata-template.xls) + +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](https://openbis.ch/wp-content/uploads/2022/02/masterdata-metadata.xls) + + + +More extensive documentation on the XLS format for masterdata and +metadata registration can be found +[here](https://unlimited.ethz.ch/display/openBISDoc2010/Excel+Import+Service). + +Updated on January 13, 2023 + +## Properties overview + +[](# "Print this article") + + + +The overview of all properties registered in openBIS and their +assignments to types is available under the **Types** section in the +admin UI, as shown below. + + + + + +Updated on March 1, 2022 + +## Internal properties and vocabularies + +[](# "Print this article") + + + +Some properties and vocabularies are internally defined in openBIS. + +These can be identified by the **$** sign. + + + +Internal properties (e.g. $NAME, $BARCODE, etc) cannot be deleted nor +modified, not even by an instance admin. + + + +Internal vocabularies (e.g. $DEFAULT\_COLLECTION\_VIEWS, etc), cannot be +deleted and their existing terms cannot be deleted nor modified, however +an instance admin can add new terms to an internal vocabulary. + + + +Updated on January 5, 2023 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/space-management.md b/docs/user-documentation/general-admin-users/admins-documentation/space-management.md new file mode 100644 index 0000000000000000000000000000000000000000..da05ff557d6f278b6795f9a4fdc7456cea24a716 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/space-management.md @@ -0,0 +1,297 @@ +Space Management +==== + +## Create new Inventory Spaces + +[](# "Print this article") + + +The default Inventory contains two +folders: **Materials** and **Methods**. These are openBIS *Spaces*. + +Additional *Spaces* can be created by an *Instance admin*. + + + +## Create a new Inventory Space from the ELN UI + + + +From openBIS version 20.10.4 it is possible to create *Spaces* directly +from the ELN interface. + +To create a new *Space* under the Inventory: + + + +1. Select **Inventory** in the main menu +2. Click on **+New Inventory Space** in the Inventory page + + + + + + + +3\. Enter the **Code** for the *Space*, e.g. EQUIPMENT. Please note that +codes only accept alphanumeric characters, –, . , \_. + +4\. **Save** + + + + + + + +### Multi-group instances + + + +In a multi-group instance, the *Instance admin* can choose where to +create a new *Space*: + + + +1. **no group**. The new *Space* will have no prefix and the Settings + defined in General Settings will apply (see [General ELN + Settings](https://openbis.ch/index.php/docs/admin-documentation/multi-group-set-up/general-eln-settings/)). +2. **in one of the existing groups**. The new *Space* will have the + group prefix and the Settings of that group will apply (see [Group + ELN + Settings](https://openbis.ch/index.php/docs/admin-documentation/multi-group-set-up/group-eln-settings/)). + + + + + + + + + + + +## Create a new Inventory Space from the core UI + + + +In the core UI: + + + +1. Select **Admin -> Spaces** +2. Click **Add Space** at the bottom of the page +3. Enter the *Space* **Code**, e.g. **EQUIPMENT** +4. **Save** + + + + + + + + +### Set Inventory Spaces + + +When new *Spaces* are created in the core UI, they are automatically +displayed under the *Lab Notebook* part of the ELN main menu. + +It is possible to move a new *Space* to the Inventory, by editing the +**Settings** under **Utilities** in the **ELN UI:** + + + +1. Go to the **Settings** and click **Edit.** +2. Go to the **Inventory Spaces** section in the **Settings** and click + the **+** button as shown below. +3. Select the *Space* you want to move to the *Inventory* from the list + of available *Spaces*. +4. **Save** the Settings. +5. Refresh the browser. + + + + + + + +Updated on April 26, 2023 + +## Create new ELN Spaces + +[](# "Print this article") + + +## Create a new Lab Notebook Space from the ELN UI + + + +From openBIS version 20.10.4 it is possible to create *Spaces* directly +from the ELN interface. To create a new Space under the Inventory: + + + +1. Select **Lab Notebook** in the main menu +2. Click on **+New** **Space** in the Lab Notebook page + + + +  + + + + +3\. Enter the **Code** for the *Space*. Please note that codes only +accept alphanumeric characters, –, . , \_. + +4\. **Save**   + + + + + +### Multi-group instances + + + +In a multi-group instance, the *Instance admin* can choose where to +create a new *Space*: + + + +1. **no group**. The new *Space* will have no prefix and the Settings + defined in General Settings will apply (see [General ELN + Settings](https://openbis.ch/index.php/docs/admin-documentation/multi-group-set-up/general-eln-settings/)). +2. **in one of the existing groups**. The new *Space* will have the + group prefix and the Settings of that group will apply (see [Group + ELN + Settings](https://openbis.ch/index.php/docs/admin-documentation/multi-group-set-up/group-eln-settings/)). + + + + + + + + + + + +Use cases where this could be useful: + +1. in a multi-group instance with user folders in the Lab Notebook it + is desired to have in addition some *Spaces* that are not linked to + a particular user, but maybe rather to some projects. +2. in a multi-group instance it is not at all desired to have the lab + notebooks organised by users, but rather by projects. A *system + admin* can configure the user management config file not to create + users folders in the lab notebook section (see [Multi group + instances](https://unlimited.ethz.ch/display/openBISDoc2010/User+Group+Management+for+Multi-groups+openBIS+Instances)). + + + +The rights for *Spaces* not belonging to any group need to be manually +assigned by an *Instance admin*. + + + +## Create a new Lab Notebook Space from the core UI + + + +In the core UI:  + + + +1. Select **Admin -> Spaces** +2. Click **Add Space** at the bottom of the page +3. Enter the Space **Code**, e.g. **EQUIPMENT** +4. **Save** + + + + + + + +By default all *Spaces* created in the core UI are shown under the Lab +Notebook part of the ELN UI. + +Updated on April 26, 2023 + +## Delete Spaces + +[](# "Print this article") + + + +*Spaces* can be deleted by *Instance admins* or by *Space admins*. + + + +To delete a *Space*: + +1. Click on the **Space** in the main menu +2. Select **Delete** from the **More..** dropdown + + + + + +3\. Provide a **reason** for deletion + +4\. **Accept** + + + + + +Notes: + +*Spaces* are not moved to the trashcan, but they are permanently deleted +straight away. + +*Spaces* can only be deleted when they are empty and no entries +previously belonging to the *Space* are in the trashcan. + + + + + + + +Updated on April 26, 2023 + +## Move Spaces between Lab Notebook and Inventory + +[](# "Print this article") + + + +If a *Space* belongs to the Inventory, this information is stored in the +**ELN Settings,** under the section **Inventory Spaces.** + + + +To move a *Space* from the Lab Notebook to the Inventory, click on the +**+** button on top of the **Inventory Spaces** section, select the +*Space* you want to move and **Save** the Settings. + + + +To move a *Space* from the Inventory to the Lab Notebook, click on the +**–** button next to the *Space* you want to remove in the **Inventory +Spaces** section and **Save** the Settings. + + + +ELN Settings can be edited by Instance admins, group admins in +multi-group instances and by anyone with admin rights to the +ELN\_SETTINGS *Space*. + + + + + +Updated on August 2, 2022 diff --git a/docs/user-documentation/general-admin-users/admins-documentation/user-registration.md b/docs/user-documentation/general-admin-users/admins-documentation/user-registration.md new file mode 100644 index 0000000000000000000000000000000000000000..e9bafc3bba1aac2c6b66c94885bbd9c1f8c06820 --- /dev/null +++ b/docs/user-documentation/general-admin-users/admins-documentation/user-registration.md @@ -0,0 +1,201 @@ +User Registration +==== + +## openBIS roles + +[](# "Print this article") + + + + +### Observer + +This role can be assigned to the whole openBIS instance (*Instance +Observer*) or to specific *Spaces* or *Projects* (*Space* or *Project +Observer*). Users with this role have read-only access to the whole +openBIS (*Instance Observer*), or to a specified *Space* or *Project* +(*Space* or *Project Observer*). + +An Observer can see and search everything in an openBIS instance or the +*Space/Project* which they have access to. They can also download +datasets. They cannot modify nor delete anything. + + + +### Space/Project User + +Extends Observer permissions with some creating and editing +functionality. Permissions are limited to specified *Space(s)* or +*Project(s)*. + +Can do everything that Observer and additionally: + +- create + - objects + - collections +- edit + - objects + - collections + - projects + + + +### Space/Project Power User + +Extends *Space/Projec*t User permissions with some deleting, editing and +processing functionality. Permissions are limited to specified +*Space(s)* or *Project(s)*. + +Can do everything that *Space/Project* User and additionally: + +- create projects +- delete + - projects + - data sets + - objects + - collections + +Please note that this role cannot be assigned via the ELN UI, only via +admin UI. + + +### Space/Project Admin + +Extends Space/Project Power User permissions allowing to manage roles +and projects inside given *Space(s)* or *Project(s)*. + +Can do everything that Space/Project Power User and additionally: + +- assign and remove Space/Project roles + + + +### Instance Admin + +Has the full access to given openBIS instance. + +Can do everything that Space/Project Admin and additionally: + +- create + - space + - material + - person + - property type + - vocabulary + - material type + - object type + - collection type + - data set type +- create/delete instance admin role +- edit + - material + - property type + - property type assignment + - vocabulary + - material type + - object type + - collection type + - data set type +- assign/unassign property type +- delete + - space + - vocabulary terms + - material type + - sample type + - experiment type + - data set type + + + +Please note that this role cannot be assigned via the ELN UI, only via +admin UI. + + + + +Updated on April 26, 2023 + +## User Profile + +[](# "Print this article") + +In the User Profile, a user who is logged in into openBIS can find the +following information: + + + +1. **First Name** +2. **Last Name** +3. **Email** +4. **openBIS session token** +5. **Zenodo API Token** ([Export to + Zenodo](https://openbis.ch/index.php/docs/user-documentation-20-10-3/data-export/export-to-zenodo/)) + + + +First name, last name and email are automatically filled in when LDAP or +SSO are used for authentication. + +In case of file-based authentication, this information can be entered +here directly from the user. + + + + + + + +For file-based authentication, users can also change their password +here, from the **Change Password** option under the **More..** dropdown. + + + + + +Updated on June 28, 2022 + +## Assign home space to a user + +[](# "Print this article") + + + +When a home space is assigned to a user, this becomes marked as **My +Space** for that user in the lab notebook, as shown below. + + + + + + + +When users are registered via the ELN UI, a *Space* with their username +is created (see [User +Registration)](https://openbis.ch/index.php/docs/admin-documentation/user-registration/) +and this is automatically set as home space for the user. + +The same happens in multi-group instances where spaces are created for +each user in the lab notebook section. + +An *instance admin* can change the home space of a user or assign one to +a user that does not have a home space assigned from the admin UI, as +shown below. + + + + + + + +Please note that when a user is inactivated, the home space assigned to +that user is moved in the ELN UI to the folder **Others (disabled).** If +this is not desired, the space should be removed as home space from the +inactivated user. This can be done by an *instance admin*. + + + + + + + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-admin-users/index.rst b/docs/user-documentation/general-admin-users/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d08734a0e5c3cfda7f20c8cff25008bb79b3fb24 --- /dev/null +++ b/docs/user-documentation/general-admin-users/index.rst @@ -0,0 +1,8 @@ +##################### +General Admin Users +##################### + +.. toctree:: + :maxdepth: 4 + + Admins Documentation </user-documentation/general-admin-users/admins-documentation/index> diff --git a/docs/user-documentation/general-users/additional-functionalities.md b/docs/user-documentation/general-users/additional-functionalities.md new file mode 100644 index 0000000000000000000000000000000000000000..47f8b06e6583f1b285c57943c36487829264d9c4 --- /dev/null +++ b/docs/user-documentation/general-users/additional-functionalities.md @@ -0,0 +1,723 @@ +Additional Functionalities +========================== + +## Visualise Relationships + +[](# "Print this article") + + +Parent-child relationships between *Objects* can be visualised as trees +or tables in the ELN. + +To see the genealogical tree, select the **Hierarchy Graph** option from +the **More…**dropdown in an entity form*.* + + + + + + + +Large trees can be pruned, by selecting how many levels of parents +and/or children and which types to show. + + + + + +To view the genealogy of an *Object* in a tabular format, select the +**Hierarchy Table** option from the **More…** dropdown. + +Updated on March 4, 2022 + +## Tables + +[](# "Print this article") + + + +All tables in the ELN have a similar format and functionalities. The +tables have been redesigned for the 20.10.3 release of openBIS. + +Here we give an overview of the main functionalities of the tables. + + + +## Filters + +Two filter options are available form the **Filters** button: **Filter +Per Column** and **Global Filter**. The first allows to filter on +individual columns, or multiple columns, whereas the second filters +terms across the entire table using the **AND** or **OR** operator. + +>  +> + +> + +> +>  + +>  + +## Sorting + +It is possible to sort individual columns or also multiple columns. For +multi-column sorting, you should click on the column header and press +the **Cmd** keyboard key. The order of sorting is shown by a number in +each column, as shown below. + + + + + +>  + +## Exports + +Tables can be exported in different ways, using the export button shown +below. + +>  + + + +>  +> +> 1. 1. **Import Compatible**: +> 1. **Yes**: in this case some columns which are incompatible +> with imports (i.e. registration date, registrator, +> modification date, modifier) are not exported even if +> selected; some columns that are required by openBIS for +> imports are added to the exported file even if not +> selected (i.e. code, identifier, $ column). Moreover text +> fields are exported in HTML, to keep the formatting upon +> import. +> 2. **No**: in this case all columns or selected columns are +> exported. +> +>  +> + +> +>  +> +>  +> +> 2\. **Columns**: +> +> 1. 1. 1. **All (default order)**. All columns are exported, in +> accordance with the selection explained above for import +> compatibility. +> 2. **Selected (shown order)**. Selected columns are exported, +> in accordance with the selection explained above for +> import compatibility. +> + +> +>  +> +>  3. **Rows**: +> +> 1. 1. 1. 1. **All Pages**. All pages of the table are exported. +> 2. **Current Page**. Only the currently visible page of +> the table is exported. +> 3. **Selected Rows**. Only selected rows in the table are +> exported. +> + +> +> 4\. **Value**: +> +> 1. 1. 1. **Plain Text**. Text fields are exported in plain text, +> without any formatting. This option is not available if +> the export is import-compatible. +> 2. **Rich Text**. Text fields are exported in HTML format. +> + +> +>  +> +> Tables are exported to **XLS** format. Exported tables can be used for +> updates via the **XLS Batch Update Objects**. +> +>  +> +>  +> +>  + +## Columns + +Users can select which properties to display in the table clicking on +the **Columns** button. It is also possible to show all properties or +hide all properties. The position of the columns can also be changed by +placing the cursor next to the = sign in the list and moving the fields. +This information is stored in the database for each user. + + + + + + + +### **Spreadsheets** + +If a table contains *Objects* which have a spreadsheet field which is +filled in, a spreadsheet icon is displayed in the table. Upon clicking +on the icon, the content of the spreadsheet can be expanded.  + +>  +> + +> + +> +>  + +### Text fields + +If a table contains Objects which have long text fields, only the +beginning of the text is shown and can be expanded. If the text contains +a picture or a table, an icon is shown in the table and the content of +the text becomes visible by clicking on the icon. + +>  +> + +> +>  + +## **Selection of entries in table** + +Single entries in a table can be selected using the checkbox in the row. +By clicking the checkbox in the table header, all entries of the table +are selected. After selection of entries, some actions become available: + +> - **Delete**: allows to move the selected entries to the trashcan. +> - **Move**: allows to move the selected entries to a different +> *Collection/Experiment.* +> - **Generate barcodes**: allows to generate custom barcodes for the +> selected entries. +> - **Update custom barcodes**: allows to update existing custom +> barcodes of the selected entries. +> - **Clear selection**: allows to clear the selection made. + + + + + + + +In *Object* tables inside *Experiments/Collections* there is an +**Operations** column, which allow users to perform certain tasks on an +*Object*: + +> 1. Upload a file to the *Object* +> 2. Move the *Object* to another Experiment/Collection. +> 3. Update Barcode. +> 4. Open the hierarchy graph. This is the graph showing parent/child +> connections of the *Object*. +> 5. Open the hierarchy table. This is the table showing parent/child +> connections of the *Object*. + + + + + + + + + + + + + +Updated on April 26, 2023 + +## Browse Entries by Type + +[](# "Print this article") + + +The **Object Browser** under the **Utilities** main menu allows to see +all entries of the same type and all *Experimental Steps*, which may be +contained in different *Experiments/Collections* and *Projects*. + + + +This is useful when there are entries of a certain type that belong to +different *Collections* (e.g. protocols of the same type stored in two +different protocol collections), or to have an overview of all +*Experimental Steps*, independently of the *Experiment* they belong to. + + + + + +From the **Object Browser** page, it is also possible to **Batch +register** or **Batch update** *Objects* using an XLS or TSV template. + + + + + + + + + +Updated on April 25, 2023 + +## Trashcan + +[](# "Print this article") + + +When *Experiments*, *Objects* and *Datasets* are deleted, they are moved +to the openBIS **trashcan**, under the **Utilities** main menu. Items +can be removed from the trashcan only by someone with *Space admin* or +*Instance admin* role. Deletion from the trashcan is **IRREVERSIBLE**. + + + +Note: *Spaces* and *Projects* are directly permanently deleted, they are +not moved to the trashcan first. + + + +To empty the whole trashcan, click the blue **Empty Trash **button above +the table. + +To delete permanently single entries choose one of two options from the +Operations dropdown: + + + +- **delete permanently**: deletes permanently only the selected entry. +- **delete permanently (including dependent deletions)**: if the + selected entry had children which are also in the trashcan, this + option allows to permanently delete both the entry and its children. + + + +If one entity was unintentionally deleted, the operation can be reverted +at this stage by choosing the** Revert Deletions** option from +the **Operations** drop down in the table. + + + + + +Updated on October 9, 2022 + +## Vocabulary Browser + +[](# "Print this article") + + +The **Vocabulary browser** is accessible from the **Utilities** main +menu. This shows all controlled vocabularies registered in openBIS and +the terms they contain. Vocabularies are predefined lists of values to +choose from in given fields. Vocabularies can be created/modified by an +openBIS *Instance admin* (see [New Entity Type +Registration](https://openbis.ch/index.php/docs/admin-documentation-openbis-19-06-4/new-entity-type-registration/)). + +This information is needed for filling the forms for **Batch +Upload **or**Batch Update** of *Objects* via TSV file. If an *Object* +has a property of type *Controlled Vocabulary*, the codes of the +vocabulary have to be entered in the .tsv template file. This is not the +case for XLS Batch registration or update, where labels can be used. + + + + + +Updated on April 25, 2023 + +## Freeze Entities + +[](# "Print this article") + + +Each level of the openBIS hierarchy (Space, Project, +Experiment/Collection, Object, Dataset) can be frozen, so it can be no +longer edited and/or deleted. + +At every level, everything contained underneath is selected by default +to be frozen. E.g. if I choose to freeze a Space, everything contained +in the Space is automatically selected to be frozen. Single entities can +be manually unselected. + +A Space admin role is necessary to freeze entities in a given Space. + + +**IMPORTANT: the freezing is IRREVERSIBLE!** + + +This operation cannot be undone from any UI, not even by an *Instance +admin.* Please freeze entities only when you are absolutely sure that +they should not be further modified! + +### **How to freeze an entity** + + +At each level of the openBIS hierarchy (*Space, Project, +Experiment/Collection, Object, Dataset*) the **Freeze Entity** option is +available under the **More..** dropdown menu. See the example for a +*Space* below. + + + + + + + + + + + +If you select this, a list of entities contained or connected to the one +selected will be presented to you, as shown below. By default everything +is selected, so you need to unselect entries that you do not want to +freeze. + + + + + + + + + +To freeze one or several entities, you need to provide your login +password and save. + + +**Rules for freezing** + + + +1. **Freeze Space only** + +[TABLE] + + + + + +1. **Freeze Project only** + + + + + +[TABLE] + + + + + +**3. Freeze Experiment/Collection only** + + + + + +[TABLE] + + + + + +**4. Freeze Object only** + + + + + +[TABLE] + + + + + + + +**5. Freeze Dataset only ** + + + + +[TABLE] + + +Updated on April 25, 2023 + +## Navigation menu + +[](# "Print this article") + + + +openBIS 20.10.6 features a new navigation menu. + + + + + + + +This has the following functionalities: + + + +**1.Filter**. You can filter the menu by names or codes. + + + + + + + + + +**2. Root nodes**. If you do not want to navigate the full menu, but +only a section of it, you can set the section you want to navigate as +root node, by clicking the icon shown in the picture below. + + + + + + + +This now becomes the root node, as shown below. To restore the full menu +view, you can click on the root node icon shown below. + + + + + +**3. Sorting**. The default sorting of the menu is in alphabetical. It +is now possible to sort separately individual sections of the menu +(*ELN, Inventory, Stock*) and individual nodes inside those sections. It +is possible to do a custom sorting by moving around (drag&drop) entities +in the menu. Please note that this is only possible inside a given +level, i.e. you can re-organise *Objects* inside a +*Collection/Experiment*; *Collections/Experiments* inside a *Project*; +*Projects* inside a *Space*. However, you cannot move entities from one +level to another, i.e. you cannot move an *Object* to a different +*Collection/Experiment*; a *Collection/Experimen*t to a different +*Project*; a *Project* to a different *Space*. This can only be done +from the **Move** option under the **More..** dropdown menu in the +forms. + + + + + + + + + + + + + + + +**4. Collapse/Expand.** The full menu or individual nodes can be +expanded or collapsed, with the button shown below. + + + + + + + + + + + +**5. Scroll to selected node**. In some cases, the view in the main ELN +page does not correspond to an entry selected in the menu. You can +scroll to the selected node in the menu, using the button shown below. + + + + + + + +The state of the menu is saved. Every time you change something in the +menu, this change will be saved and when you login next time you will +see the menu in the state you last saved it. + +Updated on April 26, 2023 + +## Custom Imports + +[](# "Print this article") + + + +From openBIS version 20.10.4, Custom Imports, previously available only +in the core UI, are available in the ELN UI. + + + +Custom imports allow users to import metadata in a custom way, by using +a dropbox script in the background. You can use this if you want to +parse a file in a given format and import the information from this file +as metadata in openBIS. + + + +Custom imports are not available by default, but need to be enabled on +the server side by a *system admin*, and a dropbox script needs to be +associated with an import (see [Custom +Imports](https://unlimited.ethz.ch/display/openBISDoc2010/Custom+Import)). + + + +If one or more custom imports are configured in openBIS, the **Custom +Import** option is available under the **Utilities** in the **main +menu**. + +The available custom imports can be selected from the **Custom Import +Service** drop down menu in the Custom Import page (see below) + + + + + + + +If the available custom import provides a template that can be used as +input for the import, the template will be available to download from +the Custom Import page. + + + + + + + +If the custom import is not configured to provide a template, no +download link is shown in the Custom Import page. + + + + + + + +Updated on April 26, 2023 + +## Entity history + +[](# "Print this article") + + + +Whenever an entity of type *Collection/Experiment*, *Object* or +*Dataset* is modified in openBIS, the changes are stored in the +database. The stored changes are modifications to property fields, +addition and deletion of parents/children for *Objects* and *Datasets*, +changes of *Space/Project/Experiment/Object* ownership if an entity is +moved. + +The **History** of changes of each entity is now available in the ELN +UI. In versions prior to openBIS 20.10.3 this was only available in the +core UI. + + + + + +### History table for Collections + + + +In a *Collection* page, the **History** can be accessed from the +**More..** dropdown list. + + + + + + + +The **History** table shows the version number of the changes, the +author of the changes, the changes made (with the values before- in red, +and after the change – in green), and the timestamp, i.e. the time when +the changes were made. + + + +For a *Collection*, the **PermID** (Permanent Identifier) of the +*Project* it belongs to is shown. If a *Collection* is moved from one +*Project* to another, the PermID of the old and new *Projects* are shown +in the history table. + + + + + + + + + +The **show** option in **Full Document** shows the full metadata of the +entry (not only the changed fields) when changes were applied. This is +displayed in JSON format. + + + + + + + + + +### History table for Objects + + + +For every *Object*, the history of changes can be accessed from the +**More..** dropdown on the *Object* page. + + + + + + + + + +For an *Object*, the **PermID** (Permanent Identifier) of the +*Collection* it belongs to is shown. If an *Object* is moved from one +*Collection* to another, the PermID of the old and new *Collections* are +shown in the history table. + + + +### History table for Datasets + + + +For every dataset, the history of changes can be accessed from the +**More..** dropdown on the *Dataset* page. + + + + + + + +For a *Dataset*, the **PermID** (Permanent Identifier) of the +*Object*/*Collection* it belongs to is shown. If a* Dataset* is moved +from one *Object*/*Collection* to another, the PermID of the old and new +*Objects*/*Collections* are shown in the history table. + +Updated on November 10, 2022 diff --git a/docs/user-documentation/general-users/barcodes.md b/docs/user-documentation/general-users/barcodes.md new file mode 100644 index 0000000000000000000000000000000000000000..d6e2b9812ab3d04cd15ea95e59bddaca70dfb0bd --- /dev/null +++ b/docs/user-documentation/general-users/barcodes.md @@ -0,0 +1,134 @@ +Barcodes +==== + + +[](# "Print this article") + + + + + +## Printers + +There are several manufacturers of printers and different kinds of +barcodes and paper to adapt to different use cases. Most manufacturers +have their own proprietary printer driver and language for labels. + +To allow freedom of choice for the barcode printer, the openBIS ELN-LIMS +allows to configure both the type of barcodes and the layout and size of +the labels. openBIS uses this information to produce a PDF document, +thus having as single requirement that the printer driver used allows to +print PDF documents using applications such as Adobe Acrobat Reader or +Preview (Mac). + + + +### Printer Configuration + +There are different types of printer drivers. The two types we can +define as generic are **PS** (PostScript) (recommended) and **PCL** +(Printer Command Language). Printers with these drivers are likely to +print PDF documents and other types of documents with embedded fonts, +images, etc… + +The printer paper type needs to be configured for each printer. Two +layouts are supported: + +- **Split**: The PDF will contain separate pages with each barcode. +- **Continuous**: The PDF will contain a continuous layout with the + barcodes. More uncommon for this applications. + +The printer paper size needs to be configured for each printer. It is +possible to indicate the size of the barcode, so it can fit. + + + +### Printer testing + +We provide two example documents that can be used to test the printer. + + + +- Split barcodes example PDF: + [printer-test-code128-split-50-15](https://openbis.ch/wp-content/uploads/2021/08/printer-test-code128-split-50-15.pdf) +- Continuous barcodes example PDF: + [printer-test-code128-continuous-50-15](https://openbis.ch/wp-content/uploads/2021/08/printer-test-code128-continuous-50-15.pdf) + + + +Please consider that these examples likely do not correspond to the +particular paper size of the printer being evaluated and as such the +barcodes may look squashed. In order to obtain optimal results, the +paper size would need to be configured. However, for the test it is +enough to verify that the printer can print those files. + + + + + +### Printer Advice before purchasing + +Before purchasing a printer, we recommend to check with the manufacturer +that the barcode printer provides a general driver and that it can print +one of the documents provided as example above. + + + +### Tested Printers + +- Zebra ZD420 + + + + +## Scanners + +There are several manufacturers of barcode scanners. In most cases +scanners act as a keyboard for the computer, so when the barcode scanner +scans a barcode it will type whatever has been scanned. + + + +### Scanner Configuration + +The scanner keyboard layout should be the same as the computer used. If +not this could cause problems if there are any special characters. + + + +### Scanner testing + +Open a notepad and scan the barcodes provided in the examples below. The +scanner should read them and type the correct output. + + + +- Barcode Code 128. + [scanner-test-code128-50-15](https://openbis.ch/wp-content/uploads/2021/08/scanner-test-code128-50-15.pdf). + This should give as output “20210720122856003-454071†without + quotes. +- Barcode QR Code. + [scanner-test-qrcode-50-50](https://openbis.ch/wp-content/uploads/2021/08/scanner-test-qrcode-50-50.pdf). + This should give as output “20210720122856003-454071†without + quotes. +- Barcode Micro QR Code. + [scanner-test-microqrcode-30-30](https://openbis.ch/wp-content/uploads/2021/08/scanner-test-microqrcode-30-30.pdf). + This should give as output “20210720122856003-454071†without + quotes. + + + + +### Scanner Advice before purchasing + +Before purchasing a scanner, ensure that the barcode scanner provides a +keyboard driver and ask the manufacturer’s support to scan the examples +above. + + + +### Tested Scanners + +- Honeywell 1902G-BF + +Updated on July 27, 2022 diff --git a/docs/user-documentation/general-users/data-archiving.md b/docs/user-documentation/general-users/data-archiving.md new file mode 100644 index 0000000000000000000000000000000000000000..5e402ebe577dab3737054169aa646c19243a5a91 --- /dev/null +++ b/docs/user-documentation/general-users/data-archiving.md @@ -0,0 +1,96 @@ +# Data archiving + +[](# "Print this article") + + + +## Dataset archiving + + + +openBIS supports archiving of datasets to Strongbox +([https://www.strongboxdata.com/](https://www.strongboxdata.com/)) as +described in [Datasets +Archiving](https://unlimited.ethz.ch/display/openBISDoc2010/Archiving+Datasets) + + + +This needs to be set up and configured by a *system admin*. + + + +To trigger archiving manually from the ELN, navigate to a dataset and +use the *Request or disallow archiving* button, as shown below. + + + + + + + + + + + +Please note that the strongbox has a minimum size requirement of +**10GB**. If a single dataset is below this threshold it will be queued +for archiving and it will be archived only when additional datasets in +the same *Space/Project/Experiment* are selected for archiving and the +minimum size is reached. All datasets are bundled together and archived +together. This implies that if unarchiving is requested for one dataset +in a bundle, all other datasets will also be unarchived. + + + +### Dataset archiving helper tool + + + +If you wish to archive multiple datasets, you can use the **Archiving +Helper** tool under **Utilities** in the main menu. You can search for +datasets and select multiple ones to be archived, by clicking the +**Request Archiving** button on the top of the page. + + + + + +It is possible to search datasets by size, by selecting *Property* in +the **Field Type**, *Size (bytes)\[ATTR.SIZE\]* in the **Field Name** +and the desired **Comparator Operator**, as shown below. + + + + + +## Dataset unarchiving + + + +Once the dataset is archived on tapes, the button on the dataset page +changes to **Unarchive**, as shown below. Datasets can be unarchived by +using this button. + + + + + + + + + + +### Dataset unarchiving helper tool + + + +To unarchive several datasets it is possible to use the **Unarchiving +Helper** tool, under **Utilities** in the main menu, as shown below. You +can search for datasets and select multiple ones to be unarchived, using +the **Unarchive** button on tope of the page. + + + + + +Updated on April 25, 2023 diff --git a/docs/user-documentation/general-users/data-export.md b/docs/user-documentation/general-users/data-export.md new file mode 100644 index 0000000000000000000000000000000000000000..cbad0587068d7e5a4776b55ed88b9db4997bc02a --- /dev/null +++ b/docs/user-documentation/general-users/data-export.md @@ -0,0 +1,198 @@ +Data Export +==== + +## Export to File + +[](# "Print this article") + + +### Export Lab Notebooks + + +All levels of the *Lab Notebook* and *Inventory* can be exported, using +the 2 export options in the **More..** drop down, as shown below. It is +possible to export metadata only, or metadata and data (up to 10 GBs). + + + + + + + + + +In this way, users can export their complete lab notebook with all data +contained in it. Everything is exported to a zip file, which maintains +the same structure used in openBIS. Each folder contains several file +formats (*.txt, .html, .json, .docx*) with the metadata of the +corresponding *Project, Experiment, Object and Datasets* (see below). + + + + + + +A link to download the zip file is sent via email to the user. Email +notification needs to be configured by a *system admin* during or after +installation, as explained in [Configure Data Store +Server](https://unlimited.ethz.ch/display/openBISDoc2010/Installation+and+Administrators+Guide+of+the+openBIS+Data+Store+Server) +[.](https://wiki-bsse.ethz.ch/display/openBISDoc1906/Installation+and+Administrators+Guide+of+the+openBIS+Data+Store+Server) + + +In a similar way, it is possible to export *Projects*, *Experiments, +Objects, Dataset*s. + +### Export Builder + + +It is also possible to export the content of openBIS using the +**Export** **to ZIP** under **Exports** in the **Utilities** main menu. + Here users can select items from different *Spaces* and export them by +clicking the **Export Selected** button. + + + +Also in this case, a link to download the data is sent to the user via +email, as described above. + + + + + + + +Updated on April 25, 2023 + +## Export to Zenodo + +[](# "Print this article") + + +Currently openBIS offers an integration with the **Zenodo** data +repository ([https://zenodo.org/).](https://zenodo.org/) + + +This enables data direct data transfer from openBIS to Zenodo. First of +all the connection to Zenodo needs to be configured by a *system admin* +in the DSS service.properties (see [How to configure the openBIS +DSS)](https://unlimited.ethz.ch/display/openBISDoc2010/Installation+and+Administrators+Guide+of+the+openBIS+Data+Store+Server) +If this is configured, a lab manager, who has admin rights for the +**Settings,** needs to enable it in the ELN, as explained in [Enable +Transfer to Data +Repositories](https://openbis.ch/index.php/docs/admin-documentation-openbis-19-06-4/enable-transfer-to-data-repositories/)**.** + +### Create Zenodo Personal Access Token + + +In order to be able to export data to Zenodo, you need a valid Zenodo +account. You also need to create a **personal access token.** This can +be done from the **Applications** under **Settings** in Zenodo, as shown +below: + + + +### Save Zenodo Personal Access Token in openBIS + + +After creating the personal access token in Zenodo, this needs to be +stored in openBIS, with the following procedure: + +1. Go to **User Profile** under **Utilities** in the main menu. +2. Enable editing. +3. Add the personal access token from Zenodo. +4. **Save.** + + + + + + +### Export data to Zenodo + + +To export data to Zenodo: + +1. Go to **Exports** -> **Export to Zenodo** under **Utilities** in + the main menu. +2. Select the data you want to export from the menu. +3. enter a **Submission** **Title.** +4. Click **Export Selected** on top of the export form. +5. The selected data are transferred as a zip file to Zenodo. You are + now redirected to Zenodo, where you should fill in additional + metadata information. +6. Publish the entry in Zenodo. + + + + + + + + + +After you hit the **Publish** button in Zenodo, a new entry with the +details of this submission will be created in the **Publications** +folder in the **Inventory**. Please note that this may take a few +minutes. + + + + + +Updated on April 25, 2023 + +## Export to ETH Research Collection + +[](# "Print this article") + + + +The [ETH Research Collection](https://www.research-collection.ethz.ch/) +is a FAIR repository for publications and research data provided by ETH +Zurich to its scientists. + + + +Data can be uploaded to the ETH Research Collection **only by members of +ETH Zurich**. This export feature is only available to ETHZ members. + + + +To export data to the ETH Research Collection: + + + +1. Go to **Utilities** -> **Exports** -> **Export to Research + Collection**. +2. Select what to export from the tree. +3. Select the **Submission Type** from the available list: *Data + collection, Dataset, Image, Model, Sound, Video, Other Research + Data*. +4. Select the **Retention Period** that will be used in the ETH + Research Collection: *10 years, 15 years, indefinite.* This is time + for which the data will be preserved in the Research Collection. +5. Click the **Export Selected** button on top of the page. +6. The selected data are transferred as zip file to the ETH Research + Collection. You will be redirected to the ETH Research Collection + and will need to complete the submission process there. + + + + + + + +A new entry with the details of this submission will be created in the +**Publications** folder in the **Inventory** after the submission +process in complete. This may take a few minutes. + + + +The size limit for one single export to the ETH Research Collection is +10GB. + + + + + +Updated on April 25, 2023 diff --git a/docs/user-documentation/general-users/data-upload.md b/docs/user-documentation/general-users/data-upload.md new file mode 100644 index 0000000000000000000000000000000000000000..8809b54d753baf9bca6a01d224c009c4d78dfdce --- /dev/null +++ b/docs/user-documentation/general-users/data-upload.md @@ -0,0 +1,284 @@ +Data Upload +==== + +## Data upload via web UI + +[](# "Print this article") + + + + To upload data via the web interface: + + + +1.Click the **Upload** button in the form, as shown below. + + + +2\. Select the dataset type (e.g. Attachment). + +3\. Fill in the relevant fields in the form. It is advisable to always +enter a **Name**, because this is shown in the menu. If the name is not +provided, the dataset code is shown. + +4\. Drag and drop files in the **Files** **Uploader** area or browse for +files. + +5\. When uploading a zip file, the option to **uncompress before +import** will be presented in the form. + +6\. **Save.**  + + + + + + + +**Note for MacOS users: **the default MacOS archiver generates hidden +folders that become visible in openBIS upon unarchive. To avoid this +there are two options: + +1. Zip using the following command on the command-line: *zip -r +  folder-name.zip folder-name/\* -x “\*.DS\_Storeâ€* +2. Use an external archiver (e.g. Stuffit Deluxe). + +Updated on March 23, 2023 + +## Data upload via dropbox + +[](# "Print this article") + + + +Web upload of data files is only suitable for files of limited size (few +GB). To upload larger data, openBIS uses dropbox scripts that run in the +background (see +[Dropboxes](https://unlimited.ethz.ch/display/openBISDoc2010/Dropboxes)). +A default dropbox script is provided with the openBIS ELN-LIMS plugin, +and the dropbox folder needs to be set up by a *system admin*. + +If this is available, users need to organise their data in a specific +way: + + + +**Folder 1** + +**     Data** (can be single files or folders) + + + +**Folder 1** needs to have a specific name that encodes the information +of where the data should be uploaded to openBIS. + +The name of **Folder 1** can be generated from the ELN interface: + + + +1. From the page where you want to upload data, select **Dataset upload + helper tool for eln-lims dropbox** from the **More…** dropdown and + follow the instructions on screen. + + + + + + + +2\. Select: + +1. The dataset type from the list of available types (mandatory); +2. Enter the name of your dataset (optional, but recommended); +3. Copy the generated name of the folder using the copy to clipboard + icon. + + + + + + + +3\. In your finder/explorer, create a new folder and paste the name you +copied from openBIS. Place your data in this folder. + + + + + + + +4\. Place this folder containing your data inside the +**eln-lims-dropbox** folder. openBIS continuously monitors this folder +and when data are placed here, they are **moved** to the final storage. +The move happens after a predefined (and customisable) inactivity period +on the eln-lims-dropbox folder. + + + +## Dropbox with markerfile + + + +In case of uploads of data >100GB we recommend to configure the +**eln-lims-dropbox-marker**. The set up and configuration need to be +done by a *system admin*. The process of data preparation is the same as +described above, however in this case the data move to the openBIS final +storage only starts when a markerfile is placed in the +eln-lims-dropbox-marker folder. The marker file is an empty file with +this name:  **.MARKER\_is\_finished\_<folder-to-upload-name>. +**Please note the “.†at the start of the name, which indicates that +this is a hidden file. This file should also not have any extension. For +example, if the folder to be uploaded has the following name: + + + +O+BARILLAC+PROJECT\_1+EXP1+RAW\_DATA+test + + + +The marker file should be named: + + + +.MARKER\_is\_finished\_O+BARILLAC+PROJECT\_1+EXP1+RAW\_DATA+test + + + + + + + +### **How to create the Marker file in Windows** + + + +You can create the Marker file in Windows using a text editor such as +**Editor**. Any other text editor will also work. + +1. open **Editor.** +2. Save the file with a name such as + .*MARKER\_is\_finished\_O+BARILLAC+PROJECT\_1+EXP1+RAW\_DATA+test.* +3. The file is automatically saved with a “.txt†extension. This needs + to be removed. +4. Use the *Rename* option to remove the extension from the file. + + + + +### **How to create the Marker file on Mac** + + + +If you are not familiar with the command line, you can create an empty +text file using for example the **TextEdit** application in a Mac. Any +other text editor will also work. + +1. Open the **TextEdit** application and save an empty file with a name + such as + *.MARKER\_is\_finished\_O+BARILLAC+PROJECT\_1+EXP1+RAW\_DATA+test*. +2. Save to any format. +3. You will get a message to say that files starting with “.†are + reserved for the system and will be hidden. Confirm that you want to + use “.†+4. To show these hidden files, open the Finder and press **Command + + Shift + . (period)**. +5. The file you saved before has an extension, that needs to be + removed. If the extension is not shown in your Finder, go to Finder + > Preferences menu, select the Advanced tab, and check the “Show + all filename extensions†box. +6. Remove the extension from the file. + + + +## Dropbox monitor + + + +It is possible to check the status of the upload via dropbox using the +**Dropbox Monitor** under **Utilities** in the main menu. + +The Dropbox Monitor shows a table with all available dropboxes for a +given openBIS instance. By default, *default-dropbox, eln-lims-dropbox +and eln-lims-dropbox-marker* are shown. + +If data are uploaded in a dropbox folder, users can see the status of +the data upload in the table. A red face in the column **Last Status** +indicates a failure of data import, a green face indicates successful +data import. + + + + + + + +If you click on the row of the table above, you can see the details of +every upload attempt for a given dropbox, as shown below. For failures, +the log with the error is shown. + + + + + + + +## Registration of metadata for datasets via dropbox + + + +Starting from openBIS version 20.10.2, the default eln-lims dropbox +supports the registration of metadata for datasets. The metadata needs +to be provided in a file called **metadata.json.** This file should be +placed inside the folder with the openBIS-generated name described +above, together with the data. This is shown in the example below. + +O+BARILLAC+PROJECT\_1+EXP1+RAW\_DATA+test + +is the folder with the openBIS-generated name. Inside this folder there +is the metadata.json file, and the data, which consists of a few files +and 2 folders. + + + + + + + +For example, the metadata.json file for the default RAW\_DATA dataset +type would be: + +{ “properties†: + +{ “$NAME†: “my raw dataâ€, + +“NOTES†: “This is a test for metadata upload via dropbox†} + +} + + + +It is possible to download the template metadata.json file for each +dataset type from the **Other Tools** section under the **Utilities** in +the main menu. + + + + + + + + + + + +In **Other Tools**, there is also the **Show available storage space** +button, which shows the available storage space on the openBIS instance. +This is helpful in calculating how much space one might require for +future data upload, especially large data. + + + + + +Updated on April 26, 2023 diff --git a/docs/user-documentation/general-users/general-overview.md b/docs/user-documentation/general-users/general-overview.md new file mode 100644 index 0000000000000000000000000000000000000000..aad2540bc301c3af705110782853ea85ea6fab49 --- /dev/null +++ b/docs/user-documentation/general-users/general-overview.md @@ -0,0 +1,51 @@ +# General Overview + +[](# "Print this article") + + +The openBIS platform has three primary functionalities: + + +1. **Inventory management** of laboratory samples, materials, + protocols, equipment. +2. **Laboratory notebook**, to document lab experiments. +3. **Data management**, to store all data related to lab experiments + (raw, processed, analysed data, scripts, Jupyter notebooks, etc.). + + +It is possible to use all functionalities or only selected ones. + + + +In the most general use-case, the **Inventory** is shared by all lab +members, so everyone can access information about available lab +materials and regularly used protocols. + +In addition, every lab member has a personal folder in the **Lab +notebook**, where to organise projects and experiments. This folder can +be shared with other lab members or collaborators with openBIS access. +Experimental steps described in the lab notebook can be linked to +protocols and samples stored in the inventory. Experimental steps can +also be linked to each other. + +**Data** of any sort can be attached to the corresponding Experimental +step in different ways, depending on the size. + +Data can be exported to data repositories, such as +[Zenodo](https://zenodo.org/) or the [ETH Research +Collection](https://www.research-collection.ethz.ch/) (for ETHZ users +only). + + +This allows to have the complete overview of workflows and information, +from initial data generation to data analysis and publication. + + +The openBIS ELN interface can be accessed via a URL of this type: +**https://openbis-xxx/openbis/webapp/eln-lims/** + + +where *openbis-xxx* is the name of the server specified in the openBIS +configuration file, during the installation by a system admin. + +Updated on July 28, 2022 diff --git a/docs/user-documentation/general-users/img/Batch-update-entries-one-collection-column-selection-1024x584.png b/docs/user-documentation/general-users/img/Batch-update-entries-one-collection-column-selection-1024x584.png new file mode 100644 index 0000000000000000000000000000000000000000..3d55fd75248664573311a1fb2d92d05b01c7d7c7 Binary files /dev/null and b/docs/user-documentation/general-users/img/Batch-update-entries-one-collection-column-selection-1024x584.png differ diff --git a/docs/user-documentation/general-users/img/Batch-update-storage-positions.png b/docs/user-documentation/general-users/img/Batch-update-storage-positions.png new file mode 100644 index 0000000000000000000000000000000000000000..cc882c1898f8f007571235bd510b30ef770c56d8 Binary files /dev/null and b/docs/user-documentation/general-users/img/Batch-update-storage-positions.png differ diff --git a/docs/user-documentation/general-users/img/ELN-copy-exp-step.png b/docs/user-documentation/general-users/img/ELN-copy-exp-step.png new file mode 100644 index 0000000000000000000000000000000000000000..f4ffdb2239c32791a6a6b6dde5e13d54f3e95806 Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-copy-exp-step.png differ diff --git a/docs/user-documentation/general-users/img/ELN-create-project.png b/docs/user-documentation/general-users/img/ELN-create-project.png new file mode 100644 index 0000000000000000000000000000000000000000..33c94d52b11682810de613182450203b9975331b Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-create-project.png differ diff --git a/docs/user-documentation/general-users/img/ELN-new-exp-step-from-exp-step-1.png b/docs/user-documentation/general-users/img/ELN-new-exp-step-from-exp-step-1.png new file mode 100644 index 0000000000000000000000000000000000000000..209bbd19eda32eabf4e6e5077c503b486ec5a683 Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-new-exp-step-from-exp-step-1.png differ diff --git a/docs/user-documentation/general-users/img/ELN-new-exp-step-from-experiment.png b/docs/user-documentation/general-users/img/ELN-new-exp-step-from-experiment.png new file mode 100644 index 0000000000000000000000000000000000000000..eca39cc96a2b414e5d2cc67e9c0d77bb8290ff1e Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-new-exp-step-from-experiment.png differ diff --git a/docs/user-documentation/general-users/img/ELN-new-project.png b/docs/user-documentation/general-users/img/ELN-new-project.png new file mode 100644 index 0000000000000000000000000000000000000000..352c38b1df737e7f961161480e933bec07f114f4 Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-new-project.png differ diff --git a/docs/user-documentation/general-users/img/ELN-register-exp-step.png b/docs/user-documentation/general-users/img/ELN-register-exp-step.png new file mode 100644 index 0000000000000000000000000000000000000000..21d2dbef19f665e08ab2193202615bc6203a1ccd Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-register-exp-step.png differ diff --git a/docs/user-documentation/general-users/img/ELN-register-experiments.png b/docs/user-documentation/general-users/img/ELN-register-experiments.png new file mode 100644 index 0000000000000000000000000000000000000000..511af5412329f7728daa709eb591ded07c865100 Binary files /dev/null and b/docs/user-documentation/general-users/img/ELN-register-experiments.png differ diff --git a/docs/user-documentation/general-users/img/Exp-Ste-templates-1024x598.png b/docs/user-documentation/general-users/img/Exp-Ste-templates-1024x598.png new file mode 100644 index 0000000000000000000000000000000000000000..ec6dd36bcc091137bbef3aa75a67532ad4f4dc9e Binary files /dev/null and b/docs/user-documentation/general-users/img/Exp-Ste-templates-1024x598.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2020-02-27-at-14.52.07-300x248.png b/docs/user-documentation/general-users/img/Screenshot-2020-02-27-at-14.52.07-300x248.png new file mode 100644 index 0000000000000000000000000000000000000000..1cab4dee512eb06699aaef4c7fcd0bf998216407 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2020-02-27-at-14.52.07-300x248.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2020-02-28-at-15.29.17.png b/docs/user-documentation/general-users/img/Screenshot-2020-02-28-at-15.29.17.png new file mode 100644 index 0000000000000000000000000000000000000000..c0df905e845246038c403c58178f857b273199f0 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2020-02-28-at-15.29.17.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2020-02-28-at-15.29.33.png b/docs/user-documentation/general-users/img/Screenshot-2020-02-28-at-15.29.33.png new file mode 100644 index 0000000000000000000000000000000000000000..63bc8566b22cb85b3f68cd44454591b4a3c7fb7b Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2020-02-28-at-15.29.33.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2020-03-10-at-11.14.21-300x229.png b/docs/user-documentation/general-users/img/Screenshot-2020-03-10-at-11.14.21-300x229.png new file mode 100644 index 0000000000000000000000000000000000000000..5066b225242b460a6e95a5aef14b46dbebf27878 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2020-03-10-at-11.14.21-300x229.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2020-05-29-at-09.31.49-300x202.png b/docs/user-documentation/general-users/img/Screenshot-2020-05-29-at-09.31.49-300x202.png new file mode 100644 index 0000000000000000000000000000000000000000..16c78248944fc78f450cfcce3681731938d5033c Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2020-05-29-at-09.31.49-300x202.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-18.40.02.png b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-18.40.02.png new file mode 100644 index 0000000000000000000000000000000000000000..a4bc90ed5617dd9da3ca01d13f18f293834acad8 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-18.40.02.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.00.58.png b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.00.58.png new file mode 100644 index 0000000000000000000000000000000000000000..63bcd99226cafba339f11f5d5e42bbbba5766f93 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.00.58.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.29.33-1024x186.png b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.29.33-1024x186.png new file mode 100644 index 0000000000000000000000000000000000000000..a90ca07934b04b2fe8fcb7e184f4f2b452bc684a Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.29.33-1024x186.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.40.53.png b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.40.53.png new file mode 100644 index 0000000000000000000000000000000000000000..db69c29174e997aae86bdf52955d99a41107ef2a Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2021-09-21-at-19.40.53.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-02-25-at-16.32.27-1024x359.png b/docs/user-documentation/general-users/img/Screenshot-2022-02-25-at-16.32.27-1024x359.png new file mode 100644 index 0000000000000000000000000000000000000000..e917fec0cf5584cb1a2f07fbf62f7842063d5b29 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-02-25-at-16.32.27-1024x359.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-02-28-at-22.57.24-1024x535.png b/docs/user-documentation/general-users/img/Screenshot-2022-02-28-at-22.57.24-1024x535.png new file mode 100644 index 0000000000000000000000000000000000000000..0ad42b101a0464c35cc27fc8a294b41054ee78ef Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-02-28-at-22.57.24-1024x535.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-03-01-at-23.57.58-1024x398.png b/docs/user-documentation/general-users/img/Screenshot-2022-03-01-at-23.57.58-1024x398.png new file mode 100644 index 0000000000000000000000000000000000000000..676963e518fabac48327efb74b4d8e6e0ea97437 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-03-01-at-23.57.58-1024x398.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-03-02-at-00.16.41-1024x411.png b/docs/user-documentation/general-users/img/Screenshot-2022-03-02-at-00.16.41-1024x411.png new file mode 100644 index 0000000000000000000000000000000000000000..556d1485062e6c4a8e745c3bafe5d8c23b9dc5e0 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-03-02-at-00.16.41-1024x411.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-03-02-at-00.17.26-1024x467.png b/docs/user-documentation/general-users/img/Screenshot-2022-03-02-at-00.17.26-1024x467.png new file mode 100644 index 0000000000000000000000000000000000000000..e3d882486a395c790cc161b4ef01a7c70faec89a Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-03-02-at-00.17.26-1024x467.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-03-04-at-12.47.18-1024x506.png b/docs/user-documentation/general-users/img/Screenshot-2022-03-04-at-12.47.18-1024x506.png new file mode 100644 index 0000000000000000000000000000000000000000..c4217af0da6adfc56d6a7457281794b7acd2aa17 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-03-04-at-12.47.18-1024x506.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-10-13-at-15.59.01-1.png b/docs/user-documentation/general-users/img/Screenshot-2022-10-13-at-15.59.01-1.png new file mode 100644 index 0000000000000000000000000000000000000000..56bf55dad209299a4b6b6b5aa1c58841ba006bed Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-10-13-at-15.59.01-1.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-10-13-at-15.59.01.png b/docs/user-documentation/general-users/img/Screenshot-2022-10-13-at-15.59.01.png new file mode 100644 index 0000000000000000000000000000000000000000..56bf55dad209299a4b6b6b5aa1c58841ba006bed Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-10-13-at-15.59.01.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-2022-11-15-at-11.39.05.png b/docs/user-documentation/general-users/img/Screenshot-2022-11-15-at-11.39.05.png new file mode 100644 index 0000000000000000000000000000000000000000..652f4c2edb1c684dc9b1d2f0c1357aae45aa5fa2 Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-2022-11-15-at-11.39.05.png differ diff --git a/docs/user-documentation/general-users/img/Screenshot-tsv-file-batch-upload-1024x221.png b/docs/user-documentation/general-users/img/Screenshot-tsv-file-batch-upload-1024x221.png new file mode 100644 index 0000000000000000000000000000000000000000..1e5dacce3c5a242aa3162106d771028b00e8dcfa Binary files /dev/null and b/docs/user-documentation/general-users/img/Screenshot-tsv-file-batch-upload-1024x221.png differ diff --git a/docs/user-documentation/general-users/img/Select-dataset.png b/docs/user-documentation/general-users/img/Select-dataset.png new file mode 100644 index 0000000000000000000000000000000000000000..0b30d7a425f5d05952b015bbc43eb2cb343ebaa6 Binary files /dev/null and b/docs/user-documentation/general-users/img/Select-dataset.png differ diff --git a/docs/user-documentation/general-users/img/Unarchive.png b/docs/user-documentation/general-users/img/Unarchive.png new file mode 100644 index 0000000000000000000000000000000000000000..847fc424fe773812bf70a22618d14ebe8dfa6908 Binary files /dev/null and b/docs/user-documentation/general-users/img/Unarchive.png differ diff --git a/docs/user-documentation/general-users/img/add-parent-via-barcode-2.png b/docs/user-documentation/general-users/img/add-parent-via-barcode-2.png new file mode 100644 index 0000000000000000000000000000000000000000..e427b9fae40b09e431fd47f4a1067803c948aa79 Binary files /dev/null and b/docs/user-documentation/general-users/img/add-parent-via-barcode-2.png differ diff --git a/docs/user-documentation/general-users/img/add-parent-via-barcode.png b/docs/user-documentation/general-users/img/add-parent-via-barcode.png new file mode 100644 index 0000000000000000000000000000000000000000..cfcad971114a8962269c7b6dfa7e45f292ff94a5 Binary files /dev/null and b/docs/user-documentation/general-users/img/add-parent-via-barcode.png differ diff --git a/docs/user-documentation/general-users/img/add-strorage-position.png b/docs/user-documentation/general-users/img/add-strorage-position.png new file mode 100644 index 0000000000000000000000000000000000000000..f415873db0bb8abb9e78d73ed7099230692ff84c Binary files /dev/null and b/docs/user-documentation/general-users/img/add-strorage-position.png differ diff --git a/docs/user-documentation/general-users/img/advanced-search-create-and-save-query.png b/docs/user-documentation/general-users/img/advanced-search-create-and-save-query.png new file mode 100644 index 0000000000000000000000000000000000000000..6f0e9c2d3893606e5dc1a9e8ca4781ebdc12fc48 Binary files /dev/null and b/docs/user-documentation/general-users/img/advanced-search-create-and-save-query.png differ diff --git a/docs/user-documentation/general-users/img/advanced-search-load-saved-query.png b/docs/user-documentation/general-users/img/advanced-search-load-saved-query.png new file mode 100644 index 0000000000000000000000000000000000000000..8cf14bded882dcde4f9b26227162cac5aa0bd0ed Binary files /dev/null and b/docs/user-documentation/general-users/img/advanced-search-load-saved-query.png differ diff --git a/docs/user-documentation/general-users/img/archiving-button.png b/docs/user-documentation/general-users/img/archiving-button.png new file mode 100644 index 0000000000000000000000000000000000000000..d20fbcd08fe53cb8501381f93f1a68ce1d91eb37 Binary files /dev/null and b/docs/user-documentation/general-users/img/archiving-button.png differ diff --git a/docs/user-documentation/general-users/img/archiving-helper-1024x529.png b/docs/user-documentation/general-users/img/archiving-helper-1024x529.png new file mode 100644 index 0000000000000000000000000000000000000000..a43f4616c3ca0b87fcdb983729bcc9d7417c73f4 Binary files /dev/null and b/docs/user-documentation/general-users/img/archiving-helper-1024x529.png differ diff --git a/docs/user-documentation/general-users/img/arciving-helper-search-by-size-1024x423.png b/docs/user-documentation/general-users/img/arciving-helper-search-by-size-1024x423.png new file mode 100644 index 0000000000000000000000000000000000000000..1d2b05a4729731078bdff9f5996553f2b6b61ebd Binary files /dev/null and b/docs/user-documentation/general-users/img/arciving-helper-search-by-size-1024x423.png differ diff --git a/docs/user-documentation/general-users/img/available-storage-1024x149.png b/docs/user-documentation/general-users/img/available-storage-1024x149.png new file mode 100644 index 0000000000000000000000000000000000000000..df089422cef8f05d366216222dfb0df65b55866c Binary files /dev/null and b/docs/user-documentation/general-users/img/available-storage-1024x149.png differ diff --git a/docs/user-documentation/general-users/img/batch-register-entries-object-browser-1.png b/docs/user-documentation/general-users/img/batch-register-entries-object-browser-1.png new file mode 100644 index 0000000000000000000000000000000000000000..86c7405e7bbbbe4a6d25f9414650ad0a82e82499 Binary files /dev/null and b/docs/user-documentation/general-users/img/batch-register-entries-object-browser-1.png differ diff --git a/docs/user-documentation/general-users/img/batch-register-entries-object-browser-2.png b/docs/user-documentation/general-users/img/batch-register-entries-object-browser-2.png new file mode 100644 index 0000000000000000000000000000000000000000..86c7405e7bbbbe4a6d25f9414650ad0a82e82499 Binary files /dev/null and b/docs/user-documentation/general-users/img/batch-register-entries-object-browser-2.png differ diff --git a/docs/user-documentation/general-users/img/batch-register-entries-object-browser.png b/docs/user-documentation/general-users/img/batch-register-entries-object-browser.png new file mode 100644 index 0000000000000000000000000000000000000000..86c7405e7bbbbe4a6d25f9414650ad0a82e82499 Binary files /dev/null and b/docs/user-documentation/general-users/img/batch-register-entries-object-browser.png differ diff --git a/docs/user-documentation/general-users/img/batch-register-entries-one-collection-1024x300.png b/docs/user-documentation/general-users/img/batch-register-entries-one-collection-1024x300.png new file mode 100644 index 0000000000000000000000000000000000000000..6db8408696e4d2734e1cdd069b702ce59ea4ed11 Binary files /dev/null and b/docs/user-documentation/general-users/img/batch-register-entries-one-collection-1024x300.png differ diff --git a/docs/user-documentation/general-users/img/batch-update-entries-object-browser.png b/docs/user-documentation/general-users/img/batch-update-entries-object-browser.png new file mode 100644 index 0000000000000000000000000000000000000000..d6e9990fdd26d4a0036788c68752249955cada73 Binary files /dev/null and b/docs/user-documentation/general-users/img/batch-update-entries-object-browser.png differ diff --git a/docs/user-documentation/general-users/img/children-generator-1024x477.png b/docs/user-documentation/general-users/img/children-generator-1024x477.png new file mode 100644 index 0000000000000000000000000000000000000000..d6ae75ef2dc77a3457cd43b3f39c40f82e0a12d9 Binary files /dev/null and b/docs/user-documentation/general-users/img/children-generator-1024x477.png differ diff --git a/docs/user-documentation/general-users/img/collection-TSV-batch-update-menu.png b/docs/user-documentation/general-users/img/collection-TSV-batch-update-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..ddeece1da82bc58390cc8b7161d5b8fb218a2276 Binary files /dev/null and b/docs/user-documentation/general-users/img/collection-TSV-batch-update-menu.png differ diff --git a/docs/user-documentation/general-users/img/collection-XLS-batch-update-menu.png b/docs/user-documentation/general-users/img/collection-XLS-batch-update-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..af87fb4fb68627da4ed67c194a335a5be89a5d3f Binary files /dev/null and b/docs/user-documentation/general-users/img/collection-XLS-batch-update-menu.png differ diff --git a/docs/user-documentation/general-users/img/collection-form-view-show-objects.png b/docs/user-documentation/general-users/img/collection-form-view-show-objects.png new file mode 100644 index 0000000000000000000000000000000000000000..ce2f3f3020215b98d57291e46ec04f09c33157dc Binary files /dev/null and b/docs/user-documentation/general-users/img/collection-form-view-show-objects.png differ diff --git a/docs/user-documentation/general-users/img/collection-list-view-1024x408.png b/docs/user-documentation/general-users/img/collection-list-view-1024x408.png new file mode 100644 index 0000000000000000000000000000000000000000..58b52f3ac6b0db7f16020ca7f98995de1da97a28 Binary files /dev/null and b/docs/user-documentation/general-users/img/collection-list-view-1024x408.png differ diff --git a/docs/user-documentation/general-users/img/collection-list-view-edit-collection.png b/docs/user-documentation/general-users/img/collection-list-view-edit-collection.png new file mode 100644 index 0000000000000000000000000000000000000000..e9612ce66ec5431558261f0b16c2bbe91254fd0d Binary files /dev/null and b/docs/user-documentation/general-users/img/collection-list-view-edit-collection.png differ diff --git a/docs/user-documentation/general-users/img/collections-form-view-1024x575.png b/docs/user-documentation/general-users/img/collections-form-view-1024x575.png new file mode 100644 index 0000000000000000000000000000000000000000..82e48504e2894fecf61c628db18bc0836caa9cb0 Binary files /dev/null and b/docs/user-documentation/general-users/img/collections-form-view-1024x575.png differ diff --git a/docs/user-documentation/general-users/img/columns-in-tables-1024x571.png b/docs/user-documentation/general-users/img/columns-in-tables-1024x571.png new file mode 100644 index 0000000000000000000000000000000000000000..abfac7da9e47e0eb78ab5f309bccfe535eb67174 Binary files /dev/null and b/docs/user-documentation/general-users/img/columns-in-tables-1024x571.png differ diff --git a/docs/user-documentation/general-users/img/copy-entry.png b/docs/user-documentation/general-users/img/copy-entry.png new file mode 100644 index 0000000000000000000000000000000000000000..c697d521c9a31c6350091c863d05eee418c162c1 Binary files /dev/null and b/docs/user-documentation/general-users/img/copy-entry.png differ diff --git a/docs/user-documentation/general-users/img/copy-menu.png b/docs/user-documentation/general-users/img/copy-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..f21ee7acae29a0587a0821febb5109cbf11fc3bc Binary files /dev/null and b/docs/user-documentation/general-users/img/copy-menu.png differ diff --git a/docs/user-documentation/general-users/img/copy-object-options-1024x191.png b/docs/user-documentation/general-users/img/copy-object-options-1024x191.png new file mode 100644 index 0000000000000000000000000000000000000000..2b99e80fb1cace960a537e19a666d8ee671c98d0 Binary files /dev/null and b/docs/user-documentation/general-users/img/copy-object-options-1024x191.png differ diff --git a/docs/user-documentation/general-users/img/copy-protocol-exp-step-1024x233.png b/docs/user-documentation/general-users/img/copy-protocol-exp-step-1024x233.png new file mode 100644 index 0000000000000000000000000000000000000000..e430ed320ab92c03836fdef950a3b97be66dbe81 Binary files /dev/null and b/docs/user-documentation/general-users/img/copy-protocol-exp-step-1024x233.png differ diff --git a/docs/user-documentation/general-users/img/create-new-order.png b/docs/user-documentation/general-users/img/create-new-order.png new file mode 100644 index 0000000000000000000000000000000000000000..f235ad6b51f1bb089f1fb35604135adc552ed8f4 Binary files /dev/null and b/docs/user-documentation/general-users/img/create-new-order.png differ diff --git a/docs/user-documentation/general-users/img/custom-import-no-template.png b/docs/user-documentation/general-users/img/custom-import-no-template.png new file mode 100644 index 0000000000000000000000000000000000000000..955318d41cdaab7e8e3413c97b5e912c8eb7232c Binary files /dev/null and b/docs/user-documentation/general-users/img/custom-import-no-template.png differ diff --git a/docs/user-documentation/general-users/img/custom-import-template.png b/docs/user-documentation/general-users/img/custom-import-template.png new file mode 100644 index 0000000000000000000000000000000000000000..c9d082498f5e7a9ff5901f5b0bc0594b1061853a Binary files /dev/null and b/docs/user-documentation/general-users/img/custom-import-template.png differ diff --git a/docs/user-documentation/general-users/img/custom-imports-1024x459.png b/docs/user-documentation/general-users/img/custom-imports-1024x459.png new file mode 100644 index 0000000000000000000000000000000000000000..bcec3b3da57d42580e67c55400f24d7cc054cfad Binary files /dev/null and b/docs/user-documentation/general-users/img/custom-imports-1024x459.png differ diff --git a/docs/user-documentation/general-users/img/customize-collection-view.png b/docs/user-documentation/general-users/img/customize-collection-view.png new file mode 100644 index 0000000000000000000000000000000000000000..2cf6f995091190c538e7454b5bda4e58c8e469a6 Binary files /dev/null and b/docs/user-documentation/general-users/img/customize-collection-view.png differ diff --git a/docs/user-documentation/general-users/img/cyberduck-config.png b/docs/user-documentation/general-users/img/cyberduck-config.png new file mode 100644 index 0000000000000000000000000000000000000000..f681b7e50429824a52bca262f1aac935999bd7b3 Binary files /dev/null and b/docs/user-documentation/general-users/img/cyberduck-config.png differ diff --git a/docs/user-documentation/general-users/img/cyberduck-navigation.png b/docs/user-documentation/general-users/img/cyberduck-navigation.png new file mode 100644 index 0000000000000000000000000000000000000000..538bb6727e587d41bff8ed59766398fab452aec7 Binary files /dev/null and b/docs/user-documentation/general-users/img/cyberduck-navigation.png differ diff --git a/docs/user-documentation/general-users/img/data-navigation-driver-icon.png b/docs/user-documentation/general-users/img/data-navigation-driver-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..60ef0729ab0a2ba4ff957facdf0215f1132d9102 Binary files /dev/null and b/docs/user-documentation/general-users/img/data-navigation-driver-icon.png differ diff --git a/docs/user-documentation/general-users/img/data-structure-example-for-dropbox.png b/docs/user-documentation/general-users/img/data-structure-example-for-dropbox.png new file mode 100644 index 0000000000000000000000000000000000000000..41e2e89a0f083e0a8d4c99c7f0807017bf642d4a Binary files /dev/null and b/docs/user-documentation/general-users/img/data-structure-example-for-dropbox.png differ diff --git a/docs/user-documentation/general-users/img/dataset-history-dropdown.png b/docs/user-documentation/general-users/img/dataset-history-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..c111a1fea5da2c39489469645e1a5e57b857552a Binary files /dev/null and b/docs/user-documentation/general-users/img/dataset-history-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/dataset-upload-UI-1024x951.png b/docs/user-documentation/general-users/img/dataset-upload-UI-1024x951.png new file mode 100644 index 0000000000000000000000000000000000000000..a5c85d3d98634fdc7451348015b4cce0df1c89a2 Binary files /dev/null and b/docs/user-documentation/general-users/img/dataset-upload-UI-1024x951.png differ diff --git a/docs/user-documentation/general-users/img/dataset-upload-with-metadata-json.png b/docs/user-documentation/general-users/img/dataset-upload-with-metadata-json.png new file mode 100644 index 0000000000000000000000000000000000000000..5b28e2d32c01b4695265a5a2553514a791c2bbfa Binary files /dev/null and b/docs/user-documentation/general-users/img/dataset-upload-with-metadata-json.png differ diff --git a/docs/user-documentation/general-users/img/dataset-uploader-helper-tool-1024x436.png b/docs/user-documentation/general-users/img/dataset-uploader-helper-tool-1024x436.png new file mode 100644 index 0000000000000000000000000000000000000000..9251c9c6756d48074cbbabef9016b653e8272f47 Binary files /dev/null and b/docs/user-documentation/general-users/img/dataset-uploader-helper-tool-1024x436.png differ diff --git a/docs/user-documentation/general-users/img/dataset-uploader-helper-tool-more-dropdown.png b/docs/user-documentation/general-users/img/dataset-uploader-helper-tool-more-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..eb8062166bc598c024e4329350801921ab71c6d4 Binary files /dev/null and b/docs/user-documentation/general-users/img/dataset-uploader-helper-tool-more-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/default-experiment-form.png b/docs/user-documentation/general-users/img/default-experiment-form.png new file mode 100644 index 0000000000000000000000000000000000000000..3569ebd5209af57a475efe4b121309340e5fb9d4 Binary files /dev/null and b/docs/user-documentation/general-users/img/default-experiment-form.png differ diff --git a/docs/user-documentation/general-users/img/delete-storage-positions.png b/docs/user-documentation/general-users/img/delete-storage-positions.png new file mode 100644 index 0000000000000000000000000000000000000000..1c4080dea4fdc7d371927ae65264d40335026a5a Binary files /dev/null and b/docs/user-documentation/general-users/img/delete-storage-positions.png differ diff --git a/docs/user-documentation/general-users/img/dolphin.png b/docs/user-documentation/general-users/img/dolphin.png new file mode 100644 index 0000000000000000000000000000000000000000..1bc392ba1b4dc3b6697f98ed9d7e3318ca87c4de Binary files /dev/null and b/docs/user-documentation/general-users/img/dolphin.png differ diff --git a/docs/user-documentation/general-users/img/download-metadata-template.png b/docs/user-documentation/general-users/img/download-metadata-template.png new file mode 100644 index 0000000000000000000000000000000000000000..cacd13813b9feb85cab9ebbef424e070257d9ed7 Binary files /dev/null and b/docs/user-documentation/general-users/img/download-metadata-template.png differ diff --git a/docs/user-documentation/general-users/img/dropbox-monitor-details-1024x457.png b/docs/user-documentation/general-users/img/dropbox-monitor-details-1024x457.png new file mode 100644 index 0000000000000000000000000000000000000000..c442215a8352b8d66c49836c6e33d2a00cbab473 Binary files /dev/null and b/docs/user-documentation/general-users/img/dropbox-monitor-details-1024x457.png differ diff --git a/docs/user-documentation/general-users/img/dropbox-monitor-menu-1024x491.png b/docs/user-documentation/general-users/img/dropbox-monitor-menu-1024x491.png new file mode 100644 index 0000000000000000000000000000000000000000..f6c7f218dba2b3435fba2b12d610f8d1b48d58bd Binary files /dev/null and b/docs/user-documentation/general-users/img/dropbox-monitor-menu-1024x491.png differ diff --git a/docs/user-documentation/general-users/img/edit-delete-forms.png b/docs/user-documentation/general-users/img/edit-delete-forms.png new file mode 100644 index 0000000000000000000000000000000000000000..89fb14c8e2775d0ab0fc5e0bfc00d236b6b643af Binary files /dev/null and b/docs/user-documentation/general-users/img/edit-delete-forms.png differ diff --git a/docs/user-documentation/general-users/img/exp-step-object-browser-1024x646.png b/docs/user-documentation/general-users/img/exp-step-object-browser-1024x646.png new file mode 100644 index 0000000000000000000000000000000000000000..6686627c9456c475db15b37a85d28aeb03699706 Binary files /dev/null and b/docs/user-documentation/general-users/img/exp-step-object-browser-1024x646.png differ diff --git a/docs/user-documentation/general-users/img/exp-step-parent-added-after-search-1024x332.png b/docs/user-documentation/general-users/img/exp-step-parent-added-after-search-1024x332.png new file mode 100644 index 0000000000000000000000000000000000000000..f37817554772af232646906965ca775e214aa9c3 Binary files /dev/null and b/docs/user-documentation/general-users/img/exp-step-parent-added-after-search-1024x332.png differ diff --git a/docs/user-documentation/general-users/img/exp-step-search-parent-1024x201.png b/docs/user-documentation/general-users/img/exp-step-search-parent-1024x201.png new file mode 100644 index 0000000000000000000000000000000000000000..20b96a5f840e919356f353bff0f734bb56ecaf80 Binary files /dev/null and b/docs/user-documentation/general-users/img/exp-step-search-parent-1024x201.png differ diff --git a/docs/user-documentation/general-users/img/export-space.png b/docs/user-documentation/general-users/img/export-space.png new file mode 100644 index 0000000000000000000000000000000000000000..d06e046d2bac67b011d5cec458ed416a4a2573c9 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-space.png differ diff --git a/docs/user-documentation/general-users/img/export-table-columns.png b/docs/user-documentation/general-users/img/export-table-columns.png new file mode 100644 index 0000000000000000000000000000000000000000..d0e9421ed57935fbad365b2a6cde0fd92f10996c Binary files /dev/null and b/docs/user-documentation/general-users/img/export-table-columns.png differ diff --git a/docs/user-documentation/general-users/img/export-table-rows.png b/docs/user-documentation/general-users/img/export-table-rows.png new file mode 100644 index 0000000000000000000000000000000000000000..3b322d775495f88ddba244175758093765226d81 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-table-rows.png differ diff --git a/docs/user-documentation/general-users/img/export-table-values.png b/docs/user-documentation/general-users/img/export-table-values.png new file mode 100644 index 0000000000000000000000000000000000000000..1cb37942d0857e3dc8d883527e0fd4ebbddc0ca2 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-table-values.png differ diff --git a/docs/user-documentation/general-users/img/export-tables-1024x419.png b/docs/user-documentation/general-users/img/export-tables-1024x419.png new file mode 100644 index 0000000000000000000000000000000000000000..a2dca3c726e7405ea7fac88e121220883bb390c2 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-tables-1024x419.png differ diff --git a/docs/user-documentation/general-users/img/export-tables-import-compatible.png b/docs/user-documentation/general-users/img/export-tables-import-compatible.png new file mode 100644 index 0000000000000000000000000000000000000000..db8e2a95ab7f16cf6ec8133a05d0af0aa5ad6ab4 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-tables-import-compatible.png differ diff --git a/docs/user-documentation/general-users/img/export-to-research-collection-1024x818.png b/docs/user-documentation/general-users/img/export-to-research-collection-1024x818.png new file mode 100644 index 0000000000000000000000000000000000000000..531747ec3359c48f01ff30a441885f7a78f7cead Binary files /dev/null and b/docs/user-documentation/general-users/img/export-to-research-collection-1024x818.png differ diff --git a/docs/user-documentation/general-users/img/export-to-zenodo-1024x862.png b/docs/user-documentation/general-users/img/export-to-zenodo-1024x862.png new file mode 100644 index 0000000000000000000000000000000000000000..0fa1fae7388114c298f8404a1fc300e8ae2f3651 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-to-zenodo-1024x862.png differ diff --git a/docs/user-documentation/general-users/img/export-to-zip.png b/docs/user-documentation/general-users/img/export-to-zip.png new file mode 100644 index 0000000000000000000000000000000000000000..c7ef78ab3f6c8e66999ab31ab99ca86a10952025 Binary files /dev/null and b/docs/user-documentation/general-users/img/export-to-zip.png differ diff --git a/docs/user-documentation/general-users/img/exported-space-1024x302.png b/docs/user-documentation/general-users/img/exported-space-1024x302.png new file mode 100644 index 0000000000000000000000000000000000000000..be7d024655e080b045ef2b25cd81e4956a406d7d Binary files /dev/null and b/docs/user-documentation/general-users/img/exported-space-1024x302.png differ diff --git a/docs/user-documentation/general-users/img/filter-per-column-tables-1024x248.png b/docs/user-documentation/general-users/img/filter-per-column-tables-1024x248.png new file mode 100644 index 0000000000000000000000000000000000000000..4c74db74f824ee582f6f69215bf69f0e23f26a08 Binary files /dev/null and b/docs/user-documentation/general-users/img/filter-per-column-tables-1024x248.png differ diff --git a/docs/user-documentation/general-users/img/freeze-space.png b/docs/user-documentation/general-users/img/freeze-space.png new file mode 100644 index 0000000000000000000000000000000000000000..2ad77eb3b008a1e16882b98ab3ab86006dd38354 Binary files /dev/null and b/docs/user-documentation/general-users/img/freeze-space.png differ diff --git a/docs/user-documentation/general-users/img/freze-selection-1024x469.png b/docs/user-documentation/general-users/img/freze-selection-1024x469.png new file mode 100644 index 0000000000000000000000000000000000000000..f5e400a9e579051379b4619b52b82f39b6408188 Binary files /dev/null and b/docs/user-documentation/general-users/img/freze-selection-1024x469.png differ diff --git a/docs/user-documentation/general-users/img/generate-zenodo-token-1024x498.png b/docs/user-documentation/general-users/img/generate-zenodo-token-1024x498.png new file mode 100644 index 0000000000000000000000000000000000000000..e93ac88515f16a70309ab6638c5df1485e75c9e2 Binary files /dev/null and b/docs/user-documentation/general-users/img/generate-zenodo-token-1024x498.png differ diff --git a/docs/user-documentation/general-users/img/global-filter-tables-1024x219.png b/docs/user-documentation/general-users/img/global-filter-tables-1024x219.png new file mode 100644 index 0000000000000000000000000000000000000000..ae7a19e375bc94d310570eefc631e93e84e78cd3 Binary files /dev/null and b/docs/user-documentation/general-users/img/global-filter-tables-1024x219.png differ diff --git a/docs/user-documentation/general-users/img/hierarchy-graph-1024x392.png b/docs/user-documentation/general-users/img/hierarchy-graph-1024x392.png new file mode 100644 index 0000000000000000000000000000000000000000..bfd8e3fba83088de2d136d16d460892c73e1811f Binary files /dev/null and b/docs/user-documentation/general-users/img/hierarchy-graph-1024x392.png differ diff --git a/docs/user-documentation/general-users/img/history-collection-dropdown.png b/docs/user-documentation/general-users/img/history-collection-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..5f6850f97f6966bd53e5674187c94077621af75c Binary files /dev/null and b/docs/user-documentation/general-users/img/history-collection-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/jupyter-1.png b/docs/user-documentation/general-users/img/jupyter-1.png new file mode 100644 index 0000000000000000000000000000000000000000..918b0c1825b258e4a3c9d22d3dd892434a719057 Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter-1.png differ diff --git a/docs/user-documentation/general-users/img/jupyter-1024x316.png b/docs/user-documentation/general-users/img/jupyter-1024x316.png new file mode 100644 index 0000000000000000000000000000000000000000..347714bdedb3a4615279818e861c31d6edb1f2eb Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter-1024x316.png differ diff --git a/docs/user-documentation/general-users/img/jupyter-2-1024x470.png b/docs/user-documentation/general-users/img/jupyter-2-1024x470.png new file mode 100644 index 0000000000000000000000000000000000000000..e022f7f6345ac294cd1ce9a2f7cd3633f96b8d1b Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter-2-1024x470.png differ diff --git a/docs/user-documentation/general-users/img/jupyter-kernels.png b/docs/user-documentation/general-users/img/jupyter-kernels.png new file mode 100644 index 0000000000000000000000000000000000000000..3d0a5a096a69d3fe59b2e9a73bab2f26b2b2f154 Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter-kernels.png differ diff --git a/docs/user-documentation/general-users/img/jupyter-navigation-menu.png b/docs/user-documentation/general-users/img/jupyter-navigation-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..70f4639838649f7699ed271995c39dfbd870b711 Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter-navigation-menu.png differ diff --git a/docs/user-documentation/general-users/img/jupyter-notebook-buttons.png b/docs/user-documentation/general-users/img/jupyter-notebook-buttons.png new file mode 100644 index 0000000000000000000000000000000000000000..d18a36b76d264835ecca70f91574eca182bc4f47 Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter-notebook-buttons.png differ diff --git a/docs/user-documentation/general-users/img/jupyter_notebook_save_dataset-1024x553.png b/docs/user-documentation/general-users/img/jupyter_notebook_save_dataset-1024x553.png new file mode 100644 index 0000000000000000000000000000000000000000..d2ee07541199f6b919835f763e8f1efec4f2b3c5 Binary files /dev/null and b/docs/user-documentation/general-users/img/jupyter_notebook_save_dataset-1024x553.png differ diff --git a/docs/user-documentation/general-users/img/manage-access-labnotebook-space.png b/docs/user-documentation/general-users/img/manage-access-labnotebook-space.png new file mode 100644 index 0000000000000000000000000000000000000000..a4794f6e3b5cd962d030cafed5681bb3ae22f20b Binary files /dev/null and b/docs/user-documentation/general-users/img/manage-access-labnotebook-space.png differ diff --git a/docs/user-documentation/general-users/img/manage-access-project.png b/docs/user-documentation/general-users/img/manage-access-project.png new file mode 100644 index 0000000000000000000000000000000000000000..04913dd7ff343bb555a3cdc06593096e0a7c9441 Binary files /dev/null and b/docs/user-documentation/general-users/img/manage-access-project.png differ diff --git a/docs/user-documentation/general-users/img/mangae-access-space-dropdown.png b/docs/user-documentation/general-users/img/mangae-access-space-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..3732337151e7ba6ed6f1e90c2e21207f660b8de1 Binary files /dev/null and b/docs/user-documentation/general-users/img/mangae-access-space-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/manual-session-token-1024x135.png b/docs/user-documentation/general-users/img/manual-session-token-1024x135.png new file mode 100644 index 0000000000000000000000000000000000000000..0299fd7dd05a2660765c186d19669c4e57064d17 Binary files /dev/null and b/docs/user-documentation/general-users/img/manual-session-token-1024x135.png differ diff --git a/docs/user-documentation/general-users/img/menu-change-sorting.png b/docs/user-documentation/general-users/img/menu-change-sorting.png new file mode 100644 index 0000000000000000000000000000000000000000..ce5de909ec34893e236f98e0c407c973a7579742 Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-change-sorting.png differ diff --git a/docs/user-documentation/general-users/img/menu-collapse.png b/docs/user-documentation/general-users/img/menu-collapse.png new file mode 100644 index 0000000000000000000000000000000000000000..c73221681b708c638ce2f6f3b3804075cb0da76c Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-collapse.png differ diff --git a/docs/user-documentation/general-users/img/menu-filter.png b/docs/user-documentation/general-users/img/menu-filter.png new file mode 100644 index 0000000000000000000000000000000000000000..910f244cbc66df46dcd7b416c5677beed26c0104 Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-filter.png differ diff --git a/docs/user-documentation/general-users/img/menu-scroll-to-selected-node-1.png b/docs/user-documentation/general-users/img/menu-scroll-to-selected-node-1.png new file mode 100644 index 0000000000000000000000000000000000000000..6c70e8e93a7d904236218cf6fc82cebdac5f4dbc Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-scroll-to-selected-node-1.png differ diff --git a/docs/user-documentation/general-users/img/menu-select-root-node.png b/docs/user-documentation/general-users/img/menu-select-root-node.png new file mode 100644 index 0000000000000000000000000000000000000000..f34e61b7e51599a64d7ae6fdaf92985fe5aa1f51 Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-select-root-node.png differ diff --git a/docs/user-documentation/general-users/img/menu-selected-root-node.png b/docs/user-documentation/general-users/img/menu-selected-root-node.png new file mode 100644 index 0000000000000000000000000000000000000000..a1e965c83fc2286ca837d000b7cd1e40f2ee4a93 Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-selected-root-node.png differ diff --git a/docs/user-documentation/general-users/img/menu-sorting-options.png b/docs/user-documentation/general-users/img/menu-sorting-options.png new file mode 100644 index 0000000000000000000000000000000000000000..9c976d5da77a1b031c71fd59e6a5701e32f7af28 Binary files /dev/null and b/docs/user-documentation/general-users/img/menu-sorting-options.png differ diff --git a/docs/user-documentation/general-users/img/move-dataset-1-1024x241.png b/docs/user-documentation/general-users/img/move-dataset-1-1024x241.png new file mode 100644 index 0000000000000000000000000000000000000000..d52337878e8c0d425ab774b5a0e20c883c6a08f4 Binary files /dev/null and b/docs/user-documentation/general-users/img/move-dataset-1-1024x241.png differ diff --git a/docs/user-documentation/general-users/img/move-dataset-more-dropdown.png b/docs/user-documentation/general-users/img/move-dataset-more-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..203110b2e226e754c01246c1bd551e7150e97e1e Binary files /dev/null and b/docs/user-documentation/general-users/img/move-dataset-more-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/move-experiment-1024x168.png b/docs/user-documentation/general-users/img/move-experiment-1024x168.png new file mode 100644 index 0000000000000000000000000000000000000000..3efc0598ee549ea143ea4d49fd388ad8552a78c5 Binary files /dev/null and b/docs/user-documentation/general-users/img/move-experiment-1024x168.png differ diff --git a/docs/user-documentation/general-users/img/move-experiment-accept-1024x120.png b/docs/user-documentation/general-users/img/move-experiment-accept-1024x120.png new file mode 100644 index 0000000000000000000000000000000000000000..77b36903f2ddfcfbd5d6a59c3f94a07a1ae4b2ae Binary files /dev/null and b/docs/user-documentation/general-users/img/move-experiment-accept-1024x120.png differ diff --git a/docs/user-documentation/general-users/img/move-experiments-to-other-project-1024x373.png b/docs/user-documentation/general-users/img/move-experiments-to-other-project-1024x373.png new file mode 100644 index 0000000000000000000000000000000000000000..a1070eace9c20ef9a4becc0aedc670220854a73f Binary files /dev/null and b/docs/user-documentation/general-users/img/move-experiments-to-other-project-1024x373.png differ diff --git a/docs/user-documentation/general-users/img/move-from-table-1-1024x412.png b/docs/user-documentation/general-users/img/move-from-table-1-1024x412.png new file mode 100644 index 0000000000000000000000000000000000000000..6a11bc867b5aa9d6b86aec66155e9fdf0959c938 Binary files /dev/null and b/docs/user-documentation/general-users/img/move-from-table-1-1024x412.png differ diff --git a/docs/user-documentation/general-users/img/move-menu.png b/docs/user-documentation/general-users/img/move-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..0daa98a2e54f95e9a3fc1cfa7b5a7f8eec896f4a Binary files /dev/null and b/docs/user-documentation/general-users/img/move-menu.png differ diff --git a/docs/user-documentation/general-users/img/move-objects-from-object-table-in-collection-1024x527.png b/docs/user-documentation/general-users/img/move-objects-from-object-table-in-collection-1024x527.png new file mode 100644 index 0000000000000000000000000000000000000000..56cb10b43b4eca26ce2ca793d401fb539b7912cd Binary files /dev/null and b/docs/user-documentation/general-users/img/move-objects-from-object-table-in-collection-1024x527.png differ diff --git a/docs/user-documentation/general-users/img/move-options.png b/docs/user-documentation/general-users/img/move-options.png new file mode 100644 index 0000000000000000000000000000000000000000..7a9084da6d6461450ee69c04f8feb79785c18328 Binary files /dev/null and b/docs/user-documentation/general-users/img/move-options.png differ diff --git a/docs/user-documentation/general-users/img/multi-colums-sorting-1024x334.png b/docs/user-documentation/general-users/img/multi-colums-sorting-1024x334.png new file mode 100644 index 0000000000000000000000000000000000000000..5529caa033d93032c0c40c42a472afbe2577b2e9 Binary files /dev/null and b/docs/user-documentation/general-users/img/multi-colums-sorting-1024x334.png differ diff --git a/docs/user-documentation/general-users/img/navigation-menu.png b/docs/user-documentation/general-users/img/navigation-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..798b40a054aaf64a5222b7c09f3e307db47009f7 Binary files /dev/null and b/docs/user-documentation/general-users/img/navigation-menu.png differ diff --git a/docs/user-documentation/general-users/img/object-broswer-types-selection.png b/docs/user-documentation/general-users/img/object-broswer-types-selection.png new file mode 100644 index 0000000000000000000000000000000000000000..43a06f7bd4549a9b57f6db8bc62246e47f5b99dc Binary files /dev/null and b/docs/user-documentation/general-users/img/object-broswer-types-selection.png differ diff --git a/docs/user-documentation/general-users/img/object-browse-batch-reister.png b/docs/user-documentation/general-users/img/object-browse-batch-reister.png new file mode 100644 index 0000000000000000000000000000000000000000..a09e4b1d3aa78f2b77a0fc4f8075877daaac5200 Binary files /dev/null and b/docs/user-documentation/general-users/img/object-browse-batch-reister.png differ diff --git a/docs/user-documentation/general-users/img/object-browser-batch-update.png b/docs/user-documentation/general-users/img/object-browser-batch-update.png new file mode 100644 index 0000000000000000000000000000000000000000..569926968635abeb9fa750c5e0a4f4d1ddc87a41 Binary files /dev/null and b/docs/user-documentation/general-users/img/object-browser-batch-update.png differ diff --git a/docs/user-documentation/general-users/img/object-browser-xls-batch-update.png b/docs/user-documentation/general-users/img/object-browser-xls-batch-update.png new file mode 100644 index 0000000000000000000000000000000000000000..9756b547fc2d2420344f227d0b3b875844e0e367 Binary files /dev/null and b/docs/user-documentation/general-users/img/object-browser-xls-batch-update.png differ diff --git a/docs/user-documentation/general-users/img/object-history-dropdown.png b/docs/user-documentation/general-users/img/object-history-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..94e5caeef7cfafbf303e1b90d4da0810f3e02289 Binary files /dev/null and b/docs/user-documentation/general-users/img/object-history-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/old-batch-update.png b/docs/user-documentation/general-users/img/old-batch-update.png new file mode 100644 index 0000000000000000000000000000000000000000..f316b2661e240a3b32ed1c4a08a462ac1209e97a Binary files /dev/null and b/docs/user-documentation/general-users/img/old-batch-update.png differ diff --git a/docs/user-documentation/general-users/img/operations-column-1024x405.png b/docs/user-documentation/general-users/img/operations-column-1024x405.png new file mode 100644 index 0000000000000000000000000000000000000000..7751b3caf2e34f6502efaad26e6e761629192d43 Binary files /dev/null and b/docs/user-documentation/general-users/img/operations-column-1024x405.png differ diff --git a/docs/user-documentation/general-users/img/order-form-1-1024x556.png b/docs/user-documentation/general-users/img/order-form-1-1024x556.png new file mode 100644 index 0000000000000000000000000000000000000000..835f272fd154543a2c1b32ac3dec266fd6fba680 Binary files /dev/null and b/docs/user-documentation/general-users/img/order-form-1-1024x556.png differ diff --git a/docs/user-documentation/general-users/img/project-more-dropdown.png b/docs/user-documentation/general-users/img/project-more-dropdown.png new file mode 100644 index 0000000000000000000000000000000000000000..61a408e38c1f93d111e22e2a3be379d1836a09a6 Binary files /dev/null and b/docs/user-documentation/general-users/img/project-more-dropdown.png differ diff --git a/docs/user-documentation/general-users/img/project-overview-1-1024x516.png b/docs/user-documentation/general-users/img/project-overview-1-1024x516.png new file mode 100644 index 0000000000000000000000000000000000000000..394a5cb7b5d9ac0c07c8c87d16172f926eefe2d9 Binary files /dev/null and b/docs/user-documentation/general-users/img/project-overview-1-1024x516.png differ diff --git a/docs/user-documentation/general-users/img/publications-collection.png b/docs/user-documentation/general-users/img/publications-collection.png new file mode 100644 index 0000000000000000000000000000000000000000..34f795a572d6f23b22a0c946547c2e4d5f63b6e6 Binary files /dev/null and b/docs/user-documentation/general-users/img/publications-collection.png differ diff --git a/docs/user-documentation/general-users/img/register-objects-assign-parents-in-same-transaction.png b/docs/user-documentation/general-users/img/register-objects-assign-parents-in-same-transaction.png new file mode 100644 index 0000000000000000000000000000000000000000..f4d9c993d5c801d2cb9e6c4ba0ec6384da5d348c Binary files /dev/null and b/docs/user-documentation/general-users/img/register-objects-assign-parents-in-same-transaction.png differ diff --git a/docs/user-documentation/general-users/img/register-single-entry-collection-button-1024x299.png b/docs/user-documentation/general-users/img/register-single-entry-collection-button-1024x299.png new file mode 100644 index 0000000000000000000000000000000000000000..285b67efee186cb0e4770346c43b47c99a710c93 Binary files /dev/null and b/docs/user-documentation/general-users/img/register-single-entry-collection-button-1024x299.png differ diff --git a/docs/user-documentation/general-users/img/register-single-entry-collection-more-1024x300.png b/docs/user-documentation/general-users/img/register-single-entry-collection-more-1024x300.png new file mode 100644 index 0000000000000000000000000000000000000000..2b1cb5734e1fcbd5459f4a67b7d52dcec0d343e8 Binary files /dev/null and b/docs/user-documentation/general-users/img/register-single-entry-collection-more-1024x300.png differ diff --git a/docs/user-documentation/general-users/img/remove-parents-1024x313.png b/docs/user-documentation/general-users/img/remove-parents-1024x313.png new file mode 100644 index 0000000000000000000000000000000000000000..e2b0b3a16690231c2e55e671a9d548c3b0fa3daf Binary files /dev/null and b/docs/user-documentation/general-users/img/remove-parents-1024x313.png differ diff --git a/docs/user-documentation/general-users/img/search-and-paste-parents-1024x572.png b/docs/user-documentation/general-users/img/search-and-paste-parents-1024x572.png new file mode 100644 index 0000000000000000000000000000000000000000..aa634b3174adcaab694aa2678f8cc9b749783430 Binary files /dev/null and b/docs/user-documentation/general-users/img/search-and-paste-parents-1024x572.png differ diff --git a/docs/user-documentation/general-users/img/selection-entries-table-1024x425.png b/docs/user-documentation/general-users/img/selection-entries-table-1024x425.png new file mode 100644 index 0000000000000000000000000000000000000000..23ef3f9eb975879013e5a9b38706ffe9376dfd70 Binary files /dev/null and b/docs/user-documentation/general-users/img/selection-entries-table-1024x425.png differ diff --git a/docs/user-documentation/general-users/img/session-token-1024x329.png b/docs/user-documentation/general-users/img/session-token-1024x329.png new file mode 100644 index 0000000000000000000000000000000000000000..c1d6b095b70c1463a8561021383b8069b0cdd7f6 Binary files /dev/null and b/docs/user-documentation/general-users/img/session-token-1024x329.png differ diff --git a/docs/user-documentation/general-users/img/show-experiments-objects-in-projects.png b/docs/user-documentation/general-users/img/show-experiments-objects-in-projects.png new file mode 100644 index 0000000000000000000000000000000000000000..c771bf5e3d80c4e65044e720ed8dd5a00cbd845c Binary files /dev/null and b/docs/user-documentation/general-users/img/show-experiments-objects-in-projects.png differ diff --git a/docs/user-documentation/general-users/img/stock-navigation-menu.png b/docs/user-documentation/general-users/img/stock-navigation-menu.png new file mode 100644 index 0000000000000000000000000000000000000000..61101ae9e715faac48f190fb498933d62d07df67 Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-navigation-menu.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-order-1.png b/docs/user-documentation/general-users/img/stock-new-order-1.png new file mode 100644 index 0000000000000000000000000000000000000000..3d5aec65054ab9df88dd9b12c776423b3d83977e Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-order-1.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-order-code.png b/docs/user-documentation/general-users/img/stock-new-order-code.png new file mode 100644 index 0000000000000000000000000000000000000000..eba7b429c4bcec0be01bb19f1e377e829bfff462 Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-order-code.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-order-identification-info.png b/docs/user-documentation/general-users/img/stock-new-order-identification-info.png new file mode 100644 index 0000000000000000000000000000000000000000..4b27d26ea8ebdfab7705c46a60f0a123509d738e Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-order-identification-info.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-product-1.png b/docs/user-documentation/general-users/img/stock-new-product-1.png new file mode 100644 index 0000000000000000000000000000000000000000..01b5d7a0009fcecf23fb30c69270d175a9b348d3 Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-product-1.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-product.png b/docs/user-documentation/general-users/img/stock-new-product.png new file mode 100644 index 0000000000000000000000000000000000000000..d40b7a394ed1147cad96c6f36aedb5b12a7397c2 Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-product.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-request-1.png b/docs/user-documentation/general-users/img/stock-new-request-1.png new file mode 100644 index 0000000000000000000000000000000000000000..20b60197a9c5be16ea3e72dcb42a9e326a87d6db Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-request-1.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-request.png b/docs/user-documentation/general-users/img/stock-new-request.png new file mode 100644 index 0000000000000000000000000000000000000000..70b674f637745ce3fe130e979fbc828d7724dcc1 Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-request.png differ diff --git a/docs/user-documentation/general-users/img/stock-new-supplier.png b/docs/user-documentation/general-users/img/stock-new-supplier.png new file mode 100644 index 0000000000000000000000000000000000000000..ee6422d66b744aed4e4f7da0bb109c8d6f71c12c Binary files /dev/null and b/docs/user-documentation/general-users/img/stock-new-supplier.png differ diff --git a/docs/user-documentation/general-users/img/storage-assign-positions-1024x355.png b/docs/user-documentation/general-users/img/storage-assign-positions-1024x355.png new file mode 100644 index 0000000000000000000000000000000000000000..d8fee1f31a2d40f8575bbbb7023c1f06f0246670 Binary files /dev/null and b/docs/user-documentation/general-users/img/storage-assign-positions-1024x355.png differ diff --git a/docs/user-documentation/general-users/img/storage-position-single-delete-1024x634.png b/docs/user-documentation/general-users/img/storage-position-single-delete-1024x634.png new file mode 100644 index 0000000000000000000000000000000000000000..9b96a1d6df615cd1c8f166e1b918ad9726ff777a Binary files /dev/null and b/docs/user-documentation/general-users/img/storage-position-single-delete-1024x634.png differ diff --git a/docs/user-documentation/general-users/img/storage-position-table-in-sample-1024x248.png b/docs/user-documentation/general-users/img/storage-position-table-in-sample-1024x248.png new file mode 100644 index 0000000000000000000000000000000000000000..70c0861a47404e60d6f512933b3b7c1cf8e962c1 Binary files /dev/null and b/docs/user-documentation/general-users/img/storage-position-table-in-sample-1024x248.png differ diff --git a/docs/user-documentation/general-users/img/storage-positions-multiple-delete-from-table-1024x582.png b/docs/user-documentation/general-users/img/storage-positions-multiple-delete-from-table-1024x582.png new file mode 100644 index 0000000000000000000000000000000000000000..b3deff1e5e20330a718f9ac4daf6b608ca119951 Binary files /dev/null and b/docs/user-documentation/general-users/img/storage-positions-multiple-delete-from-table-1024x582.png differ diff --git a/docs/user-documentation/general-users/img/storage-selection-1024x202.png b/docs/user-documentation/general-users/img/storage-selection-1024x202.png new file mode 100644 index 0000000000000000000000000000000000000000..52775c2dfcc8641cec97b3f0cf3e767b51c6e7b6 Binary files /dev/null and b/docs/user-documentation/general-users/img/storage-selection-1024x202.png differ diff --git a/docs/user-documentation/general-users/img/trashcan-1024x302.png b/docs/user-documentation/general-users/img/trashcan-1024x302.png new file mode 100644 index 0000000000000000000000000000000000000000..51953e6eefb43d2c6d732223a6a87e1b03536c06 Binary files /dev/null and b/docs/user-documentation/general-users/img/trashcan-1024x302.png differ diff --git a/docs/user-documentation/general-users/img/unarchiving-helper-1024x473.png b/docs/user-documentation/general-users/img/unarchiving-helper-1024x473.png new file mode 100644 index 0000000000000000000000000000000000000000..78dc5b57174b8886baeac232a4df17760d67d14e Binary files /dev/null and b/docs/user-documentation/general-users/img/unarchiving-helper-1024x473.png differ diff --git a/docs/user-documentation/general-users/img/user-profile-session-token.png b/docs/user-documentation/general-users/img/user-profile-session-token.png new file mode 100644 index 0000000000000000000000000000000000000000..42c74e3df9fb83defdca5103e9fd17b0bfef6a82 Binary files /dev/null and b/docs/user-documentation/general-users/img/user-profile-session-token.png differ diff --git a/docs/user-documentation/general-users/img/vocabulary-browser-1024x483.png b/docs/user-documentation/general-users/img/vocabulary-browser-1024x483.png new file mode 100644 index 0000000000000000000000000000000000000000..d3b4465724def8a9bf04f9e6496c7537bb769034 Binary files /dev/null and b/docs/user-documentation/general-users/img/vocabulary-browser-1024x483.png differ diff --git a/docs/user-documentation/general-users/img/warning-sign-1024x904.png b/docs/user-documentation/general-users/img/warning-sign-1024x904.png new file mode 100644 index 0000000000000000000000000000000000000000..dfea9f8a9908043df69e53d313a878fe84084e26 Binary files /dev/null and b/docs/user-documentation/general-users/img/warning-sign-1024x904.png differ diff --git a/docs/user-documentation/general-users/img/win-sftp-1.png b/docs/user-documentation/general-users/img/win-sftp-1.png new file mode 100644 index 0000000000000000000000000000000000000000..4d684fe43e21ac53ee4c9414d16b863d38870c43 Binary files /dev/null and b/docs/user-documentation/general-users/img/win-sftp-1.png differ diff --git a/docs/user-documentation/general-users/img/win-sftp-2.png b/docs/user-documentation/general-users/img/win-sftp-2.png new file mode 100644 index 0000000000000000000000000000000000000000..601ec39227f57ba7e042d78b9eca94e5d896e2dc Binary files /dev/null and b/docs/user-documentation/general-users/img/win-sftp-2.png differ diff --git a/docs/user-documentation/general-users/img/win-sftp-3.png b/docs/user-documentation/general-users/img/win-sftp-3.png new file mode 100644 index 0000000000000000000000000000000000000000..8215ffa34250e04cbf39b021d98ee10561032e9f Binary files /dev/null and b/docs/user-documentation/general-users/img/win-sftp-3.png differ diff --git a/docs/user-documentation/general-users/img/win-sftp-4.png b/docs/user-documentation/general-users/img/win-sftp-4.png new file mode 100644 index 0000000000000000000000000000000000000000..eea12a8bb1c128095abbd79015278784d88aa559 Binary files /dev/null and b/docs/user-documentation/general-users/img/win-sftp-4.png differ diff --git a/docs/user-documentation/general-users/index.rst b/docs/user-documentation/general-users/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..17cb04662aa213db96f6c0636b482dc1eb0644d7 --- /dev/null +++ b/docs/user-documentation/general-users/index.rst @@ -0,0 +1,18 @@ +General Users +============= + +.. toctree:: + :maxdepth: 4 + + general-overview + inventory-of-materials-and-methods + managing-storage-of-samples + barcodes + lab-notebook + data-upload + data-export + data-archiving + search + additional-functionalities + managing-lab-stocks-and-orders-2 + tools-for-analysis-of-data-stored-in-openbis diff --git a/docs/user-documentation/general-users/inventory-of-materials-and-methods.md b/docs/user-documentation/general-users/inventory-of-materials-and-methods.md new file mode 100644 index 0000000000000000000000000000000000000000..8bc01c1e0147022faa3ecb6b3af7a53f329a2851 --- /dev/null +++ b/docs/user-documentation/general-users/inventory-of-materials-and-methods.md @@ -0,0 +1,666 @@ +Inventory Of Materials And Methods +==== + +## Customise Collection View + +[](# "Print this article") + + + +It is possible customise the view of *Collections* in the ELN. + +The default *Collection* can have a **Form View** or a **List View**. +Depending on this selection, the collection view will be different. + + + + + + + + + +**Form View:** This shows the metadata of the *Collection* along with +the table of objects. This view is useful when a user wants to see +specific metadata for a *Collection*. + + + + + +If you do not see the table with the Objects in the form, you need to +enable this by selecting **Show Objects** from the **More..** dropdown + + + + + + + +**List View: **The metadata of the *Collection* is not shown in this +view, but only the table of objects is shown. + + + + + + + +In this case a user would need to click on **More..**, and **Edit** +**Collection** in order to see the metadata and be able to edit the +*Collection*. + + + + + +Updated on April 25, 2023 + +## Register single entries in a Collection + +[](# "Print this article") + + + + + +In this example, we will see how to register one *Object* of type +**Sample** in the **Raw Samples** *Collection.* The same procedure +should be followed to register any other *Object* in other +*Collections*. + + + +1. Click on the **Raw Samples** *Collection* folder in the main menu. +2. Click the **+ New Sample ** in the main page +3. Fill in the form +4. **Save** + + + +Please note that the *Object type* shown in the **+New** button (in this +case **Sample**), is what is defined as *default object type* for the +*Collection*. If this is missing in the *Collection,* the button will +not be present. + + + + + + + +To register a different object type in the Collection: + + + +1. Select **New Object** from the **More** drop down menu (as shown + below) +2. Select the relevant *Object type* from the list *(Sample,* in this + case*).* +3. Fill in the form +4. **Save** + + + + + +Updated on April 25, 2023 + +## Batch register entries in a Collection + +[](# "Print this article") + + + +It is possible to register several samples at once via file upload. Two +methods are currently available: + +1. Batch registration via Excel template file (XLS Batch Register + Objects) +2. Batch registration via TSV template file (TSV Batch Register + Objects) + + + + + + + +In openBIS versions prior to 20.10.6, the XLS batch registration is not +recommended to register several hundreds of entries. The use of the TSV +batch upload to register several hundreds of entries is recommended in +those cases. + + + +## Batch registration via Excel template file + + + +To register several entries of the same type with an Excel file: + +1. Navigate to the relevant collection (e.g.** Samples**). +2. Select **XLS Batch Register Object*****s*** from the + **More*** *drop-down menu (see figure above) +3. Download the **template** file and fill in the relevant information. + (Example file: + [SAMPLE-COLLECTION-REGISTRATION-SAMPLE-STORAGE\_POSITION-template](https://openbis.ch/wp-content/uploads/2022/02/SAMPLE-COLLECTION-REGISTRATION-SAMPLE-STORAGE_POSITION-template-2.xlsx)) +4. Upload the file. + + + +#### **Codes** + + + +In most cases, *Object* types have the option to auto-generate codes set +to true in the admin UI. In this case, openBIS automatically generates +codes and identifiers when *Objects* are registered. If that is not the +case, the code needs to be manually entered by the users in the Excel +template. The current template does not have a **Code** column. This can +however be manually added if codes should be provided by the user and +not automatically generated by openBIS. If codes should be manually +entered and are missing, openBIS will show the error message +“*UserFailureExceptionmessage: Code cannot be empty for a non auto +generated code.*â€Â + + + +#### **Controlled vocabularies** + + + +For Controlled Vocabularies fields, i.e. fields with a drop down menu, +you can enter either the **code** or the **label** of the terms in the +Excel file. + +Please note that codes are not case-sensitive, but labels are. + +Codes and labels of vocabulary terms can be seen under +**Utilities -> Vocabulary Browser**. + + + +#### Assign parents + + + +1. **Assign already existing parents** + + + +If the parents you want to assign to your Objects are already registered +in openBIS, in the **Parents** column of the Excel file, you can assign +the relationship, by providing the identifier of the parent (i.e. /SPACE +code/PROJECT code/OBJECT code). If you want to add multiple parents to +one Object, every identifier should be in a new line in the +corresponding Excel cell. A new line in an Excel cell is entered with +the keyboard shortcuts **Alt** + **Enter.** + +Example file: +[SAMPLE-COLLECTION-REGISTRATION-ANTIBODY-STORAGE\_POSITION-template](https://openbis.ch/wp-content/uploads/2022/02/SAMPLE-COLLECTION-REGISTRATION-ANTIBODY-STORAGE_POSITION-template-1.xlsx) + + + +** Note:** no other separators (e.g “,†or “;â€) should be used, +otherwise an error will be thrown. + + + +**2. Register Objects and assign parents in the same batch registration +process. ** + + + +If you want to register a few *Objects* and at the same time establish a +parent-child relationship between some of them, you can do so by using +the **$** and **Parents** columns. In the example below we want to +register 2 *Objects*, antibody 1 and antibody 2. We want to assign +antibody 1 as parent of antibody 2. In the **$ column** corresponding to +antibody 1 we need to enter numbers or letters proceeded by the $ symbol +(i.e. $1, or $parent1). In the **Parents** column of antibody 2, we need +to use the same value used in the **$ column** for antibody 1. + + + + + + + +#### Date format + +For date fields, the expected format is YYYY-MM-DD. + + + +### Register storage positions and samples in the same XLS file + + + +A **sample** and its **storage** **position** can be registered +together, as shown in the template provided above: + + + +- The info in the **$** column of the **sample** spreadsheet should + match the **Parents** column in **Storage Positions** spreadsheet. + In the $ column you can enter numbers or letters proceeded by the $ + symbol (i.e. $1, $2 or $parent1, $parent2)**.** + + + +## Batch registration via TSV template file + + + +1. Select **TSV** **Batch Register Object*****s*** from the + **More*** *drop-down menu +2. Select the *Object* type (E.g. Sample or Storage) +3. Download the **template** file and fill in the relevant information +4. Upload the file + +** ** + +### **Rules to follow to fill in the template .tsv file** + + + +1. **Identifiers**: + 1. Identifiers are given by **/SPACE code/PROJECT code/OBJECT + code**, e.g **/MATERIALS/EQUIPMENT/INS1**. Users can provide + their own identifiers, or these can be automatically generated + by openBIS. + 2. To have identifiers automatically generated by openBIS, + completely remove the **identifier** column from the file. +2. **Lists**. In fields that have lists to choose from (called + **Controlled Vocabularies**), the code of the term needs to be + entered. Term codes can be seen under **Utilities -> Vocabulary + Browser**. +3. **Parents**. Use the following syntax to enter parents: + **identifier1, identifier2, identifier3.** +4. **Parents annotations**. Use the following syntax to annotate + parents: + **identifier:xxx;COMMENTS:xxxx\identifier:yyy;COMMENTS:yyyy**. Where + **COMMENTS** is the property used for the annotation in this case + (to be replaced with the actual property used). +5. **Date fields**. The expected syntax for dates is YYYY-MM-DD. + + +## Advantages of XLS batch registration vs the old batch registration + + + +1. XLS batch registration uses labels instead of codes in the column + headers in the template file. +2. Fields which are Controlled Vocabularies can use labels instead of + codes. +3. The template can be used as it is, and no modifications are + necessary by removing the identifier column, as it was in case of + the old batch registration. +4. Upload of samples and storage positions can now be performed using + single template file. + + + +The *old* batch register mode is being maintained for backward +compatibility and will be phased out. + + + + + +Updated on April 25, 2023 + +## Batch register entries in several Collections + +[](# "Print this article") + + + +It is possible to batch register *Objects* that belong to different +*Collections*. + +This can be done from the **Object Browser** page, under **Utilities**. +Two options are available: + + + +1. **XLS Batch Register Objects**: batch registration via Excel + template file. +2. **TSV Batch Register Objects**: batch registration via .tsv template + file. + + + + + + + +### XLS Batch Register Objects + + + +This option for batch registration is available since openBIS version +20.10.3. It allows to register *Objects* of different types to multiple +*Collections*. + +You can select which types you want to register from the list of +available types. + + + + + +You can then download the template that will allow you to register +*Objects* of the selected types to single or multiple *Collections*. The +*Space, Project, Collection* need to be entered in the file. The +complete path for *Projects* and *Collections* need to be used, as shown +in this example file: +[SAMPLE-GENERAL-REGISTRATION-EXPERIMENTAL\_STEP-MASS\_MEASUREMENT-SAMPLE-template](https://openbis.ch/wp-content/uploads/2022/03/SAMPLE-GENERAL-REGISTRATION-EXPERIMENTAL_STEP-MASS_MEASUREMENT-SAMPLE-template.xlsx) + + + +### TSV Batch Register Objects + + + +The batch registration via .tsv file allows to batch register only one +type of *Object* at a time. *Objects* however can be registered to +several *Collections*. + +This batch upload method is kept for backward compatibility, but it will +be phased out. + + + + + + + +In this case, if *Objects* are to be registered to multiple +*Collections*, an **identifier** for the *Objects* needs to be provided, +as shown below. This is not the case with the XLS batch registration, +where identifiers can be automatically generated by openBIS. + + + + + + + +Updated on April 25, 2023 + +## Batch update entries in a Collection + +[](# "Print this article") + + + +It is possible to modify the values of one or more fields in several +objects simultaneously via batch update. This can be done in two ways: + + + +1. **XLS Batch Update Objects** +2. **TSV Batch Update Objects** + + + + + +### XLS Batch Update Objects + + + +1. Navigate to the relevant collection (e.g. **Raw Samples**). +2. In the Collection table, from the **Columns,** select **Identifier** + and the field(s) you want to update (e.g. **Source**), as shown + below + + + + + +3\. If you have several entries you can filter the table +(see [Tables](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/tables/)) + +4\. **Export** the table choosing the options **Import Compatible= YES; +Selected Columns; All pages/Current page/Selected rows** (depending on +what you want to export)**.** + + + + + +5\. Modify the file you just exported and save it. + +6\. Select **XLS Batch Update Objects** from the **More..** dropdown + + + + + +6\. Upload the file you saved before and click **Accept**. Your entries +will be updated. + + + +**Note**: + +If a column is removed from the file or a cell in a column is left empty +the corresponding values of updated samples will be preserved. + +To delete a value or a parent/child connection from openBIS one needs to +enter  + + into the corresponding cell in the XLS file. + + +### TSV Batch Update Objects + + + +1. Navigate to the relevant collection (e.g. **Raw Samples**). + +2\. Select **TSV** **Batch Update Objects** from the **More…** dropdown. + + + + + + + +3\. Select the relevant *Object* *type*, e.g. **Sample ** + + + + + +4\. Download the available **template** + +5\. Fill in the **identifiers** of the objects you want to update +(identifiers are unique in openBIS. This is how openBIS knows what to +update). You can copy the identifiers from the identifier column in the +table and paste them in the file. Identifiers have this format: +/MATERIALS/SAMPLES/SAMPLE1. + +6\. Fill in the values in the columns you want to update + +7\. Save the file and upload it via the **XLS Batch Update +Objects** from the **More..** dropdown + + + +**Note**: + +If a column is removed from the file or a cell in a column is left empty +the corresponding values of updated samples will be preserved. + +To delete a value/connection from openBIS one needs to enter + +**\_ \_DELETE\_ \_** into the corresponding cell in the file. + +Updated on April 25, 2023 + +## Batch update entries in several Collections + +[](# "Print this article") + + + +It is possible to batch update *Objects* that belong to different +*Collections*. + +This can be done from the **Object Browser** page, under **Utilities**. +Two options are available: + + + +1. **XLS Batch Update Objects**: batch update via Excel template file. +2. **TSV Batch Update Objects**: batch update via .tsv template file. + + + + + + + +### XLS Batch Update Objects + +This option for batch update is available since openBIS version 20.10.3. +It allows to update *Objects* of different types that belong to +different *Collections*. + +You can select which types you want to update from the list of available +types. + + + + + +You can then download the template that will allow you to update +*Objects* of the selected types to single or multiple *Collections*. The +*Space, Project, Collection* need to be entered in the file. The +complete path for *Projects* and *Collections* need to be used. In +addition, identifiers for the *Objects* need to be provided: identifiers +are unique in openBIS, by providing them openBIS will know which +*Objects* have to be updated. Example file: +[SAMPLE-GENERAL-REGISTRATION-EXPERIMENTAL\_STEP-MASS\_MEASUREMENT-SAMPLE-template](https://openbis.ch/wp-content/uploads/2022/03/SAMPLE-GENERAL-REGISTRATION-EXPERIMENTAL_STEP-MASS_MEASUREMENT-SAMPLE-template-1.xlsx) + + + + + +### TSV Batch Update Objects + + + +The batch update via .tsv file allows to batch update only one type of +*Object* at a time. However, it is possible to update *Objects* that +belong to several *Collections*. + +This batch update method is kept for backward compatibility, but it will +be phased out. + + + + + + + +The *Space, Project, Collection* need to be entered in the file. The +complete path for *Projects* and *Collections* need to be used. In +addition, identifiers for the *Objects* need to be provided: identifiers +are unique in openBIS, by providing them openBIS will know which +*Objects* have to be updated. + + + + + + + +Updated on April 25, 2023 + +## Copy entries + +[](# "Print this article") + + + + + +To create a copy of an existing entry, select **Copy** from the +**More..** drop down menu in the *Collection* page. + + + + + + + + When an entry is copied, the user has the option to **link parents**, +**copy children into the Parents’ collection** and **copy the comments +log**. + +All these options are disabled by default. + + + + + +Updated on July 27, 2022 + +## Move entries to a different Collection + +[](# "Print this article") + + + +You can move entries to a different *Collection* either from the e*ntry* +form or from a *Collection* table. + + + +### Move from entry form + + + +To move entries to a different *Collection*, select **Move** from the +**More…** drop down menu in the entry form. + + + + + + + +You have the option to move to an existing *Collection* or to create a +new *Collection*. + + + + + + + +### Move from Collection Table + + + +It is also possible to move objects from *Collection* tables. You can +select one or multiple entries from a table and click on the **Move** +button. + +Also in this case you can move to an existing *Collection* or create a +new one. + + + + + + + + + +Updated on July 27, 2022 diff --git a/docs/user-documentation/general-users/lab-notebook.md b/docs/user-documentation/general-users/lab-notebook.md new file mode 100644 index 0000000000000000000000000000000000000000..45b2b293aa3e5f9b1d83d66ed073c3c6d504a09b --- /dev/null +++ b/docs/user-documentation/general-users/lab-notebook.md @@ -0,0 +1,807 @@ +Lab Notebook +==== + +## Register Projects + +[](# "Print this article") + + +In a personal folder, users can register one or more *Projects* they +currently work on. *Projects* in openBIS only have a **Description** +field, no additional fields can be added. + + + +1. Navigate to the relevant *Space* in the *Lab Notebook* menu and + click the **+ New Project** + +2. Should you have an empty page, select **Show Identification Info** + and **Show Description** from the **More…** dropdown +3. *Projects* do not have a **Name** field, but only **Code**. Codes + can only take alphanumeric characters and no spaces.Codes are + prettified in the Main Menu. +4. Enter a **Description** for the project. +5. Click **Save** on top of the form. + + + +In the **More…** dropdown you have additional options on what you can do +in the Project folder, as shown below. + + + + + +Updated on April 25, 2023 + +## Register Experiments + +[](# "Print this article") + + +Inside one *Project*, a user can register several *Experiments*, which +can in turn be divided into single *Experimental Steps.* + + + +To register one Experiment: + + + +1. Navigate to the relevant *Project* in the **Lab Notebook** menu +2. Select **Default Experiment** from the **+New** dropdown, as shown + below. *Please note that your openBIS instance might have different + types of Experiments, depending on + +3. Fill in the relevant fields in the form. +4. Select **Show in project overview = true** if the *Experiment* is + important and should be shown in the *Project* form. +5. Click **Save*** *on top of the form. + + + + + +Updated on April 25, 2023 + +## Register Experimental Steps + +[](# "Print this article") + + +As mentioned above, the various steps executed when performing an +Experiment in the lab can be registered in openBIS as  *Experimental +Steps or Entries.* + +The default *Experimental Step* has pre-defined fields, as shown below: + + + + + +An *Entry*, is a blank page, with no pre-defined fields: + + + + + + +To register a default *Experimental Step* or *Entry*: + + +1. Navigate to the relevant **Experiment** in the *Lab Notebook* menu + and click the **+ New** button, as shown below. +2. Select **Experimental Step** or **Entry** +3. Fill in the relevant information or select an available template + from the list (see below). +4. If **Show in project overview*** *is set to true, this *Experimental + Step* or *Entry* will be displayed on the *Project* page. +5. Click **Save** on top of the form. + + + + + + + +### **Comments Log** + + +Several comments can be added by different users who have write-access +to a given user Space: + +1. Click the button in the **Comments** section*.* +2. Enter the **comment**. +3. Click **Save***.* + + + +Updated on April 25, 2023 + +## Add parents and children to Experimental Steps + +[](# "Print this article") + + + +In the default *Experimental Step* and in the *Entry*, there is a +**Parents** section where it is possible to specify links to materials +and methods from the *Inventory* or to any other *Object*, e.g. another +*Experimental Step* or *Entry*. + + + +**Parents** are all samples/materials used in an experimental procedure, +standard protocols from the inventory followed in the experimental +procedure, the equipment used. It is also possible to set one +*Experimental Step/Entry* as parent of a second *Experimental +Step/Entry,* to keep the connection between the two. + + + +The name of this section and which parents should be shown in the form, +is customisable by the *lab manager* or *group admin* as described in +[Customise Parents and Children Sections in Object +Forms](https://openbis.ch/index.php/docs/admin-documentation-openbis-19-06-4/customise-parents-and-children-sections-in-object-forms/) + + +## Adding a parent + + + + + + +### Adding a parent of a predefined type in the form + + + +In the screenshot above, **General protocol** is predefined as parent +type in the form. We have two options to add a parent of this predefined +type: + + + +#### **1. Search** + + + +1. 1. Click on the **Search** button. + 2. Enter the **name** or **code** of the entry you want to add as + parent. + 3. Select the entry you want to add from the list presented to you. + +The parent will be added only when you **save** the entity. + + + + + + + +#### **2. Paste** + + + +1. 1. You may copy the identifier of an entry you want to add as + parent from a file, or from an advanced search or from another + ELN page. You can paste the identifier(s) in the **Paste** text + field. + 2. click the **+Add** button + + + + + +  + + + +### Adding parent of any available type + + + +If you want to add a parent that is not specified in the *Experimental +Step* form, you can use the **Search Any** or **Paste Any** options next +to **Parents.** + + + + + + + + + +#### 1. Search Any + + + +1. Click **Search Any** +2. Select the *Object* type for which you want to add a parent +3. Search by **code** or **name** as explained above +4. Click the **+ Add** button + + +#### 2. Paste Any + + + +There are cases where you may want to add several parents of the same +type or also of different types. In this case, we recommend to use the +**Advanced Search** to find the entries you want to add. You can select +the desired entries from the table and the **Copy Identifiers** button +will become visible. You can copy the identifiers and paste them in the +**Paste Any** field in the *Experimental Step* page, as shown below. + + + + + + + + + + + + +### Adding parent via barcodes + +If you want to add a parent that is registered in openBIS and has a +barcode associated with it by scanning the barcode: + + + +1.Click on the **barcode** icon in the Parents section + + + +2\. A **Barcode Reader** window opens + + + +3\. Scan the barcode of the entry you want to add as parent + +4\. Click on the **Add Objects** button + +5\. **Close** + + + + + +## Removing a parent + + + +To remove a parent, choose **Remove*** *from the **Operations*** *drop +down in the parent table, as shown below. + + + + + + +## **Adding and Removing Children** + + + +Children of *Experimental Steps* are usually derivative *Experimental +Steps,* or products of the *Experimental Step.* As for the **Parents** +section, this section can also be customised by a *group admin* or *lab +manager* in the **ELN Settings** ([Customise Parents and Children +Sections in Object +Forms)](https://openbis.ch/index.php/docs/admin-documentation-openbis-19-06-4/customise-parents-and-children-sections-in-object-forms/). + + + +The procedure for adding and removing children is the same as explained +for parents. + + +### Children Generator + +The **Children Generator** creates a matrix of all the parents entered +in the* Experimental Step*, as shown below. Combinations of parents +needed to generate children can then be selected by the user. The +*Object* type to assign to the children and the number of replicas need +to be specified. The children will then be automatically generated by +openBIS upon registration of the *Experimental Step*. + + + +## Parent-child relationships between entries in lab notebook + +In the Lab Notebook section, if you create a new *Object* from an +existing *Object*, independently of the type, this will be automatically +set as parent of the new Object. For example, if you create a new +Experimental Step (measurement 4) from an existing Experimental Step +(measurement 3), this will be automatically set as child of measurement +3, as shown below. + + + + + + +If you do not wish to have this relationship established, you need to +create the new Object starting from the Experiment level, as shown +below. + + + + + +Updated on April 25, 2023 + +## How to use protocols in Experimental Steps + +[](# "Print this article") + + + + + +When adding protocols to an *Experimental Step*, two options are +available: + +1. Link to a **Protocol** stored in the *Inventory*. This can be used + if the protocol was followed exactly in all steps as described. +2. Create a **local copy of the Protocol** from the *Inventory* in the + current *Experiment*. This should be done if some steps of the main + protocol were modified. These modifications can be edited in the + local copy of the protocol, while the template is left untouched. + + + +To create a local copy under the current Experiment of a template +protocol stored in the *Inventory*: + +1. Add a protocol as parent. +2. From the **Operations** dropdown in the parents table + select*** *Copy to Experiment.** +3. Provide the **Object code** for the new protocol. +4. A copy of the protocol is created under the current *Experiment*, + where the user can modify it. This copy has the original protocol + set as parent, so that connection between the two is clear. + + + + + + +Updated on April 26, 2023 + +## Move Experimental Steps + +[](# "Print this article") + + + +To move an *Experimental Step* to a different *Experiment*, choose +**Move** from the **More..** drop down, as shown in the picture above.  + + + + + + + +It is possible to move *Experimental Steps* from the *Object* table +which is presented on an *Experiment* or *Collection* page. + +Select the entries to move and use the **Move** button on the table. You +can move to an existing *Experiment*/*Collection* or create a new one. + + + + + +Updated on April 25, 2023 + +## Copy Experimental Steps + +[](# "Print this article") + + + +To copy an *Experimental Step*, select **Copy** from the **More…** drop +down menu, as shown below. + + + + + + +When an *Experimental Step* is copied, the user has the option to **link +parents, copy children to the current Experiment** and **copy the +comments log.** The *Experimental Step* is copied inside the same +*Experiment*. + + + +Updated on April 25, 2023 + +## Use templates for Experimental Steps + +[](# "Print this article") + + + +Templates need to be defined by the lab manager in the [**ELN +Settings**](https://openbis.ch/index.php/docs/admin-documentation/create-templates-for-objects/). +If templates have been created for a given *Experimental Step*, you can +choose from the list of available templates by clicking the **Template** +button on the *Object* form, as shown below.  + + + +A template of an *Experimental Step* is an *Experimental Step* with +pre-filled values. Templates are useful when you need to repeat an +*Experimental Step* with the same parameters several times and you wold +like to have default values for those parameters.  + + + + + + +Updated on December 8, 2022 + +## Data Access + +[](# "Print this article") + + +*Datasets* are displayed on the left hand-side of the +*Experiment/Object* form, as shown below. + + + +To navigate and open data registered in openBIS via Finder or Explorer, +open the *Dataset* folder and click on the drive icon next to the +Dataset type name (see above)*. *If SFTP has been configured by a system +admin, you will be provided with a link to copy/paste in an application +such as [Cyberduck](https://cyberduck.io/) or other. + +Please check our documentation for SFTP server +configuration: [Installation and Administrators Guide of the openBIS +Data Store +Server](https://unlimited.ethz.ch/display/openBISDoc2010/Installation+and+Administrators+Guide+of+the+openBIS+Data+Store+Server#InstallationandAdministratorsGuideoftheopenBISDataStoreServer-ExampleSFTPclientconfiguration) + + + +For native access through Windows Explorer or Mac Finder we recommend +the following: + + + +- Windows + 10: [https://www.nsoftware.com/sftp/netdrive/](https://www.nsoftware.com/sftp/netdrive/) +- Mac OS X Yosemite and + higher: [https://mountainduck.io](https://mountainduck.io/) +- Kubuntu: Default Dolphin File Manager with SFTP support + + +### Example of SFTP Net Drive connection: + +1\. open SFTP Net Drive and click on **New**: + + + + + +2\. Edit the drive with the following info, as shown below: + +   a. **Drive name**: choose any name you want. Can be the same as +your openBIS server, but does not have to be. + +   b. **Remote Host**: the name of your openBIS. For example, if the +url of your openBIS is https://openbis- +demo.ethz.ch/openbis/webapp/eln-lims, then openbis-demo.ethz.ch is the +name you want to enter. + +  c. **Remote por**t: enter 2222. + +  d. **Authentication type**: Password (this is selected by default). + +  e. **Username**: the username you use to login to openBIS. + +  f. **Password**: the password you use to login to openBIS. + +  g. **Root folder on server**: you can leave the default, User’s home +folder. + +  h. Press **OK** after filling in all the information above. + + + + + + + +3\. After saving the drive, select it in the drivers’ window and click +**Connect**. + + + + + +3\. openBIS will now appear as a drive in your Explorer window. Click on +the **ELN-LIMS** folder and navigate to the folder containing the data +you want to access. + + + + + + + +Note: if you encounter the error message “*SSH connection failed: Could +not find a part of the path*.†you can fix this by disabling the cache +(Drives -> Advanced -> Enable Caching), and disabling log files. +The error is caused by an attempt to create files in a folder not +available to Windows. + + + + + +### Example of Cyber Duck configuration + + + +Create a new connection in cyberduck: + +1. select **SFTP (SSH File Transfer Protocol)** +2. **Nickname**: the name you want to use for the server +3. **Server**: the name of the server you want to connect to. In the + example below openbis-training.ethz.ch. Replace this with the name + of your own openBIS server. +4. **Port**: 2222 +5. **Username**: this is the username with which you connect to your + openBIS +6. **Password**: this is the password you use to connect to your + openBIS +7. **SSH** private Key: none + + + + + +Save the specifications and connect to the server. + +You will see the folders of your own openBIS in the Cyberduck window and +you can navigate to your data from there. + + + + + +### Example of Dolphin File Manager configuration + + + +To access the Dataset form and edit the Dataset metadata, click on the +Dataset code or Name (if provided). + + + +### SFTP access via session token + +To access via session token (for example when using SSO authentication) +you need to provide the following credentials: + + + +**Username: ?** + +**Password: session token**. + + + +The session token can be copied from the **User Profile** under +**Utilities** in the main menu, as shown below. + + + + + + + +Updated on May 5, 2023 + +## Move Datasets + +[](# "Print this article") + + + +It is possible to move a *Dataset* from one *Experiment/Object* to +another *Experiment/Object*. + +1. Click on the *Dataset* in the main menu +2. In the *Dataset* page select **Move** from the **More..** dropdown +3. Enter the name or code of the *Experiment* or *Object* where you + want to move the *Dataset* to. If you start typing, openBIS will + show you a list of possible entries that match what you entered. +4. Press the **Accept** button. + + + + + + + + + + + + + + + + + +Updated on April 25, 2023 + +## Move one Experiment to a different Project + +[](# "Print this article") + + + +It is possible to move one Experiment and all contained Objects and +Datasets from one Project to another. + +If Objects contain parent/child relationships these are preserved. + + + +To move one Experiment from one Project to another: + + + +1. Select the Experiment you want to move from the main menu +2. Select **Move** from the **More…** dropdown + + + + + + + +3\. Enter the code of the Project where you want to move your +Experiment. If you start typing the code, openBIS will prompt you with a +list of available options and you can select the appropriate one from +there. + + + + + +4\. Click **Accept** + + + +Updated on April 25, 2023 + +## Project Overview + +[](# "Print this article") + + +All *Experiments* and *Experimental Ste*ps have a **Show in project +overview** checkbox. When selected, these *Experiments* and/or +*Experimental Steps* will be shown in the *Project* form, as shown +below. + + + +This allows users to have a better overview of a *Project* and highlight +the most important findings. + + + + + + + +If the *Experiments* and *Object* tables are not shown in the project +page, you need to select **Show Experiments** and **Show Objects** from +the More.. drop down. + + + + +menu. + + + +Updated on April 25, 2023 + +## Edit and Delete Projects, Experiments, Experimental Steps + +[](# "Print this article") + + + + + +*Projects*, *Experiments* and *Experimental Steps* can be edited at any +time, by selecting the **Edit** icon from the toolbar of the relevant +page. + +*Projects*, *Experiments* and *Experimental Steps* can be deleted using +the **Delete** option under **More** tab in the toolbar. + + + + + + + +*Experiments* and *Experimental Steps* are moved to the **trashcan**, +from where they need to be removed in order to be permanently deleted +from the database. *Projects* are directly deleted, they are not moved +to the trashcan first. *Projects* can be deleted only after deleting all +the *Experiments* they contain. + +Please be aware that, by default, only users with *Space Admin and +Instance Admin*  role have permission to delete. Default permissions can +be modified only by a *system admin* (see [Changing the openBIS +capability role +map](https://unlimited.ethz.ch/display/openBISDoc2010/Installation+and+Administrator+Guide+of+the+openBIS+Server#InstallationandAdministratorGuideoftheopenBISServer-ChangingtheCapability-Rolemap)) + +Updated on April 25, 2023 + +## Share Lab Notebooks and Projects + +[](# "Print this article") + + +It is possible to share either a complete lab notebook or single +*Projects*, using the **Manage Access** option in the **More..** +dropdown of a *Space* or *Project* page, as shown below. + + + + + + + +Available roles are: + +1. **Observer**: read-only access to Space or Project +2. **User**: can create and modify entities in Space or Project +3. **Admin**: can create, modify and delete entities in Space or + Project + + + +The roles can be granted to: + +1. **User**: the user needs to be already registered in openBIS. The + username of the user needs to be entered. +2. **Group**: the name of a user group existing in openBIS needs to be + entered. + + + + + + + + + + + + + + + + + + + +Updated on April 25, 2023 diff --git a/docs/user-documentation/general-users/managing-lab-stocks-and-orders-2.md b/docs/user-documentation/general-users/managing-lab-stocks-and-orders-2.md new file mode 100644 index 0000000000000000000000000000000000000000..c7977cc5f41419ce676aa4668f5241a5093c46ad --- /dev/null +++ b/docs/user-documentation/general-users/managing-lab-stocks-and-orders-2.md @@ -0,0 +1,245 @@ +# Managing Lab Stocks and Orders + +[](# "Print this article") + + +It is possible to use openBIS to manage stocks of products and create +orders of products to buy for the lab. + +Every lab member can register products and place requests of products to +buy. The requests can be converted into orders by the lab manager or the +person responsible for purchases in the lab. The orders created with +openBIS contain the information that can be sent to the suppliers. + + + + + + +In the **Stock Catalog** folder, a lab can create one collection of all +products purchased in the lab and one collection of all suppliers used +for purchasing. Each product must be linked to 1 supplier. + +Every lab member by default has *Space User* access rights to the +**Stock Catalog** folder and is able to register products, suppliers and +place requests for products to buy. + +The **Stock Orders** folder is visible to all lab members, who have by +default *Space Observer* rights to it. The lab manager, or person +responsible for purchases, has *Space Admin* rights to this Space. +Orders can be created based on the requests placed in the **Stock +Catalog**. + + +## STOCK CATALOG + + + +### Building the catalog of products and suppliers + + +#### Catalog of suppliers + + + +To build the catalog of all suppliers used for purchasing products by +the lab: + +> 1. Go to the **Supplier Collection** folder under **Stock** *->* +> **Stock Catalog***->* **Suppliers** in the main menu. +> 2. Click on the **+ New Supplier** button in the *Collection* page. +> 3. Follow the steps explained in the [Register +> Entries](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/register-single-entries-in-a-collection/) +> documentation page. +> +>  + + + +To register several suppliers at once, follow the steps described in +[Batch register entries in a +Collection.](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/batch-register-entries-in-a-collection/) + +#### Catalog of products + + + +To build the catalog of all products purchased in the lab: + +> 1. Go to the **Product Collection** folder under **Stock** *->* +> **Stock Catalog***->* **Products** in the main menu. +> 2. Click the **+ New Product** button in the *Collection* page. + + + + +>  +> +> 3. For each product it is necessary to register one supplier as +> parent. Select the correct supplier from the list of suppliers +> registered in the **Supplier Collection.** The process for adding +> parents is the same as described for Experimental Steps: [Add +> parents](https://openbis.ch/index.php/docs/user-documentation-20-10-3/lab-notebook/add-parents-and-children-to-experimental-steps/). +> +>  + + + + + + +To register several suppliers at once, follow the steps described in +[Batch register entries in a +Collection.](https://openbis.ch/index.php/docs/user-documentation-20-10-3/inventory-of-materials-and-methods/batch-register-entries-in-a-collection/) + + +### Creating requests for products to order + + + +Every lab member can create requests for products that need to be +ordered: + +> 1. Go to the **Request Collection** folder under **Stock** *->* +> **Stock Catalog***->* **Requests** in the main menu. +> 2. Click the **+ New Request** button in the *Collection* page. + + + + + +>     3. When you fill in the form the following information needs to +> be provided: +> +>  +> +> 1. - **Order Status**. Options are **Delivered**, **Paid**, +> **Ordered**, **Not yet ordered**. When you create a request +> set this field to **Not yet ordered.** Only requests with this +> **Order Status** can be processed to orders. +> +> 2.  +> - Add the product you for which you want to place a request for +> order. This can be done in two ways**:** +> +> 1\. add a product that is already present in the catalog. This process +> is the same as described for adding parents in Experimental Steps: +> [Add +> parents](https://openbis.ch/index.php/docs/user-documentation-20-10-3/lab-notebook/add-parents-and-children-to-experimental-steps/). +> The quantity, i.e. how many units of the product are requested, needs +> to be specified. +> +> 2\. add a product that is not yet registered in the Catalog. In this +> case the information shown in the picture below needs to be provided. +> After creating the request, the product entered here is automatically +> registered in the Product Catalog. +> +>  + +Please note that only 1 product can be added to 1 request. + + + + + +> 4. Click **Save** on top of the form. + + +## STOCK ORDERS + + + +This section is accessible by default by every lab member. However, by +default, only the person in charge of lab purchases can process orders +based on the requests created in the Stock Catalog by every lab member. + +### Processing product orders from requests + + + +To create orders of products from requests created in the Stock Catalog: + +> 1. Go to the **Order Collection** folder under **Stock** *->* +> **Stock Orders***->* **Orders** in the main menu. +> 2. Click the **+ New Order** button in the *Collection* page. + + + +>  +> +>  +> +> 3\. If you do not see the **Code** in the form, select **Show +> Identification Info** from the **More..** dropdown + + + + + + + +4\. Enter a **Code** for the order + + + + + + + +>  +> +>  3. If an **order** **template** form is available (see [Create +> Templates for +> Objects](https://openbis.ch/index.php/docs/admin-documentation-20-10-3/create-templates-for-objects/)), +> this template can be used and most fields will be automatically filled +> (see [Use templates for Experimental +> Steps](https://openbis.ch/index.php/docs/user-documentation-20-10-3/lab-notebook/use-templates-for-experimental-steps/)). +> If no template is available, the relevant fields in the form need to +> be filled in with the relevant information. + + + + + +> 4\. Enter the **Order Status.** This field is mandatory. Available +> options are **Delivered**, **Paid**, **Ordered**, **Not yet ordered**. +> When you first create the order, you should set the status to **Not +> yet ordered**. +> +> 5. Add one or more requests to the Order. Only requests with Order +> Status set to **Not yet ordered** will be displayed and can be +> selected. +> +> 6. Click **Save** on top of the form. + + + + + +If the price information is available in the products, the total cost of +the order is calculated by openBIS and displayed in the order form, as +shown above. + +By using the **Print Order** button in the order form, the order can be +printed as text file that can be sent to the suppliers for purchasing +the products. + +To simplify the process of ordering multiple products from the same +supplier, all information related to the same supplier is grouped in one +single text file. + +In the example presented in the picture above, there are 2 products to +buy from fluka and 1 product to buy from Sigma-Aldrich. In this case the +two attached files have been printed from the Order form in openBIS, +using the **Print Order** button: +[order\_ORD1\_p0; ](https://openbis.ch/wp-content/uploads/2022/02/order_ORD1_p0.txt) +[order\_ORD1\_p1](https://openbis.ch/wp-content/uploads/2022/02/order_ORD1_p1.txt) + + + +Once the order is processed, you should change the **Order Status** to +**Ordered**. This will automatically change the **Order Status** in all +connected requests. Requests with this oder status cannot be added to +additional orders. + +Updated on April 25, 2023 diff --git a/docs/user-documentation/general-users/managing-storage-of-samples.md b/docs/user-documentation/general-users/managing-storage-of-samples.md new file mode 100644 index 0000000000000000000000000000000000000000..adf51769069a7766a7a461781281d4fd8f0ed692 --- /dev/null +++ b/docs/user-documentation/general-users/managing-storage-of-samples.md @@ -0,0 +1,240 @@ +Managing Storage Of Samples +==== + +## Allocate storage positions to samples + +[](# "Print this article") + + +If we want to track the storage position of samples, openBIS provides a +graphical overview of lab storages. + +Lab storages need to be configured by a *lab manager* or *group admin*, +as explained here: [Configure Lab +Storage](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-materials-and-samples/configure-lab-storage/) + + +This can be done in two ways: + +1. add storage information on the sample form during (or after) sample + registration +2. batch register storage positions for several samples + + +### Register storage position for a single sample + + + +1\. Navigate to the **Storage** section, at the bottom of the sample +form. Click the **+ New Storage Positions** above the table, as shown +below: + + + + +2. In the widget that opens, select the appropriate **Storage** from the +dropdown menu. Storage must be configured by a lab manager or group +admin as explained in [Configure Lab +Storages](https://openbis.ch/index.php/docs/admin-documentation/customise-inventory-of-materials-and-samples/configure-lab-storage/) + + + +3\. Select the **position** in the storage (shelf and rack). + +4\. If the sample is in a box, provide a **Box Name.** + +5\. Select the **Box Size** form the list of configured sizes (the list +can be configured by an *Instance Admin)*. + +6\. Select the **Position** in the box. + +7\. Click **Accept.** + + + + +#### Add additional metadata to storage positions + + +By default, the storage only keeps track of locations. If the **Storage +Position** has been configured by an *Instance admin* to have additional +metadata (e.g. freezing date), these can be added by clicking on the +link in the storage table, as shown below. The link becomes available +after saving the sample. + + + + + + + +The additional information can be entered in the **Storage Position** +*Object* form. + +### Batch register storage positions + +#### XLS Batch Registration + +With the new XLS batch registration, samples and their storage positions +can be registered in one transaction using the XLS template file, as +explained in [Batch register entries in a +Collection](https://openbis.ch/index.php/docs/user-documentation/inventory-of-materials-and-methods/batch-register-entries-in-a-collection/). + + + +#### Batch Registration with TSV file + + +Storage positions are modelled in openBIS as children of other entries. +To register the positions for several samples with the Batch +Registration using the .tsv template, first the parent samples need to +be registered in openBIS. In a second step, the positions are assigned. + +To assign storage positions in batch mode follow the steps below: + +> 1. Select **Storage positions **from the **Batch Registration** drop +> down menu. +> 2. Download the **template file**. +> 3. Remove the **identifier** column from the file (identifiers need +> to be automatically generated by openBIS). +> 4. Fill in the **parents** column. These are the identifiers of the +> samples for which we want to register the storage +> positions(/MATERIALS/PROJECT/OBJECT\_CODE). +> 5. Fill the remaining information about the storage positions. +> 6. Save the file and upload with the **Batch Registration**. + +An example file can be found +here: [SAMPLE-STORAGE\_POSITION-template.txt](https://wiki-bsse.ethz.ch/download/attachments/147412090/SAMPLE-STORAGE_POSITION-template.txt?version=1&modificationDate=1502441624183&api=v2) + +Updated on April 26, 2023 + +## Batch update storage positions + +[](# "Print this article") + + + +To update several storage positions, we can use the batch update option +from the Object Browser: + + + +1. Go to the **Object Browser** under **Utilities** in the main menu +2. Select the object type **Storage Position** from the dropdown menu + (see picture) + +3. Use the table **Filter** to select the storage positions you want to + update + (see [Tables](https://openbis.ch/index.php/docs/user-documentation/additional-functionalities/tables/)) +4. Export the table (see + [Tables](https://openbis.ch/index.php/docs/user-documentation/additional-functionalities/tables/)) +5. Edit the file to make the changes needed (e.g. change the name of a + box, change the storage, change a box position, change box size etc) +6. Select **XLS Batch Update Objects** from the **More..** dropdown. + + + +7\. Import the file you modified before and update the storage +positions. + + + +Updated on April 25, 2023 + +## Delete storage positions + +[](# "Print this article") + + + + +## Delete single storage positions + + + +To delete a single storage position from a sample: + + + +1. Edit the sample for which you want to deleted the storage position +2. Navigate to the **Storage** section at the end of the page +3. Use the “**–**†button in the **Storage Position** table, as shown + in the picture +4. Save the sample + + + + + +Please note that the storage position deleted in this way is moved to +the trashcan. To delete the position permanently, this has to be deleted +from the trashcan (see +[Trashcan](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/trashcan/)). + + + + + +## Remove one of multiple positions in the same box + + + +If one sample has been assigned to multiple positions in the same box +and you need to remove only one or some of them, you can follow these +steps: + + + +1. **Edit** the sample for which you need to remove the storage + position in the box +2. Navigate to the **Storage** section at the end of the page +3. Click on the table row** **(see picture below) +4. **Unselect** the position you want to remove (eg. A5 in the example + below) +5. Click **Accept** +6. **Save** the sample + + + + + + + +## Delete multiple storage positions + + + +To delete multiple storage positions from multiple samples we can use +the **Object Browser**. + + + +1. Go to the **Object Browser** under **Utilities** in the main menu +2. Select **Storage Position** from the **Object Type** dropdown + + + + + + + +3\. **Filter** the table to find the storage positions you want to +delete +(see [Tables](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/tables/)) + +4\. Select the positions you want to delete from the table and click the +**Delete** button (see picture below) + +5\. You will be asked to provide a reason for deletion + +6\. The deleted storage positions will be moved to the trashcan and +should be removed from there to be permanently deleted (see +[Trashcan) ](https://openbis.ch/index.php/docs/user-documentation-20-10-3/additional-functionalities/trashcan/) + + + + + + + +Updated on May 2, 2023 diff --git a/docs/user-documentation/general-users/search.md b/docs/user-documentation/general-users/search.md new file mode 100644 index 0000000000000000000000000000000000000000..ec971ff5a561b3a2213f3c21bda8b382c8ccfe8b --- /dev/null +++ b/docs/user-documentation/general-users/search.md @@ -0,0 +1,38 @@ +Search +==== + + +[](# "Print this article") + + + +It is possible to save and re-use searches created in the [Advanced +search](https://openbis.ch/index.php/docs/user-documentation-20-10-3/search/advanced-search/). +*Space* *admin* rights are required to save searches in a given Space. +Searches can be used by anyone with *User* or *Observer* rights to a +given Space. + + + +In the Advanced Search page, build your search criteria (see example +below). To save the search, click the **Save** button and enter: + + + +1. The **Name** of the search +2. The **Experiment/Collection** where the search should be stored + + + +Searches are stored in *Experiments/Collections*. + + + + +Saved searches are available from the **load a saved search** drop down +menu, at the top of the **Advanced Search** page.  + + + + +Updated on July 28, 2022 diff --git a/docs/user-documentation/general-users/tools-for-analysis-of-data-stored-in-openbis.md b/docs/user-documentation/general-users/tools-for-analysis-of-data-stored-in-openbis.md new file mode 100644 index 0000000000000000000000000000000000000000..6882772e628bdaa7a21ba653431f98eddf863f8f --- /dev/null +++ b/docs/user-documentation/general-users/tools-for-analysis-of-data-stored-in-openbis.md @@ -0,0 +1,223 @@ +Tools For Analysis Of Data Stored In Openbis +==== + +## Jupyter Notebooks + +[](# "Print this article") + + +Jupyter notebooks are web applications that combine text, code and +output ([https://jupyter.org/](https://jupyter.org/)). Jupyter supports +over 40 programming languages. + +Jupyter notebooks can be used to analyze data stored in openBIS. + + +It is possible to connect to a JupyterHub server and launch Jupyter +notebooks directly from the openBIS interface. This feature is not +available by default, but needs to be enabled and configured by a +*system admin*. JupyterHub docker containers are available from our +download page: [openBIS +download.](https://wiki-bsse.ethz.ch/display/bis/openBIS+Download+Page) +Further documentation can be found here: [JupyterHub for +openBIS](https://unlimited.ethz.ch/display/openBISDoc2010/JupyterHub+for+openBIS) + + + +### How to use Jupyter notebooks from openBIS + + + +Jupyter notebooks can be opened at every level of the openBIS hierarchy +(*Space, Project, Experiment/Collection, Object, Dataset*) from the +**More…** dropdown menu, as shown below. + + + + + + + +If you get a similar error as the one shown below when you try to launch +a notebook from an entity, you need to start the JupyterHub server by +going to the main menu **Utilities** -> **Jupyter Workspace**. This +error appears when the JupyterHub server is restarted (e.g. after an +upgrade), because the user profile needs to be recreated. + + + + + +If you go to the Jupyter workspace, the user profile is re-created on +the server. After this, you can open a notebook from any entity of the +openBIS hierarchy as explained above (*Space, Project, +Experiment/Collection, Object, Dataset*). + + + + Jupyter notebooks can also be launched from the main menu, under +**Utilities**, as shown below. + + + + + +**Note**: if you use SSO for authentication (eg. Switch aai), the first +time you want to work with a Jupyter notebook, you first need to open +the **Jupyter Workspace** and then launch a notebook from wherever you +want to open it. + + + +When you launch a notebook from the **New Jupyter Notebook** in the main +menu under **Utilities**, it is necessary to enter: + + +1. The **dataset(s)** needed for the analysis. +2. The **owner** of the Jupyter notebook. Jupyter notebooks are saved + back to openBIS as datasets, and these belong either to an + *Experiment/Collection* or to an *Object*. The owner is the + *Experiment/Collection* or *Object* where the notebook should be + stored. +3. The **directory name**. This is the name of the folder that will be + created on the JupyterHub server. +4. **Notebook name**. This is the name of the Jupyter notebook. + + + +Jupyter notebooks can also be opened from a *Project*, *Experiment*, +*Experimental Step* choosing the corresponding option in the **More** +drop down menu. When opening notebooks from an *Experiment* or +*Experimental Step*, all connected datasets are automatically selected. +If some are not needed, they can be deselected. + + +### Overview of Jupyter notebook opened from openBIS. + +The Jupyter notebooks running on the JupyterHub server for openBIS +support the following kernels: *Bash, Octave, Python 2, Python 3, R, +SoS* ([Script of Scripts).](https://vatlab.github.io/sos-docs/) + +When you open a Jupyter notebook from openBIS, the default kernel used +is Python 3, but you can change to another language as shown below. + + + + + + + + +The Jupyter notebook opened from the openBIS interface contains some +pre-filled cells. All cells need to be run. The information of two cells +should be modified: **Name of the dataset** where the notebook will be +stored and **Notes** (in red below). + + + + + +If you are running a JupyterHub version released after July 2021 +(available at +[https://hub.docker.com/u/openbis](https://hub.docker.com/u/openbis)) +you do not need to enter username and password, as authentication uses +the openBIS session token. + + + +#### What to do in case of invalid session token + + + +If your session token is not automatically renewed you will see a long +error message when you try to retrieve information of a dataset. At the +bottom of the error message you can see: + + + + + + + +In such case, the session token can be manually entered in the cell as +shown below: + + + +      + + + + +The session token can be copied from the **User Profile** under the +**Utilities** Main Menu in the ELN. + +Enter the session token, run the cell above and then move to the next +cell to get the dataset(s) information. + + + +Alternatively you can go to the Jupyter Workspace under **Utilities** +and restart the server. + + + +Your script should be written in the section named *Process your data +here*, that contains one empty cell (see below). You can, of course, add +additional cells. + + + + + +After the analysis is done, the notebook can be saved back to openBIS, +by running the last few cells which contain the information about where +the notebook will be stored (as shown below). + + + + + + + +The last pre-filled cell in the notebook, contains the information on +where to upload the Jupyter notebook in openBIS. After you run this +cell, you can go back to the ELN interface, refresh the webpage and you +will see your Jupyter notebook uploaded to the Object or Experiment you +specified. By default the Jupyter notebook are save to datasets of type +ANALYSIS\_NOTEBOOK. If you prefer to use a different type, you can edit +the pre-filled cell shown above. + + + +## Using a local Jupyter installation with openBIS + +It is also possible to use a local Jupyter installation with openBIS. In +this case, it is possible to download an extension for JupyterLab that +adds 3 buttons to a default notebook: + +1. connect to an openBIS instance; +2. download datasets from the openBIS instance; +3. upload the notebook to openBIS. + + + + + +The JupyterLab openBIS extension is available from: [JupyterLab openBIS +extension](https://www.npmjs.com/package/jupyterlab-openbis) + + + +Updated on April 25, 2023 + +## MATLAB toolbox + +[](# "Print this article") + + +The MATLAB toolbox for openBIS allows to access data stored in openBIS +directly from MATALB. Full documentation can be found here: [MATLAB +API](https://sissource.ethz.ch/sispub/openbis/-/tree/master/api-openbis-matlab) + +Updated on April 17, 2023 diff --git a/docs/user-documentation/legacy-advance-features/index.rst b/docs/user-documentation/legacy-advance-features/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391