Configuration
The Illumina NextSeq 1000/2000 On-Prem Integration Package v1.0.0 supports the on-premise integration of Clarity LIMS to Illumina NextSeq 1000/2000 sequencing systems.
For instructions on validating and troubleshooting the NextSeq 1000/2000 Integration, refer to NextSeq 1000/2000 On-Prem Integration v1.0.0 User Interaction, Validation and Troubleshooting.
⚠️ 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.
ℹ️ When the Library Prep Validation v2.3.3 workflow is imported, it includes the Illumina Universal Sample Identifier global field. This field is a text field that is reserved for CLPA support and is optional. The value of this field is not required for this integration.
Prerequisites and Assumptions
It is assumed that samples entering the NextSeq 1000/2000 On-Prem Sequencing v1.0 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 Clarity LIMS (Clarity & LabLink Reference Guide) documentation.
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.
Workflows, Protocols, and Steps
The NextSeq 1000/2000 On-Prem Integration Package v1.0.0 includes the following workflows:
NextSeq 1000/2000 On-Prem Sequencing v1.0
[Optional] Library Prep Validation v2.3.3 (recommended for validation purposes)
The following protocols and steps are included in these workflows.
Library Prep Validation v2.3.3 Workflow
NextSeq 1000/2000 On-Prem Sequencing v1.0 Workflow
Validation Workflow
The Library Prep Validation v2.3.3 workflow allows for validation of the system after installation is complete. For details, refer to NextSeq 1000/2000 On-Prem Integration v1.0.0 User Interaction, Validation and Troubleshooting.
Step 1: Library Pooling and Dilution (NextSeq 1000/2000 On-Prem Sequencing v1.0)
In this step, the addition of RSB dilutes pooled samples. Manually create a working pool based on the final loading concentration required.
⚠️ Create one pool per step. The Calculate Volumes automation supports one pool only.
Master Step Fields
The following fields are defined on the Library Pooling and Dilution (NextSeq 1000/2000 On-Prem Sequencing v1.0) step.
Library Pooling and Dilution (NextSeq 1000/2000 On-Prem Sequencing v1.0) Master Step Field Configuration
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 |
Global Fields
The following table lists the global fields that are configured to display on the Library Pooling and Dilution (NextSeq 1000/2000 On-Prem Sequencing v1.0) step.
Library Pooling and Dilution (NextSeq 1000/2000 On-Prem Sequencing v1.0) Global Field Configuration
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 |
|
|
Step 2: Load to Reagent Cartridge (NextSeq 1000/2000 On-Prem Sequencing v1.0)
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.
ℹ️ The NextSeq 1000/2000 reagent cartridges support different read cycle numbers. Make sure that the read cycle values configured are within the maximum allowable reads for the cartridge type.
Master Step Fields
The following fields defined on the Load to Reagent Cartridge (NextSeq 1000/2000 On-Prem Sequencing v1.0) step are required for sample sheet generation.
Load to Reagent Cartridge (NextSeq 1000/2000 On-Prem Sequencing v1.0) Master Step Fields Configuration
Field Name | Field Type | Field Constraints/Options | Preset Values/Additional Options and Drop-down Items |
Run Name | Text |
| |
Instrument Type | Text Dropdown |
|
|
Run Mode | Text |
|
|
Paired End | Text Dropdown |
|
|
Read 1 Cycles | Numeric Dropdown |
|
|
Read 2 Cycles | Numeric Dropdown |
|
|
Index Reads | Text Dropdown |
|
|
Index Read 1 | Numeric Dropdown |
|
|
Index Read 2 | Numeric Dropdown |
|
|
Analysis Workflow | Text |
|
|
Adapter Sequence Read 1 | Text | ||
Adapter Sequence Read 2 | Text | ||
Barcode Mismatches Index 1 | Numeric Dropdown |
| |
Barcode Mismatches Index 2 | Numeric Dropdown |
| |
Override Cycles | Text | ||
Local Analysis Workflow Versions | Text |
| |
FASTQ Compression Format | Text Dropdown |
|
|
Step 3: AUTOMATED - Sequencing Run (NextSeq 1000/2000 On-Prem Sequencing v1.0)
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.
⚠️ Do not add samples to the Ice Bucket or start or complete the step. The integration completes these actions automatically.
Master Step Fields
The following fields are defined on the AUTOMATED - Sequencing Run (NextSeq 1000/2000 On-Prem Sequencing v1.0) 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.
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 |
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.
Master Step Field | RunParameters.xml Field | On Record Details Screen |
Instrument Platform |
| Visible |
Instrument Type |
| Visible |
Run Status |
| Visible |
Sequencing Log |
| Visible |
Global Fields
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 On-Prem Sequencing v1.0) step.
Step 4: Demultiplexing (NextSeq 1000/2000 On-Prem Sequencing v1.0)
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.
⚠️ Do not add samples to the Ice Bucket or start the AUTOMATED - Sequencing Run (NextSeq 1000/2000 On-Prem Sequencing v1.0) step. The integration completes these actions automatically.
Master Step Fields
The following fields are configured on the Demultiplexing (NextSeq 1000/2000 On-Prem Sequencing v1.0) master step.
Master Step Field Configuration for Demultiplexing (NextSeq 1000/2000 On-Prem Sequencing v1.0) Step
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 Status | Text | Read Only | |
Reagent Cartridge ID | Text | Read Only | Hidden |
Global Fields
The following table lists the global fields that are configured on the Demultiplexing (NextSeq 1000/2000 On-Prem Sequencing v1.0) step. These fields are used to display the demultiplexing result metrics for individual library in the sample pool.
Global Field Configuration for Demultiplexing (NextSeq 1000/2000 On-Prem Sequencing v1.0) Step
Field Name | Field Type | Field Constraints/Options |
# One Mismatch Index Reads | Numeric | Read Only |
# Perfect Index Reads | Numeric | Read Only |
# Reads | Numeric | Read Only |
How the NextSeq 1000/2000 On-Premise Integration Works
The following diagram shows how the integration works between the NextSeq 1000/2000 and Clarity LIMS.
Sample Sheet Generation
On the Load To Reagent Cartridge (NextSeq 1000/2000 On-Prem Sequencing v1.0) step, the run and analysis parameters entered in the Run Details screen are validated using the scripts in this step. This validation occurs when the Validate Run Setup and Create Sample Sheet automation is triggered. If the validation passes, Clarity LIMS generates the sample sheet using the driver file generator. The sample sheet contains all the run and analysis configuration required to start the run on the instrument.
For more information on how to start a local run, refer to instructions for initiating a sequence run in the NextSeq 1000/2000 Product Documentation.
Run Status, Primary Metrics, and Analysis Results Parsing and Recording
After the sequencing run is started on the instrument, the instrument generates the files as the sequencing and analysis run progresses. The integration monitors these files to track the run.
The following table shows the run statuses and how the integration service handles them.
Run Status
Status | Description |
|
|
|
|
The integration immediately starts the Demultiplexing (NextSeq 1000/2000 On-Prem Sequencing v1.0) step after completing the AUTOMATED - Sequencing Run (NextSeq 1000/2000 On-Prem Sequencing v1.0) step. In the Demultiplexing step, the integration does the following actions:
Searches for the CopyComplete.txt file produced by the instrument as a sign that the analysis is complete.
After analysis is completed, the integration downloads the Demultiplex_Stats.csv file that contains the demultiplexing results. Then, the integration zips the run metric files (Adapter_Metrics.csv, Demultiplex_Stats.csv, Index_Hopping_Counts.csv, Quality_Metrics.csv, and Top_Unknown_Barcodes.csv) and attaches the Run_Metrics.zip file to the step. After detecting the Demultiplex_Stats.csv file, the Analysis Status field is updated to Completed. Otherwise, this field is set to Failed to signal that the BCL Convert analysis has failed.
The Demultiplex_Stats.csv file is parsed and details are recorded in the Sample Details table for each library in the library pool. For multi-lane flow cells, the demultiplex details (for example, number of reads) are aggregated as a sum.
Updates the Multiline Sequencing Log field.
The integration does not automatically complete the step. You must assign the QC flag to the individual library before manually completing the step.
Start A Sequencing Run On Instrument
For more information on how to start a local run, refer to instructions for initiating a standard SBS or XLEAP-SBS sequencing run in the NextSeq 1000/2000 Product Documentation.
Enabling Planned Run Generation for Samples Having Duplicate Name with Different Indexes
The library preparation workflow of the samples must be configured to ensure unique derived sample names before routing the samples through the library preparation workflow.
Components Installed
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
Information on installed workflows, protocols, steps, and automation points is provided in the Workflows, Protocols, and Steps section of NextSeq 1000/2000 On-Prem Integration v1.0.0 User Interacion, Validation and Troubleshooting.
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).
Rules and Constraints
⚠️ The NextSeq 1000/2000 Reagent Cartridge barcode must 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.
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 must 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 On-Prem Sequencing v1.0) 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 On-Prem Sequencing v1.0) step. This step is semi-automated, and the SIS integration service does not update the demultiplexing results correctly if they have been manually started.
Last updated