This section explains how to validate the installation of the Illumina NextSeq 1000/2000 Integration Package v2.5.0.
The validation process involves the following items:
Running samples through the Library Prep Validation v2.3.3 workflow.
The workflow contains a single-step protocol that models the library prep workflow required to produce libraries tagged with index sequences. At the end of the step, these libraries are routed to NextSeq 1000/2000 Sequencing v2.4 workflow.
Running the libraries through the NextSeq 1000/2000 Sequencing v2.4 workflow. This process validates the following information:
Successful sequential step advancement of samples in the following steps:
Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4)
Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4)
AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4)
Demultiplexing (NextSeq 1000/2000 Sequencing v2.4)
Automatic validation of run setup information before sample sheet generation or planned run creation.
Automated generation of a sample sheet. The sample sheet is used to start the sequencing run on NextSeq 1000/2000 Control Software (NCS) via Local run mode.
Automated creation of a planned run on Illumina Connected Analytics. The NextSeq 1000/2000 Control Software retrieves the planned run to start the run via Hybrid or Cloud run mode.
Automated tracking of the NextSeq 1000/2000 sequencing run and parsing of run statistics from BaseSpace Sequence Hub into Clarity LIMS using the integration service.
Automated tracking of the secondary analysis using DRAGEN (up to BCL Convert only).
Parsing of demultiplexing metrics from BaseSpace Sequence Hub into Clarity LIMS using the integration service.
Before running the validation steps below, these steps assume that the NextSeq 1000/2000 Integration Package v2.5.0 is installed, and that you have imported the default Clarity LIMS configuration.
For information on how the integration works, refer to NextSeq 1000/2000 Integration v2.5.0 Configuration.
The following steps set up Clarity LIMS in preparation for running samples through the Library Prep Validation v2.3.3 and NextSeq 1000/2000 Sequencing v2.4 workflows.
On the Configuration tab, under Workflows, activate both the Library Prep Validation v2.3.3 and NextSeq 1000/2000 Sequencing v2.4 workflows.
On the Projects and Samples screen, create a project and add samples to it.
Assign the samples to the Library Prep Validation v2.3.3 workflow.
Follow the steps in Library Prep Validation Protocol to run the Library Prep Validation workflow with the following:
Label Group = TruSeq HT Adapters v2 (D7-D5)
Sequencing Instrument = NextSeq 1000/2000
On exit from the step, the Routing Script automation is triggered. This automation assigns samples to the first step of the NextSeq 1000/2000 Sequencing v2.4 workflow, which is Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) step.
In Lab View, locate the NextSeq 1000/2000 Sequencing v2.4 protocol. The samples are queued for the Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) step.
Add the samples to the Ice Bucket and select View Ice Bucket.
On the Ice Bucket screen, select Begin Work.
On the Pooling screen, perform the following actions:
Create a pool by dragging samples into the Pool Creator.
Type a name for the pool or accept the default name (Pool #1).
Select Record Details.
On the Record Details screen, the Reagent Lot Tracking section tracks the Resuspension Buffer (RSB) lot information used in the step. To add and activate additional reagent lots, refer to Add and Configure Reagent Kits and Lots in the Clarity LIMS (Clarity & LabLink Reference Guide) documentation.
In the Reagent Lot Tracking section, select from the active lots displayed in the drop-down list.
The Step Details area contains two required fields:
Final Loading Concentration (pM) — The value entered in this field is the recommended final loading concentration specified in the NextSeq 1000/2000 Product Documentation. The value depends on the library type. The default drop-down list contains the values 650, 750, 1000, and 2000. A custom value is acceptable.
Final Loading Volume (ul) — The value in this field is the final loading volume of the pool into the reagent cartridge. The field is prepopulated with the configured default value, 24 µl, specified in the NextSeq 1000/2000 Product Documentation. The value is editable when more volume is necessary.
Select Calculate Volumes.
This selection triggers the Calculate Volumes automation. This automation calculates the volume required for each library to form a pool that has the concentration and volume specified in the step details fields.
The automation also generates the Calculation File (CSV) and attaches it to the step. This file contains volume information of each of the samples and RSB buffer to add to the pool. Select the file to download it, then open it in Excel.
In the Sample Details table, select the pool icon to view details on the pool composition.
Select Next Steps.
This selection triggers the Set Next Step automation, which sets the next step for samples to ADVANCE, advancing them to the next step in the protocol. The next step is Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4).
On the Assign Next Steps screen, the next step for samples is already set to the next step in the workflow. The next step is Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4).
Select Finish Step.
At the end of this step, the pool of samples automatically advances to Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4) step.
In Lab View, locate the NextSeq 1000/2000 Sequencing v2.4 protocol. The pool of samples is queued for the Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4) step.
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 checks that there is only one container input to the step.
On the Placement screen, perform the following actions:
Drag the pool into the NextSeq 1000/2000 Reagent Cartridge field in the Placed Samples area.
Scan or type the barcode of the reagent cartridge into the NextSeq 1000/2000 Reagent Cartridge field.
Select Record Details.
On exit of the Placement screen, the Validate Reagent Cartridge Barcode automation checks that the reagent cartridge barcode conforms to the barcode mask [A-Z]{2}[0-9]{7}-[A-Z0-9]{4}. If not, an error message displays.
On entry to the Record Details screen, the Retrieve Analysis Workflow Versions automation fetches the available analysis workflow versions from ICA. It then updates the preset values of both Local Analysis Workflow Versions & Cloud Analysis Workflow Versions field.
On the Record Details screen, the Reagent Lot Tracking section tracks the NextSeq 1000/2000 Reagent Cartridge lot information used in the step. Follow the steps in Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) step if you must add a lot.
In the Reagent Lot Tracking section, select from the active lots displayed in the drop-down list.
The fields displayed on the Record Details screen are used to create planned run and generate the sample sheet file.
Run Name — Enter the experiment name. Only alphanumeric characters, dashes, and underscores are permitted. Spaces are not permitted.
Instrument Type — Select from preset options (NextSeq 1000 or NextSeq 2000).
Run Mode — Select from preset options: Local, Hybrid, Cloud. For more information on the different run modes, refer to Run Mode Details.
Paired End — Select from preset options (True or False).
Read 1 Cycles — Select from preset options (301, 151, 101, 51) or type a custom value.
Read 2 Cycles — Select from preset options (301, 151, 101, 51) or type a custom value.
Index Reads — Select from preset options (No Index, Single Index, Dual Index).
Index Read 1 — Select from preset options (0, 6, 8) or type a custom value.
Index Read 2 — Select from preset options (0, 6, 8) or type a custom value.
Analysis Workflow — Read only. This field is set to GenerateFASTQ.
[Optional] Local Analysis Workflow Versions — Default is None. Only mandatory when Run Mode = Local/Hybrid and Analysis Workflow = GenerateFASTQ. Select according to the DRAGEN version installed on the instrument.
[Optional] Cloud Analysis Workflow Versions — Default is None. Only mandatory when Run Mode = Cloud and Analysis Workflow = GenerateFASTQ. Select the cloud DRAGEN version to be used.
FASTQ Compression Format:
If Run Mode = Local/Hybrid, Analysis Workflow = GenerateFASTQ, and Local Analysis Workflow Version >= 3.7.4, select gzip or DRAGEN.
If Run Mode = Cloud, Analysis Workflow = GenerateFASTQ, and Local Analysis Workflow Version >= 3.7.4, field is set to gzip automatically.
Otherwise, select None.
[Optional] Adapter Sequence Read 1 — Enter the Read 1 adapter sequence of the index adapter kit.
[Optional] Adapter Sequence Read 2 — Enter the Read 2 adapter sequence of the index adapter kit.
[Optional] Barcode Mismatches Index 1 — Select from preset options (0, 1, 2). Leave it blank if you are unsure.
[Optional] Barcode Mismatches Index 2 — Select from preset options (0, 1, 2). Leave it blank if you are unsure.
[Optional] Override Cycles — String used to specify UMI cycles and mask out cycles of a read (for example, N1Y150;I8;I7N1;Y141U10). Leave it blank if you are unsure.
Instructions — Read only.
On the Record Details screen, select Validate Run Setup and Create Planned Run.
This selection triggers the automation script, which does the following actions:
Validates the parameters entered on the Record Details screen.
If Run Mode is Hybrid or Cloud, create the planned run.
Generates the sample sheet and attaches it to the placeholder in the Files area of the Record Details screen for all Run Mode types.
Select Next Steps.
On the Assign Next Steps screen, the next step for samples is set to the next step in the workflow. The next step is AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4).
Select Finish Step.
At the end of this step, the pool of samples automatically advances to and is queued for the AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) step. The sequencing run is ready to be started. For details on how to start the sequencing run for different run modes, refer to NextSeq 1000/2000 Integration v2.5.0 Configuration.
This step is fully automated.
The integration starts the step automatically and data from the run is parsed back to Clarity LIMS. No user interaction is required. However, you can open and review the various stages of the step in Clarity LIMS. Do not perform any action when reviewing the data.
Read summary metrics are recorded for the library pool in the Step Details section and the Sample Details table.
Values are populated in the following master step fields:
Run Name
Current Read
Flow Cell ID
Reagent Cartridge Lot Number
Instrument ID
Run Status
Current Cycle
Flow Cell Lot Number
Instrument Platform
Instrument Control Software Version
Output Folder
Secondary Analysis Workflow
Reagent Cartridge ID
Instrument Type
RTA Version
Sequencing Log
The summary metrics (per run level) populate in the following global fields.
% Bases >=Q30 R1
% Bases >=Q30 R2
% Error Rate R1
% Error Rate R2
Yield (Gb) R1
Yield (Gb) R2
Reads PF R1
Reads PF R2
%PF R1
%PF R2
% Aligned R1
% Aligned R2
% Phasing R1
% Phasing R2
% Prephasing R1
% Prephasing R2
Intensity Cycle 1 R1
Intensity Cycle 1 R2
Cluster Density R1
Cluster Density R2
At the end of this step, the pool of samples automatically advances to (and queues for) the Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) step.
This step is semi-automated.
The integration starts the step automatically and demultiplexing data from the GenerateFASTQ secondary analysis is parsed back to Clarity LIMS. Review the data parsed and assign QC, depending on the criteria set, and complete the step.
In the Record Details screen, perform the following actions:
Review demultiplexing data.
Demultiplexing metrics are recorded for the library pool in the Sample Details table. Metrics include columns for # Reads, # Perfect Index Reads, and # One Mismatch Index Reads.
The following metric files generated by the DRAGEN onboard or Cloud analysis module are stored under the Files section as Run_Metrics.zip:
Adapter_Metrics.csv
Demultiplex_Stats.csv
Index_Hopping_Counts.csv
Quality_Metrics.csv
Top_Unknown_Barcodes.csv
The Analysis Status step field is updated with the analysis status.
Assign QC flags to all the individual sample. There are two ways of doing this step.
Manually assign QC flags through the QC column in Sample Details table.
Automatically assign QC flag by running Assign QC flags automation. This option is for scenarios where a huge number of libraries are involved.
In the Step Details section, the following step fields are visible. (N is the number of criteria. You can use one or more criteria.)
Criteria N - Source Data Field — Select from preset options (for example, # Reads).
Criteria N - Operator — Select from preset options (for example, >= (greater than or equal to)).
Criteria N - Threshold Value — Enter the desired threshold value.
After filling up the criteria fields, select Assign QC flags. This selection triggers the automation script, which loops through each library in the pool and apply QC flag base on the criteria set previously.
This automation also generates an AssignQC Result file under Files section.
Select Next Steps.
On the Assign Next Steps screen, the Next Step field for all samples is prepopulated with Mark protocol as complete.
Select Finish Step.
At this point, the whole NextSeq 1000/2000 Integration workflow is fully validated.
If an automation trigger does not appear to run its corresponding scripts, refer to Troubleshooting Automation in the Clarity LIMS (API & Database) documentation.
If the AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) step starts but does not finish, complete the following steps:
Log in to Clarity LIMS using the default user account and use one of the following methods to open the step in Clarity LIMS:
Method 1: In Lab View, find the step in the Recent Activities pane.
Method 2: Search for the step in Clarity LIMS using reagent cartridge barcode as the search term.
On the Record Details screen, locate the Sequencing Log field. The multiline text field contains logging information.
If you cannot reach the Record Details screen, or if the Sequencing Log field does not contain enough information to resolve the issue, contact the Clarity LIMS support team. Supply the relevant information from the troubleshooting steps already performed.
Use only alphanumeric, dash, and underscore characters in the submitted sample names. Failing to do so causes sample sheet validation failure in Load To Reagent Cartridge step.
Do not create more than one pool for this step. The Calculate Volumes automation in this step supports one pool only.
The NextSeq 1000/2000 Reagent Cartridge barcode should not be modified after a successful validation. Modifications can cause issues when Clarity LIMS tries to update the status and sample details of subsequent steps.
Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
The integration includes the following features:
Preconfigured NextSeq 1000/2000 Sequencing v2.4 workflow that maps to lab protocols and instrument runs.
The following preconfigured protocols:
Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4)
Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4)
AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4)
Demultiplexing (NextSeq 1000/2000 Sequencing v2.4)
Automatic validation of run setup information before sample sheet generation or planned run creation.
Automated generation of a sample sheet. The sample sheet is used to start the sequencing run on NextSeq 1000/2000 Control Software (NCS) via Local run mode.
Automated creation of a planned run. The NCS retrieves and starts the planned run via Hybrid or Cloud run mode.
Automated tracking of the NextSeq 1000/2000 sequencing run and parsing of run statistics from BaseSpace Sequence Hub into Clarity LIMS.
Automated tracking of the secondary DRAGEN analysis (up to BCL Convert only) and parsing of demultiplexing metrics from BaseSpace Sequence Hub into Clarity LIMS.
The following Cloud analysis supported applications:
BCL Convert v4.2.7 or earlier under BaseSpace Sequence Hub DRAGEN Analysis
BCL Convert v4.2.7 under ICA Workflow Session Tracking
Local analysis supported BCL Convert v4.2.7 and earlier.
[Optional] Preconfigured Library Prep Validation v2.3.3 workflow used for validation purposes only. The workflow contains a single-step protocol that models the library prep workflow required to produce libraries tagged with index sequences. At the end of the step, these libraries are routed to NextSeq 1000/2000 Sequencing v2.4 workflow. For more information, refer to NextSeq 1000/2000 Integration v2.5.0 User Interaction, Validation and Troubleshooting.
[Optional] An integration of Clarity LIMS Product Analytics (CLPA) that make Clarity LIMS data available to the ICA and CLPA. This integration also requires installation and configuration. For more information, refer to Clarity LIMS Product Analytics Integration v1.3.0 Configuration.
Last Updated: November 2024
Release Date: June 2024
Document Version: 2
These release notes describe the key changes to software components for the Clarity LIMS NextSeq 1000/2000 Integration Package v2.5.0.
Refer to Compatibility under Instruments & Integrations.
Updates the Demultiplexing step in NextSeq 1000/2000 Sequencing workflow with the following changes:
The Sample Details table displays the index sequence.
The Sample Details table only displays the following demultiplexing stats due to changes in Demultiplex_Stats.csv:
# Reads
# Perfect Index Reads
# One Mismatch Index Reads
The demultiplexing stats displayed are aggregated for multi-lane flow cells (for example, P3).
The following run metrics files are included in Run_Metrics.zip and attached to the step:
Adapter_Metrics.csv
Demultiplex_Stats.csv
Index_Hopping_Counts.csv
Quality_Metrics.csv
Top_Unknown_Barcodes.csv
Analysis Status is now visible on the step.
The integration service and integration-related properties have been moved from configuration files to database.
Supports DRAGEN BCL Convert v4.2.7 analysis, including:
Cloud BCL Convert v4.2.7 running under the ICA Workflow Session Tracking application
Local BCL Convert v4.2.7
Demultiplexing stats are now correctly displayed in the Sample Details table in Demultiplexing step when the same samples with different indexes are in the run. For multi-lane flow cells, the demultiplexing stats are aggregated.
The Validate Reagent Cartridge Barcode automation in the Load to Reagent Cartridge step now only accepts the [A-Z]{2}[0-9]{7}-[A-Z0-9]{4} barcode format.
Sequencing run error triggered by disk space full on instrument causes RunParameters.xml to be empty and the run event cannot be processed on Clarity LIMS. This error is unlikely to occur as pre-run checks on the instrument check for sufficient disk space before run is started.
Sample sheet and planned run generation will fail if any of the samples in the pools has been assigned QC flag in prior steps before entering the Load to Reagent Cartridge step.
NextSeq 1000/2000 Integration v2.5.0 supports future ICA services and includes new custom fields and modifications to existing automations. The integration package requires the NextSeq 1000/2000 Sequencing v2.4 workflow. You can install this workflow through the Illumina Preset Protocols (IPP). If you do not want to upgrade through the IPP, you can manually upgrade the workflow configuration.
To modify the existing NextSeq 1000/2000 Sequencing v2.3 workflow, you must make the following changes:
Add the Measurement global field.
Modify the Master Step field.
Modify the Demultiplexing (NextSeq 1000/2000 Sequencing v2.3) master and protocol steps.
Update the Validate Reagent Cartridge Barcode step automation.
When the /opt/gls/clarity/config/configure_nextseq1k2k.sh script is running as part of the installation and configuration process, do not use the default names for the automated sequencing and demultiplexing steps. Instead, use the names in the modified workflow.
To make modifications after configuration, use the omxProps-ConfigTool utility to update the following properties:
The Illumina NextSeq 1000/2000 Integration Package v2.5.0 supports the integration of Clarity LIMS to Illumina NextSeq 1000/2000 sequencing systems.
For instructions on validating and troubleshooting the NextSeq 1000/2000 Integration, refer to .
The configuration provided in this integration has been established to support NextSeq 1000/2000 lab processes. Any configuration changes to protocols or workflows — including renaming protocols, steps, and fields — could break the process.
The Illumina NextSeq 1000/2000 Integration Package v2.5.0 is compatible with Illumina cloud hosted deployments only.
This integration requires a Personal, Professional, or Enterprise BaseSpace Sequence Hub subscription.
It is assumed that samples entering the NextSeq 1000/2000 Sequencing v2.4 workflow have gone through library preparation and quantification processes. Before they are assigned to the workflow, samples have completed the following actions:
Samples have been accessioned into Clarity LIMS.
Samples have been run through QC and library prep.
Samples have the Molarity (nM) global field set to some value. The Calculate Volumes automation in the Library Pooling and Dilution step requires a value in the Molarity (nM) global field.
For more information on sample accessioning, refer to Sample Accessioning and Upload and Modify Samples in the Getting Started section of the .
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 .
The NextSeq 1000/2000 Integration Package v2.5.0 includes the following workflows:
NextSeq 1000/2000 Sequencing v2.4
[Optional] Library Prep Validation v2.3.3 (recommended for validation purposes)
The following protocols and steps are included in these workflows.
In this step, the addition of RSB dilutes pooled samples. Manually create a working pool based on the final loading concentration required.
¹ These automations are required for CLPA support only.
The following fields are defined on the Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) step.
Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) Master Step Field Configuration
The following table lists the global fields that are configured to display on the Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) step.
Library Pooling and Dilution (NextSeq 1000/2000 Sequencing v2.4) Global Field Configuration
In this step, scan the reagent cartridge barcode into Clarity LIMS, then manually place the working pool into the reagent cartridge for the NextSeq 1000/2000 run. This step validates the run setup and analysis information and generates the sample sheet file and/or creates a planned run depending on the Run Mode selected.
¹ These automations are required for CLPA support only.
² These automations are required for the NextSeq 1000/2000 Sequencing v2.4 workflows and contain additional logic needed for CLPA support. If you would like to remove CLPA support, contact Illumina Support.
There are 24 fields defined on the Load to Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4) step. These fields are required for sample sheet generation and planned run creation.
Load to Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4) Master Step Fields Configuration
This step is fully automated.
The integration starts and completes the step automatically. Data from the run is parsed back to Clarity LIMS. No user interaction is required. In this step, the pooled samples in the reagent cartridge are sequenced on the NextSeq 1000/2000 instrument.
¹ These automations are required for CLPA support only.
There following fields are defined on the AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) step. These fields are used to display the run status and sequencing run and analysis configuration parsed from the RunParameters.xml file of the sequencing run.
Run Parameters and Corresponding Clarity LIMS Step Fields
The following table shows how some of the step fields map to the fields on the RunParameters.xml file, and whether the field is visible on the Record Details screen.
Additional Master Step Fields and Values
The following table shows how the other step fields derive their values, and whether the step field is visible on the Record Details screen.
The following global fields are used to capture the run metrics in Clarity LIMS.
% Bases >=Q30 R1
% Bases >=Q30 R2
% Error Rate R1
% Error Rate R2
Yield (Gb) R1
Yield (Gb) R2
Reads PF R1
Reads PF R2
%PF R1
%PF R2
% Aligned R1
% Aligned R2
% Phasing R1
% Phasing R2
% Prephasing R1
% Prephasing R2
Intensity Cycle 1 R1
Intensity Cycle 1 R2
Cluster Density R1
Cluster Density R2
At the end of this step, the pool of samples is automatically advanced to (and queued for) the Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) step.
This step is a semi-automated step.
The integration starts the step automatically and demultiplexing data from the GenerateFASTQ secondary analysis is parsed back to Clarity LIMS. The lab scientist reviews the demultiplexing result parsed into Clarity LIMS, assigns QC flags, and completes the step.
¹ These automations are required for CLPA support only.
The following table lists the master step fields that are configured on the Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) master step.
Master Step Field Configuration for Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) Step
The following table lists the global fields that are configured on the Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) step. These fields are used to display the demultiplexing result metrics for individual library in the sample pool.
The demultiplexing statistics are aggregated for multi-lane flow cells. For each demultiplexing field (for example, # Reads) displayed in the Sample Details table for the multi-lane flow cell (for example, P3), the displayed value is the sum of the statistics across all lanes.
Global Field Configuration for Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) Step
On the Load To Reagent Cartridge (NextSeq 1000/2000 Sequencing v2.4) step, when the Validate Run Setup and Create Planned Run automation is triggered, the run and analysis parameters entered in the Run Details screen are used to create a planned run. Then, the run and analysis configuration is validated. If the validation fails, an error message is sent to Clarity LIMS. If the validation passes, the sample sheet is generated (and sent back to Clarity LIMS) and/or a planned run is created depending on the Run Mode selected.
Local run mode: Only the sample sheet is generated and stored on Clarity LIMS. The sample sheet contains all the run and analysis configuration required to start the run on the instrument.
Hybrid/Cloud run mode: A planned run is created. This planned run contains all the run and analysis configuration required to start the run on the instrument. The sample sheet is also generated and stored on Clarity LIMS for reference purposes.
If a planned run with the same sample and project name has been created previously, the original case with the previous sample name can be reflected in the sample sheet generated from the Validate Run Setup and Create Planned Run automation. To resolve this issue, change the sample or project name in Clarity LIMS and run the automation again.
After the sequencing run is started on the instrument, NextSeq 1000/2000 Control Software (NCS) notifies BaseSpace Sequence Hub that the sequencing run has started.
BaseSpace Sequence Hub then does the following actions:
Local run mode: Creates a run on the BaseSpace Sequence Hub database with the run configuration information received from NCS.
Hybrid/Cloud run mode: Creates a run on the BaseSpace Sequence Hub database by copying the run configuration information from the planned run using a special Cloud Run ID received from NCS.
After the run is created on BaseSpace Sequence Hub, a run update event message that carries the RunStarted equivalent message is created on BaseSpace Sequence Hub and delivered to Clarity LIMS SQS queue service. The message is captured and processed by the integration.
Based on the reagent cartridge barcode information in the event message (refer to the following example), the integration service looks in the queue of AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) step for a container with the same reagent cartridge barcode. When identified, the step is started automatically and the Run Status field on Record Details screen is updated to RunStarted. The integration service then updates all the other step fields (for example, Current Read, Output Folder) by parsing the details from the RunParameters.xml uploaded to BaseSpace Sequence Hub by NCS.
The NextSeq 1000/2000 Control Software (NCS) continues to notify BaseSpace Sequence Hub (BSSH) of any run status change throughout the course of the sequencing run. The run update event delivery process continues as described in the previous section.
The following table lists the run status details and how the integration service handles each status.
Configuring a run with the Proactive, Run Monitory and Storage option. Local runs are done in Local mode, and cloud or hybrid runs are done in Cloud or Hybrid mode.
Starting a local, cloud, or hybrid run.
Clarity LIMS requires unique library names when samples are re-queued to the workflow in the NextSeq 1000/2000 integration. Assign unique names to libraries after going through library preparation.
The following steps are used to configure the library preparation workflow correctly before routing the samples for re-queuing:
From Configuration, select the Lab Work tab.
Search for the library preparation workflow used for the re-queued samples.
In the Master Step of the library preparation workflow, modify the naming convention under Step Type to generate unique library names (for example, appending LIMS ID to the default naming convention, like OutputItemLIMSID).
Select Save.
The following sections describe the various components that are installed by default as part of this integration. These components include the following items:
Reagent categories/label groups
Reagent kits
Control types
Containers
Reagent Categories/Label Groups
TruSeq HT adapters v2 (D7-D5)
Reagent Kits
Resuspension Buffer (RSB)
NextSeq 1000/2000 reagent cartridge
Container Types
Tube
96-well plate
NextSeq 1000/2000 reagent cartridge
Control Types
PhiX v3
This integration supports the NextSeq 1000/2000 reagent cartridge with barcode provided in the format [A-Z]{2}[0-9]{7}-[A-Z0-9]{4} (for example, EC1234567-EC03).
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:
Which samples, and how many, can enter each step together.
Which samples, and how many, can be pooled together.
The NextSeq 1000/2000 reagent cartridge barcode must be unique. There should not be multiple NextSeq 1000/2000 reagent cartridge containers in the system with the same name.
Reagent labels (indexes) must be unique.
One library pool can only contain one library or control with no label (index).
Do not manually start or complete the AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) step. This step is a fully automated step, and the integration service does not update samples correctly if they have been manually started.
Do not manually start the Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) step. This step is semi-automated, and the integration service does not update the demultiplexing result correctly if they have been manually started.
For the automated run to start successfully, select Validate Run Setup and Create Planned Run in the Load to Reagent Cartridge step.
This integration moves the integration service and integration-related properties from the configuration files to the database.
Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
The Library Prep Validation v2.3.3 workflow allows for validation of the system after installation is complete. For details, refer to .
Create one pool per step. The Calculate Volumes automation supports one pool only.
Use alphanumeric, dash, or underscore characters only in the submitted sample names. Any other characters can cause sample sheet validation failure in the Load to Reagent Cartridge step. The NextSeq 1000/2000 Sequencing workflow handles these characters in the Load to Reagent Cartridge step by replacing them with an underscore in the submitted sample name. The Sample Details table in the Demultiplexing step reflects the modified submitted sample name.
The NextSeq 1000/2000 reagent cartridges support different read cycle numbers. Make sure that the read cycle values configured for the planned run are within the maximum allowable reads for the cartridge type.
Do not modify or disable the Retrieve Analysis Workflow Versions automation script. Modifying or disabling the script breaks the integration.
There is backend validation of the sample sheet content. This validation makes sure that the sample sheet is valid to set up a Local Mode run or is ready for DRAGEN applications. Refer to for submitted sample name character restrictions.
Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
Do not modify the master step field names. This action causes the integration to break.
¹ For information on how the integration works, refer to Run Status, Primary Metrics, and Analysis Results Parsing and Recording in .
Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
For details on how to start a run using different run modes, refer to .
Refer to the for the following information:
The before routing the samples through the library preparation workflow.
Information on installed workflows, protocols, steps, and automation points is provided in the Workflows, Protocols, and Steps section of .
The NextSeq 1000/2000 Reagent Cartridge barcode should not be modified after a successful validation. Modifications can cause issues when Clarity LIMS tries to update the status and sample details of subsequent steps.
Version
Changes
2
Updated Compatibility section to reference Compatibility matrix table.
1
Initial release.
Property
Description
integration.nextseq1k2k.v2.automatedStepNames
Comma-separated step names for the automated sequencing step
integration.nextseq1k2k.v2.analysisStepNames
Comma-separated step names for the demultiplexing step
Field Name | Field Type | Field Constraints/Options | Preset Values/Additional Options and Drop-down Items |
Final Loading Concentration (pM) | Numeric Dropdown |
|
|
RSB Volume (ul) | Numeric |
|
|
Master Step Field | RunParameters.xml Field | On Record Details Screen |
Current Cycle | Calculated based on CompletedCycles Field | Visible |
Current Read | Calculated based on CompletedCycles field against PlannedCycles | Visible |
Flow Cell ID | FlowCellSerialNumber | Visible |
Flow Cell Lot Number | FlowCellLotNumber | Visible |
Instrument Control Software Version | ApplicationVersion | Visible |
Instrument ID | InstrumentSerialNumber | Visible |
Output Folder | OutputFolder | Visible |
Reagent Cartridge ID | CartridgeSerialNumber | Visible |
Reagent Cartridge Lot Number | CartridgeLotNumber | Visible |
RTA Version | RtaVersion | Visible |
Run Name | ExperimentName | Visible |
Secondary Analysis Workflow | SecondaryAnalysisWorkflow | Visible |
Flow Cell Mode | FlowCellMode | Hidden |
Instrument Run ID | Derived from OutputFolder | Hidden |
Run End Time | RunEndTime | Hidden |
Run Start Time | RunStartTime | Hidden |
Secondary Analysis Mode | SecondaryAnalysisMode | Hidden |
Secondary Analysis Platform Version | SecondaryAnalysisPlatformVersion | Hidden |
SkipObdd | SkipObdd | Hidden |
Master Step Field | Description | On Record Details Screen |
Instrument Platform |
| Visible |
Instrument Type |
| Visible |
Run Status |
| Visible |
Sequencing Log |
| Visible |
BaseSpace Run ID |
| Hidden |
Field Name | Field Type | Field Constraints/Options |
Index Sequence | Text | Read Only |
# One Mismatch Index Reads | Numeric | Read Only |
# Perfect Index Reads | Numeric | Read Only |
# Reads | Numeric | Read Only |
Run Status | Shown in Step | Details |
RunStarted | AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) |
|
RunCompletedSuccessfully | AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) |
|
RunErroredOut | AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) |
|
RunAbortedByUser | AUTOMATED - Sequencing Run (NextSeq 1000/2000 Sequencing v2.4) |
|
AnalysisStarted | Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) |
|
AnalysisCompleted | Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) |
|
AnalysisFailed | Demultiplexing (NextSeq 1000/2000 Sequencing v2.4) |
|
Field Name | Field Type | Field Constraints/Options | Preset Values/Additional Options and Drop-down Items |
Final Loading Concentration (pM) | Numeric Dropdown |
| Presets
|
Final Loading Volume (ul) | Numeric |
| Default
|
Library Pool Volume (ul) | Numeric |
| Hidden |
RSB Volume for Pool (ul) | Numeric |
| Hidden |
Field Name | Field Type | Field Constraints/Options | Preset Values/Additional Options and Drop-down Items |
Run Name | Text |
|
Instrument Type | Text Dropdown |
| Presets
|
Run Mode | Text Dropdown |
| Presets
|
Paired End | Text Dropdown |
| Presets
|
Read 1 Cycles | Numeric Dropdown |
| Presets
|
Read 2 Cycles | Numeric Dropdown |
| Presets
|
Index Reads | Text Dropdown |
| Presets
|
Index Read 1 | Numeric Dropdown |
| Presets
|
Index Read 2 | Numeric Dropdown |
| Presets
|
Analysis Workflow | Text |
| Default
|
Adapter Sequence Read 1 | Text |
Adapter Sequence Read 2 | Text |
Barcode Mismatches Index 1 | Numeric Dropdown | Presets
|
Barcode Mismatches Index 2 | Numeric Dropdown | Presets
|
Override Cycles | Text |
Cloud Run ID | Text |
| Hidden |
Use Custom Index Read 1 Primer | Toggle Switch | Default
Hidden |
Use Custom Index Read 2 Primer | Toggle Switch | Default
Hidden |
Use Custom Read 1 Primer | Toggle Switch | Default
Hidden |
Use Custom Read 2 Primer | Toggle Switch | Default
Hidden Custom primer option is currently not supported. Do not enable as it will break the integration. |
Instructions | Multiline Text |
| Default
|
Local Analysis Workflow Versions | Text Dropdown | Default
|
Cloud Analysis Workflow Versions | Text Dropdown | Default
|
FASTQ Compression Format | Text Dropdown |
| Presets
Default
|
Field Name | Field Type | Field Constraints/Options | Preset Values/Additional Options and Drop-down Items |
Criteria 1 - Source Data Field | Text Dropdown | Custom Entries | Presets
|
Criteria 2 - Source Data Field | Text Dropdown | Custom Entries | Presets
|
Criteria 1 - Operator | Text Dropdown | Custom Entries | Presets
|
Criteria 2 - Operator | Text Dropdown | Custom Entries | Presets
|
Criteria 1 - Threshold Value | Numeric | Valid integer value |
Criteria 2 - Threshold Value | Numeric | Valid integer value |
Log | Multiline Text | Read Only |
Analysis Completed Tim | Text | Read Only | Hidden |
Analysis Started Time | Text | Read Only | Hidden |
Analysis Status | Text | Read Only |
BSSH Analysis ID | Text | Read Only | Hidden |
Reagent Cartridge ID | Text | Read Only | Hidden |
This field is used by the Calculate Volumes automation.</blockquote
This field is used by the Calculate Volumes automation.
Used in creating planned run.
Custom primer option is currently not supported. Do not enable as it will break the integration.
Custom primer option is currently not supported. Do not enable as it will break the integration.
Custom primer option is currently not supported. Do not enable as it will break the integration.
Used for parsing demultiplexing results
