The integration includes the following features:
Preconfigured NovaSeqDx v1.2 workflow that maps to lab protocols and instrument runs.
The following preconfigured protocols:
Run Format (NovaSeqDx v1.2)
NovaSeqDx Standard (NovaSeqDx v1.2) (supports the loading of pooled libraries into a library tube)
NovaSeqDx Xp (NovaSeqDx v1.2) (supports individual lane loading on the NovaSeq)
AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)
Automated generation of v2 sample sheet. This file is automatically uploaded to the instrument via the API.
Automatic validation of run setup information. This information is used to create the run recipe and initiate the run.
Automated tracking of the NovaSeqDx sequencing run and parsing of run statistics into Clarity LIMS, including the following features:
Progress and metrics of sequencing run
Per-instrument sequencing runs (tracked as part of the Run ID field value)
Sequencing run parameters
Sequencing run data directory location
Real-Time Analysis v3 (RTA3) version and other run-specific information
[Optional] Preconfigured Library Prep Validation v2.3.4 workflow used for validation purposes only. The workflow contains a single-step protocol that models the library prep required to produce normalized libraries that are ready for the NovaSeqDx v1.2 workflow. For more information, refer to NovaSeq 6000Dx Integration v1.3.0 User Interaction, Validation and Troubleshooting. The Library Prep Validation v2.3.4 workflow is available in the Illumina Preset Protocols (IPP) v2.9 package.
Last Updated: November 2024
Release Date: July 2024
Document Version: 2
These release notes describe the key changes to software components for the Clarity LIMS NovaSeqDx Integration Package v1.3.0.
Refer to Compatibility under Instruments & Integrations.
Some integration properties are moved to database and can now be accessed and updated via System Setting in Clarity v6.3.
This change requires updates to the configure_sequencer_api_application.sh script.
Refer to NovaSeq 6000Dx Integration v1.3.0 Configuration for configurable properties.
Fixed the denial of service (CVE-2024-30172) vulnerability.
None
Version
Changes
2
Updated Compatibility section to reference Compatibility matrix table.
1
Initial release.
The Illumina NovaSeq 6000Dx Integration v1.3.0 supports the integration between Clarity LIMS and the NovaSeq 6000Dx instrument. The integration includes the following changes:
Compatibility with Oracle Linux. For compatibility, refer to NovaSeq 6000Dx Integration v1.3.0 Release Notes.
Security fixes. This document provides instructions for installing NovaSeq 6000Dx Integration v1.3.0 and describes the components that are installed in the default configuration.
If the user is new to the NovaSeq 6000Dx integration, then follow the instructions provided in this section. If the user has installed NovaSeq 6000Dx Integration v1.1.0, then note that there are no user-facing changes in the configured workflow between NovaSeq 6000Dx Integration v1.1.0 and NovaSeq 6000Dx Integration v1.3.0. It is safe to use the existing NovaSeq 6000Dx v1.1 workflow installed with IPP v2.5.0 and reconfigure the integration for this workflow instead. For more information, refer to [Optional] Configure Properties in Installation Steps.
NovaSeq 6000Dx Integration v1.3.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
The RPM installs the Sequencer API WAR file into the same Tomcat container as Clarity LIMS. The WAR file is installed to the following location:
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.
The application.yml configuration file is installed to the following location:
The file properties are configured with a script during the installation process.
For a complete list of all properties included in the application.yml file and the properties installed into database, refer to Integration Properties Details.
The scripts in the following table are installed to the following location:
During installation, the RPM runs these scripts as they are needed.
If running the sequencing service and Automation Worker on the same instance, the instance must also be running a compatible version of the Oracle Linux operating system. For compatibility, refer to NovaSeq 6000Dx Integration v1.3.0 Release Notes.
NovaSeq 6000Dx Integration v1.3.0 includes the following workflows, protocols, and steps listed below. These workflows can be found in IPP v2.9.
For detailed descriptions of the steps and automations included in each protocol, and details on other components in the configuration, refer to NovaSeq 6000Dx Integration v1.3.0 Configuration.
For instructions on using the Library Prep Validation v2.3.4 protocol, refer to NovaSeq 6000Dx Integration v1.3.0 User Interaction, Validation and Troubleshooting.
The NovaSeq 6000Dx instrument software includes the following components:
NovaSeq 6000Dx Operating Software (NVOS) — 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 6000Dx recipes — Provides system operation instructions for use with NovaSeq 6000Dx 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 BSSH (when the instrument is configured for use with BSSH).
For the NovaSeq 6000Dx API integration to work, the instrument must be able to communicate with Clarity LIMS through the API. Complete the following steps to configure the NVOS and confirm that you can access Clarity LIMS from the instrument.
Launch NVOS and wait for the initialization process to complete.
On the NVOS Instrument Settings page, do as follows.
Select the Global Settings tab.
Under Instrument Mode, select one of the following modes:
Allow users to switch between IVD and RUO
IVD Only
RUO Only
If you selected IVD Only instrument mode, select the IVD Settings tab and complete the following steps:
Configure Run Setup as follows.
Select the Select runs from the LIMS server option.
Enter the Clarity LIMS URL (e.g., https://yourserver.claritylims.com).
[Optional] Under Output Location, enter the output folder location. You can also specify the output folder location when setting up a run in NVOS.
If you selected RUO Only instrument mode, select the RUO Settings tab and complete the following steps:
Configure Run Setup as follows.
Select the Select runs from the LIMS server option.
Enter the Clarity LIMS URL(e.g., https://yourserver.claritylims.com).
Configure Default Work Type as follows.
[Optional] If selection support between NovaSeq Xp or NovaSeq Standard is required for the workflow, select the Enable workflow selection checkbox.
Select the required default workflow type: NovaSeq Standard or NovaSeq Xp.
[Optional] Configure Output Location as follows.
[Optional] Enter the output folder location. You can also specify the output folder location when setting up a run in NVOS.
[Optional] To upload and store run data in the cloud server, select the BSSH checkbox. Select a Configuration option (Run Monitoring and Storage or Run Monitoring Only) and select your Hosting Location from the drop-down list.
Select Save to complete the configuration.
On the NVOS home page, you can now select Sequence to log into Clarity LIMS and start a run. nova
This section explains how to validate the installation of the Illumina NovaSeqDx Integration Package v1.3.0.
The validation process involves the following items:
Running samples through the Library Prep Validation workflow.
The workflow contains a single-step protocol that models the library prep required to produce normalized libraries. At the end of the step, the normalized libraries advance to the workflow selected.
Running normalized libraries through the NovaSeqDx v1.2 workflow validates the following items:
Successful routing of samples from the Run Format (NovaSeqDx v1.2) step to the NovaSeqDx Standard (NovaSeqDx v1.2) or NovaSeqDx Xp (NovaSeqDx v1.2) step.
Automated generation of v2 sample sheet. This file automatically uploads to the sequencing system via the Sequencer API.
Automatic validation of run setup information. Information is uploaded to the NovaSeq 6000Dx Operating Software (NVOS) via the Sequencer API and is used to create the run recipe and initiate the run.
Automated tracking of the NovaSeq 6000Dx sequencing run and parsing of run statistics into Clarity LIMS, via the Sequencer API.
The validation steps assume that the NovaSeqDx Integration Package v1.3.0 is installed and you have imported the default Clarity LIMS configuration.
The following steps set up Clarity LIMS in preparation for running samples through the Library Prep Validation v2.3.4 and NovaSeqDx v1.2 workflows.
On the Configuration tab, under Workflows, activate both the Library Prep Validation v2.3.4 and NovaSeqDx v1.2 workflows.
On the Projects and Samples screen, create a project and add samples to it.
Assign the samples to the Library Prep Validation workflow.
This single-step protocol models the library prep required to produce normalized libraries that are ready for the NovaSeqDx v1.2 workflow.
Label Group = TruSeq HT Adapters v2 (D7-D5)
Sequencing Instrument = NovaSeqDx
On exit from the step, the Routing Script automation is triggered. This automation assigns samples to the first step of the NovaSeqDx v1.2 workflow, Define Run Format (NovaSeqDx v1.2). This is the only step in Protocol 1: Run Format (NovaSeqDx v1.2).
This protocol includes a single step, Define Run Format (NovaSeqDx v1.2). The step allows for the assignment of per sample values for the following fields:
NovaSeqDx Run Mode
Loading Workflow Type
Normalized Molarity
Flowcell Type
Final Loading Concentration (pM)
At the end of the step, samples are routed to the NovaSeqDx Standard or NovaSeqDx Xp protocol. This routing is done according to the selected Loading Workflow Type. The selected NovaSeqDx Run Mode must be compatible with the Loading Workflow Type and Flowcell Type. The following table shows the compatibility for the combinations of each Flowcell Type based on the NovaSeqDx Standard protocol.
NovaSeqDx Standard Protocol Compatibility
The following table shows the compatibility for the combinations of each Flowcell Type based on the NovaSeqDx Xp protocol.
NovaSeqDx Xp Protocol Compatibility
In Lab View, locate the Run Format (NovaSeqDx v1.2) protocol. The samples are queued for the Define Run Format (NovaSeqDx v1.2) step.
Add the samples to the Ice Bucket and select View Ice Bucket.
On the Ice Bucket screen, select Begin Work.
On the Record Details screen in the Sample Details table, populate the following fields (values can vary across samples):
NovaSeqDx Run Mode — Select DX or RUO.
Loading Workflow Type — Select NovaSeq Standard or NovaSeq Xp from the drop-down list.
Flowcell Type — Select SP, S1, S2, or S4.
Final Loading Concentration (pM) — Select from the two preset options: 225 (for PCR-free workflows), 400 (for Nano workflows), or enter a different value.
Normalized Molarity (nM) — These values are copied over from the previous step. If this column is not populated during library prep, enter the values here.
Select Next Steps, which triggers the Set Next Steps automation and the following actions:
Sets the value of the next step (for all samples) to Remove from workflow. The Routing Script automation expects this value and requires it to advance samples to the next step.
Checks that the NovaSeqDx Run Mode value is compatible with the Loading Workflow Type and Flowcell Type. This automation also generates an error message if the Loading Workflow Type or the Flowcell Type are incompatible.
Calculates the Minimum Molarity.
Checks Normalized Molarity value. For samples with no Normalized Molarity value (eg, empty value, not including 0), generates an error message notifying that the field cannot be empty.
Compares each sample Normalized Molarity value with the Minimum Molarity value.
On the Assign Next Steps screen:
In the Sample Details table, the Next Step for all samples is prepopulated with Remove from workflow, regardless of the Loading Workflow Type.
For samples whose Normalized Molarity value is lower than the Minimum Molarity value, the Loading Workflow Type is set to Remove from workflow. A message is recorded in the Warning field for the sample.
To proceed, choose one of the following options:
Return to the Record Details screen and adjust the Normalized Molarity value so that it equals or exceeds the Minimum Molarity value. The Loading Workflow Type must be set to NovaSeq Standard or NovaSeq Xp, as applicable.
Complete the protocol without correcting the Normalized Molarity value. In this case, the samples in question are removed from the Clarity LIMS workflow.
Select Finish Step. The Routing Script automation is triggered:
Samples whose Loading Workflow Type is set to Remove from workflow are removed from the Clarity LIMS workflow. (Occurs when the Normalized Molarity value is lower than the Minimum Molarity.)
Samples whose Loading Workflow Type is set to NovaSeq Standard are routed to the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step. This step is the first step in the NovaSeqDx Standard protocol.
Samples whose Loading Workflow Type is set to NovaSeq Xp are routed to the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step. This step is the first step in the NovaSeqDx Xp protocol.
In this protocol, samples are pooled and added to the library tube in preparation for the NovaSeq 6000Dx run. The protocol contains two steps:
Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2)
Dilute and Denature (NovaSeqDx v1.2)
In Lab View, locate the NovaSeqDx Standard (NovaSeqDx v1.2) protocol.
Samples for the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step are queued.
On the Queue screen, add samples of the same Flowcell Type to the Ice Bucket and select View Ice Bucket.
On the Ice Bucket screen, select Begin Work.
When the step begins, the Validate Single NovaSeqDx Run Mode automation is triggered. This automation checks that the samples have the same NovaSeqDx Run Mode (RUO or DX).
On the Pooling screen, perform the following actions:
Create a pool by dragging samples into the Pool Creator.
Enter a name for the pool or accept the default name (eg, Pool #1).
Select Record Details.
After exiting the Pooling screen, the Validate Inputs Flowcell Type and Single Pool is triggered. The automation verifies the following items:
All samples in the pool have been assigned the same Flowcell Type.
Only one pool has been created.
On the Record Details screen in the Step Details area, complete the two required fields and one optional field, as needed:
Number of Flowcells to Sequence — Used in volume calculations, to make sure that the volumes are sufficient for the number of times the pool is sequenced.
Minimum Per Sample Volume (ul) — Used to calculate how much of each sample is included in the pool. The field is prepopulated with the configured default value 5 µl, but can be edited.
% PhiX (2.5 nM) Spike-In — Used to calculate the volume of PhiX v3 control included in the pool for the given percentage of spike-in. The field is optional and can be edited.
If the smallest Per Sample Volume (ul) value is < 5, Clarity LIMS automatically assigns a value of 5 to the Adjusted Per Sample Volume (ul) field.
Clarity LIMS changes the Adjusted Per Sample Volume (ul) field value for all other samples in the batch, based on the ratio used to increase the lowest value to 5.
In the Sample Details table, select the pool icon to view details on the pool composition.
Select Next Steps to trigger the Set Next Step automation. This automation sets the next step for samples to ADVANCE and advances them to the next step in the protocol, Dilute, and Denature (NovaSeqDx v1.2). The automation also copies the NovaSeqDx Run Mode value from the input pool to the output pool.
On the Assign Next Steps screen, the next step for samples is set to the next step in the workflow: Dilute and Denature (NovaSeqDx v1.2).
Select Finish Step.
At the end of this step, the pool of samples automatically advances to the Dilute and Denature (NovaSeqDx v1.2) step.
In Lab View, locate the NovaSeqDx Standard (NovaSeqDx v1.2) protocol. The pool of samples queued for the Dilute and Denature (NovaSeqDx v1.2) step are listed.
Add the samples to the Ice Bucket and select View Ice Bucket.
On the Ice Bucket screen, select Begin Work. The Validate Single Input automation is triggered. This automation verifies that only one container is input for the step.
On the Placement screen:
Drag the pool into the library tube in the Placed Samples area.
Scan or type the barcode of the library tube into the Library Tube field.
Select Record Details.
After exiting the Placement screen, the Validate Library Tube Barcode automation makes sure that the library tube barcode conforms to the barcode mask that corresponds with the NovaSeqDx Run Mode in the following table. If the barcode does not match, an error message displays. The automation also copies the Flowcell Type and Loading Workflow Type values from step inputs to outputs.
In the Reagent Lot Tracking section, select from the active lots displayed in each drop-down list.
The fields displayed on the Record Details screen are used to set up the run and generate the sample sheet. Some of these fields are autopopulated and some must be completed manually.
Fields Displayed on Record Details Screen of Dilute and Denature (NovaSeqDx v1.2)
On the Record Details screen, select Validate Run Setup and Generate Sample Sheet. This triggers the automation script, which performs the following actions:
Validates the parameters entered on the Record Details screen.
Generates the v2 sample sheet and attaches it to the placeholder in the Files area of the Record Details screen.
Select Next Steps.
On the Assign Next Steps screen, the Next Step for samples is prepopulated with Remove from workflow. The Routing Script automation expects this value, and requires the value to advance samples to the next step.
Select Finish Step.
After exiting the step, the following actions occur:
The Routing Script automation is triggered and samples are routed to AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
In Lab View, the pool of samples is queued for the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
At this point in the workflow, the user interaction ends. Proceed to AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
In this protocol, samples are pooled and added to lanes on the NovaSeq 6000Dx flow cell. The option selected in the Define Run Format (NovaSeqDx v1.2) step determines the flow cell type.
The protocol contains three steps:
Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2)
Dilute, Denature & ExAmp (NovaSeqDx v1.2)
Load to Flowcell (NovaSeqDx v1.2)
In Lab View, locate the NovaSeqDx Xp (NovaSeqDx v1.2) protocol. The samples are queued for the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
On the Queue screen, add samples of the same Flowcell Type to the Ice Bucket and select View Ice Bucket.
On the Ice Bucket screen, select Begin Work.
On the Pooling screen, do as follows.
Create a pool by dragging samples into the Pool Creator.
Enter a name for the pool or accept the default name (e.g., Pool #1).
Select Record Details.
On exiting the Pooling screen, the Validate Inputs Flowcell Type and Single Pool automation is triggered. The automation verifies the following items:
All samples in the pool are assigned the same Flowcell Type.
Only one pool was created.
On the Record Details screen, in the Step Details area, complete the two required fields and one optional field, as needed:
Number of Lanes to Sequence — Used in volume calculations to make sure that volumes are sufficient for the number of times the pool is sequenced.
Minimum Per Sample Volume (ul) — Used to calculate how much of each sample is included in the pool. The field is prepopulated with the configured default value 5 µl, but can be edited.
% PhiX (0.25nM) Spike-In — Used to calculate the volume of PhiX v3 control to be included in the pool for the given percentage of spike-in. The field is optional and can be edited.
If the smallest Per Sample Volume (ul) value is < 5, Clarity LIMS automatically assigns a value of 5 to the samples Adjusted Per Sample Volume (ul) field.
Clarity LIMS then adjusts the Adjusted Per Sample Volume (ul) field value for all other samples in the batch, based on the ratio used to increase the lowest value to 5.
[Optional] In the Sample Details table, select the pool icon to view details on the pool composition.
Select Next Steps to trigger the Set Next Step automation. This automation performs the following actions:
Copies the Flowcell Type values from the step inputs to the step outputs.
Sets the next step for samples to ADVANCE, advancing them to the next step in the protocol—Dilute, Denature & ExAmp (NovaSeqDx v1.2).
On the Assign Next Steps screen, the next step for samples is set to Dilute, Denature & ExAmp (NovaSeqDx v1.2).
Select Finish Step.
At the end of this step, the pool of samples automatically advances to the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step.
In Lab View, locate the NovaSeqDx Xp (NovaSeqDx v1.2) protocol. The pool of samples queued for the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step displays.
Add the pool to the Ice Bucket and select View Ice Bucket.
[Optional] On the Ice Bucket screen, set the number of derivatives to create (placed into the flow cell lanes) and select Begin Work.
On entry to the Record Details screen, the Calculate Volumes automation is triggered. This automation sets the following values based on the selected Flowcell Type:
BP Aliquot Volume (ul)
NaOH Volume (ul)
Tris-HCl Volume (ul)
DPX1 Volume (ul)
DPX2 Volume (ul)
DPX3 Volume (ul)
Mastermix per Lane (ul)
The automation also populates the Flowcell Type and Loading Workflow Type columns of the Sample Details table.
The automation also generates the Calculation File (CSV) and attaches it to the step. This file contains information about the DPX Mastermix volume and the volume of Mastermix, NaOH, and Tris-HCl to add per working pool (refer to the next step).
On the Record Details screen, perform the following actions:
In the Reagent Lot Tracking section, select from the active lots displayed in each drop-down list.
In the Step Details section, verify that the DPX1, DPX2, and DPX3 reagent volume values are populated. The script sets these values and they cannot be edited.
[Optional] In the Sample Details table, select the pool icon to view details of the working pool composition.
Make sure that the following values and columns are populated:
BP Aliquot
Mastermix per lane
NaOH
Tris-HCl
Flowcell Type
Loading Workflow Type
A script sets these values and columns and they cannot be edited. The working pool number is appended to the bulk pool name, so that you can identify which working pools are derived from the same bulk pool.
In the Files area, select the Calculation File (CSV) to open it and view details on the DPX Mastermix volume and the volume of Mastermix, NaOH, and Tris-HCl to add per working pool.
Select Next Steps.
On the Assign Next Steps screen, the next step is already set to Load to Flowcell (NovaSeqDx v1.2).
Select Finish Step.
On the Ice Bucket screen, perform the following actions:
In the Container Options panel, select the appropriate flow cell type from the Destination Container drop-down list.
Select Begin Work.
The Validate Inputs and Selected Container automation checks the following information:
The Flowcell Type field is set to a valid value (SP, S1, S2, or S4) and each input has the same value for the field.
The container type selected matches the value in the Flowcell Type field.
The number of outputs matches the number of lanes on the selected flow cell type. If validation fails, an error message reports the number of working pools does not match the number of lanes available on the flow cell.
On the Placement screen, do as follows.
Drag pools from the left of the screen over into the Placed Samples area on the right.
Scan or type the barcode of the flow cell into the Flowcell field.
Select Record Details.
After exiting the Placement screen, the Validate Flowcell Barcode automation makes sure that the container barcode conforms to the barcode mask for the selected Flowcell Type. This automation also copies the Flowcell Type and Loading Workflow Type field values from step inputs to outputs. The following table shows the barcode mask information.
The fields displayed on the Record Details screen are used to set up the run and generate the sample sheet.
Some of these fields are autopopulated and some must be entered manually. Refer to the following table for details.
Fields Displayed on Record Details Screen of Load to Flowcell (NovaSeqDx v1.2) Step
Select Validate Run Setup and Generate Sample Sheet to trigger the automation script. The script performs the following actions:
Validates the parameters entered on the Record Details screen.
Generates the sample sheet and attaches it to the placeholder in the Files area on the Record Details screen.
Select Next Steps.
On the Assign Next Steps screen, the Next Step field for samples is prepopulated with Mark protocol as complete.
Select Finish Step.
At this point in the workflow, the user interaction ends. The flow cell is queued for the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
Proceed to AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
This protocol contains a single fully automated step: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
The integration starts the step automatically and data from the run is parsed back into Clarity LIMS. User interaction is not required, but you can review the stages of the step in Clarity LIMS (refer to Review Run Data).
The NovaSeqDx Run (NovaSeqDx v1.2) step contains two automations:
Set Next Steps — This automation is disabled (Set to Not Used). By default, the Sequencer API is used to set the next step for output samples.
Update Lane Number — This automation is triggered automatically upon entry to the Record Details screen. To make sure that the Lane Number displays correctly, do not disable or modify this automation.
Read summary metrics are recorded for the library pool. After the run is complete, open the step and review these metrics displayed on the Next Steps screen in the Step Data section and the Sample Details table.
When setting up a run on the NovaSeq 6000Dx instrument, NVOS sends a request for the run recipe.
The Sequencer API validates that samples and containers are correctly queued for the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
Clarity LIMS sends a JSON response to NVOS. The response includes the run recipe information and a link to download the sample sheet (used with analysis software such as bcl2fastq2).
When the run starts, NVOS sends a RunStarted run status request. The Sequencer API then does the following:
Validates reagent kit information in the RunStarted request:
Verifies that the reagent kit exists. If the reagent kit does not exist, the Sequencer API creates the kit and enables on the master step.
Verifies that the reagent kit is activated. If the reagent kit is not active, the Sequencer API activates it.
Initiates the step for the queued samples. The step produces one output file placeholder per lane of the flow cell in use, based on the flow cell type.
Records all relevant information from the RunStarted request on the step (such as reagent lots and step fields).
At the end of the run, NVOS sends one of the following run status requests:
RunCompletedSuccessfully
RunEndedByUSer
RunErroredOut
The Sequencer API updates the step with any new information, which includes only the status and cycle/read information.
After primary analysis completes, NVOS sends a request containing the parsed run metrics. NVOS sends a request only when the run completes successfully. However, the API does not make this assumption and accepts the request regardless of status. The Sequencer API then does the following:
Records the metrics into the fields on file placeholder outputs in Clarity LIMS.
Sample sheet generation and contents
NovaSeq 6000Dx run
User authentication and login
Run recipe contents
If an automation trigger does not appear to run its corresponding scripts, refer to the following sections in the Clarity LIMS API documentation:
If the automated run step starts, but does not complete, do as follows.
Use one of the following methods to open the in progress step in Clarity LIMS:
Log in to the default user account.
In Lab View, find the step in the Recent Activities pane.
Search for the step in Clarity LIMS. You can use the Library Tube or Flowcell barcode as the search term. The steps depend on whether the search is a NovaSeqDx Standard or NovaSeqDx Xp run.
On the Record Details screen, the Sequencing Log multiline text field contains logging information.
Contact the Clarity LIMS support team. Provide the relevant information from the troubleshooting steps already performed.
In addition to updating the Sequencing Log multiline text field on the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step, the Sequencer API writes a detailed log file to
Log messages include the Library Tube ID and Flow Cell ID whenever the messages are related to a sequencing run-related request. In the Clarity LIMS workflows, these IDs are recorded as container names.
Some log messages are not directly related to a sequencing run request, such as downloading the sample sheet. In this case, the file LIMS ID and file name are included in log messages. The sample sheet downloaded by the sequencing system has a name that includes the sequencing container ID (Library Tube for Standard or Flowcell for Xp). The relevant container name search finds most of the log messages for this request. However, the LIMS ID of the file must be known in order to retrieve all messages related to the file download. The LIMS ID is found in the Clarity LIMS API and, for sample sheets used in a run, in the recipe response (which can also be found in the log file).
Example lines from the log file:
This script modifies /opt/gls/clarity/tomcat/current/bin/setenv.sh for Clarity LIMS Tomcat to load the Secret Utility environment variable file (/etc/profile.d/claritysecret.sh) during startup.
The installer validates the import of the workflow and provides the Warning/Error details in STDOUT, which allows you to either proceed with the import or cancel it.
Follow the steps in to run the Library Prep Validation workflow with the following:
Do not change this value. If Next Step is not set to Remove from workflow, the routing script is not routed samples correctly.
Only create one pool.
Assuming the default Minimum Per Sample Volume (ul) value of 5, for a given batch:
Select Calculate Volumes to trigger the . This automation performs calculations based on the selected Flowcell Type, then generates and attaches the Calculation File (CSV) to the step. This file contains volume information about the pool and the individual samples that it contains.
On the Record Details screen, the Reagent Lot Tracking section lets you tracks the NaOH, Resuspension Buffer, and Tris-HCl reagents used in the step. To add and activate reagent lots, refer to Add and Configure Reagent Kits and Lots in the .
The v2 sample sheet generated does not include Cloud and Analysis sections. Contact Illumina Support for information on generating v2 sample sheets with those sections.
Do not change this value. If Next Step is not set to Remove from workflow, the routing script is not able to route samples correctly.
Do not add samples to the Ice Bucket or start the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step. The integration adds samples automatically.
Create only one pool.
Assuming the default Minimum Per Sample Volume (ul) value of 5, for a given batch:
Select Calculate Volumes to trigger the . This automation performs calculations based on the selected Flowcell Type, then generates and attaches the Calculation File (CSV) to the step. This file contains volume information about the pool and the individual samples that it contains.
On the Record Details screen, the Reagent Lot Tracking section tracks the DPX1, DPX2, DPX3, NaOH, Resuspension Buffer, and Tris-HCl reagents used in the step. These reagents must be added. To add and activate reagent lots, refer to Add and Configure Reagent Kits and Lots in the .
The v2 sample sheet generated does not include Cloud and Analysis sections. Contact Illumina Support for information on generating v2 sample sheets with these sections.
Do not add samples to the Ice Bucket or start the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step. The integration adds samples automatically.
The Illumina Preset Protocols (IPP) Package include a Set Next Steps automation configured on the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step. You can use this automation to override the default next step behavior. For more information, refer to .
The following steps summarize how the Sequencer API integration works. For details on sample sheet generation and the sequence of events involved in the NovaSeq run, refer to .
Completes the step in Clarity LIMS if the status is RunCompletedSuccessfully. For all other status options, the step remains in progress. This action is the default autocomplete step behavior. For more information, refer to .
provides detailed information on how the following components work with the Sequencer API integration:
Troubleshooting Automated Worker in the .
Troubleshooting Automation in the .
If an error occurs that does not provide direction on how to proceed, (e.g., the error is related to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step) review the log file information. For more details, refer to .
If unable to reach the Record Details screen, or if the Sequencing Log field does not contain enough information to resolve the issue, review the sequencer-api.log file. For details, refer to .
Flowcell Type | Run Mode |
SP | RUO |
S1 | RUO |
S2 | RUO, DX |
S4 | RUO, DX |
Flowcell Type | Run Mode |
SP | RUO |
S1 | RUO |
S2 | RUO |
S4 | RUO |
NovaSeqDx Run Mode | Valid Barcode Mask |
RUO | [A-Z]{2}[0-9]{7}-[A-Z]{3} |
DX | DX[0-9]{7}-[A-Z]{3} |
Flowcell Type | Barcode Mask |
SP | [A-Z0-9]{5}DR[A-Z0-9]{2} |
S1 | [A-Z0-9]{5}DR[A-Z0-9]{2} |
S2 | [A-Z0-9]{5}DM[A-Z0-9]{2} |
S4 | [A-Z0-9]{5}DS[A-Z0-9]{2} |
Script Name
User
Description
configure_sequencer_api_proxy.sh
root
Adds configuration to the proxy to allow communication with the Sequencer API after Tomcat has been started.
Run this script in the following scenarios:
When the Sequencer API is first installed.
When reconfiguring the Clarity LIMS proxy. This process happens until a version of Clarity LIMS that includes the necessary configuration files from /etc/httpd/clarity/*.conf is available.
configure_sequencer_api_env.sh
root
Adds Secret Management setting into the Clarity LIMS Tomcat configuration.
Run this script when the Sequencer API is first installed on a Secret Util-enabled Clarity LIMS.
configure_sequencer_api_application.sh
glsjboss
Configures the installed application.yml file.
Sets the Clarity LIMS URL and the key to use when signing access tokens.
Field | Value |
Experiment Name | Enter the experiment name. Only alphanumeric characters, dashes, and underscores are permitted. Spaces are not permitted. |
BaseSpace Sequence Hub Configuration | Presets
|
Workflow | Automatically populated with the preset GenerateFASTQ. |
Workflow Type | Presets
|
Index Read 1 | Presets
|
Index Read 2 | Presets
|
Paired End | Presets
|
Read 1 Cycles | Presets
* Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151. |
Read 2 Cycles | Presets
* Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151. |
Use Custom Read 1 Primer | Select if applicable. |
Use Custom Read 2 Primer | Select if applicable. |
Use Custom Index Read 1 Primer | Select if applicable. |
Use Custom Recipe | Select if applicable. |
Custom Recipe Path | If the Use Custom Recipe option is selected, enter the path to the custom recipe file to be used. |
Output Folder | Enter network path for sequencing run folder. For example: |
Analysis Software Version | Enter the software version for BCL Convert Analysis for v2 sample sheet. Leave blank if not applicable. |
Override Cycles | Enter the Override Cycles value for v2 sample sheet. Leave blank if not applicable. |
Field | Value |
Experiment Name | Enter the experiment name. Only alphanumeric characters, dashes, and underscores are permitted. Spaces are not permitted. |
BaseSpace Sequence Hub Configuration | Presets
|
Workflow | Automatically populated with the preset GenerateFASTQ. |
Workflow Type | Presets
|
Index Read 1 | Presets
|
Index Read 2 | Presets
|
Paired End | Presets
|
Read 1 Cycles | Presets
* Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151. |
Read 2 Cycles | Presets
* Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151. |
Use Custom Read 1 Primer | Select if applicable. |
Use Custom Read 2 Primer | Select if applicable. |
Use Custom Index Read 1 Primer | Select if applicable. |
Use Custom Recipe | Select if applicable. |
Custom Recipe Path | If the Use Custom Recipe option is selected, enter the path to the custom recipe file to be used. |
Output Folder | Enter network path for sequencing run folder. For example: |
Library Tube Barcode | Scan the library tube barcode. |
Analysis Software Version | Enter the software version for BCL Convert Analysis for v2 sample sheet. Leave blank if not applicable. |
Override Cycles | Enter the Override Cycles value for v2 sample sheet. Leave blank if not applicable. |
Illumina NovaSeqDx Integration Package v1.3.0 supports the integration of Clarity LIMS to Illumina NovaSeq 6000Dx instruments.
For instructions on user interaction for each step, validating and troubleshooting Illumina NovaSeqDx Integration Package v1.3.0, refer to NovaSeq 6000Dx Integration v1.3.0 User Interaction, Validation and Troubleshooting.
The configuration provided in this integration has been established to support NovaSeq 6000Dx lab processes. Any configuration changes to protocols or workflows—including renaming protocols, steps, and fields—could break the process.
Samples enter the NovaSeqDx v1.2 workflow as normalized libraries. It is assumed that the following steps have completed before samples are assigned to the workflow:
Samples have been accessioned into the Clarity LIMS.
Samples have been run through QC and library prep.
Samples have been normalized, and the value is captured in a field called Normalized Molarity (nM).
For more information on sample accessioning, refer to the following sections of the Getting Started section of the Clarity LIMS (Clarity & LabLink Reference Guide) documentation:
Sample Accessioning
Using Sample Lists to Upload and Modify Samples
You can assign samples to workflows automatically, using a routing script, or manually—from the Projects & Samples dashboard. Refer to Assign and Process Samples in the Clarity LIMS (Clarity & LabLink Reference Guide) documentation.
The Illumina NovaSeq 6000Dx Integration Package v1.3.0 includes the following workflows:
NovaSeqDx v1.2
Library Prep Validation v2.3.4 (optional, but recommended for validation purposes)
The following describes the protocols and steps included in these workflows.
The Library Prep Validation v2.3.4 workflow allows for validation of the system after installation is complete. For details, refer to NovaSeq 6000Dx Integration v1.3.0 User Interaction, Validation and Troubleshooting.
This protocol sets the Loading Workflow Type and allows the choice of the appropriate Flowcell Type and Final Loading Concentration (pM). After the protocol, a routing script sends the normalized libraries to either the NovaSeqDx Standard (NovaSeqDx v1.2) or the NovaSeqDx Xp (NovaSeqDx v1.2) protocol.
This protocol contains one step: Define Run Format (NovaSeqDx v1.2).
Step input: Normalized Template Plate (NTP, normalized libraries)
Step output: None
There are four fields defined on the Define Run Format (NovaSeqDx v1.2) master step.
The following table lists field configuration details.
Define Run Format (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Define Run Format (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
Samples are routed to this protocol when their Loading Workflow Type value is set to NovaSeq Standard. Samples are pooled and added to a library tube in preparation for the NovaSeqDx Run.
At the end of this protocol, a routing script sends the library tube to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) protocol.
This protocol contains the following two steps:
Step 1: Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2)
Step 2: Dilute and Denature (NovaSeqDx v1.2)
In this step, libraries are placed manually into a single pool. Resuspension buffer and reagents are added.
Step input: NTP (normalized libraries)
Step output: Bulk pool
The following fields are defined on the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step.
Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step.
Global Custom Fields Configuration (Derived Sample)
In this step, the addition of NaOH, Tris-HCl, and Resuspension Buffer (RSB) denatures and dilutes pooled samples. Manually place the pooled samples into the library tube for the NovaSeqDx Run.
In addition, this step validates the run setup information and generates the sample sheet file.
Step input: Bulk pool
Step output: Library tube
The following table lists field configuration details for the fields that are defined on the Dilute and Denature (NovaSeqDx v1.2) step. These fields are required for sample sheet and JSON file generation.
Dilute and Denature (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Dilute and Denature (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
Samples are routed to this protocol when their Loading Workflow Type value is set to NovaSeq Xp.
Samples are pooled and added to lanes on the NovaSeqDx flow cell type selected in the Define Run Format (NovaSeqDx v1.2) step. At the end of this protocol, the flow cell is sent to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) protocol.
This protocol contains the following three steps:
Step 1: Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2)
Step 2: Dilute, Denature & ExAmp (NovaSeqDx v1.2)
Step 3: Load to Flowcell (NovaSeqDx v1.2)
Manually place libraries into a pool.
Step input: NTP (normalized libraries)
Step output: Bulk pool
The fields in the following table are defined on the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
In this step, the addition of DPX, NaOH, Tris-HCl, and RSB denatures and dilutes pooled samples. Manually create working pools based on the number of lanes that you want to sequence.
Step input: Bulk pool
Step output: Working pool - variable number (choose how many working pools to create per bulk pool)
The following table lists field configuration details for the fields that are defined on the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step. A script sets these field values. They are not editable while running the step.
Dilute, Denature & ExAmp (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
In this step, scan the flow cell barcode into the Clarity LIMS and manually place the working pools into the lanes of the flow cell for the NovaSeqDx run. This step validates the run setup information and generates the sample sheet file.
Step input: Working pool
Step output: Flow cell (output containers: SP, S1, and S2 with 2 lanes, and S4 with 4 lanes)
The following table lists the field configuration details for the fields defined on the Load to Flowcell (NovaSeqDx v1.2) step.
Load to Flowcell (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Load to Flowcell (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
This final protocol contains one fully automated step, AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
Step input: Library tube from NovaSeqDx Standard or flow cell from NovaSeqDx Xp protocol
Step output: Result file/measurement
In this step, pooled samples are sequenced on the NovaSeq 6000Dx instrument and the run metrics are recorded in Clarity LIMS.
The following table shows the master step fields that are configured on the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
Clarity LIMS Master Step Field Configuration
The following table shows the global custom fields that capture the run metrics in Clarity LIMS.
Custom Field Configuration
Note the following details:
Values are aggregated across all lanes. Some values (eg, Yield PF (Gb) R1) are summed while others are averaged.
The names listed previously are the default global custom field names installed with the NovaSeqDx v1.2 configuration provided in the Illumina Preset Protocols (IPP) Package v2.9 or later.
All global configuration fields are configured on the Container entity.
All field names are configurable via the Clarity LIMS Configuration > Custom Fields screen (Global Fields tab).
If field names are changed in Clarity LIMS, they must also be changed in the integration.sequencer_api.v2.run.metricUdfNames properties. All fields are configured to be visible on the Record Details screen for the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step (in the Sample Details table). For more information, refer to the Properties section of Components Installed.
The sample sheet is generated on the step before the run. This step is either Dilute and Denature (NovaSeqDx v1.2) in the NovaSeqDx Standard protocol or Load to Flowcell (NovaSeqDx v1.2) in the NovaSeqDx Xp protocol. This step places samples on the library tube or flow cell that is loaded in the NovaSeq 6000Dx instrument.
In the default configuration, the Validate Run Setup and Generate Sample Sheet automation generates one sample sheet file for use with bcl2fastq v2.20 downstream analysis. This file is in the comma-separated values (CSV) format.
The sample sheet is uploaded to the NovaSeq 6000Dx Operating Software (NVOS) via the /Illumina/Sequencer/v2/sequencing-run/files endpoint to the Sequencer API. The file endpoint allows for a file to be downloaded from Clarity LIMS using OAuth (instead of Basic Authentication), which is required for NovaSeq 6000Dx.
The run recipe response sets the sample sheet URL to the link to download the file from this endpoint and sets the sampleSheetRequiresOAuth value to true.
The following steps outline the sequence of events that occurs when a flow cell is loaded onto the NovaSeq 6000Dx instrument.
The following sections describe the components (files, properties, reagent categories/label groups, reagent kits, and containers) that are installed by default as part of this integration.
Illumina NovaSeq 6000Dx Integration v1.3.0 is distributed as an RPM package, BaseSpaceLIMS-sequencer-api. This RPM package must be installed on the Clarity LIMS server.
The BaseSpaceLIMS-sequencer-api RPM installs the following items:
Sequencer API WAR file
application.yml configuration file
The following configuration scripts:
configure_sequencer_api_proxy.sh
configure_sequencer_api_env.sh
configure_sequencer_api_application.sh
If the NGS Extensions Package is not already installed, or if a version earlier than v5.25.0 is installed, the latest version is installed by default with the NovaSeq 6000Dx integration. For details, refer to NovaSeq 6000Dx Integration v1.3.0 Release Notes.
If NGS Extensions Package v5.25.0 or later is already installed, upgrade is not forced or required.
The following table lists the components installed by the RPM package.
Refer to Integration Properties Details for the properties installed with the integration package.
TruSeq HT Adapters v2 (D7-D5)
Buffer Cartridge
Cluster Cartridge
DPX1
DPX2
DPX3
NaOH
Resuspension Buffer (RSB)
SBS Cartridge
Tris-HCl
Library Tube
SP
S1
S2
S4
This integration supports the following items:
Library tube with barcode provided in the following formats:
RUO mode: [A-Z]{2}[0-9]{7}-[A-Z]{3}
Example: AB1234567-LIB
DX mode: DX[0-9]{7}-[A-Z]{3}
Example: DX1234567-LIB
SP, S1, S2, or S4 flow cell with barcode provided in one of the following formats:
SP and S1 flow cell: [A-Z0-9]{5}DR[A-Z0-9]{2}
S2 flow cell: [A-Z0-9]{5}DM[A-Z0-9]{2}
S4 flow cell: [A-Z0-9]{5}DS[A-Z0-9]{2}
Example: H1991DMXX
For details on configuring the NovaSeq 6000Dx Operating Software (NVOS) for integration with Clarity LIMS, contact the Clarity LIMS Support team.
The requirements for the routing script functionality are as follows.
On the steps that use the routing script (Define Run Format (NovaSeqDx v1.2) and Dilute and Denature (NovaSeqDx v1.2)):
The Next Step for all samples must be set to Remove from workflow. A script sets this value. The value must not change in the Assign Next Steps screen.
In the protocol configuration screen, the following settings are required and must not be changed:
In the Next Steps section, for the last step in the protocol, the method of assigning the next step must be set to Automatic.
The integration.sequencer_api.v2.run.autoCompleteOnlyAtSuccess and integration.sequencer_api.v2.run.autoComplete properties determine the conditions under which the last step of the NovaSeq 6000Dx workflow, AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2), is automatically completed. The two scenarios for autocompletion of the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step are as follows.
The step autocompletes only when the run status is RunCompletedSuccesfully (default behavior).
The step autocompletes regardless of the run status.
By default, both properties are set to true and the step only completes if the run is successful. If the run fails or is aborted, the step must be completed manually in Clarity LIMS.
For the step to autocomplete regardless of the result of the sequencing run, change the autoCompleteOnlyAtSuccess property value to false.
Edit the value of integration.sequencer_api.v2.run.autoCompleteOnlyAtSuccess property as required using the omxProps-ConfigTool utility.
Save the file.
The following table shows how the combined value of the integration.sequencer_api.v2.run.autoComplete and integration.sequencer_api.v2.run.autoCompleteOnlyAtSuccess properties affects the autoComplete behavior of the sequencing step.
run.autoComplete and run.autoCompleteOnlyAtSuccess Value Matrix
The workflow configuration contains several validation checks. To make sure that the calculations work properly, it is important that you do not disable any of this validation logic. The validation checks determine the following information:
Which samples, and how many, can enter each step together.
Which samples, and how many, can be pooled together.
The library tube ID must be unique. There must not be multiple library tube containers in the system with the same name.
Reagent labels (indexes) must be unique.
Only controls are permitted as unindexed samples. All other unindexed samples and pools are not permitted.
For sample sheet generation constraints, refer to the Bcl2fastq2 Sample Sheet Generation section in Illumina Instrument Sample Sheets (NGS v5.17 & later).
Do not manually start the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step. This step is fully automated and the sequencing service may not update samples correctly if they have been manually started.
For the automated run to start successfully, the Validate Run Setup and Generate Sample Sheet button must be selected.
Not required for Illumina cloud hosted installations.
Run this script when the Sequencer API is first installed. If you run the script multiple times, the script reconfigures each setting to its default. The only exception is the signing key. For this setting, you are asked if you want a reset. If the reset is done, all previously issued tokens are no longer valid.
Do not add samples to the Ice Bucket or start the step. The integration starts the step automatically.
Create only one pool per step.
Validate Unique Indexes automation is not used. The Clarity LIMS configuration for pooling handles this functionality.
For accurate pipetting of each sample in a pool for sequencing, the Per Sample Volume (ul) value must be equal to or higher than the Minimum Per Sample Volume (ul). The default value (set at 5) can be edited.
The script definition portion of Validate Run Setup has been moved into the Validation Script custom field due to the 4000 character limit. If modification is required on Validate Run Setup script, perform the changes directly on the Validation Script custom field default value.
Create only one pool per step.
Validate Unique Indexes automation is not used. The Clarity LIMS configuration for pooling handles this functionality.
To ensure accurate pipetting of each sample in a pool for sequencing, the Per Sample Volume (ul) value must be equal to or higher than the Minimum Per Sample Volume (ul). The default value (set at 5) can be edited.
The script definition portion of Validate Run Setup has been moved into the Validation Script custom field due to the 4000 character limitation.
This step is fully automated. Do not add samples to the Ice Bucket or start the step manually. If steps are manually started, the sequencing service may not update the samples correctly.
Do not disable or modify this automation to ensure the Lane Number displays properly.
These global custom fields are configured on the Container entity, visible on each input, and must not be confused with per-lane metrics. All run metrics tracked in Clarity LIMS are overall metrics for the run. There are currently no per-lane metrics provided by NovaSeq 6000Dx Operating Software.
Configure the steps that are considered sequencing run steps in the integration.sequencer_api.v2.novaseq.sequenceStepNames property. The property is a list and each entry must be the exact name of a sequencing step, not the name of the underlying master step/process type. For more information, refer to the Properties section of Components Installed.
If no matching container is found, or if the samples in the container are incorrectly queued, an error is thrown and the step is not started. This validation is also done during the run recipe request immediately prior, so this error case should not be encountered.
The NovaSeq 6000Dx v1.2 configuration is delivered through the Illumina Preset Protocols (IPP) Package v2.9. IPP Package v2.9 requires installation of NGS Extensions Package v5.25.0 or later.
Field Name
Field Type
Options
Additional Options and Dropdown Items
Comment
Multiline Text
None
Flowcell Type
Text Dropdown
Required Field
Custom Entries
Presets
SP
S1
S2
S4
Instruction
Text
Read Only
Default
Add Flowcell Type, Loading Workflow Type, and NovaSeqDx Run Mode
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
Field Name
Field Type
Options
Additional Options and Dropdown Items
Adjusted Per Sample Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Final Loading Concentration (pM)
Numeric Dropdown
Required Field
Custom Entries
Presets
225
400
Decimal places displayed = 0
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Minimum Molarity (nM)
Numeric
Decimal places displayed = 2
Normalized Molarity (nM)
Numeric
Decimal places displayed = 2
NovaSeqDx Run Mode
Text Dropdown
Required Field
Presets
DX
RUO
Per Sample Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Warning
Text Dropdown
Read Only
Custom Entries
Presets
The Normalized Molarity (nM) is too low.
n/a
Field Name
Field Type
Options
Additional Options and Dropdown Items
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Field Name
Field Type
Options
Additional Options and Dropdown Items
RSB Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Field Name
Field Type
Options
Additional Options and Dropdown Items
DPX1 Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
DPX2 Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
DPX3 Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
Field Name
Field Type
Options
Additional Options and Dropdown Items
BP Aliquot Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Mastermix per Lane (ul)
Numeric
Read Only
Decimal places displayed = 0
NaOH Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Tris-HCl Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Field Name
Field Type
Options
Additional Options and Dropdown Items
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Field Name
Field Type
Options
Additional Options and Dropdown Items
Current Cycle
Numeric
Read Only
Decimal places displayed = 0
Current Read
Numeric
Read Only
Decimal places displayed = 0
Firmware Version
Text
Read Only
Flow Cell Expiration Date
Date
Read Only
Flow Cell ID
Text
Read Only
Flow Cell Lot Number
Text
Read Only
Flow Cell Mode
Text
Read Only
Flow Cell Part Number
Text
Read Only
Flow Cell Side
Text
Read Only
Instrument Control Software Version
Text
Read Only
Instrument ID
Text
Read Only
Instrument Type
Text
Read Only
Lane Counter
Numeric
Read Only
Default
1
Hidden
Loading Workflow Type
Text
Read Only
Output Folder
Text
Read Only
RTA Version
Text
Read Only
Run Completion Date
Text
Read Only
Hidden
Run ID
Text
Read Only
Run Status
Text
Read Only
Sequencing Log
Multiline Text
Read Only
Field Name
Field Type
Options
Additional Options and Dropdown Items
% Aligned R1
Numeric
Read Only
Decimal places displayed = 2
% Aligned R2
Numeric
Read Only
Decimal places displayed = 2
% Bases >=Q30 R1
Numeric
Read Only
Decimal places displayed = 2
% Bases >=Q30 R2
Numeric
Read Only
Decimal places displayed = 2
% Error Rate R1
Numeric
Read Only
Decimal places displayed = 2
% Error Rate R2
Numeric
Read Only
Decimal places displayed = 2
% Phasing R1
Numeric
Read Only
Decimal places displayed = 3
% Phasing R2
Numeric
Read Only
Decimal places displayed = 3
% Prephasing R1
Numeric
Read Only
Decimal places displayed = 3
% Prephasing R2
Numeric
Read Only
Decimal places displayed = 3
%PF R1
Numeric
Read Only
Decimal places displayed = 2
%PF R2
Numeric
Read Only
Decimal places displayed = 2
Cluster Density (K/mm^2) R1
Numeric
Read Only
Cluster Density (K/mm^2) R2
Numeric
Read Only
Intensity Cycle 1 R1
Numeric
Read Only
Intensity Cycle 1 R2
Numeric
Read Only
Reads PF (M) R1
Numeric
Read Only
Decimal places displayed = 2
Reads PF (M) R2
Numeric
Read Only
Decimal places displayed = 2
Yield PF (Gb) R1
Numeric
Read Only
Decimal places displayed = 2
Yield PF (Gb) R2
Numeric
Read Only
Decimal places displayed = 2
Files Installed
Location
Description
Illumina#Sequencer#v2.war
/opt/gls/clarity/tomcat/current/webapps
War file for Sequencer API.
configure_sequencer_api_application.sh
/opt/gls/clarity/config/
Script that configures the Sequencer API application through its external application.yml file.
configure_sequencer_api_env.sh
/opt/gls/clarity/config/
Script that configures the Clarity LIMS Tomcat configuration to include Secret Util settings.
configure_sequencer_api_proxy.sh
/opt/gls/clarity/config/
Script that configures the proxy to allow communication with the Sequencer API application.
sequencer-api.conf
/etc/httpd/clarity/
Proxy setting to communicate with Clarity LIMS.
run.autoComplete property value
run.autoCompleteOnlyAtSuccess property value
Outcome
true
true
Step automatically completes only if the sequencing run is successful.
If run is not successful, the step does not automatically complete, and the run details are recorded in Clarity LIMS.
true
false
Step automatically completes, regardless of the run status.
false
true
Step does not automatically complete.
Run details are recorded in Clarity LIMS.
false
false
Step does not automatically complete.
Run details are recorded in Clarity LIMS.
Field Name
Field Type
Options
Additional Options and Dropdown Items
% PhiX (2.5 nM) Spike-In
Numeric
Range = 0–100
Bulk Pool Volume (ul)
Numeric
Decimal places displayed = 2
Number of Flowcells to Sequence
Numeric
Required Field
Range = 1–10
Decimal places displayed = 0
Minimum Per Sample Volume (ul)
Numeric
Required Field
Decimal places displayed = 2
Default
5
Number of Samples in Pool
Numeric
Decimal places displayed = 0
Default
0
PhiX Volume (ul)
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
Numeric
Decimal places displayed = 2
Default
0
Field Name
Field Type
Options
Additional Options and Dropdown Items
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
NaOH Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
RSB Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Tris-HCl Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Volume of Pool to Denature (ul)
Numeric
Read Only
Decimal places displayed = 0
Field Name
Field Type
Options
Additional Options and Dropdown Items
Analysis Software Version
Text
BaseSpace Sequence Hub Configuration
Text Dropdown
Required Field
Presets
Not Used
Run Monitoring Only
Run Monitoring and Storage
Custom Recipe Path
Text
Experiment Name
Text
Required Field
Index Read 1
Numeric Dropdown
Required Field
Custom Entries
Range = 0–20
Decimal places displayed = 0
Presets
0
6
8
Index Read 2
Numeric Dropdown
Required Field
Custom Entries
Range = 0–20
Decimal places displayed = 0
Presets
0
6
8
Output Folder
Text
Required Field
Override Cycles
Text
Paired End
Text Dropdown
Required Field
Presets
True
False
Read 1 Cycle
Numeric Dropdown
Required Field
Custom Entries
Range = 1–251
Decimal places displayed = 0
Presets
251*
151
101
51
* Value of 251 is only supported for SP flow cell type. For all other cell types, maximum value is 151.
Read 2 Cycle
Numeric Dropdown
Required Field
Custom Entries
Range = 0–251
Decimal places displayed = 0
Presets
251*
151
101
51
* Value of 251 is only supported for SP flow cell type. For all other cell types, maximum value is 151.
Run Mode
Text Dropdown
Read Only
Presets
SP
S1
S2
S4
Use Custom Index Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 2 Primer
Toggle Switch
Default
None Set
Use Custom Recipe
Toggle Switch
Required Field
Default
No
Validation Script
Multiline Text
Required Field
Read Only
Default value is provided in the drop-down section that follows the table.
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Custom
Field Name
Field Type
Options
Additional Options and Dropdown Items
% PhiX (0.25nM) Spike-in
Numeric
Range = 0– 100
Bulk Pool Volume (ul)
Numeric
Decimal places displayed = 2
Minimum Per Sample Volume (ul)
Numeric
Required Field
Default
5
Decimal places displayed = 2
Number of Lanes to Sequence
Numeric
Required Field
Decimal places displayed = 0
Number of Samples in Pool
Numeric
Default
0
Decimal places displayed = 0
PhiX Volume (ul)
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
Numeric
Default
0
Decimal places displayed = 0
Field Name
Field Type
Options
Additional Options and Dropdown Items
Analysis Software Version
Text
BaseSpace Sequence Hub Configuration
Text Dropdown
Required Field
Presets
Not Used
Run Monitoring Only
Run Monitoring and Storage
Custom Recipe Path
Text
Experiment Name
Text
Required Field
Index Read 1
Numeric Dropdown
Required Field
Custom Entries
Presets
0
6
8
Range = 0–20
Decimal places displayed = 0
Index Read 2
Numeric Dropdown
Required Field
Custom Entries
Presets
0
6
8
Range = 0–20
Decimal places displayed = 0
Library Tube Barcode
Text
Required Field
Output Folder
Text
Required Field
Override Cycles
Text
Paired End
Text Dropdown
Required Field
Presets
True
False
Read 1 Cycles
Numeric Dropdown
Required Field
Custom Entries
Range = 1–251
Decimal places displayed = 0
Presets
251*
151
101
51
* Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151.
Read 2 Cycles
Numeric Dropdown
Required Field
Custom Entries
Range = 0–251
Decimal places displayed = 0
Presets
251*
151
101
51
* Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151.
Run Mode
Text Dropdown
Read Only
Presets
SP
S1
S2
S4
Use Custom Index Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 2 Primer
Toggle Switch
Default
None Set
Use Custom Recipe
Toggle Switch
Required Field
Default
No
Validation Script
Multiline Text
Required Field
Read Only
Default value provided in the drop-down section following the table.
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Custom
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
Used in Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step only. Displays on Record Details screen and in the generated CSV file.
Not displayed in user interface
Do not remove this field as it is used by Validate Run Setup and Generate Sample Sheet automation script.
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
Not displayed in user interface
Do not remove this field as it is used by Validate Run Setup and Generate Sample Sheet automation script.
