Clarity LIMS Product Analytics Integration v1.0 Workflow Installation
Clarity LIMS Product Analytics Integration v1.0 workflow slices can be used with Clarity LIMS and the NovaSeq v3 and NextSeq 1000/2000 workflows. Before you install these workflows, make sure you have the following applications and integrations:
| • | Clarity LIMS v6.0 or later |
| • | NGS v5.21 or later (the version depends on the version of Illumina Preset Protocols (IPP) that is installed) |
| • | IPP v2.3 or later |
| • | NovaSeq 6000 Integration v3.4 (or later) or NextSeq 1000/2000 Integration v2.3 (or later) |
For more information on the NovaSeq integration, refer to Clarity LIMS Product Analytics Integration v1.0 Configuration and User Interaction. For more information on the NextSeq 1000/2000 integration, refer to NextSeq 1000/2000 Integration v2.3 Configuration and User Interaction.
Clarity LIMS Product Analytics is an integrated feature for the following integrations. No further configuration is required.
| • | NextSeq 1000/2000 Integration v2.3 and later |
| • | Library Prep Validation v2.2.0 and later |
The following table shows the workflow slices used with Clarity LIMS Product Analytics Integration v1.0. For each integration, install only one version of the workflow: either the product analytics-enabled or the non-product analytics-enabled workflow.
Workflow Slice Installation
The Clarity LIMS product analytics-enabled workflow slices in the table are different versions than the workflows that are not product analytics enabled. Therefore, there should not be any workflow conflicts. Download and install the workflows as follows.
| 1. | Download the appropriate workflow slice files based on the following table. |
| 2. | In the Command Prompt, enter md5 <filename> (eg, md5 <novaseq-v3.4-config.xml>) to confirm that the file has the MD5 hash. |
| 3. | After the files have downloaded, copy them to the Clarity LIMS server for installation. |
[Optional] Library Preparation Workflow Updates
If necessary, you can also update the library prep workflow configuration to work with Clarity LIMS Product Analytics Integration v1.0. The update steps are as follows.
| 1. | Update the routing scripts. |
| 2. | Associate the product analytics automation scripts to an existing step. |
| 3. | Update existing automations with product analytics automation. |
Update routing script
The following routing scripts from the NovaSeq and NextSeq integrations must be up to date to work with the Clarity LIMS product analytics-enabled workflow versions:
| • | NovaSeq Workflow v3.4 |
| • | NovaSeq Workflow v3.6 |
| • | NextSeq 1000/2000 Workflow v2.2 |
If you need to update these scripts, refer to the applicable step in either the NovaSeq or NextSeq workflow installation instructions.
Associate Clarity LIMS product analytics automation scripts to existing step
The following library preparation workflows already have Clarity LIMS product analytics automations enabled:
| • | Library Prep Workflow v2.0.5 |
| • | Library Prep Workflow v2.2.0 (available as part of IPP v2.4) |
These workflows already have the Register Sample & Register Step Started and Register Step Completed automations created. These automations need to be enabled on the protocol step of the applicable library preparation workflow.
For all other workflows, the following Clarity LIMS product analytics automations are required:
| • | Register Sample |
| • | Register Step Started |
| • | Register Step Completed |
Update existing automation with Clarity LIMS product analytics automation
In Clarity LIMS, the automation feature supports only one automation for each trigger location and style. Because the product analytics automations require trigger locations and styles—specifically, either Step/Automatic upon entry or Step/Automatic upon exit—the product analytics script must be added to the end of the existing script. For instructions, refer to the applicable step in either the NovaSeq or NextSeq workflow installation instructions.
