Skip to content
Snippets Groups Projects
Commit 98dd729b authored by Marco Del Tufo's avatar Marco Del Tufo
Browse files

Update customise-inventory-of-materials-and-samples.md

parent a569476d
No related branches found
No related tags found
1 merge request!40SSDM-13578 : 2PT : Database and V3 Implementation - include the new AFS "free"...
......@@ -23,12 +23,9 @@ 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.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.html)
2. Create a first folder called Samples inside the **Materials** folder
*(Project)*
3. Create a second folder called Raw Samples** ***(Collection)*
*Instance admin*, from the admin interface, as explained here: [New Entity Type Registration](https://openbis.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.html)
2. Create a first folder called Samples inside the **Materials** folder *(Project)*
3. Create a second folder called **Raw Samples (Collection)**
......@@ -36,14 +33,13 @@ to adopt the following steps:
To create the *Project* folder:
> 1. Click on the **Materials** folder
> 2. Click the **+ New Project** button in the form.
>
1. Click on the **Materials** folder
2. Click the **+ New Project** button in the form.
![image info](img/create-project-materials-1024x286.png)
> 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.
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.
......@@ -55,22 +51,14 @@ To create the *Project* folder:
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.
>
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.
![image info](img/create-collection-materials-1024x403.png)
> 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.readthedocs.io/en/latest/user-documentation/general-users/inventory-of-materials-and-methods.html#customise-collection-view))**
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.readthedocs.io/en/latest/user-documentation/general-users/inventory-of-materials-and-methods.html#customise-collection-view))**
......@@ -100,7 +88,7 @@ To delete an existing Collection:
2\. Select **Delete** under the **More..** drop down menu
2. Select **Delete** under the **More..** drop down menu
......@@ -113,28 +101,19 @@ Updated on February 6, 2023
When a new *Object type* is created by an *Instance admin (*see [New
Entity Type
Registration)](https://openbis.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.html)*,*
the storage widget is disabled by default.
When a new *Object type* is created by an *Instance admin (*see [New Entity Type Registration)](https://openbis.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.html), 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.readthedocs.io/en/latest/user-documentation/general-users/managing-storage-of-samples.html#allocate-storage-positions-to-samples),
the **Storage** should be enabled in the **Settings**, under
**Utilities**. This can be done by a *group admin*.
If we want to track storage positions for this particular *Object type* as described in [Allocate storage positions to samples](https://openbis.readthedocs.io/en/latest/user-documentation/general-users/managing-storage-of-samples.html#allocate-storage-positions-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 **
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
......@@ -145,16 +124,14 @@ Updated on April 26, 2023
## Configure Lab Storage
Fridges and freezers can be configured in the **Settings**, under
**Utilities**.
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.
4. Click the **+ New Storage** button above the storage table, as shown below.
5. Fill in the **Storage Form** as explained below
![image info](img/settings-new-lab-storage-1024x498.png)
......@@ -162,38 +139,21 @@ Fridges and freezers can be configured in the **Settings**, under
**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.
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
Storage positions by default have the following metadata:
......@@ -210,7 +170,6 @@ Storage positions by default have the following metadata:
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.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.html)).
the admin interface (see [New Entity Type Registration](https://openbis.readthedocs.io/en/latest/user-documentation/general-admin-users/admins-documentation/new-entity-type-registration.html)).
Updated on February 6, 2023
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment