Skip to content
Snippets Groups Projects
openbis-data-modelling.md 3.3 KiB
Newer Older
Marco Del Tufo's avatar
.
Marco Del Tufo committed
openBIS Data Modelling
======================

barillac's avatar
barillac committed
# Overview
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
openBIS has the following data structure:
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
1.  **Space**: entity with *Code and *Description**
2.  **Project**: entity with *Code* and *Description*
3.  **Experiment/Collection:** entity with *user-defined properties*
Marco Del Tufo's avatar
.
Marco Del Tufo committed
4.  **Object**: entity with *user-defined properties* 
barillac's avatar
barillac committed
5.  **Dataset**: folder where data files are stored. A dataset has *user-defined properties*      
Marco Del Tufo's avatar
.
Marco Del Tufo committed
      
barillac's avatar
barillac committed
![image info](img/openbis-data-model-v3.png)
Marco Del Tufo's avatar
.
Marco Del Tufo committed


barillac's avatar
barillac committed
*Space* is the top level. Below *Spaces* there are *Projects* and below *Projects* there are *Experiments/Collections*. 
In the general openBIS data model, *Objects* can:
- be shared across *Spaces* (i.e. they do not belong to any Space)
- belong to a *Space*
- belong to a *Project*
- belong to an *Experiment/Collection*
Marco Del Tufo's avatar
.
Marco Del Tufo committed
  
barillac's avatar
barillac committed
*Datasets* can be associated only to *Experiments/Collections* or to *Objects*.  
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
Access to openBIS is controlled at the *Space* level, *Project* level or openBIS instance level (see [openBIS roles ](../general-admin-users/admins-documentation/user-registration.md#openbis-roles)).
Marco Del Tufo's avatar
.
Marco Del Tufo committed

  

barillac's avatar
barillac committed
## Data model in openBIS ELN-LIMS 
-------------------------------
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
In the openBIS ELN-LIMS a simplified data model is used, as shown below.  
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
![image info](img/ELN-data-model-v2.png). 
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
In this case, *Objects* can only belong to *Experiments/Collections*.
barillac's avatar
barillac committed
## Inventory
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
The inventory is usually conceived to be shared by all lab members. The
inventory is used to store all materials and protocols (i.e. standard
operating procedures) used in the lab. It is possible to create
additional inventories, for example of instruments and equipment.
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
The picture below shows an example of an Inventory with the different openBIS levels.  
Marco Del Tufo's avatar
.
Marco Del Tufo committed

barillac's avatar
barillac committed
![image info](img/inventory-data-model.png)
Marco Del Tufo's avatar
.
Marco Del Tufo committed




## Lab Notebook

By default, the lab notebook is organised per user. Each user has a
personal folder (=*Space*), where to create *Projects*, *Experiments*
barillac's avatar
barillac committed
and Experimental Steps (=*Objects*). Data files can be uploaded to *Datasets*. Example structure:
Marco Del Tufo's avatar
.
Marco Del Tufo committed

  
barillac's avatar
barillac committed
![image info](img/labnotebook-data-model.png)
barillac's avatar
barillac committed
Some labs prefer to organise their lab notebook using an organization
per project rather than per user. In this case an openBIS *Space* would
correspond to a lab Project and an openBIS *Project* could be a
sub-project or a user folder (one folder per user working on the same project). 
Marco Del Tufo's avatar
.
Marco Del Tufo committed
  

barillac's avatar
barillac committed
# openBIS parents and children
Marco Del Tufo's avatar
.
Marco Del Tufo committed
----------------------------

barillac's avatar
barillac committed
*Objects* can be linked to other *Objects*, *Datasets* to other *Datasets* with
Marco Del Tufo's avatar
.
Marco Del Tufo committed
N:N relationship. In openBIS these connections are known as *parents*
and *children*.

  

barillac's avatar
barillac committed
![image info](img/objects-parents-children.png)![image info](img/dataset-parents-children.png)


Marco Del Tufo's avatar
.
Marco Del Tufo committed

  

## Examples of parent-child relationships

1.  One or more samples are derived from one main sample. This is the
    parent of the other samples:  
barillac's avatar
barillac committed


![image info](img/sample-vials.png)
Marco Del Tufo's avatar
.
Marco Del Tufo committed
      
barillac's avatar
barillac committed
2.  One Experimental step is performed following a protocol stored in the
    inventory, on a sample stored in the inventory, using a given equipment. The protocol, the sample and the equipment are the parents of the Experimental step


![image info](img/exp-step-parents.png)

Marco Del Tufo's avatar
.
Marco Del Tufo committed
      
3.  One Experimental Step is done after another and we want to keep
barillac's avatar
barillac committed
    track of the links between the steps: 
    
     
![image info](img/exp-step-parents-children.png)
Marco Del Tufo's avatar
.
Marco Del Tufo committed