Installation
The Illumina NovaSeq 6000 Integration v3.6.0 supports the integration between Clarity LIMS (v6.2 and later) and the NovaSeq 6000 instrument. This integration also includes updates to the technology stack and third party libraries and utilities. The key changes from v3.5.1 are as follows.
Updated the preconfigured NovaSeq 6000 workflow to include Clarity LIMS Product Analytics (CLPA) automation scripts by default.
Compatibility with Oracle Linux. For compatibility, refer to NovaSeq 6000 Integration v3.6.0 Release Notes.
ℹ️ Clarity LIMS is automatically stopped during installation of the RPM and will need to be restarted. The file-based and API-based integrations cannot run at the same time. When the API-based integration has finished installing, shut down Clarity LIMS and uninstall the file-based integration.
This document provides instructions for installing NovaSeq 6000 Integration v3.6.0. It also describes the components that are installed in the default configuration.
If you are installing the NovaSeq 6000 integration for the first time, follow the instructions provided in this document.
If NovaSeq 6000 Integration v3.5.1 is already installed, with only minor changes to the default configuration, follow the instructions provided in this document and then duplicate the configuration changes from the v3.5.1 workflow.
If there have been significant changes to the default configuration, follow the instructions provided in NovaSeq 6000 Integration v3.6.0 Manual Upgrade.
Supporting Documentation
For details on installed protocols and steps, automations, generated and captured files, and rules and constraints, refer to NovaSeq 6000 Integration v3.6.0 Configuration.
For information on validating and troubleshooting the integration, refer to NovaSeq 6000 Integration v3.6.0 User Interaction, Validation and Troubleshooting.
For information on the NovaSeq 6000 instrument system, refer to the NovaSeq 6000 System Support Resources.
Prerequisites
NovaSeq 6000 Integration v3.6.0 has the following prerequisites:
Sequencer API RPM Installation Components
NovaSeq Integration v3.6.0 is distributed as the BaseSpaceLIMS-sequencer-api RPM package. This package must be installed on the Clarity LIMS server.
The BaseSpaceLIMS-sequencer-api RPM installs the following files and scripts:
Sequencer API WAR file
application.yml configuration file
configure_sequencer_api_proxy.sh configuration script
configure_sequencer_api_env.sh configuration script
configure_sequencer_api_application.sh configuration script
Sequencer API WAR
The RPM installs the Sequencer API WAR file into the same Tomcat container as Clarity LIMS. The WAR file is at /opt/gls/clarity/tomcat/current/webapps/Illumina#Sequencer#v2##2.6.0.0.war. The version number can differ.
The WAR file is deployed automatically when Clarity LIMS launches. Because the RPM installs a new WAR file, Clarity LIMS is automatically stopped during installation of the RPM. Restart Clarity LIMS before installing the NovaSeq and Library Prep Validation workflow configuration from the IPP.
Configuration File
The application.yml configuration file is installed at /opt/gls/clarity/extensions/sequencer-api/application.yml. As part of the installation process, the file is configured with one of the configuration scripts.
For a complete list of all properties included in the application.yml file, refer to NovaSeq 6000 Integration v3.6.0 Configuration.
Configuration Scripts
The scripts in the following table are installed at the /opt/gls/clarity/config/ folder. During installation, the RPM runs these scripts as they are needed.
Script Name | User | Description |
configure_sequencer_api_proxy.sh | root |
ℹ️ Not required for Illumina cloud hosted installations. |
configure_sequencer_api_env.sh | root | Adds Secret Management setting into the Clarity LIMS Tomcat configuration. |
configure_sequencer_api_application.sh | glsjboss |
⚠️ Run this script when the Sequencer API is first installed.
|
Installation Steps
If running the sequencing service and Automation Worker on the same instance, the instance must also be running a compatible version of Oracle Linux. For compatibility, refer to NovaSeq 6000 Integration v3.6.0 Release Notes.
Workflows, Protocols, and Steps Installed
NovaSeq 6000 Integration v3.6.0 includes the workflows, protocols, and steps listed in the following table. The workflows are found in IPP v2.6.0 package.
NovaSeq 6000 v3.8 Workflow
Library Prep Validation v2.3.1 Workflow
For detailed descriptions of the steps and automations included in each protocol, and details on other components in the configuration, refer to NovaSeq 6000 Integration v3.6.0 Configuration.
For instructions on using the Library Prep Validation v2.3.1 protocol, refer to NovaSeq 6000 Integration v3.6.0 User Interaction, Validation and Troubleshooting.
⚠️ The configuration provided in this integration has been established to support NovaSeq 6000 lab processes. Any configuration changes to protocols or workflows, including renaming protocols, steps, and fields, could break process.
Instrument Software
The NovaSeq instrument software includes the following components:
NovaSeq Control Software (NVCS) — Contains the user interface for setting up the sequencing run. Responsible for controlling the instrument and acquiring the images.
Real-Time Analysis v3 (RTA3) — Takes the images generated by the first module, processes, and analyzes them. Makes sure that data files are created and copied to the final destination folder.
Sequencing Analysis Viewer (SAV) — Displays the important quality metrics generated by the RTA3 software.
NovaSeq recipes — Provides system operation instructions for use with NovaSeq 6000 reagent kits for SP, S1, S2, and S4 flow cells.
Universal Copy Service — Copies output files to destinations such as final destination folder and/or BaseSpace Sequence Hub (when the instrument is configured for use with BaseSpace Sequence Hub).
Instrument Integration Configuration
For the NovaSeq API integration to work, the NovaSeq instrument must be able to communicate with Clarity LIMS through the API. Complete the following steps to configure the NVCS and confirm that you can access Clarity LIMS from the instrument.
Launch NVCS and wait for the initialization process to complete.
On the NVCS Settings page, do the following:
Under Mode Selection, select Server-Based.
In the adjacent field, enter the Clarity LIMS URL (e.g., https://customerserver.claritylims.com).
[Optional] In the Output Folder field, enter the default output folder location. You can also specify the output folder location when setting up a run in NVCS.
Select Save to complete the configuration.
On the NVCS home page, you can now select Sequence to log into Clarity LIMS and start a run.
Last updated