Illumina NovaSeqDx Integration Package v1.2.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.2.0, refer to .
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.
Prerequisites and Assumptions
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 :
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 .
Workflows, Protocols, and Steps
The Illumina NovaSeq 6000Dx Integration Package v1.2.0 includes the following workflows:
NovaSeqDx v1.2
Library Prep Validation v2.3.1 (optional, but recommended for validation purposes)
The following describes the protocols and steps included in these workflows.
Library Prep Validation v2.3.1 Workflow
Protocol: Library Prep Validation v2.3.1
Purpose:
Included for validation purposes only, this protocol models the library prep steps required to advance samples to the Run Format (NovaSeqDx v1.2) protocol.
The protocol contains a single step - Library Prep Validation v2.3.1. After this step, a routing script sends the samples to the first step of the NovaSeqDx v1.2 workflow - Define Run Format (NovaSeqDx v1.2).
Steps:
Library Prep Validation v2.3.1
NovaSeqDx v1.2 Workflow
Protocol 1: Run Format (NovaSeqDx v1.2)
Purpose:
Allows for the assignment of per sample values for the following properties:
NovaSeqDx Run Mode: Select either RUO or DX.
Loading Workflow Type: Select either NovaSeq Standard or NovaSeq Xp.
Normalized Molarity (nM): Enter a value for each sample.
Flowcell Type: Select from options SP, S1, S2, or S4.
Final Loading Concentration (pM): Select from options 225 (PCR-free workflows) or 400 (Nano workflows), or enter a different value.
Compares the Normalized Molarity value of each sample with the Minimum Molarity value.
Validates user selection on NovaSeqDx Run Mode, Loading Workflow Type and Flowcell Type.
Routing script sends samples to the NovaSeqDx Standard or NovaSeqDx Xp protocol, according to the selected Loading Workflow Type.
Samples with Normalized Molarity less than Minimum Molarity are removed from the workflow.
Steps:
Define Run Format (NovaSeqDx v1.2)
Protocol 2: NovaSeqDx Standard (NovaSeqDx v1.2)
Purpose:
Samples are pooled and added to the library tube in preparation for the NovaSeq 6000Dx run. The run setup information is validated and a sample sheet is generated.
Routing script sends the library tube to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) protocol.
Steps:
Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2)
Dilute and Denature (NovaSeqDx v1.2)
Protocol 3: NovaSeqDx Xp (NovaSeqDx v1.2)
Purpose:
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 run setup information is validated and a sample sheet is generated.
Routing script sends flow cell to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) protocol.
Steps:
Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2)
Dilute, Denature & ExAmp (NovaSeqDx v1.2)
Load to Flowcell (NovaSeqDx v1.2)
Protocol 4: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)
Purpose:
All samples complete the workflow by going through this protocol.
This protocol contains one fully automated step.
âš Do not add samples to the Ice Bucket or start the step. The integration starts the step automatically.
Steps:
AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)
Validation Workflow
Protocol 1: Run Format (NovaSeqDx v1.2)
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).
Automatically triggered on exit of the Record Details screen, this automation completes the following actions:
Sets the next step for samples to REMOVE:
nextStep = ::REMOVE::
Checks NovaSeqDx Run Mode, Loading Workflow Type, and Flowcell Type. Only the NovaSeq Standard with the S2/S4 flow cell is supported for the NovaSeqDx Run Mode:
if (input.::NovaSeqDx Run Mode:: == ::DX::) {
if (input.::Loading Workflow Type:: == ::NovaSeq Xp::) {
fail(::Invalid option selected. NovaSeq Standard shall be selected for DX mode.::);
};
if (input.::Flowcell Type:: == ::SP:: || input.::Flowcell Type:: == ::S1::) {
fail(::Invalid option selected. Only S2 or S4 flowcell shall be selected for DX mode.::);
};
};
Calculates the Minimum Molarity with the following formula:
Checks Normalized Molarity value. For samples with no Normalized Molarity value (e.g., empty value, not including 0), generates an error message informing that the field cannot be empty:
if (!input.hasValue(::Normalized Molarity (nM)::)) {
fail(::The Normalized Molarity cannot be empty.::) ;
}
Compares the Normalized Molarity value of each sample with the Minimum Molarity value. If the Normalized Molarity value is lower than the Minimum Molarity value, this sets the Loading Workflow Type of the sample to [Remove from workflow]. The automation also records a message in the Warning field for the sample:
else if (input.::Normalized Molarity (nM):: < input.::Minimum Molarity (nM)::) {
input.::Warning:: = ::The Normalized Molarity is too low.::;
input.::Loading Workflow Type:: = ::[Remove from workflow]::;
} else {
input.::Warning:: = ::n/a::
}
At this point, the following options are available:
Correct the NovaSeqDx Run Mode and Normalized Molarity value on the Record Details screen. Edit the Loading Workflow Type field and set it to NovaSeq Standard or NovaSeq Xp, as applicable.
Complete the protocol without correcting the Normalized Molarity value. In this case, those samples are removed from the workflow.
Routing Script Automation
Automatically triggered on exit of the step, this automation invokes the changeWorkflow script, which routes step inputs appropriately.
Samples with Loading Workflow Type field value = NovaSeq Standard are routed to the NovaSeqDx v1.2 workflow. Then, the samples are queued for the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step.
Samples with Loading Workflow Type field value = NovaSeq Xp are routed to the NovaSeqDx v1.2 workflow. Then, the samples are queued for the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
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
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
Global Fields
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)
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
Protocol 2: NovaSeqDx Standard (NovaSeqDx v1.2)
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)
Step 1: Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2)
In this step, libraries are placed manually into a single pool. Resuspension buffer and reagents are added.
Create only one pool per step.
Step input: NTP (normalized libraries)
Step output: Bulk pool
Validate Unique Indexes automation is not used. The Clarity LIMS configuration for pooling handles this functionality.
Validate Single NovaSeqDx Run Mode Automation
The Validate Single NovaSeqDx Run Mode automation is triggered on entry of the step. The following automation checks that all input samples have the same NovaSeqDx Run Mode assigned:
âš 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.
Assuming the default Minimum Per Sample Volume (ul) value of 5, this automation completes the following steps for a given batch:
If the smallest Per Sample Volume (ul) value is less than 5, automatically assigns a value of 5 to the Adjusted Per Sample Volume (ul) field of the sample.
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.
Calculates the Total Sample Volume (ul) field value.
Sets the Volume of Pool to Denature (ul) value a calculates the NaOH Volume (ul) and Tris-HCl Volume (ul) values based on the Flowcell Type.
if ( input.::Flowcell Type:: == ::SP:: ) {
output.::Volume of Pool to Denature (ul):: = 100 ;
output.::NaOH Volume (ul):: = 25 ;
output.::Tris-HCl Volume (ul):: = 25
} ;
if ( input.::Flowcell Type:: == ::S1:: ) {
output.::Volume of Pool to Denature (ul):: = 100 ;
output.::NaOH Volume (ul):: = 25 ;
output.::Tris-HCl Volume (ul):: = 25
} ;
if ( input.::Flowcell Type:: == ::S2:: ) {
output.::Volume of Pool to Denature (ul):: = 150 ;
output.::NaOH Volume (ul):: = 37 ;
output.::Tris-HCl Volume (ul):: = 38
} ;
if ( input.::Flowcell Type:: == ::S4:: ) {
output.::Volume of Pool to Denature (ul):: = 310 ;
output.::NaOH Volume (ul):: = 77;
output.::Tris-HCl Volume (ul):: = 78
}
Uses the NovaSeq_Standard_Bulk_Pool1.csv, NovaSeq_Standard_Bulk_Pool2.csv, and NovaSeq_Standard_Bulk_Pool3.csv template files to generate a single CSV file containing information about the pool and the samples it contains. The generated file is available for download in the Files section of the Record Details milestone in the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step.
Resets the Total Sample Volume (ul) and Number of Samples in Pool field values so that the automation is idempotent.
step.::Number of Samples in Pool:: = step.::Number of Samples in Pool:: - 1;
step.::Total Sample Volume (ul):: = step.::Total Sample Volume (ul):: - input.::Adjusted Per Sample Volume (ul)::
Set Next Step Automation
Automatically triggered on exit of the Record Details screen, the following automation sets the next step for samples to ADVANCE, advancing them to the Dilute and Denature (NovaSeqDx v1.2) step in the protocol:
nextStep = ::ADVANCE::
The following automation copies the NovaSeqDx Run Mode values from the step inputs to the step outputs:
output.::NovaSeqDx Run Mode:: = input.::NovaSeqDx Run Mode::
Master Step Fields
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
Field Name
Field Type
Options
Additional Options and Dropdown Items
% PhiX (2.5 nM) Spike-In
Numeric
Range = 0–100
Bulk Pool Volume (ul)
ℹ For calculation purposes, not displayed
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
ℹ For calculation purposes, not displayed
Numeric
Decimal places displayed = 0
Default
0
PhiX Volume (ul)
ℹ For calculation purposes, not displayed
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
ℹ For calculation purposes, not displayed
Numeric
Decimal places displayed = 2
Default
0
Global Fields
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)
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)
ℹ Used in Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step only. Displays on Record Details screen and in the generated CSV file.
Numeric
Read Only
Decimal places displayed = 0
Step 2: Dilute and Denature (NovaSeqDx v1.2)
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
Validate Single Input Automation
Automatically triggered at the beginning of the step, this automation checks that there is only one container input to the step.
script:validateSampleCount -min 1 -max 1
Validate Library Tube Barcode Automation
Automatically triggered on exit of the Placement screen, this automation completes the following actions:
Validates the library tube barcode to ensure it conforms to the following barcode masks:
DX mode: DX[0-9]{7}-[A-Z]{3}
RUO mode: [A-Z]{2}[0-9]{7}-[A-Z]{3}
if ((input.::NovaSeqDx Run Mode:: == ::DX:: && !output.container.name.matches(::^DX[0-9]{7}-[A-Z]{3}$::)) || (input.::NovaSeqDx Run Mode:: == ::RUO:: && !output.container.name.matches(::[A-Z]{2}[0-9]{7}-[A-Z]{3}::))) {
fail(::Invalid Library Tube Barcode. Please verify and try again.::)
}
Copies Flowcell Type and Loading Workflow Type field values from step inputs to outputs:
Validate Run Setup and Generate Sample Sheet Automation
Triggered by a button on the Record Details screen, this automation completes the following actions:
ℹ 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.
Copies the Flowcell Type from the step input to the Run Mode field (hidden):
step.::Run Mode:: = input.::Flowcell Type::
Experiment Name only contains alphanumeric, dash, or underscore characters. Spaces are not permitted.
When Workflow Type = No Index, both Index Read 1 and Index Read 2 must be zero.
When Workflow Type = Single Index, Index Read 1 must be greater than zero, and Index Read 2 must be zero.
When Workflow Type = Dual Index, both Index Read 1 and Index Read 2 must be greater than zero.
if(!step.::Experiment Name::.matches(::[a-zA-Z0-9-_]+::)) {
fail(::Experiment Name contains prohibited characters. Allowed characters are: a-z, A-Z, 0-9, -, and _::)
};
if (step.::Workflow Type:: == ::No Index::) {
if (step.::Index Read 1:: != 0 || step.::Index Read 2:: != 0) {
fail(::Index Read 1 and Index Read 2 must be 0 if No Index is selected.::)
}
} else if (step.::Workflow Type:: == ::Single Index::) {
if (step.::Index Read 1:: == 0 || step.::Index Read 2:: != 0) {
fail(::Index Read 1 must be greater than 0 and Index Read 2 must be 0 if Single Index is selected.::)
}
} else {
if (step.::Index Read 1:: == 0 || step.::Index Read 2:: == 0) {
fail(::Index Read 1 and Index Read 2 must be greater than 0 if Dual Index is selected.::)
}
};
Checks the Paired End and Read 2 Cycles field values as follows.
If Paired End = True, both Read 1 Cycles and Read 2 Cycles must be greater than 0.
If Paired End = False, Read 2 Cycles must be zero.
if (step.::Paired End::.toBoolean()) {
if (step.::Read 1 Cycles:: == 0 || step.::Read 2 Cycles:: == 0) {
fail(::Read 1 Cycles and Read 2 Cycles must be greater than 0 if Paired End is True.::)
}
} else {
if (step.::Read 2 Cycles:: != 0) {
fail(::Read 2 Cycles must be 0 if Paired End is False.::)
}
};
Checks the Flowcell field value as follows.
If Flowcell Type value is not SP, checks that the values of Read 1 Cycles and Read 2 Cycles are each 151 or less. If the value is greater than 151, an error message is generated.
if (input.::Flowcell Type::!=::SP:: && step.::Read 1 Cycles:: > 151) {
fail(::Read 1 Cycles must not be larger than 151 if it is not SPrime Flowcell::)
};
if (input.::Flowcell Type::!=::SP:: && step.::Read 2 Cycles:: > 151) {
fail(::Read 2 Cycles must not be larger than 151 if it is not SPrime Flowcell::)
};
Validate Analysis Software Version to ensure it is a valid version string.
if (step.hasValue(::Analysis Software Version::) && !step.::Analysis Software Version::.matches(::^(\\d+)(\\.\\d+)*$::)) {
fail(::Analysis Software Version contains prohibited characters. Allowed characters are 0-9 and period. It shall start and end with numbers and separated by single period e.g. 3.8.4::)
};
Validate Override Cycles value to contain only Y, N, I, U, 0-9, and semicolon characters.
if (step.hasValue(::Override Cycles::) && !step.::Override Cycles::.matches(::[YNIU0-9;]+::)) {
fail(::Override Cycles ontains prohibited characters. Allowed characters are: Y, N, I, U, 0-9 and ;. Example: N1Y150;I8;I7N1;Y141U10.::)
};
Automatically triggered on exit of the step, this automation invokes the changeWorkflow script, which routes step outputs to the NovaSeqDx v1.2 workflow, and queues them for the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
The default automation command line is as follows.
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
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
ℹ Not displayed in user interface
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.
ℹ Do not remove this field as it is used by Validate Run Setup and Generate Sample Sheet automation script.
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Custom
Validation Script
step.::Run Mode:: = input.::Flowcell Type::; if (!step.::Experiment Name::.matches(::[a-zA-Z0-9-_]+::)) { fail(::Experiment Name contains prohibited characters. Allowed characters are: a-z, A-Z, 0-9, -, and _::) }; if (step.::Workflow Type:: == ::No Index::) { if (step.::Index Read 1:: != 0 || step.::Index Read 2:: != 0) { fail(::Index Read 1 and Index Read 2 must be 0 if No Index is selected.::) } } else if (step.::Workflow Type:: == ::Single Index::) { if (step.::Index Read 1:: == 0 || step.::Index Read 2:: != 0) { fail(::Index Read 1 must be greater than 0 and Index Read 2 must be 0 if Single Index is selected.::) } } else { if (step.::Index Read 1:: == 0 || step.::Index Read 2:: == 0) { fail(::Index Read 1 and Index Read 2 must be greater than 0 if Dual Index is selected.::) } }; if (step.::Paired End::.toBoolean()) { if (step.::Read 1 Cycles:: == 0 || step.::Read 2 Cycles:: == 0) { fail(::Read 1 Cycles and Read 2 Cycles must be greater than 0 if Paired End is True.::) } } else { if (step.::Read 2 Cycles:: != 0) { fail(::Read 2 Cycles must be 0 if Paired End is False.::) } }; if (input.::Flowcell Type:: != ::SP:: && step.::Read 1 Cycles:: > 151) { fail(::Read 1 Cycles must not be larger than 151 if it is not SPrime Flowcell::) }; if (input.::Flowcell Type:: != ::SP:: && step.::Read 2 Cycles:: > 151) { fail(::Read 2 Cycles must not be larger than 151 if it is not SPrime Flowcell::) }; if (step.hasValue(::Analysis Software Version::) && !step.::Analysis Software Version::.matches(::^(\\d+)(\\.\\d+)*$::)) { fail(::Analysis Software Version contains prohibited characters. Allowed characters are 0-9 and period. It shall start and end with numbers and separated by single period e.g. 3.8.4::) }; if (step.hasValue(::Override Cycles::) && !step.::Override Cycles::.matches(::[YNIU0-9;]+::)) { fail(::Override Cycles contains prohibited characters. Allowed characters are: Y, N, I, U, 0-9 and ;. Example: N1Y150;I8;I7N1;Y141U10.::) }; nextStep = ::REMOVE::
Global Fields
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)
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]
Protocol 3: NovaSeqDx Xp (NovaSeqDx v1.2)
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)
Step 1: Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2)
Manually place libraries into a pool.
Create only one pool per step.
Step input: NTP (normalized libraries)
Step output: Bulk pool
Validate Unique Indexes automation is not used. The Clarity LIMS configuration for pooling handles this functionality.
Validate Inputs Flowcell Type and Single Pool Automation
Automatically triggered on exit of the Pooling screen, this automation completes the following actions:
Checks that all samples in the pool have the same Flowcell Type assigned to them.
Checks that only one pool has been created.
Changes the value of error and logging messages to reference the type of pool passed as 'bulk' pool.
Triggered when the Calculate Volumes button is selected on the Record Details screen, this automation completes the following actions:
Calculates the number of samples in the pool:
step.::Number of Samples in Pool:: = step.::Number of Samples in Pool:: + 1
Sets the value of the Bulk Pool Volume (ul) and PhiX Volume (ul) field, based on the selected Flowcell Type:
step.::PhiX Volume (ul):: = !step.hasValue(::% PhiX (0.25nM) Spike-In::) ? 0 : step.::% PhiX (0.25nM) Spike-In::;
if (input.::Flowcell Type:: == ::SP::) {
step.::Bulk Pool Volume (ul):: = step.'Number of Lanes to Sequence' * 18;
step.::PhiX Volume (ul):: *= 0.7;
};
if (input.::Flowcell Type:: == ::S1::) {
step.::Bulk Pool Volume (ul):: = step.'Number of Lanes to Sequence' * 18;
step.::PhiX Volume (ul):: *= 0.7;
};
if (input.::Flowcell Type:: == ::S2::) {
step.::Bulk Pool Volume (ul):: = step.'Number of Lanes to Sequence' * 22;
step.::PhiX Volume (ul):: *= 0.8;
};
if (input.::Flowcell Type:: == ::S4::) {
step.::Bulk Pool Volume (ul):: = step.'Number of Lanes to Sequence' * 30;
step.::PhiX Volume (ul):: *= 1.1;
};
if (step.::PhiX Volume (ul):: == 0) {
step.::PhiX Volume (ul):: = ::::;
};
Calculates the Per Sample Volume (ul) to be added to the pool:
input.::Per Sample Volume (ul)::= (((input.::Final Loading Concentration (pM)::* 5/ 1000) / input.::Normalized Molarity (nM)::) * step.::Bulk Pool Volume (ul)::) / step.::Number of Samples in Pool::
âš 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.
Assuming the default Minimum Per Sample Volume (ul) value of 5, completes the following steps for a given batch:
If the smallest Per Sample Volume (ul) value is less than 5, automatically assigns a value of 5 to the sample Adjusted Per Sample Volume (ul) field.
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.
Calculates the Total Sample Volume (ul) field value:
Uses the NovaSeq_Xp_Bulk_Pool.csv and NovaSeq_Xp_Bulk_Pool2.csv template files to generate a single CSV file containing information about the bulk pool and the samples it contains. The generated file is available for download in the Files segment of the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
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
Field Name
Field Type
Options
Additional Options and Dropdown Items
% PhiX (0.25nM) Spike-in
Numeric
Range = 0– 100
Bulk Pool Volume (ul)
ℹ For calculation purposes, not displayed
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
ℹ For calculation purposes, not displayed
Numeric
Default
0
Decimal places displayed = 0
PhiX Volume (ul)
ℹ For calculation purposes, not displayed
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
ℹ For calculation purposes, not displayed
Numeric
Default
0
Decimal places displayed = 0
Global Fields
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)
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]
Step 2: Dilute, Denature & ExAmp (NovaSeqDx v1.2)
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)
Validate Inputs Flowcell Type Automation
Automatically triggered at the beginning of the step, this automation invokes the validate_flowcell_for_input_pools script. This script completes the following actions:
Checks the inputs to the step and validates that the Flowcell Type field is set to a valid value (SP, S1, S2, or S4). This automation also checks that all inputs have the same value for this field.
The container type selected matches the value in the Flowcell Type field.
Uses the NovaSeq_Xp_Working_Pool.csv and NovaSeq_Xp_Working_Pool2.csv template files to generate a single CSV file. This file contains information about the DPX volume and the volume of BP Aliquot, Mastermix, NaOH, and Tris-HCI to add per working pool. The generated file is available for download in the Files segment of the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step.
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
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
Global Fields
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)
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
Step 3: Load to Flowcell (NovaSeqDx v1.2)
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)
Validate Inputs and Selected Container Automation
Automatically triggered at the beginning of the step, this automation invokes the validate_flowcell_for_input_pools and validateSelectedContainer scripts. These scripts validate the step inputs and the container selected by the user, as follows.
Checks that the Flowcell Type field has been set to a valid value (SP, S1, S2, or S4) and that all inputs have the same value.
Checks that the number of outputs matches the number of lanes on the selected flow cell type. If validation fails, an error message informs that the number of working pools does not match the number of lanes available on the flow cell.
The following defines the number of samples allowed for different flow cell types:
SP: 2 working pools
S1: 2 working pools
S2: 2 working pools
S4: 4 working pools
Checks that the container type selected on entry to the Placement screen matches the value in the Flowcell Type field. If validation fails, an error message displays.
Validate Run Setup and Generate Sample Sheet Automation
ℹ The script definition portion of Validate Run Setup has been moved into the Validation Script custom field due to the 4000 character limitation.
If modification is required to the Validate Run Setup script, perform the changes directly on Validation Script custom field default value.
The script definition portion of Generate Sample Sheet is unchanged.
Automatically triggered by selecting a button on the Record Details screen, this automation:
Copies the Flowcell Type from the step input to the Run Mode field (hidden):
step.::Run Mode:: = input.::Flowcell Type::
Validates the parameters entered on the Record Details screen, which is used to set up the run and generate the sample sheet file.
Experiment Name only contains alphanumeric, dash, or underscore characters. Spaces are not permitted.
When Workflow Type = No Index, both Index Read 1 and Index Read 2 must be 0.
When Workflow Type = Single Index, Index Read 1 must be greater than 0 and Index Read 2 must be 0.
When Workflow Type = Dual Index, both Index Read 1 and Index Read 2 must be greater than 0.
if(!step.::Experiment Name::.matches(::[a-zA-Z0-9-_]+::)) {
fail(::Experiment Name contains prohibited characters. Allowed characters are: a-z, A-Z, 0-9, -, and _::)
};
if (step.::Workflow Type:: == ::No Index::) {
if (step.::Index Read 1:: != 0 || step.::Index Read 2:: != 0) {
fail(::Index Read 1 and Index Read 2 must be 0 if No Index is selected.::)
}
} else if (step.::Workflow Type:: == ::Single Index::) {
if (step.::Index Read 1:: == 0 || step.::Index Read 2:: != 0) {
fail(::Index Read 1 must be greater than 0 and Index Read 2 must be 0 if Single Index is selected.::)
}
} else {
if (step.::Index Read 1:: == 0 || step.::Index Read 2:: == 0) {
fail(::Index Read 1 and Index Read 2 must be greater than 0 if Dual Index is selected.::)
}
};
Checks the Paired End and Read 2 Cycles field values.
When Paired End = True, both Read 1 Cycles and Read 2 Cycles must be greater than 0.
When Paired End = False, Read 2 Cycles must be 0.
if (step.::Paired End::.toBoolean()) {
if (step.::Read 1 Cycles:: == 0 || step.::Read 2 Cycles:: == 0) {
fail(::Read 1 Cycles and Read 2 Cycles must be greater than 0 if Paired End is True.::)
}
} else {
if (step.::Read 2 Cycles:: != 0) {
fail(::Read 2 Cycles must be 0 if Paired End is False.::)
}
};
Checks the Flowcell field value.
If Flowcell Type value is not SP, checks that the value of both Read 1 Cycles and Read 2 Cycles is 151 or less. If the value is greater than 151, an error message displays.
if (input.::Flowcell Type::!=::SP:: && step.::Read 1 Cycles:: > 151) {
fail(::Read 1 Cycles must not be larger than 151 if it is not SPrime Flowcell::)
}
if (input.::Flowcell Type::!=::SP:: && step.::Read 2 Cycles:: > 151) {
fail(::Read 2 Cycles must not be larger than 151 if it is not SPrime Flowcell::)
}
Validate Analysis Software Version
if (step.hasValue(::Analysis Software Version::) && !step.::Analysis Software Version::.matches(::^(\\d+)(\\.\\d+)*$::)) {
fail(::Analysis Software Version contains prohibited characters. Allowed characters are 0-9 and period. It shall start and end with numbers and separated by single period e.g. 3.8.4::)
};
Checks Override Cycles field value. This field contains only Y, N, I, U, 0–9, and semicolon characters.
if (step.hasValue(::Override Cycles::) && !step.::Override Cycles::.matches(::[YNIU0-9;]+::)) {
fail(::Override Cycles contains prohibited characters. Allowed characters are: Y, N, I, U, 0-9 and ;. Example: N1Y150;I8;I7N1;Y141U10.::)
};
Sets the next step for samples to ADVANCE, advancing them to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
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
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
ℹ Not displayed in user interface
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.
ℹ Do not remove this field as it is used by Validate Run Setup and Generate Sample Sheet automation script.
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Custom
Validation Script
step.::Run Mode:: = input.::Flowcell Type::; if (!step.::Experiment Name::.matches(::[a-zA-Z0-9-_]+::)) { fail(::Experiment Name contains prohibited characters. Allowed characters are: a-z, A-Z, 0-9, -, and _::) }; if (step.::Workflow Type:: == ::No Index::) { if (step.::Index Read 1:: != 0 || step.::Index Read 2:: != 0) { fail(::Index Read 1 and Index Read 2 must be 0 if No Index is selected.::) } } else if (step.::Workflow Type:: == ::Single Index::) { if (step.::Index Read 1:: == 0 || step.::Index Read 2:: != 0) { fail(::Index Read 1 must be greater than 0 and Index Read 2 must be 0 if Single Index is selected.::) } } else { if (step.::Index Read 1:: == 0 || step.::Index Read 2:: == 0) { fail(::Index Read 1 and Index Read 2 must be greater than 0 if Dual Index is selected.::) } }; if (step.::Paired End::.toBoolean()) { if (step.::Read 1 Cycles:: == 0 || step.::Read 2 Cycles:: == 0) { fail(::Read 1 Cycles and Read 2 Cycles must be greater than 0 if Paired End is True.::) } } else { if (step.::Read 2 Cycles:: != 0) { fail(::Read 2 Cycles must be 0 if Paired End is False.::) }}; if (input.::Flowcell Type:: != ::SP:: && step.::Read 1 Cycles:: > 151) { fail(::Read 1 Cycles must not be larger than 151 if it is not SPrime Flowcell::) }; if (input.::Flowcell Type:: != ::SP:: && step.::Read 2 Cycles:: > 151) { fail(::Read 2 Cycles must not be larger than 151 if it is not SPrime Flowcell::) }; if (step.hasValue(::Analysis Software Version::) && !step.::Analysis Software Version::.matches(::^(\\d+)(\\.\\d+)*$::)) { fail(::Analysis Software Version contains prohibited characters. Allowed characters are 0-9 and period. It shall start and end with numbers and separated by single period e.g. 3.8.4::) }; if (step.hasValue(::Override Cycles::) && !step.::Override Cycles::.matches(::[YNIU0-9;]+::)) { fail(::Override Cycles contains prohibited characters. Allowed characters are: Y, N, I, U, 0-9 and ;. Example: N1Y150;I8;I7N1;Y141U10.::) }; step.::Settings Header:: = step.hasValue(::UMI - Read 1 Length::) || step.hasValue(::UMI - Read 2 Length::) ? ::[Settings]:: : ::::; nextStep = ::REMOVE::
Global Fields
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)
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]
Protocol 4: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)
This final protocol contains one fully automated step, AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
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.
Step 1: 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.
Set Next Steps Automation
If necessary, override the default next step behavior used by the Sequencer API by performing the following steps:
Enable the automation and use it to set custom next step behavior and generate a log file. By default, the automation sets the next step to ADVANCE and the samples complete the protocol.
Configure the automation to trigger automatically on exit of the Record Details screen.
Update Lane Number Automation
This automation triggers automatically upon entry to the Record Details screen.
ℹ Do not disable or modify this automation to ensure the Lane Number displays properly.
Master Step Fields
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
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
Global Fields
The following table shows the global custom fields that capture the run metrics in Clarity LIMS.
Custom Field Configuration
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
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.6 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).
ℹ 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.
Sample Sheet Generation
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.
Sample Sheet Content
The following step custom fields that display in the Step Details area of the Record Details screen control the sample sheet content:
Experiment Name
Read 1 Cycles
Read 2 Cycles
Index 1 Cycles
Index 2 Cycles
Analysis Software Version
Override Cycles
Sample sheet generation script parameters and usage
Sample sheet data and configuration options
Enabling unique FASTQ file names per sequencing run
NovaSeq 6000Dx Run
The following steps outline the sequence of events that occurs when a flow cell is loaded onto the NovaSeq 6000Dx instrument.
User Authentication and Login
User authentication and login to the NovaSeq 6000Dx instrument is achieved with the getSequencerLoginURL endpoint (/Illumina/Sequencer/v2/sequencing-run/login). This endpoint returns the URL that the instrument uses to get an access token.
The Sequencer API service provides the NovaSeq 6000Dx Operating Software (NVOS) with a URL for the Clarity LIMS login screen. The NVOS displays this screen to the user. Log in to authorize NVOS to use your account to access Clarity LIMS. This authorization is automatic.
Enter credentials:
Username and password are passed to the Clarity LIMS server to make sure that the access is valid.
The user is redirected to the Sequencer login page at /Illumina/Sequencer/v2/sequencer_login.
If authentication is successful, the screen displays a success message. The Clarity LIMS server provides the OAuth token and username by redirecting to /Illumina/Sequencer/v2/sequencer_login/Success. This redirect does not reload the page, but allows the NovaSeqDx to continue with run setup.
If authentication fails, the login screen does not change and a warning message displays. A background redirect to /Illumina/Sequencer/v2/sequencer_login/Error informs the NovaSeq 6000Dx of the failure.
Respond to Validation / Recipe Request Call from Instrument
The sequencing-run/recipe/NovaSeqDx endpoint consumes a POST request with a LibraryContainerId, FlowCellId, and reagents information.
LibraryContainerId, FlowCellId, and reagents are provided by the NovaSeq 6000Dx.
LibraryContainerId and FlowCellId can match either the library tube ID or flow cell ID of the corresponding containers in Clarity LIMS.
If there are no containers or multiple containers, an error is generated.
All populated containers whose name matches either the LibraryContainerId or FlowCellId are validated as follows.
All samples in the container must be queued for a sequencing run step.
All samples must be queued for only one sequencing run step.
All samples must be queued for the same sequencing run step.
After a single container has passed validation, the run setup information (run recipe request) is returned to the NVOS via the API. Then, the run receipt is generated.
Note the following details:
The run recipe information is read from fields configured on the parent process/master step of the samples in the container. The workflow must include recipe definition in that step.
By default, the parent process/master step is the Dilute and Denature (NovaSeqDx v1.2) or Load to Flowcell (NovaSeqDx v1.2) step, depending on workflow.
The default field values match the names of the fields in the NovaSeq 6000Dx v1.2 configuration included in IPP. The field names are configurable through the recipe.udfNames.* properties. Each property corresponds to an entry in the recipe. The value of a property defines the name of the field that is used to populate that entry in the recipe.
It is assumed that this parent process/master step removes any illegal characters from the Experiment Name field.
After the recipe is generated, it is returned as a *.json file in the response, in the form defined by the Swagger definition for the API.
Run Recipe Contents
The sample sheet contents and the fields configured on the Dilute and Denature (NovaSeqDx v1.2) and Load to Flowcell (NovaSeqDx v1.2) steps control the contents of the run recipe.
Respond to Sequencing Started Call from Instrument
Matching container for the run (library tube or flow cell) is found, and contents are validated to be queued for the correct step.
ℹ 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.
Reagent kits that are configured for the Sequencer API are checked against the configuration for the step to be run:
If a kit is configured for the API but does not exist in Clarity LIMS, it is created.
If a kit exists, but is not enabled on the step to be run, the step configuration is updated to enable it.
If a kit that is to be enabled is Archived, it is set to Active.
If a kit that is to be enabled is in Pending status, it is set to Active.
If any kits enabled on the step are not configured for the Sequencer API, a warning is logged, and the API cannot complete the step without user intervention.
If any kits provided in the recipe request are not configured for the Sequencer API, they are ignored, and a warning is logged during lot tracking.
The type of flow cell being used in the run determines the number of replicates for the step.
For Standard mode, this information is based on the number of lanes in the flow cell. This information is stored as part of the Sequencer API configuration.
For XP mode, there is always one replicate, because there is already one input tracked for each lane.
The automated sequencing step is started.
Reagent lots are attached to the step. The Flow Cell and Library Tube reagents in the request are ignored. Information from these reagents is tracked in Clarity LIMS as containers and custom fields.
Any other reagents in the request are handled as follows.
If the reagent is not configured to be tracked, a warning is logged, and the reagent is ignored.
You can look up existing reagent lots by kit name (determined by Sequencer API configuration), name (the serial number in the request), and lot number (the lot number in the request).
If one or more matching reagent lots exist in Clarity LIMS, the newest one is used.
If the expiry date does not match the expiry in the request, or if the status is not set to Active, the lot is updated to have the correct expiry date and an Active status.
Otherwise a new lot is created with the following configuration:
Reagent Kit — Matching kit as determined from Sequencer API configuration and step 2.
Name — Serial number in request.
Lot Number — Lot number in request.
Expiry — Expiry date in request.
Status — Active.
If any reagents are expected to be in the request but are not, these reagents are logged. This action prevents the step from being completed without user intervention.
Master step custom fields are updated with the run information parsed from the request. For more information, refer to Respond to Record InterOps Metrics Call from Instrument.
Any important events during this request are logged into the Sequencer API log file and in the Sequencing Log multiline global custom field on the step (assuming the step was started successfully). For more information, refer to Respond to Record InterOps Metrics Call from Instrument.
Respond to Record InterOps Metrics Call from Instrument
When the metrics endpoint receives a POST, it completes the following actions:
Looks for a matching library tube or flow cell in Clarity LIMS.
Finds the in-progress sequencing step for that container.
When the step is found, the run metrics in the request are written to container global custom fields in Clarity LIMS.
Respond to Sequencing Completed Call from Instrument
If the sequencing run is successful, after the metrics are recorded, the API call for Sequencing Completed is received. The Sequencing Container matches the Information, and the following occurs in Clarity LIMS:
The Current Cycle, Current Read, and Status master step custom fields are updated.
The multiline Sequencing Log master step field is updated.
A success message is recorded in the log file at the info level:
Sequencing run with Run ID {runId} of Step '{step.name}' ({step.limsid}) completed successfully.
Clarity LIMS waits for any automations that are triggered automatically as it advances the step.
By default, Clarity LIMS assigns the next steps on the outputs to move them on to the first configured next step. If there are no next steps, the protocol is completed.
Respond to Sequencing Errored Call from Instrument
If the sequencing run is unsuccessful, the API call for Sequencing Error is received. The Sequencing Container matches the Information, and the following occurs in Clarity LIMS:
The Current Cycle, Current Read, and Status master step custom fields are updated.
The multiline Sequencing Log master step field is updated.
A failure message is recorded in the log file at the error level:
Step '${Step.name}' (${Step.limsid}) failed with Run ID ${runId}.
The step is left at the Record Details screen.
Respond to Sequencing RunEndedByUser Call from Sequencer
If the user ends a sequencing run, the API call for Sequencing RunEndedByUser is received. The Sequencing Container matches the Information, and the following occurs in Clarity LIMS:
The Current Cycle, Current Read, and Status master fields are updated.
The multiline Sequencing Log master step field is updated.
The following message is recorded in the log file, at the warning level:
"Sequencing run with Run ID ${status.runInfo.runId} of Step '${step.configuration.name}' (${step.limsid}) aborted by user ${status.runInfo.userName}."
The step is left at the Record Details screen.
Components Installed
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.2.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
The NovaSeq 6000Dx v1.2.0 configuration is delivered through the Illumina Preset Protocols (IPP) Package v2.6. IPP Package v2.6 requires installation of NGS Extensions Package v5.23.0 or later.
If NGS Extensions Package v5.23.0 or later is already installed, upgrade is not forced or required.
NovaSeq 6000Dx Integration RPM Components
The following table lists the components installed by the RPM package.
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.
application.yml Properties
The application.yml file is at opt/gls/clarity/extensions/sequencer-api/.
All properties are configured automatically during installation. You can also configure properties after installation, by editing the application.yml file. If you make changes to the file, you must restart Tomcat.
File properties represent all custom field names, both for recipe and run information.
For all custom fields, the names (values in this file) can be changed. However, the property names cannot be changed, removed, or added to. For example, the Loading Workflow Type can be changed, but recipe.udfNames.sampleLoadingType cannot.
application.yml Properties Installed
Property
Description
Default Value
spring.profiles.active
Tells the application that it is running deployed in Tomcat.
tomcat
âš Do not change
clarity.url
Base URL that the Sequencer API service uses to contact the Clarity LIMS. The installation script (configure_sequencer_api_application) prompts for this property.
clarity.username
Username to be used when communicating with Clarity LIMS.
security.signing-key
Private key that is used when signing/validating OAuth tokens. Changing this key invalidates any issued tokens.
security.token-expiry
Specifies (in hours) the expiry period for login tokens issued by the Sequencer API.
88
novaseq.sequenceStepNames
List of NovaSeq 6000Dx sequencing run step names for which the integration can find samples queued.
Names must be an exact match to the name of the step in Clarity LIMS (not the master step/process type).
Each line must be indented to the same point and start with a dash (-).
- "AUTOMATED - NovaSeq Run (NovaSeq 6000 v3.8)"
- "AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)"
novaseq.flowcells
List of supported NovaSeq 6000Dx flow cell types.
Type names exactly match the values used by the NVOS run status requests.
To add more types, provide both type and lanes properties, indented to the same point and starting with a dash (-).
- type: "SP"
lanes: 2
- type: "S1"
lanes: 2
- type: "S2"
lanes: 2
- type: "S4"
lanes: 4
novaseq.reagents
List of supported reagent kits to be tracked on sequencing steps.
lotName — The name of the lot as it appears in the run started request.
kitName — The name of the corresponding reagent kit in Clarity LIMS that the lot is tracked as.
To add more types, provide both type and lanes properties, indented to the same point and starting with a dash (-).
ℹ The name can differ in the NVOS request versus the Clarity LIMS configuration.
- lotName: "Buffer"
kitName: "Buffer Cartridge"
- lotName: "Cluster"
kitName: "Cluster Cartridge"
- lotName: "SBS"
kitName: "SBS Cartridge"
recipe.udfNames
Each value must be enclosed in quotes (e.g., recipe.udfNames.runMode "Run Mode").
Value provided for sampleLoadingType must match the value provided in the run configuration (e.g., recipe.udfNames.sampleLoadingType "Loading Workflow Type").
Configures the name of the sample sheet file placeholder on the step where run recipe information is populated, and the property value to use when the file is not found.
run.stepUdfNames
Each value must be enclosed in quotes (e.g., run.stepUdfNames.runID "Run ID")
Value provided for sampleLoadingType must match the value provided in the run configuration (e.g., run.stepUdfNames.sampleLoadingType "Loading Workflow Type"). It is expected that the run step field and the field on the input derived sample share a name.
run.metricUdfNames
run.autoComplete
true
run.autoCompleteOnlyAtSuccess
Determines which of the following options are applicable to the sequencing run step:
Autocompleted when the run status is RunCompletedSuccessfully (if autoCompleteOnlyAtSuccess is true).
Autocompleted regardless of the run status (if autoCompleteOnlyAtSuccess is false).
true
Reagent Categories/Label Groups
TruSeq HT Adapters v2 (D7-D5)
Reagent Kits
Buffer Cartridge
Cluster Cartridge
DPX1
DPX2
DPX3
NaOH
Resuspension Buffer (RSB)
SBS Cartridge
Tris-HCl
Container Types
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
NVOS Configuration
For details on configuring the NovaSeq 6000Dx Operating Software (NVOS) for integration with Clarity LIMS, contact the Clarity LIMS Support team.
Routing Script Requirements
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.
Configure autoComplete Properties
The application.yml configuration file contains the following properties:
run.autoCompleteOnlyAtSuccess
run.autoComplete
These 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.
Enable/Disable autoComplete Properties
Open the application.yml file at /opt/gls/clarity/extensions/sequencer-api/application.yml:
vi /opt/gls/clarity/extensions/sequencer-api/application.yml
Edit the value of the autoCompleteOnlyAtSuccess property as required.
Save the file.
autoComplete Properties
The following table shows how the combined value of the run.autoComplete and run.autoCompleteOnlyAtSuccess properties affects the autoComplete behavior of the sequencing step.
run.autoComplete and run.autoCompleteOnlyAtSuccess Value Matrix
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.
Rules and Constraints
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.
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.
The Library Prep Validation v2.3.1 workflow allows for validation of the system after installation is complete. For details, refer to .
Validates the parameters entered on the Record Details screen, which is used to set up the run and generate the sample sheet file. The parameters are as follows. For more information, refer to the Respond to Validation / Recipe Request Call from Instrument section of .
Generates the V2 sample sheet and attaches it to the step. For more information, refer to .
Generates the sample sheet and attaches it to the step. For more information, refer to .
Disable or configure auto-complete behavior by setting the values of the run.autoComplete and autoCompleteOnlyAtSuccess properties. For details, refer to .
If field names are changed in Clarity LIMS, they must also be changed through the run.metricUdfNames properties file in the application.yml file for the Sequencer API. 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 application.yml Properties section of .
For detailed information on the following items, refer to the bcl2fastq2 Sample Sheet Generation section of .
By default, the Sequencer API service tries to contact Clarity LIMS at http://localhost:9080/clarity/. The installation script sets the URL, but it can be configured with the clarity.url property in the application.yml file. For more information, refer to the application.yml Properties section of .
ℹ Configure the steps that are considered sequencing run steps in the novaseq.sequenceStepNames property in the application.yml file. 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 application.yml Properties section of .
The Clarity LIMS download link to the sample sheet created on the run setup step is used for the SampleSheet value in the recipe. The name of the output of the sample sheet on the setup step is configured through the recipe.sampleSheet.outputName property (Sample Sheet by default) in the application.yml file. If no matching output is found, or no file was attached to the output, the value of the recipe.sampleSheet.notAvailableValue property (Not Available by default) is used in the recipe. For more information, refer to the application.yml Properties section of .
If the NGS Extensions Package is not already installed, or if a version earlier than v5.23.0 is installed, the latest version is installed by default with the NovaSeq 6000Dx integration. For details, refer to .
Configures the names of the fields used in the run recipe. For more information, refer to the Run Recipe Contents section of .
Configures the master step field names to be used when recording run results. For more information, refer to the Master Step Fields section of Step 1: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) in .
Configures the result file custom fields/measurement global field names to be used when recording run results. These fields capture the run data. For more information, refer to the Global Fields section of Step 1: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) in .
Determines whether the sequencing run step is completed automatically after parsing the run metrics on a run (refer to run.autoCompleteOnlyAtSuccess). For more information, refer to the section.
For more information, refer to .
For sample sheet generation constraints, refer to the Bcl2fastq2 Sample Sheet Generation section in .
