diff --git a/docs/eln/devices/configurations/local_collector.mdx b/docs/eln/devices/configurations/local_collector.mdx index 8f10ac0af..056905cc3 100644 --- a/docs/eln/devices/configurations/local_collector.mdx +++ b/docs/eln/devices/configurations/local_collector.mdx @@ -1,6 +1,6 @@ --- title: Local Collectors (in docker containers) -sidebar_label: Local Collectors +sidebar_label: Local Collectors (in docker containers) --- The ELN allows data to be collected automatically from a folder using the data-collector feature. This is useful for sharing files between e.g. an instrument and the ELN. On the instrument side, the (analyses, result etc.) files can be put in a (networked shared) older. On the ELN side, we can monitor this folder for any changes and import files from the instrument directly into the ELN. diff --git a/docs/eln/devices/configurations/user_level_collection.mdx b/docs/eln/devices/configurations/user_level_collection.mdx new file mode 100644 index 000000000..268782251 --- /dev/null +++ b/docs/eln/devices/configurations/user_level_collection.mdx @@ -0,0 +1,66 @@ +--- +title: User-Level Data Collection +sidebar_label: User-Level Data Collection +--- + +Recently user-level data collection (files/folders) has been added in Chemotion ELN. This feature will be available from +v2.0. It will be available along with the existing mechanism. + +## Existing Mechanism + +Here is a brief overview of the existing mechanism. Either file or folder is collected in the data collector mechanism. + +### File Collection + +Different data files are kept under folders, each of which typically contains files specific to a particular analytical +device. The files must begin with the name abbreviation of a valid user who is registered with Chemotion for the +Chemotion to collect the files and send them to the user's inbox in ELN. These files are then extracted from the +device folders and sent to the appropriate user's inbox based on the name abbreviations. All the files are removed from +the device folders after this process is finished. + +![file_collection_1](/img/data_collector/data_collector_file_1.jpg) + +### Folder Collection + +In this mechanism, instead of files, folders are directly collected from various device folders. Each device folder +generally contains the experimental data folders from a particular device. In a similar manner, now the folders have to +begin with the name abbreviation of a valid user registered with Chemotion in order to collect them and send them to the +specific user's inbox in Chemotion ELN. Eventually, these folders are collected from the device folders, and based on the +name abbreviations, they are sent to the inbox of respective users. Upon the completion of this operation, +all the folders are deleted from the device folders. + +![folder_collection_1](/img/data_collector/data_collector_folder_1.jpg) + +:::caution WARNING +Whether it is a file or folder, they will be deleted from the device folder after each collection operation +::: + +## User-Level Data Collection Mechanism + +Along with the existing mechanism, now the user has the option to enable user-level data collection in the +Chemotion ELN. + +### User-Level File Collection + +In this case, now the device folder will contain subfolders, each identified by the name abbreviations of the +Chemotion Users. These user-specific folders will contain the experimental data files. When the data collection +operation is run by the Chemotion, then only the data files within the user-specific folders will be deleted. These +user-specific folders will remain undeleted after each operation. + +![file_collection_new](/img/data_collector/data_collector_file_new.jpg) + +### User-Level Folder Collection + +In a similar manner, the folders that need to be collected will now be kept inside user-specific folders, which are +kept inside device folders. After each successful data collection operation, the user-specific folders will remain +undeleted while all their contents will be deleted. + +![folder_collection_new](/img/data_collector/data_collector_folder_new.jpg) + +### How to enable + +This functionality has to be enabled from the `Data Collector` section in the admin panel. If the checkbox `Enable +user level data collection` remain unchecked, then the conventional data collection mechanism will remain effective. +If this checkbox is checked, then the newly added user-level data collection will be enabled. + +![user_level_selection](/img/data_collector/user_level_selection.gif) diff --git a/static/img/data_collector/data_collector_file_1.jpg b/static/img/data_collector/data_collector_file_1.jpg new file mode 100644 index 000000000..dde9a92b5 Binary files /dev/null and b/static/img/data_collector/data_collector_file_1.jpg differ diff --git a/static/img/data_collector/data_collector_file_new.jpg b/static/img/data_collector/data_collector_file_new.jpg new file mode 100644 index 000000000..3a3740885 Binary files /dev/null and b/static/img/data_collector/data_collector_file_new.jpg differ diff --git a/static/img/data_collector/data_collector_folder_1.jpg b/static/img/data_collector/data_collector_folder_1.jpg new file mode 100644 index 000000000..89df7a605 Binary files /dev/null and b/static/img/data_collector/data_collector_folder_1.jpg differ diff --git a/static/img/data_collector/data_collector_folder_new.jpg b/static/img/data_collector/data_collector_folder_new.jpg new file mode 100644 index 000000000..0ad06f12c Binary files /dev/null and b/static/img/data_collector/data_collector_folder_new.jpg differ diff --git a/static/img/data_collector/user_level_selection.gif b/static/img/data_collector/user_level_selection.gif new file mode 100644 index 000000000..6988dd680 Binary files /dev/null and b/static/img/data_collector/user_level_selection.gif differ