The Illumina NovaSeq 6000 Integration Package v2.5.0 supports the integration of Clarity LIMS to NovaSeq 6000 instruments.
This document describes the integration and includes information about the preconfigured protocols, steps, automations, installed components, configuration requirements, rules, and constraints.
⚠️ The configuration provided in this integration has been established to support NovaSeq 6000 lab processes. Any configuration changes to protocols or workflows—including renaming protocols, steps, and fields—could break the process.
Prerequisites and Assumptions
It is assumed that samples enter the NovaSeq 6000 v2.3 workflow as normalized libraries. That is, before they are assigned to the workflow the following actions occur:
Samples have been accessioned into 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).
Included for validation purposes only, this protocol models the library prep steps required to advance samples to the Run Format (NovaSeq 6000 v2.3) protocol.
The protocol contains a single step: NovaSeq Validation Library Prep (NovaSeq 6000 v2.3). At the end of this step, a routing script sends the samples to the first step of the NovaSeq 6000 v2.3 workflow, which is Define Run Format (NovaSeq 6000 v2.3).
Allows for the assignment of per sample values for Loading Workflow Type, Normalized Molarity, Flowcell Type, and Final Loading Concentration (pM).
Loading Workflow Type: Select from NovaSeq Standard or NovaSeq Xp.
Normalized Molarity: Enter a value for each sample.
Flowcell Type: Select from options S1, S2, S4, and SP.
Final Loading Concentration (pM): Select from the options 225 (PCR-free workflows) or 400 (Nano workflows). Alternatively, enter a different value.
Compares the Normalized Molarity value of each sample with the Minimum Molarity value.
Routing script sends samples to the NovaSeq Standard or NovaSeq 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 (NovaSeq 6000 v2.3)
Protocol 2: NovaSeq Standard (NovaSeq 6000 v2.3)
Purpose:
Samples are pooled and added to the library tube in preparation for the NovaSeq run. Sample sheet and run recipe files are generated.
Routing script sends library tube to the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) protocol.
Steps:
Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3)
Dilute and Denature (NovaSeq 6000 v2.3)
Protocol 3: NovaSeq Xp (NovaSeq 6000 v2.3)
Purpose:
Samples are pooled and added to lanes on the NovaSeq flow cell. The flow cell type is determined by the option selected in the Define Run Format (NovaSeq 6000 v2.3) step. Sample sheet and run recipe files are generated.
Samples are queued for the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) protocol.
Steps:
Make Bulk Pool for NovaSeq Xp (NovaSeq 6000 v2.3)
Dilute, Denature & ExAmp (NovaSeq 6000 v2.3)
Load to Flowcell (NovaSeq 6000 v2.3)
Protocol 4: AUTOMATED - NovaSeq Run (NovaSeq6000 v2.3)
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 does this action automatically.
This protocol sets the Loading Workflow Type and allows you to choose the appropriate Flowcell Type and Final Loading Concentration(pM). At the end of the protocol, a routing script sends the normalized libraries to either the NovaSeq Standard (NovaSeq 6000 v2.3) or the NovaSeq Xp (NovaSeq 6000 v2.3) protocol.
This protocol contains one step: Define Run Format (NovaSeq 6000 v2.3).
Step 1: Define Run Format (NovaSeq 6000 v2.3)
Step input: NTP (normalized libraries)
Step output: None
Set Next Steps Automation
Automatically triggered on exit of the Record Details screen, this automation does the following actions:
Sets the next step for samples to REMOVE with
nextStep = ::REMOVE::
Calculates the Minimum Molarity using the following formula:
Checks Normalized Molarity value. For samples with no Normalized Molarity value (e.g., an empty value, not including 0), the automation generates an error message stating 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 Normalized Molarity value is lower than the Minimum Molarity value, sets the Loading Workflow Type of the sample to [Remove from workflow] and records a message in the Warning field:
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, there are two options:
Correct the Normalized Molarity value on the Record Details screen. Also, 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 of NovaSeq Standard are routed to the NovaSeq 6000 v2.3 workflow and queued for the Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3) step.
Samples with Loading Workflow Type field value of NovaSeq Xp are routed to the NovaSeq 6000 v2.3 workflow and queued for the Make Bulk Pool for NovaSeq Xp (NovaSeq 6000 v2.3) step.
The default automation command line is as follows.
The following table provides field configuration details for the fields defined on the Define Run Format (NovaSeq 6000 v2.3) step.
Define Run Format (NovaSeq 6000 v2.3) Master Step Field Configuration
Field Name
Field Type
Field Constraints/Options
Preset Values/Additional Options and Drop-Down Items
Comment
Multiline Text
None
Instruction
Text
Read Only
Default
Add Flowcell Type and Loading Workflow Type below
Flowcell Type
Text Dropdown
Required Field
Custom Entries
Presets
S1
S2
S3
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
Global Fields
The following table lists the global fields that are configured to display on the Define Run Format (NovaSeq 6000 v2.3) 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
S1
S2
S4
SP
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
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: NovaSeq Standard (NovaSeq 6000 v2.3)
Samples are routed to this protocol if the Loading Workflow Type value is set to NovaSeq Standard. Samples are pooled and added to a library tube in preparation for the NovaSeq run.
At the end of this protocol, a routing script sends the library tube to the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) protocol.
This protocol contains two steps:
Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3)
Dilute and Denature (NovaSeq 6000 v2.3)
Step 1: Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3)
In this step, manually place libraries into a single pool. Resuspension buffer and reagents are added.
⚠️ Only create one pool per step.
Step input: NTP (normalized libraries)
Step output: Bulk pool
The following automations are configured on the step (in the order they are triggered at run time).
Validate Inputs Flowcell Type and Single Pool Automation
Automatically triggered on exit of the Pooling screen, this automation checks the following information:
All samples in the pool have the same Flowcell Type assigned to them.
Due to the 4000-character limit, part of the script definition of Calculate Volumes has been moved into the Calculate Volumes Script field. If this part of the script needs to be modified, you can make the changes to the default value of the Calculate Volumes Script field. The parts of the script that were moved into the Calculate Volumes Script field are identified below.
Automatically triggered when the Calculate Volumes button on the Record Details screen is selected, this automation does 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) fields, based on the selected Flowcell Type. The following part of the automation is found in the Calculate Volumes Script field:
step.::PhiX Volume (ul):: = !step.hasValue(::% PhiX (2.5nM) Spike-In::) ? 0 : step.::% PhiX (2.5nM) Spike-In::;
if (input.::Flowcell Type:: == ::SP::) {
step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 100;
step.::PhiX Volume (ul):: *= 0.6
};
if (input.::Flowcell Type:: == ::S1::) {
step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 100;
step.::PhiX Volume (ul):: *= 0.6
};
if (input.::Flowcell Type:: == ::S2::) {
step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 150;
step.::PhiX Volume (ul):: *= 0.9
};
if (input.::Flowcell Type:: == ::S4::) {
step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 310;
step.::PhiX Volume (ul):: *= 1.9
};
if (step.::PhiX Volume (ul):: == 0) {
step.::PhiX Volume (ul):: = ::::
};
Calculates the Per Sample Volume (ul) to be added to the pool. The following part of the automation is found in the Calculate Volumes Script field:
ℹ️ 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 is set at 5, which can be edited.
Assuming the default Minimum Per Sample Volume (ul) value of 5, for a given batch:
If the smallest Per Sample Volume (ul) value is less than 5, Clarity LIMS automatically assigns a value of 5 to the Adjusted Per Sample Volume (ul) field.
Clarity LIMS then adjusts the Adjusted Per Sample Volume (ul) field value for all other samples in the batch, based on the ratio used to increase the lowest value to 5.
Calculates the Total Sample Volume (ul) field value:
Sets the Volume of Pool to Denature (ul) value and calculates NaOH Volume (ul) and Tris-HCl Volume (ul) values, based on the Flowcell Type:
step.::PhiX Volume (ul):: = !step.hasValue('% PhiX (2.5nM) Spike-In') ? 0 : step.'% PhiX (2.5nM) Spike-In';
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 on the Step Setup screen of the following step: Dilute and Denature (NovaSeq 6000 v2.3).
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 (NovaSeq 6000 v2.3) step in the protocol:
nextStep = ::ADVANCE::
Validate Unique Indexes Automation
ℹ️ Not used. This functionality is handled by the Clarity LIMS configuration for pooling
Master Step Fields
The following table provides field configuration details for the fields defined on the Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3) step.
Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3) Master Step Field Configuration
Field Name
Field Type
Options
Additional Options and Drop-Down Items
% PhiX (2.5nM) Spike-In
Numeric
Range = 1–100
Decimal places displayed = 0
Bulk Pool Volume (ul)
Numeric
Decimal places displayed = 2
Minimum Per Sample Volume (uL)
Numeric
Required Field
Default
5
Decimal places displayed = 2
Number of Flowcells to Sequence
Numeric
Required Field
Range = 1–10
Decimal places displayed = 0
Number of Samples in Pool
Numeric
Default
0
Decimal places displayed = 0
PhiX Volume (ul)
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
Numeric
Default
0
Decimal places displayed = 2
Calculate Volumes Script
Text
Required Field
Read Only
Default value provided in the drop-down section following the table.
Calculate Volumes Script
step.::PhiX Volume (ul):: = !step.hasValue(::% PhiX (2.5nM) Spike-In::) ? 0 : step.::% PhiX (2.5nM) Spike-In::; if (input.::Flowcell Type:: == ::SP::) { step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 100; step.::PhiX Volume (ul):: *= 0.6 }; if (input.::Flowcell Type:: == ::S1::) { step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 100; step.::PhiX Volume (ul):: *= 0.6 }; if (input.::Flowcell Type:: == ::S2::) { step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 150; step.::PhiX Volume (ul):: *= 0.9 }; if (input.::Flowcell Type:: == ::S4::) { step.::Bulk Pool Volume (ul):: = step.::Number of Flowcells to Sequence:: * 310; step.::PhiX Volume (ul):: *= 1.9 }; if (step.::PhiX Volume (ul):: == 0) { step.::PhiX Volume (ul):: = :::: }; 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::
Global Fields
The following table lists the global fields that are configured to display on the Make Bulk Pool for NovaSeq Standard (NovaSeq 6000 v2.3) step.
Global Field Configuration (Derived Sample)
Field Name
Field Type
Options
Additional Options and Drop-Down Items
Flowcell Type
Text Dropdown
Required Field
Presets
S1
S2
S4
SP
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
NaOH Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
RSB Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Tris-HCl Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Volume of Pool to Denature (ul)
Numeric
Read Only
Decimal places displayed = 0
Step 2: Dilute and Denature (NovaSeq 6000 v2.3)
In this step, pooled samples are denatured and diluted by the addition of NaOH, Tris-HCl, and Resuspension Buffer (RSB). Samples are manually placed into the library tube that is used in the NovaSeq run. In addition, this step generates the sample sheet file and the run recipe (*json file) needed to start the NovaSeq run. The step input is Bulk pool, and the step output is Library tube.
Validate Single Input Automation
Automatically triggered at the beginning of the step, the following 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, the following automation validates the library tube barcode to make sure it conforms to the barcode mask [A-Z]{2}[0-9]{7}-[A-Z]{3}:
if (!output.container.name.matches(::[A-Z]{2}[0-9]{7}-[A-Z]{3}::)){
fail(::Invalid Library Tube Barcode. Please verify and try again.::)
}
Generate Sample Sheet & Run Recipe Automation
Automatically triggered when a button on the Record Details screen is selected, this automation does the following actions:
Copies the Flowcell Type from the step input to the step output:
Validates the parameters entered on the Record Details screen:
Experiment Name can only contain alphanumeric, dash, or underscore characters. Spaces are not permitted.
When Workflow Type is No Index, Index Read 1 must be zero. For any other Workflow Type, Index Read 1 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) {
fail(::Index Read 1 must be 0 if the Workflow Type is No Index.::)
}
} else {
if(step.::Index Read 1::== 0) {
fail(::Index Read 1 must be greater than 0 if the Workflow Type is ::+ step.::Workflow Type::+ ::.::)
}
}
When Paired End is True, Index Read 1 and Index Read 2 must be greater than zero.
When Paired End is False, Index Read 2 must be zero, Reverse Complement Workflow must be false, UMI - Read 2 Length must not have a value, and UMI - Read 2 Start from Cycle must not have a value.
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 (step.hasValue(::UMI - Read 2 Length::) || step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 2 Length and UMI - Read 2 Start From Cycle cannot be defined if Paired End is False.::);
}
}
Validates allowed read cycles to be not greater than 151 if the Flowcell Type is not SP.
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.::);
}
Validates allowed value for UMI - Read 1 Length, UMI - Read 2 Length, UMI - Read 1 From Cycle, UMI - Read 2 From Cycle.
if (step.hasValue(::UMI - Read 1 Length::) && !step.hasValue(::UMI - Read 1 Start From Cycle::)) {
fail(::UMI - Read 1 Start From Cycle must be greater than 0 if UMI - Read 1 Length is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 1 Length::) && step.hasValue(::UMI - Read 1 Start From Cycle::)) {
fail(::UMI - Read 1 Length must be greater than 0 if UMI - Read 1 Start From Cycle is greater than 0.::);
}
if (step.hasValue(::UMI - Read 2 Length::) && !step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 2 Start From Cycle must be greater than 0 if UMI - Read 2 Length is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 2 Length::) && step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 2 Length must be greater than 0 if UMI - Read 2 Start From Cycle is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 1 Length::) && step.hasValue(::UMI - Read 2 Length::)) {
fail(::UMI - Read 1 Length must be greater than 0 if UMI - Read 2 Length is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 1 Start From Cycle::) && step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 1 Start From Cycle must be greater than 0 if UMI - Read 2 Start From Cycle is greater than 0.::);
}
Sets the next step for samples to REMOVE.
nextStep = ::REMOVE::
Generates the sample sheet and the run recipe file and attaches them to the step. For details on how the files are generated and their contents, refer to Sample Sheet and Run Recipe File Generation.
Prepare Files for NovaSeq Automation
Automatically triggered on exit of the Record Details screen, this automation invokes the copy_attachments_to_network_folder script, which is included in the novaseq-remote-extensions.jar file. This script places the generated sample sheet and run recipe (*json file) into the appropriate folder on the NAS, where the instrument uses them to start the run.
Automatically triggered on exit of the step, this automation invokes the changeWorkflow script, which routes step outputs to the NovaSeq 6000 v2.3 workflow, and queues them for the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) step.
The default automation command line is as follows.
The following table provides field configuration details fields defined on the Dilute and Denature (NovaSeq 6000 v2.3) step. These fields are required for sample sheet and JSON file generation.
Dilute and Denature (NovaSeq 6000 v2.3) Master Step Field Configuration
Field Name
Field Type
Options
Additional Options and Drop-Down Items
BaseSpace Sequence Hub Configuration
Text Dropdown
Required Field
Presets
Not Used
Run Monitoring Only
Run Monitoring and Storage
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
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
Read 2 Cycles
Numeric Dropdown
Required Field
Custom Entries
Range = 0–251
Decimal places displayed = 0
Presets
251
151
101
51
Reverse Complement Workflow
Toggle Switch
Required Field
Default
Yes
Run Mode
Text Dropdown
Read Only
Presets
SP
S1
S2
S4
Sample Sheet Path
Text
Read Only
UMI - Read 1 Length
Numeric
Range = 1
Decimal places displayed = 0
UMI - Read 1 Start From Cycle
Numeric
Range = 1
Decimal places displayed = 0
UMI - Read 2 Length
Numeric
Range = 1
Decimal places displayed = 0
UMI - Read 2 Start From Cycle
Numeric
Range = 1
Decimal places displayed = 0
Use Custom Index Read 1 Primer
Toggle Switch
Default
No
Use Custom Read 1 Primer
Toggle Switch
Default
No
Use Custom Read 2 Primer
Toggle Switch
Default
No
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Global Step Fields
The following table lists the global step fields that are configured to display on the Dilute and Denature (NovaSeq 6000 v2.3) step.
Global Field Configuration (Derived Sample)
Field Name
Field Type
Options
Additional Options and Drop-Down Items
Flowcell Type
Text Dropdown
Required Field
Presets
S1
S2
S4
SP
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Protocol 3: NovaSeq Xp (NovaSeq 6000 v2.3)
Samples are routed to this protocol if the Loading Workflow Type value is set to NovaSeq Xp.
Samples are pooled and added to lanes on the NovaSeq flow cell type selected in the Define Run Format (NovaSeq 6000 v2.3) step.
At the end of the protocol, a routing script sends the flow cell to the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) protocol.
This protocol contains three steps:
Step 1: Make Bulk Pool for NovaSeq Xp (NovaSeq 6000 v2.3)
Automatically triggered when the Calculate Volumes button on the Record Details screen is selected, this automation:
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 and can be edited.
Assuming the default Minimum Per Sample Volume (ul) value of 5, for a given batch:
If the smallest Per Sample Volume (ul) value is less than 5, Clarity LIMS automatically assigns a value of 5 to the sample's Adjusted Per Sample Volume (ul) field.
Clarity LIMS then adjusts the Adjusted Per Sample Volume (ul) field value for all other samples in the batch, based on the ratio used to increase the lowest value to 5.
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 on the Step Setup screen of the following step—Dilute, Denature & ExAmp (NovaSeq 6000 v2.3).
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, this automation does the following actions:
Copies the Flowcell Type values from the step inputs to the step outputs.
Sets the next step for samples to ADVANCE, advancing them to the next step in the protocol:
In this step, pooled samples are denatured and diluted by the addition of DPX, NaOH, Tris-HCl, and RSB. Manually create working pools based on the number of lanes you want to sequence. The step input is Bulk pool and the step output is Working pool. Working pool is a variable number for how many working pools need to be created per bulk pool.
These automations are described in the order in which they are triggered at run time.
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 does the following actions:
Checks the inputs to the step and validates that the Flowcell Type field has been set to a valid value (SP, S1, S2, or S4). The automation also checks that all inputs have the same value.
Validates that the number of outputs matches the number of lanes on the selected flow cell type. If validation fails, an error message state that the number of working pools does not match the number of lanes available on the flow cell.
Uses the NovaSeq_Xp_Working_Pool.csv and NovaSeq_Xp_Working_Pool2.csv template files to generate a single CSV file containing 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 on the Step Setup screen of the following step—Load to Flowcell (NovaSeq 6000 v2.3).
Set Next Step Automation
Automatically triggered on exit of the Record Details screen, this automation:
Copies the Flowcell Type values from the step inputs to the step outputs.
Sets the next step for samples to ADVANCE, advancing them to the next step in the protocol:
The following table provides field configuration details for the fields defined on Dilute, Denature & ExAmp (NovaSeq 6000 v2.3) step. These field values are set by a script and are not editable while running the step.
The following table lists the global fields that are configured to display on the Dilute, Denature & ExAmp (NovaSeq 6000 v2.3) step.
Global Field Configuration (Derived Sample)
Field Name
Field Type
Field Constraints/Options
Preset Values/Additional Options and Drop-Down 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 (NovaSeq 6000 v2.3)
In this step, scan the flow cell barcode into Clarity LIMS, then manually place the working pools into the lanes of the flow cell that is used in the NovaSeq run. The step input is Working pool and the step output is Flow cell (output containers: S1 and S2 with 2 lanes, and S4 with 4 lanes).
These automations are described in the order in which they are triggered at run time.
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, as follows.
Check that the Flowcell Type field has been set to a valid value (S1, S2, S4, or SP) and that all inputs have the same value.
Check that the number of outputs matches the number of lanes on the selected flow cell type. If validation fails, an error message states 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
Check 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 Flowcell Barcode Automation
Automatically triggered on exit of the Placement screen, this automation validates the flow cell barcode scanned into Clarity LIMS, using the following logic:
if (input.::Flowcell Type:: == ::SP:: && !output.container.name.matches(::[A-Z0-9]{5}DR[A-Z0-9]{2}::)) {
fail(::Invalid Flowcell Barcode. Please verify and try again.::)
};
if (input.::Flowcell Type:: == ::S1:: && !output.container.name.matches(::[A-Z0-9]{5}DR[A-Z0-9]{2}::)) {
fail(::Invalid Flowcell Barcode. Please verify and try again.::)
};
if (input.::Flowcell Type:: == ::S2:: && !output.container.name.matches(::[A-Z0-9]{5}DM[A-Z0-9]{2}::)) {
fail(::Invalid Flowcell Barcode. Please verify and try again.::)
};
if (input.::Flowcell Type:: == ::S4:: && !output.container.name. matches(::[A-Z0-9]{5}DS[A-Z0-9]{2}::)) {
fail(::Invalid Flowcell Barcode. Please verify and try again.::)
};
Generate Sample Sheet & Run Recipe Automation
Automatically triggered when a button on the Record Details screen is selected, 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:
Experiment Name can only contain alphanumeric, dash, or underscore characters. Spaces are not permitted.
When Workflow Type is No Index, Index Read 1 must be zero. For any other Workflow Type, Index Read 1 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) {
fail(::Index Read 1 must be 0 if the Workflow Type is No Index.::)
}
} else{
if(step.::Index Read 1::== 0) {
fail(::Index Read 1 must be greater than 0 if the Workflow Type is ::+ step.::Workflow Type::+ ::.::)
}
};
When Paired End is True, Index Read 1 and Index Read 2 must be greater than zero.
When Paired End = False, Index Read 2 must be zero. Reverse Complement Workflow must be false. UMI - Read 2 Length and UMI - Read 2 Start from Cycle must not have a value.
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 (step.hasValue(::UMI - Read 2 Length::) || step.hasValue(::UMI - Read 2 Start From Cycle::)) {fail(::UMI - Read 2 Length and UMI - Read 2 Start From Cycle cannot be defined if Paired End is False.::);}}
Validates allowed read cycles to be not greater than 151 if the Flowcell Type is not SP.
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.::);
}
Validates allowed value for UMI - Read 1 Length, UMI - Read 2 Length, UMI - Read 1 From Cycle, UMI - Read 2 From Cycle.
if (step.hasValue(::UMI - Read 1 Length::) && !step.hasValue(::UMI - Read 1 Start From Cycle::)) {
fail(::UMI - Read 1 Start From Cycle must be greater than 0 if UMI - Read 1 Length is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 1 Length::) && step.hasValue(::UMI - Read 1 Start From Cycle::)) {
fail(::UMI - Read 1 Length must be greater than 0 if UMI - Read 1 Start From Cycle is greater than 0.::);
}
if (step.hasValue(::UMI - Read 2 Length::) && !step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 2 Start From Cycle must be greater than 0 if UMI - Read 2 Length is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 2 Length::) && step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 2 Length must be greater than 0 if UMI - Read 2 Start From Cycle is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 1 Length::) && step.hasValue(::UMI - Read 2 Length::)) {
fail(::UMI - Read 1 Length must be greater than 0 if UMI - Read 2 Length is greater than 0.::);
}
if (!step.hasValue(::UMI - Read 1 Start From Cycle::) && step.hasValue(::UMI - Read 2 Start From Cycle::)) {
fail(::UMI - Read 1 Start From Cycle must be greater than 0 if UMI - Read 2 Start From Cycle is greater than 0.::);
}
Copies the Flowcell Type value from the step inputs to the step outputs:
Sets the next step for samples to ADVANCE, advancing them to the next step in the protocol—AUTOMATED - Run (NovaSeq 6000) v2.3.
nextStep = ::ADVANCE::
Generates the sample sheet and the run recipe file and attaches them to the step. For details on how the files are generated, and their contents, refer to Sample Sheet and Run Recipe File Generation.
Prepare Files for NovaSeq Automation
Automatically triggered on exit of the Record Details screen, this automation invokes the copy_attachments_to_network_folder script, which is included in the novaseq-remote-extensions.jar file. This script places the generated sample sheet and run recipe (*json file) into the appropriate folder on the NAS, where the instrument uses them to start the run.
The following table provides field configuration details for the fields defined on the Load to Flowcell (NovaSeq 6000 v2.3) step.
Load to Flowcell (NovaSeq 6000 v2.3) Master Step Field Configuration
Field Name
Field Type
Options
Additional Options and Drop-Down Items
BaseSpace Sequence Hub Configuration
Text Dropdown
Required Field
Presets
Not Used
Run Monitoring Only
Run Monitoring and Storage
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
Library Tube Barcode
Text
Required Field
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
Read 2 Cycles
Numeric Dropdown
Required Field
Custom Entries
Range = 0–251
Decimal places displayed = 0
Presets
251
151
101
51
Reverse Complement Workflow
Toggle Switch
Required Field
Default
Yes
Run Mode
Text Dropdown
Read Only
Presets
SP
S1
S2
S4
Sample Sheet Path
Text
Read Only
UMI - Read 1 Length
Numeric
Range = 1
Decimal places displayed = 0
UMI - Read 1 Start From Cycle
Numeric
Range = 1
Decimal places displayed = 0
UMI - Read 2 Length
Numeric
Range = 1
Decimal places displayed = 0
UMI - Read 2 Start From Cycle
Numeric
Range = 1
Decimal places displayed = 0
Use Custom Index Read 1 Primer
Toggle Switch
Default
No
Use Custom Read 1 Primer
Toggle Switch
Default
No
Use Custom Read 2 Primer
Toggle Switch
Default
No
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Global Fields
The following table lists the global fields (derived samples) that are configured to display on the Load to Flowcell (NovaSeq 6000 v2.3) step.
Field Name
Field Type
Options
Additional Options and Drop-Down Items
Flowcell Type
Text Dropdown
Required Field
Presets
S1
S2
S4
SP
Protocol 4: AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3)
This final protocol contains one fully automated step, AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3).
Step 1: AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3)
Step input: Library tube from the NovaSeq Standard protocol or flow cell from the NovaSeq Xp protocol.
Step output: Result file and measurement.
⚠️ Do not add samples to the Ice Bucket or start the step manually. This is a fully automated step. The sequencing service may not update samples correctly if they have been manually started.
In this step, pooled samples are sequenced on the NovaSeq instrument. The run data network folder is monitored by the sequencing service and automation worker to determine when the sequencing run begins and ends.
When a run is initiated on the NovaSeq instrument, the NovaSeq Control Software (NVCS) looks for the sample sheet and run recipe (*.json file) on the shared network drive.
The NVCS copies the sample sheet to the run directory.
The NVCS uses the run recipe to start the sequencing run.
When the run starts:
The instrument software creates a new run folder (named <libraryID>) on the shared network drive and copies the following files into that folder:
RunParameters.xml
RunInfo.xml
LIMS/<libraryID>.json file (run recipe)
The Real-Time Analysis v3 (RTA3) software creates the InterOp folder.
The sequencing service detects the presence of the RunParameters, RunInfo, and JSON files and starts the AUTOMATED- NovaSeq Run (NovaSeq 6000 v2.3) step in Clarity LIMS.
As the run progresses, the InterOp data files are filled in.
At the end of the run, the NovaSeq:
Copies the run data files to the InterOp folder.
Creates the CopyComplete.txt file in the run folder. This step indicates to the sequencing service that the run has completed and the data files are ready.
The sequencing service triggers the Read InterOp Metrics automation. This automation reads the files, records the parsed metrics into Clarity LIMS, and finally completes the step in Clarity LIMS.
Parse Run Parameters and Generate Link to Run Folder Automation
Automatically triggered on entry to the Record Details screen, this automation does the following actions:
Parses the RunParameters.xml file attached on the Step Setup screen.
Populates the master and global step fields with extracted values.
If there is an instrument in Clarity LIMS that matches the instrument name in the file (InstrumentName field), the script associates this instrument with the run.
Generates and attaches a link to the run folder using the run output folder parsed from RunParameters.xml.
The following rules and constraints are present:
If there is no InstrumentName value in the file, the script continues, but it logs a warning.
If there is an InstrumentName value in the file and multiple instruments with the same name exist in Clarity LIMS, the script fails and logs an error.
If the RunParameters.xml file is not attached to the step during step setup, the script fails.
Every RunParameters.xml field that has an equivalent step UDF/custom field in Clarity LIMS is required — except for InstrumentName. If a field is not present in the RunParameters.xml file, Clarity LIMS logs an error to this effect.
Read InterOp Metrics Automation
Automatically triggered when the sequencing service detects the CopyComplete.txt file has been created, this automation parses the InterOp data generated by the run.
Read summary metrics are recorded on the library pool. These values are aggregated across all lanes. Some values — for example Yield PF (Gb) — are summed, while others are averaged.
Per lane metrics are recorded on the measurement outputs.
The read_interop_metrics script loads data from the InterOp files and records summary metrics into derived sample UDFs/custom fields in Clarity LIMS. If any field is not configured or cannot be written to, the script fails.
Set Next Steps Automation
Automatically triggered on exit of the Record Details screen, the following automation sets the next step to ADVANCE and the samples complete the protocol:
nextStep = ::ADVANCE::
Update Lane Number Automation
Automatically triggered on exit of the Step Setup screen, this automation updates the lane number so that Read InterOp Metrics automation script can populate lane metric to the correct lane.
⚠️ Do not disable Update Lane Number automation as it causes run metric parsing to work improperly.
Master Step Fields
The fields defined on the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) step are listed in the Clarity LIMS Configuration area (Custom Fields > Master Step Fields tab).
The following table shows how the parsed RunParameters.xml fields map to step fields configured on the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) step in Clarity LIMS.
Fields Parsed by parse_novaseq_run_parameters script
RunParameters.xml Field
Field Name
FlowCellSerialBarcode
Flow Cell ID
FlowCellPartNumber
Flow Cell Part Number
FlowCellLotNumber
Flow Cell Lot Number
FlowCellExpirationdate
Flow Cell Expiration Date
FlowCellMode
Flow Cell Mode
RunId
Run ID
ClusterSerialBarcode
PE Serial Barcode
ClusterPartNumber
PE Part Number
ClusterLotNumber
PE Lot Number
ClusterExpirationdate
PE Expiration Date
ClusterCycleKit
PE Cycle Kit
SbsSerialBarcode
SBS Serial Barcode
SbsPartNumber
SBS Part Number
SbsLotNumber
SBS Lot Number
SbsExpirationdate
SBS Expiration Date
SbsCycleKit
SBS Cycle Kit
BufferSerialBarcode
Buffer Serial Barcode
BufferPartNumber
Buffer Part Number
BufferLotNumber
Buffer Lot Number
BufferExpirationdate
Buffer Expiration
OutputRunFolder
Output Folder
WorkflowType
Loading Workflow Type
Global Fields
The global fields that are configured to support the parsing of key metrics back into Clarity LIMS are as follows.
Yield PF (Gb) R1
Yield PF (Gb) R2
Reads PF (M) R1
Reads PF (M) R2
Cluster Density (K/mm^2) R1
Cluster Density (K/mm^2) R2
%PF R1
%PF R2
% Bases >=Q30 R1
% Bases >=Q30 R2
Intensity Cycle 1 R1
Intensity Cycle 1 R2
% Phasing R1
% Phasing R2
% Prephasing R1
% Prephasing R2
% Aligned R1
% Aligned R
% Error Rate R1
% Error Rate R2
Components Installed
The following sections describe the various components that are installed by default as part of this integration. These components include files, database properties, reagent categories/label groups, reagent kits, and containers. Information on installed workflows, protocols, steps, and automation points is provided in the previous Workflows, Protocols, and Steps section.
The Illumina NovaSeq 6000 Integration v2.5.0 Package is distributed as two RPM packages:
BaseSpaceLIMS-novaseq-extensions
BaseSpaceLIMS-novaseq-sequencing-service
The RPM packages install the components listed in the following table.
The NovaSeq 6000 Integration requires installation of NGS Extensions Package v5.23.0 or later.
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 integration. For details, refer to NovaSeq 6000 Integration v2.5.0 Release Notes.
If NGS Extensions Package v5.23.0 is already installed, upgrade is not forced or required.
Secret Util Package is required for the NGS Extensions Package v5.23.0.
If the Secret Util Package is not already installed, then Secret Util package is installed along with the installation of NGS Extension Package v5.23.0.
If the Secret Util Package is already installed, upgrade is not forced or required.
Search and replace entries for transforming Windows to Linux network paths. This property must be set to the single SUFFIX used in the two previous properties.
novaseq.seqservice.netPathPrefixSearch.SUFFIX
The search prefix used to map the OutputRunFolder field in RunParameters.xml to the corresponding Linux directory.
novaseq.seqservice.netPathPrefixReplace.SUFFIX
The directory where the sequencing service looks for run folders.
Search and replace entries for transforming Windows to Linux network paths. This property must be set to the single SUFFIX used in the two properties above.
¹ This version of the integration only supports a single active search-replace pair of each type: sampleSheetPathPrefixSearchReplaceSuffixes and netPathPrefixSearchReplaceSuffixes must each contain a single number, rather than a comma-separated list of numbers.
Label Groups, Reagent Kits, and Containers
The NovaSeq 6000 Integration v2.5 Package installs the following label groups, reagent kits, and container types.
Label Groups
TruSeq HT Adapters v2 (D7-D5)
Reagent Kits
DPX1
DPX2
DPX3
Resuspension Buffer (RSB)
NaOH
Tris-HCl
Container Types
Library Tube
S1
S2
S4
SP
Instrument Integration
The following are instructions for configuring the NovaSeq instrument for the Clarity LIMS integration:
Launch NovaSeq Control Software.
On the home screen, select the menu (top left) and select Settings.
Select File-Based and enter the network folder location that NovaSeq Control Software retrieves the JSON recipe from.
Enter the network output folder location.
Select Save.
For more information, refer to the NovaSeq 6000 Sequencing System Guide at support.illumina.com.
Routing Script Requirements
The requirements for the routing script functionality are as follows.
On the steps that use the routing script — Define Run Format (NovaSeq 6000 v2.3) and Dilute and Denature (NovaSeq 6000 v2.3) — the Next Step for all samples must be set to Remove from workflow. This value is set by a script. Do not change this value in the Assign Next Steps screen.
In the protocol configuration screen, the following setting is 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.
Sample Sheet and Run Recipe File Generation
Sample sheet and run recipe file generation occurs on the step before the run—Dilute and Denature (NovaSeq 6000 v2.3) in the NovaSeq Standard protocol or Load to Flowcell (NovaSeq 6000 v2.3) in the NovaSeq Xp protocol. This step is where samples are placed on the library tube or flow cell that is loaded in the NovaSeq instrument.
In the default configuration, the Generate Sample Sheet & Run Recipe automation generates the following:
One CSV format sample sheet file for use bcl2fastq v2.20 downstream analysis
One JSON format run recipe file
The Prepare Files for NovaSeq automation places the generated files on the NAS where the instrument uses them to start the run.
How It Works
The Prepare Files for NovaSeq automation command line invokes the copy_attachments_to_network_folder script in novaseq-remote-extensions.jar. The script can be used on a remote AI node/automation worker, in case the Clarity LIMS server does not have direct access to the NAS.
The output folder for the run recipe file is found in the novaseq.runSetupFolder property.
The output folder for the sample sheet is determined by using the novaseq.sampleSheetPathPrefixReplace.<suffix> property (not a comma-separated list).
Sample Sheet Contents
The contents of the sample sheet are controlled by the following fields configured on the Dilute and Denature (NovaSeq 6000 v2.3) and Load to Flowcell (NovaSeq 6000 v2.3) steps:
Sample sheet generation script parameters and usage
Sample sheet data and configuration options
Enabling unique FASTQ file names per sequencing run
Run Recipe Contents
The contents of the run recipe are controlled by the following fields. These fields are configured on the Dilute and Denature (NovaSeq 6000 v2.3) and Load to Flowcell (NovaSeq 6000 v2.3) steps.
Experiment Name
Run Mode
Workflow Type
Sample Loading Type (populated based on Workflow field)
Paired End
Read 1
Read 2
Index Read 1
Index Read 2
Sample Sheet Path
BaseSpace Configuration
Use Custom Read 1 Primer
Use Custom Read 2 Primer
Use Custom Index Read 1 Primer
The following fields are also included in the run recipe:
Library Tube Barcode (librarytube_ID in JSON file)
NovaSeq Standard workflow — Library tube barcode is derived from the container name entered or scanned on the Placement screen.
NovaSeq Xp workflow — Library tube barcode is derived from the Library Tube Barcode field in the Load To Flowcell (NovaSeq 6000 v2.3) step.
Flowcell Barcode (flowcell_ID in JSON file)
NovaSeq Standard workflow — Library tube barcode is not output to JSON recipe file.
NovaSeq Xp workflow — Flow cell barcode is derived from the container name entered or scanned on the Placement screen.
Rehyb — preset to False.
Output Folder (output_folder in JSON file) — Derived from the system property novaseq.seqservice.netPathPrefixSearch.
Attachment — Derived from the system property novaseq.sampleSheetPathPrefixSearch with the name of the sample sheet added to the end of the path.
Use BaseSpace (use_basespace in JSON file) — Set to False if the BaseSpace Sequence Hub Configuration step field value is Not Used, and true otherwise.
Rules and Constraints
The sample sheet and run recipe files are mandatory inputs for the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) step. For the automated run to start successfully, select the Generate Sample Sheet & Run Recipe button to generate these files.
The output folders must exist on the system where the script runs (can be a remote AI node/automation worker).
The output folders must be writable by the glsai user.
Container Types
The integration supports the following container types:
Library tube with barcode provided in the following format:
[A-Z]{2}[0-9]{7}-[A-Z]{3}
Example — NV1234567-LIB
Flow cell with barcode provided in one of the following formats:
For SP and S1 — [A-Z0-9]{5}DR[A-Z0-9]{2}
For S2 — [A-Z0-9]{5}DM[A-Z0-9]{2}
For S4 — [A-Z0-9]{5}DS[A-Z0-9]{2}
Example S2 flow cell barcode — H1234DMXX
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 the following information:
Which samples, and how many, can enter each step together.
Which samples, and how many, can be pooled together.
Reagent labels (indexes) must be unique.
The library tube ID must be unique. There should not be multiple library tube containers in the system with the same name.
Only controls are permitted as unindexed samples. All other unindexed samples and pools are not permitted.
Sample sheet generation script parameters and usage
Sample sheet data and configuration options
Enabling unique FASTQ file names per sequencing run
Do not manually start the AUTOMATED - NovaSeq Run (NovaSeq 6000 v2.3) step. This step is fully automated. If the samples have been manually started, the sequencing service may not update them correctly.
The output folder must be readable by the Clarity LIMS glsjboss account on the server.
