diff --git a/docs/user-documentation/advance-features/img/ELN-data-model-v2.png b/docs/user-documentation/advance-features/img/ELN-data-model-v2.png new file mode 100644 index 0000000000000000000000000000000000000000..e1bdc4e32b2464b469a768021e7298b8c61727be Binary files /dev/null and b/docs/user-documentation/advance-features/img/ELN-data-model-v2.png differ diff --git a/docs/user-documentation/advance-features/img/ELN-data-model.png b/docs/user-documentation/advance-features/img/ELN-data-model.png deleted file mode 100644 index 7465fcb1c81f1fb24b2e498c9d1937d204c3b2de..0000000000000000000000000000000000000000 Binary files a/docs/user-documentation/advance-features/img/ELN-data-model.png and /dev/null differ diff --git a/docs/user-documentation/advance-features/img/openbis-data-model-v3.png b/docs/user-documentation/advance-features/img/openbis-data-model-v3.png new file mode 100644 index 0000000000000000000000000000000000000000..dd68c7748d4b4cec71dba13dda6b3e6e7544de56 Binary files /dev/null and b/docs/user-documentation/advance-features/img/openbis-data-model-v3.png differ diff --git a/docs/user-documentation/advance-features/img/openbis-data-model.png b/docs/user-documentation/advance-features/img/openbis-data-model.png deleted file mode 100644 index d5df0e55da34206d0cef753803c91184b347750d..0000000000000000000000000000000000000000 Binary files a/docs/user-documentation/advance-features/img/openbis-data-model.png and /dev/null differ diff --git a/docs/user-documentation/advance-features/openbis-data-modelling.md b/docs/user-documentation/advance-features/openbis-data-modelling.md index 6afcb1b7b15e1d0a412bad69409f542bc8bfec80..b89c38edfba9a8f6074e7e52ed95d2d886aaec26 100644 --- a/docs/user-documentation/advance-features/openbis-data-modelling.md +++ b/docs/user-documentation/advance-features/openbis-data-modelling.md @@ -11,7 +11,7 @@ openBIS has the following data structure: 4. **Object**: entity with *user-defined properties* 5. **Dataset**: folder where data files are stored. A dataset has *user-defined properties* - + *Space* is the top level. Below *Spaces* there are *Projects* and below *Projects* there are *Experiments/Collections*. @@ -32,7 +32,7 @@ Access to openBIS is controlled at the *Space* level, *Project* level or openBIS In the openBIS ELN-LIMS a simplified data model is used, as shown below. -. +. In this case, *Objects* can only belong to *Experiments/Collections*. diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/import-data-folder.png b/docs/user-documentation/general-admin-users/admins-documentation/img/import-data-folder.png new file mode 100644 index 0000000000000000000000000000000000000000..82104d3d95d46213217d84c9957a7a50ace5926a Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/import-data-folder.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/warning-sign-39195.png b/docs/user-documentation/general-admin-users/admins-documentation/img/warning-sign-39195.png new file mode 100644 index 0000000000000000000000000000000000000000..9a78a079ce8f11c0e18af29e6ba896aeab4f7baf Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/warning-sign-39195.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/xlsx-folder-2.png b/docs/user-documentation/general-admin-users/admins-documentation/img/xlsx-folder-2.png new file mode 100644 index 0000000000000000000000000000000000000000..da20ca7f86a3431e535b1893886e087b38fe32f4 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/xlsx-folder-2.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/img/xlxs-folder.png b/docs/user-documentation/general-admin-users/admins-documentation/img/xlxs-folder.png new file mode 100644 index 0000000000000000000000000000000000000000..999457728a248839a20739556e2508f1676c33d8 Binary files /dev/null and b/docs/user-documentation/general-admin-users/admins-documentation/img/xlxs-folder.png differ diff --git a/docs/user-documentation/general-admin-users/admins-documentation/import-openbis-exports.md b/docs/user-documentation/general-admin-users/admins-documentation/import-openbis-exports.md index 31a955e436899dc07d2ddf72879cc3995de68e4e..228da296e3b9f3c860fb06acdcafa196f4024cf2 100644 --- a/docs/user-documentation/general-admin-users/admins-documentation/import-openbis-exports.md +++ b/docs/user-documentation/general-admin-users/admins-documentation/import-openbis-exports.md @@ -1,15 +1,34 @@ # Imports of openBIS exports -It is possible to export metadata and data from one openBIS instance to another. +It is possible to export metadata and data from one openBIS instance and import them to another openBIS instance. The export process is described [here](../../general-users/data-export.md). -The exported metadata (and related masterdata) can be imported in another openBIS instance by an instance admin via the admin UI, as described in [mastedata import and export](./masterdata-exports-and-imports.md). -Exported datasets need to be imported via the [eln-lims default dropbox](../../general-users/data-upload.md#data-upload-via-dropbox). +## Metadata import -When importing both metadata and data in a different openBIS instance, first the metadata need to be imported and afterwards the data. +The exported metadata (and related masterdata) can be imported in another openBIS instance by an instance admin via the admin UI, as described in [mastedata import and export](./masterdata-exports-and-imports.md). + +Exported metadata (and masterdata) are contained in a **xlsx** folder, as shown below. + + + + +Metadata and masterdata are contained in the **metadata.xlsx** file. If some of the exported types have validation plugins or dynamic property plugins, these are exported to a **scripts** folder inside the **xlsx** folder. If some exported entities contain either large text fields that exceed the length of an Excel cell or metadata in spreadheets, these are exported to a **data** folder inside the **xlsx** folder. + +If a **data** folder and/or a **scripts** folder are present in the exported **xlsx** folder, the **xlsx** folder needs to be zipped and the **xlsx.zip** file can be imported via admin UI. +If only the **metadata.xlsx** file is contained in the **xlsx** folder, the metadata.xlsx file can be directly uploaded via admin UI. + + + +## Datasets import + +Exported datasets are contained in a **data** folder in a format ready to be imported via [eln-lims default dropbox](../../general-users/data-upload.md#data-upload-via-dropbox). + + + +The folders contained in the **data** folder need to be placed in the **eln-lims incoming directory** and from here will be uploaded to the corresponsing openBIS entities. The metadata of the datasets is read from the **metadata.json** file contained inside each dataset folder. + +When importing both metadata and data in a different openBIS instance, first the metadata need to be imported and afterwards the data. -If the exported metadata consists of an xlsx folder that contains a metadata.xlsx file and a script folder (see below), the xlsx folder needs to be zipped before import via the admin UI (xlsx.zip). - diff --git a/docs/user-documentation/general-users/additional-functionalities.md b/docs/user-documentation/general-users/additional-functionalities.md index 2e86e136ce6e536d9f519b08701e7503313d37bd..b3787325510b9e20d8394ad10cf9d2a137ffb050 100644 --- a/docs/user-documentation/general-users/additional-functionalities.md +++ b/docs/user-documentation/general-users/additional-functionalities.md @@ -3,11 +3,13 @@ Additional Functionalities ## Print PDF -For every entity in openBIS it is possible to generate a pdf using the **Print PDF** option from the **More..** dropdown menu. +For every entity in openBIS it is possible to generate a pdf using the **Print PDF** option from the **More..** dropdown menu. + +The generated pdf file can be printed or downloaded from the browser. An example for a Space is shown in the picture below. - + ## Visualise Relationships diff --git a/docs/user-documentation/general-users/data-export.md b/docs/user-documentation/general-users/data-export.md index 491dd9e84db54e294b1af7a2d6e4c2369dba6de1..074c36bb0760a0ef18482ea28d28f257833c1afd 100644 --- a/docs/user-documentation/general-users/data-export.md +++ b/docs/user-documentation/general-users/data-export.md @@ -1,4 +1,4 @@ -Data Export +Export ==== ## Export to File @@ -14,26 +14,26 @@ the **Export** option in the **More..** drop down, as shown below.  **Space** - + **Project** - + **Experiment/Collection** - + **Object** - + **Dataset** - + In each case, the following export options are available: @@ -41,23 +41,119 @@ In each case, the following export options are available:   -- **Make import compatible**. If selected, the exported data are in a format ready to be uploaded in openBIS using the default eln-lims dropbox, and the metadata XLSX file is in a format ready to be uploaded via the admin UI. -- **Export metadata as pdf**. Metadata is exported in pdf files. One pdf for each exported entity is created. -- **Export metadata as XLSX**. Metadata is exported in one xlsx file. One file containing the metadata of all exported entities and the corresponding masterdata. If **Make import compatible** is selected, this format is suitable for re-import in openBIS. -- **Export data**. Default size limit is 10GB. This can be changed in .. If **Make import compatible** is selected, exported data is in a format ready to be uploaded in openBIS using the default eln-lims dropbox. If not, the datasets will be in a folder structure that matches the ELN hierarchy. -- **Include levels below from same space**. If selected, all hirerachy levels below the selected entity and belonging to the same Space are exported. -- **Include Object and Dataset parents from same space**. If selected, Object parents and Dataset parents from the same Space are exported. Example: I export Object A, in Experiment A, in Space 1. Object A has Object B as parent, in Experiment B in Space 1. When this option is selected, Object B is also exported, otherwise it is not. -- **Include Objects and Datasets parents and children from different spaces**. This exports Object and Dataset parents and children that belong to a different Space than the Space from where Objects and Datasets are being exported. Example: I export Object A in Space 1, which has parents in Space 2. If this option is selected, the parents in Space 2 are also exported. -- **Wait for download to complete in browser**. This is suitable when exporting only metadata or small datasets. When the dowload is ready, the zip file will be available to download from the browser. +- **Make import compatible**. If selected, datasets are exported in a **data** folder and are in a format ready to be uploaded in openBIS using the default eln-lims dropbox; the metadata are exported in a **xlsx** folder which contains information in a format ready to be uploaded via the openBIS admin UI. + +- **Export metadata as PDF**. Metadata are exported in a **pdf** folder that keeps the folder structure of the ELN. At each level, one pdf file for each exported entity is generated. + +- **Export metadata as XLSX**. Metadata are exported in one **xlsx** folder. The folder contains the metadata of all exported entities and the corresponding masterdata in a **metadata.xlsx** file. If **Make import compatible** is selected, this file is suitable for re-import in openBIS. If not, the file contains some fields which are not compatible with re-imports. These fields are: PermId of entities, registrator, registration date, modifier, modification date. In addition to the metadata.xlsx file, the **xlsx** folder might contain a **scripts** folder, which contains scripts associated with types in the metadata.xlsx file, if these are present, and a **data** folder which holds the content of spreadsheet fields and large text fields that exceed the size of an Excel cell. + +- **Export data**. The default maximum size of all datasets to be exported is 10GB. This can be configured by a system admin in the [AS service.properties file](../../system-documentation/configuration/optional-application-server-configuration.md). We recommend to use [sftp](../general-users/lab-notebook.md#data-access) to download large datasets. +If **Make import compatible** is selected, datasets are exported in a **data** folder in a format ready to be uploaded in openBIS using the default eln-lims dropbox. If not, the datasets are exported in a **pdf** folder that matches the ELN hierarchy. + +- **Include levels below from same space**. If selected, all hierachy levels below the selected entity and belonging to the same Space are exported. + +- **Include Object and Dataset parents from same space**. If selected, Object parents and Dataset parents from the same Space are exported. Example: I export Object A, in Experiment A, in Space 1. Object B in Experiment B also in Space 1 is parent of Object A. When this option is selected, Object B is also exported, otherwise it is not. + +- **Include Objects and Datasets parents and children from different spaces**. This allows to export Object and Dataset parents and children that belong to a different Space than the Space from where Objects and Datasets are being exported. Example: I export Object A in Space 1, which has parents in Space 2. If this option is selected, the parents in Space 2 are also exported, otherwise they are not. + +- **Wait for download to complete in browser**. This is suitable when exporting only metadata or small datasets. When the dowload is ready, a zip file will be available to download from the browser. _Note: ensure that pop-ups are not disabled in your browser_. -- **Receive results by email**. If this option is selected, when the export is ready, you will receive an email notification with a download link. Email -notification needs to be configured on *system level* during or after -installation, as explained in [Configure Data Store -Server](../../system-documentation/standalone/optional-datastore-server-configuration.md) +- **Receive results by email**. If this option is selected, when the export is ready, you will receive an email notification with a download link. Email notification needs to be configured on *system level* during or after installation, as explained in [Configure Data Store +Server](../../system-documentation/configuration/optional-datastore-server-configuration.md) - +>  **Known limitation of openBIS 20.10.8**: images embedded in text fields are not currently exported. This limitation will be fixed in the upcoming 20.10.8.1 release. + + + + +We provide below a couple of examples of the export, to clarify how it works. + +### **1. Import-compatible export of a Space selecting all options** + +We select all options from the export widget, as shown below. + +  + +We export a Space called CATERINA in the Lab Notebook with all its sublevels (see below). + + + +One Object in this Space has a parent in a Space called METHODS (see below). + + + +The exported zip file contains 3 folders: + +**A.** **data** folder + +This contains the datasets in the correct format to be uploaded via eln-lims dropbox, as shown below. + + + + + + +**B.** **pdf** folder + +This contains folders that match the openBIS hierarchy (Space/Project/Experiment/Object). + +In this case 2 Space folders are present: + +1. **CATERINA**: is the exported space. +2. **METHODS**: contains an Object which is parent of an Object in the space CATERINA. This was exported because the option **Include Objects and Datasets parents and children from different spaces** was selected for export. + + + + + + +Inside each folder, there is a pdf of the corresponding entity. Example: + +- in the Space folder **CATERINA** there is a **CATERINA.pdf** file that contains the metadata of the Space; +- in the Project folder **PROJECT_1** there is a **PROJECT_1.pdf** file that contains the metadata of the Project; +- in the Experiment folder **My second experiment (PROJECT_1_EXP_1)** there is a **My second experiment (PROJECT_1_EXP_1).pdf** file with the metadata of the Experiment; +- in the Object folder **Step A (EXP4)** there is a **Step A(EXP4).pdf** file with the metadata of the Object and a **20240523100301019-55.pdf** file that contains the metadata of the dataset that belongs to this Object. + + +**C.** **xlsx** folder. + +This contains: + +- a **metadata.xlsx** file which has the metadata of the exported entities and the corresponding masterdata (types and properties) in the correct format to be re-imported in another openBIS instance; +- a **scripts** folder that contains evaluation plugins associated to two types defined in the metadata.xlsx file; +- a **data** folder that contains the information stored in the spreadsheet field of one of the Objects in this Space. + + + + + + + +### **2. Non import-compatible export of a Space selecting all options** + +We export the same Space as described in Example 1, with all options selected, but the export this time is not import-compatible, as shown below. + +  + + +In this case the exported zip file contains only 2 folders: **pdf** and **xlsx**. Data are exported inside the pdf folder, instead of being in a separate **data** folder. + +**A.** **pdf** folder + +This contains the same folder structure as described above. In addition, in this case, inside the Object **Step A (EXP4)** folder there is a **data** folder that contains the dataset belonging to this Object, as shown below. The metadata of the dataset is provided as a metadata.json file inside the data folder and as pdf file inside the Object folder (**Step A (EXP4)**). + + + + +**B.** **xlsx** folder + +This contains the same files and folders as described in Example 1 (see below). The only difference in this case is that the metadata.xlsx is not import-compatible. It contains some fields which are not compatible with openBIS re-import, as explained above. + + + + ## Export to Zenodo diff --git a/docs/user-documentation/general-users/img/IC-data-folder-1.png b/docs/user-documentation/general-users/img/IC-data-folder-1.png new file mode 100644 index 0000000000000000000000000000000000000000..c9c132e9b701b500c7ddb5a8bf5a6097460b52a6 Binary files /dev/null and b/docs/user-documentation/general-users/img/IC-data-folder-1.png differ diff --git a/docs/user-documentation/general-users/img/IC-data-folder-2.png b/docs/user-documentation/general-users/img/IC-data-folder-2.png new file mode 100644 index 0000000000000000000000000000000000000000..7d5dee056e885c858d51b27f1715654e9b166efb Binary files /dev/null and b/docs/user-documentation/general-users/img/IC-data-folder-2.png differ diff --git a/docs/user-documentation/general-users/img/IC-pdf-folder-1.png b/docs/user-documentation/general-users/img/IC-pdf-folder-1.png new file mode 100644 index 0000000000000000000000000000000000000000..9bc79a766df22dcc973209e98d5eb65c6b0c04b4 Binary files /dev/null and b/docs/user-documentation/general-users/img/IC-pdf-folder-1.png differ diff --git a/docs/user-documentation/general-users/img/IC-pdf-folder-2.png b/docs/user-documentation/general-users/img/IC-pdf-folder-2.png new file mode 100644 index 0000000000000000000000000000000000000000..0ace564ad27097cf511ada22c6530d0362425ca3 Binary files /dev/null and b/docs/user-documentation/general-users/img/IC-pdf-folder-2.png differ diff --git a/docs/user-documentation/general-users/img/IC-xlsx-folder-data.png b/docs/user-documentation/general-users/img/IC-xlsx-folder-data.png new file mode 100644 index 0000000000000000000000000000000000000000..d59e145fe1e37dc170a1b3c13029a7b5493f344d Binary files /dev/null and b/docs/user-documentation/general-users/img/IC-xlsx-folder-data.png differ diff --git a/docs/user-documentation/general-users/img/IC-xlsx-folder-scripts.png b/docs/user-documentation/general-users/img/IC-xlsx-folder-scripts.png new file mode 100644 index 0000000000000000000000000000000000000000..2a68c457f4a5074cb3c7777a341b708822f0391d Binary files /dev/null and b/docs/user-documentation/general-users/img/IC-xlsx-folder-scripts.png differ diff --git a/docs/user-documentation/general-users/img/NIC-pdf-folder.png b/docs/user-documentation/general-users/img/NIC-pdf-folder.png new file mode 100644 index 0000000000000000000000000000000000000000..cf5a44be86d9b12effc5cbbbb0f78b14e79d3485 Binary files /dev/null and b/docs/user-documentation/general-users/img/NIC-pdf-folder.png differ diff --git a/docs/user-documentation/general-users/img/NIC-xlsx-folder-data.png b/docs/user-documentation/general-users/img/NIC-xlsx-folder-data.png new file mode 100644 index 0000000000000000000000000000000000000000..55aa39d6eaaaf2716cf25f93279f29a0ef606c72 Binary files /dev/null and b/docs/user-documentation/general-users/img/NIC-xlsx-folder-data.png differ diff --git a/docs/user-documentation/general-users/img/NIC-xlsx-folder-scripts.png b/docs/user-documentation/general-users/img/NIC-xlsx-folder-scripts.png new file mode 100644 index 0000000000000000000000000000000000000000..e48a5dad609c827acab596ed5e39e5b98e769394 Binary files /dev/null and b/docs/user-documentation/general-users/img/NIC-xlsx-folder-scripts.png differ diff --git a/docs/user-documentation/general-users/img/export_example-inventory.png b/docs/user-documentation/general-users/img/export_example-inventory.png new file mode 100644 index 0000000000000000000000000000000000000000..c9a3b2faf9a22838c313ed74ffcc6e592c6848a2 Binary files /dev/null and b/docs/user-documentation/general-users/img/export_example-inventory.png differ diff --git a/docs/user-documentation/general-users/img/export_example-lab-notebook.png b/docs/user-documentation/general-users/img/export_example-lab-notebook.png new file mode 100644 index 0000000000000000000000000000000000000000..e36587d46efd2a84e6a58b2e28995375a92f86bc Binary files /dev/null and b/docs/user-documentation/general-users/img/export_example-lab-notebook.png differ diff --git a/docs/user-documentation/general-users/img/labnotebbok-collection-form.png b/docs/user-documentation/general-users/img/labnotebbok-collection-form.png new file mode 100644 index 0000000000000000000000000000000000000000..1cc8bf12a3a540801f6593678e10f7cdbd8711f5 Binary files /dev/null and b/docs/user-documentation/general-users/img/labnotebbok-collection-form.png differ diff --git a/docs/user-documentation/general-users/img/labnotebook-create-collection.png b/docs/user-documentation/general-users/img/labnotebook-create-collection.png new file mode 100644 index 0000000000000000000000000000000000000000..89a2e77d544bc8135d49e894d5e4ce9e1c41ae75 Binary files /dev/null and b/docs/user-documentation/general-users/img/labnotebook-create-collection.png differ diff --git a/docs/user-documentation/general-users/img/new-export-dataset-2.png b/docs/user-documentation/general-users/img/new-export-dataset-2.png new file mode 100644 index 0000000000000000000000000000000000000000..e63f2fca9cf66c36c833bae028eb5ca1b568ef21 Binary files /dev/null and b/docs/user-documentation/general-users/img/new-export-dataset-2.png differ diff --git a/docs/user-documentation/general-users/img/new-export-dataset.png b/docs/user-documentation/general-users/img/new-export-dataset.png deleted file mode 100644 index 58facfff3c35c1093dcc68464ecc1ba7615dc561..0000000000000000000000000000000000000000 Binary files a/docs/user-documentation/general-users/img/new-export-dataset.png and /dev/null differ diff --git a/docs/user-documentation/general-users/img/new-export-experiment-2.png b/docs/user-documentation/general-users/img/new-export-experiment-2.png new file mode 100644 index 0000000000000000000000000000000000000000..9c8032a63ffa294d2b1f54e15bd23eef80f8c03d Binary files /dev/null and b/docs/user-documentation/general-users/img/new-export-experiment-2.png differ diff --git a/docs/user-documentation/general-users/img/new-export-experiment.png b/docs/user-documentation/general-users/img/new-export-experiment.png deleted file mode 100644 index ca4141ffee63377115646c31cd65484d40077fb8..0000000000000000000000000000000000000000 Binary files a/docs/user-documentation/general-users/img/new-export-experiment.png and /dev/null differ diff --git a/docs/user-documentation/general-users/img/new-export-object.png b/docs/user-documentation/general-users/img/new-export-object-2.png similarity index 66% rename from docs/user-documentation/general-users/img/new-export-object.png rename to docs/user-documentation/general-users/img/new-export-object-2.png index d6c1f4ac9b91ca3550e92dc7a9ef67c5fc62b0d1..b8859bbde4ffe5c1f62c0ad286d9f54ca67f255a 100644 Binary files a/docs/user-documentation/general-users/img/new-export-object.png and b/docs/user-documentation/general-users/img/new-export-object-2.png differ diff --git a/docs/user-documentation/general-users/img/new-export-project-2.png b/docs/user-documentation/general-users/img/new-export-project-2.png new file mode 100644 index 0000000000000000000000000000000000000000..d0b68c3414c1f27e51a58346961b60b243c250e9 Binary files /dev/null and b/docs/user-documentation/general-users/img/new-export-project-2.png differ diff --git a/docs/user-documentation/general-users/img/new-export-project.png b/docs/user-documentation/general-users/img/new-export-project.png deleted file mode 100644 index 7d051a513948809f03e4b012566a8ee501c22a68..0000000000000000000000000000000000000000 Binary files a/docs/user-documentation/general-users/img/new-export-project.png and /dev/null differ diff --git a/docs/user-documentation/general-users/img/new-export-space-2.png b/docs/user-documentation/general-users/img/new-export-space-2.png new file mode 100644 index 0000000000000000000000000000000000000000..828defbde53ba39a6c122981781025bf8cf7b8ce Binary files /dev/null and b/docs/user-documentation/general-users/img/new-export-space-2.png differ diff --git a/docs/user-documentation/general-users/img/new-export-space.png b/docs/user-documentation/general-users/img/new-export-space.png deleted file mode 100644 index 47d889086cc3c8a0677acb47660aa1aa2ea7d946..0000000000000000000000000000000000000000 Binary files a/docs/user-documentation/general-users/img/new-export-space.png and /dev/null differ diff --git a/docs/user-documentation/general-users/img/print-pdf-2.png b/docs/user-documentation/general-users/img/print-pdf-2.png new file mode 100644 index 0000000000000000000000000000000000000000..c6682b60e1a0f089105f3d892c2935bc2fb4da4f Binary files /dev/null and b/docs/user-documentation/general-users/img/print-pdf-2.png differ diff --git a/docs/user-documentation/general-users/img/print-pdf.png b/docs/user-documentation/general-users/img/print-pdf.png index 596feacd96dd36ba12f6a1c1f81559227de4a607..c6682b60e1a0f089105f3d892c2935bc2fb4da4f 100644 Binary files a/docs/user-documentation/general-users/img/print-pdf.png and b/docs/user-documentation/general-users/img/print-pdf.png differ diff --git a/docs/user-documentation/general-users/img/space-export-all-options-import-compatible.png b/docs/user-documentation/general-users/img/space-export-all-options-import-compatible.png new file mode 100644 index 0000000000000000000000000000000000000000..c10186744d86d68e3d1ea5e9cc5b4645f2dc61b7 Binary files /dev/null and b/docs/user-documentation/general-users/img/space-export-all-options-import-compatible.png differ diff --git a/docs/user-documentation/general-users/img/space-export-all-options-non-import-compatible.png b/docs/user-documentation/general-users/img/space-export-all-options-non-import-compatible.png new file mode 100644 index 0000000000000000000000000000000000000000..86cb0f9ff857b9b189f7b1fa61246203d26fc249 Binary files /dev/null and b/docs/user-documentation/general-users/img/space-export-all-options-non-import-compatible.png differ diff --git a/docs/user-documentation/general-users/img/warning-sign-39195.png b/docs/user-documentation/general-users/img/warning-sign-39195.png new file mode 100644 index 0000000000000000000000000000000000000000..9a78a079ce8f11c0e18af29e6ba896aeab4f7baf Binary files /dev/null and b/docs/user-documentation/general-users/img/warning-sign-39195.png differ diff --git a/docs/user-documentation/general-users/img/warning.png b/docs/user-documentation/general-users/img/warning.png new file mode 100644 index 0000000000000000000000000000000000000000..9d2e1dde2e78b888831cb8ad87ea0431ab9b4f64 Binary files /dev/null and b/docs/user-documentation/general-users/img/warning.png differ diff --git a/docs/user-documentation/general-users/lab-notebook.md b/docs/user-documentation/general-users/lab-notebook.md index 462fa2b60d15dcee063dd0a726f51a28344c265e..cadb99b5e76366f52a115795477b47bbb98c4790 100644 --- a/docs/user-documentation/general-users/lab-notebook.md +++ b/docs/user-documentation/general-users/lab-notebook.md @@ -32,7 +32,7 @@ in the Project folder, as shown below.  -Updated on April 25, 2023 + ## Register Experiments @@ -41,25 +41,48 @@ Updated on April 25, 2023 Inside one *Project*, a user can register several *Experiments*, which can in turn be divided into single *Experimental Steps.* +openBIS provides by default 2 options for registering Experiments: + +- **Default Experiment**: The form of the Default Experment contains several metedata fields that can be filled in by the user. +- **Collection**: This form has limited metadata fields. It should be considered as a folder, to be used in cases where a user only needs to group subsequent steps, and does not need any relevant information at this folder level. + +  -To register one Experiment: +### Register a Default 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 + +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 how it has been configured by the Instance admin. +  + 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.   +### Register a Collection: + +1. Navigate to the relevant *Project* in the **Lab Notebook** menu + +2. Select **Collection** from the **+New** dropdown, as shown below. *Please note* that your openBIS instance might have different types of Experiments, depending on how it has been configured by the Instance admin. + + + +3. Fill in the **Name** of the Collection and choose the **Default Object Type** and **Default collection view**. For more info about Collections, see [Customize Collection View](../general-users/inventory-of-materials-and-methods.html#customise-collection-view) and [Collections of Materials](../general-admin-users/admins-documentation/customise-inventory-of-materials-and-samples.html#create-collections-of-materials) + +4. Click **Save** on top of the form. + + -Updated on April 25, 2023 ## Register Experimental Steps @@ -109,7 +132,7 @@ Several comments can be added by different users who have write-access to a give -Updated on April 25, 2023 + ## Add parents and children to Experimental Steps @@ -255,7 +278,7 @@ below.  -Updated on July 5, 2023 + ## How to use protocols in Experimental Steps @@ -282,7 +305,7 @@ To create a local copy under the current Experiment of a template protocol store  -Updated on April 26, 2023 + ## Move Experimental Steps @@ -309,7 +332,7 @@ can move to an existing *Experiment*/*Collection* or create a new one.  -Updated on April 25, 2023 + ## Copy Experimental Steps @@ -332,7 +355,7 @@ comments log.** The *Experimental Step* is copied inside the same  -Updated on April 25, 2023 + ## Use templates for Experimental Steps @@ -354,7 +377,7 @@ like to have default values for those parameters.   -Updated on December 8, 2022 + ## Datasets tables @@ -518,7 +541,7 @@ The session token can be copied from the **User Profile** under  -Updated on May 5, 2023 + ## Move Datasets @@ -552,7 +575,7 @@ another *Experiment/Object*.  -Updated on April 25, 2023 + ## Move one Experiment to a different Project @@ -593,7 +616,7 @@ there.  -Updated on April 25, 2023 + ## Project Overview @@ -616,7 +639,7 @@ Collections in a Project page.  -Updated on July 5, 2023 + ## Edit and Delete Projects, Experiments, Experimental Steps @@ -651,7 +674,7 @@ be modified on *system level* (see [Changing the openBIS capability role map](../../system-documentation/standalone/installation-and-configuration-guide.md#changing-the-capability-role-map)) -Updated on April 25, 2023 + ## Share Lab Notebooks and Projects @@ -686,7 +709,7 @@ The roles can be granted to:  -Updated on April 25, 2023 + ## Rich Text Editor