Configuration
Last updated
Last updated
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 NovaSeq 6000Dx Integration v1.2.0 User Interaction, Validation and Troubleshooting.
The configuration provided in this integration has been established to support NovaSeq 6000Dx lab processes. Any configuration changes to protocols or workflows—including renaming protocols, steps, and fields—could break the process.
Samples enter the NovaSeqDx v1.2 workflow as normalized libraries. It is assumed that the following steps have completed before samples are assigned to the workflow:
Samples have been accessioned into the Clarity LIMS.
Samples have been run through QC and library prep.
Samples have been normalized, and the value is captured in a field called Normalized Molarity (nM).
For more information on sample accessioning, refer to the following sections of the Getting Started section of the Clarity LIMS (Clarity & LabLink Reference Guide) documentation:
Sample Accessioning
Using Sample Lists to Upload and Modify Samples
You can assign samples to workflows automatically, using a routing script, or manually—from the Projects & Samples dashboard. Refer to Assign and Process Samples in the Clarity LIMS (Clarity & LabLink Reference Guide) documentation.
The Illumina NovaSeq 6000Dx Integration Package v1.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.
The Library Prep Validation v2.3.1 workflow allows for validation of the system after installation is complete. For details, refer to NovaSeq 6000Dx Integration v1.2.0 User Interaction, Validation and Troubleshooting.
This protocol sets the Loading Workflow Type and allows the choice of the appropriate Flowcell Type and Final Loading Concentration (pM). After the protocol, a routing script sends the normalized libraries to either the NovaSeqDx Standard (NovaSeqDx v1.2) or the NovaSeqDx Xp (NovaSeqDx v1.2) protocol.
This protocol contains one step: Define Run Format (NovaSeqDx v1.2).
Step input: Normalized Template Plate (NTP, normalized libraries)
Step output: None
There are four fields defined on the Define Run Format (NovaSeqDx v1.2) master step.
The following table lists field configuration details.
Define Run Format (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Define Run Format (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
Samples are routed to this protocol when their Loading Workflow Type value is set to NovaSeq Standard. Samples are pooled and added to a library tube in preparation for the NovaSeqDx Run.
At the end of this protocol, a routing script sends the library tube to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) protocol.
This protocol contains the following two steps:
Step 1: Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2)
Step 2: Dilute and Denature (NovaSeqDx v1.2)
In this step, libraries are placed manually into a single pool. Resuspension buffer and reagents are added.
Step input: NTP (normalized libraries)
Step output: Bulk pool
The following fields are defined on the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step.
Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step.
Global Custom Fields Configuration (Derived Sample)
In this step, the addition of NaOH, Tris-HCl, and Resuspension Buffer (RSB) denatures and dilutes pooled samples. Manually place the pooled samples into the library tube for the NovaSeqDx Run.
In addition, this step validates the run setup information and generates the sample sheet file.
Step input: Bulk pool
Step output: Library tube
The following table lists field configuration details for the fields that are defined on the Dilute and Denature (NovaSeqDx v1.2) step. These fields are required for sample sheet and JSON file generation.
Dilute and Denature (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Dilute and Denature (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
Samples are routed to this protocol when their Loading Workflow Type value is set to NovaSeq Xp.
Samples are pooled and added to lanes on the NovaSeqDx flow cell type selected in the Define Run Format (NovaSeqDx v1.2) step. At the end of this protocol, the flow cell is sent to the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) protocol.
This protocol contains the following three steps:
Step 1: Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2)
Step 2: Dilute, Denature & ExAmp (NovaSeqDx v1.2)
Step 3: Load to Flowcell (NovaSeqDx v1.2)
Manually place libraries into a pool.
Step input: NTP (normalized libraries)
Step output: Bulk pool
The fields in the following table are defined on the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
In this step, the addition of DPX, NaOH, Tris-HCl, and RSB denatures and dilutes pooled samples. Manually create working pools based on the number of lanes that you want to sequence.
Step input: Bulk pool
Step output: Working pool - variable number (choose how many working pools to create per bulk pool)
The following table lists field configuration details for the fields that are defined on the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step. A script sets these field values. They are not editable while running the step.
Dilute, Denature & ExAmp (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Dilute, Denature & ExAmp (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
In this step, scan the flow cell barcode into the Clarity LIMS and manually place the working pools into the lanes of the flow cell for the NovaSeqDx run. This step validates the run setup information and generates the sample sheet file.
Step input: Working pool
Step output: Flow cell (output containers: SP, S1, and S2 with 2 lanes, and S4 with 4 lanes)
The following table lists the field configuration details for the fields defined on the Load to Flowcell (NovaSeqDx v1.2) step.
Load to Flowcell (NovaSeqDx v1.2) Master Step Field Configuration
The following table lists the global custom fields that are configured to display on the Load to Flowcell (NovaSeqDx v1.2) step.
Global Field Configuration (Derived Sample)
This final protocol contains one fully automated step, AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
Step input: Library tube from NovaSeqDx Standard or flow cell from NovaSeqDx Xp protocol
Step output: Result file/measurement
In this step, pooled samples are sequenced on the NovaSeq 6000Dx instrument and the run metrics are recorded in Clarity LIMS.
The following table shows the master step fields that are configured on the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step.
Clarity LIMS Master Step Field Configuration
The following table shows the global custom fields that capture the run metrics in Clarity LIMS.
Custom Field Configuration
Note the following details:
Values are aggregated across all lanes. Some values (eg, Yield PF (Gb) R1) are summed while others are averaged.
The names listed previously are the default global custom field names installed with the NovaSeqDx v1.2 configuration provided in the Illumina Preset Protocols (IPP) Package v2.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).
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 Components Installed.
The sample sheet is generated on the step before the run. This step is either Dilute and Denature (NovaSeqDx v1.2) in the NovaSeqDx Standard protocol or Load to Flowcell (NovaSeqDx v1.2) in the NovaSeqDx Xp protocol. This step places samples on the library tube or flow cell that is loaded in the NovaSeq 6000Dx instrument.
In the default configuration, the Validate Run Setup and Generate Sample Sheet automation generates one sample sheet file for use with bcl2fastq v2.20 downstream analysis. This file is in the comma-separated values (CSV) format.
The sample sheet is uploaded to the NovaSeq 6000Dx Operating Software (NVOS) via the /Illumina/Sequencer/v2/sequencing-run/files endpoint to the Sequencer API. The file endpoint allows for a file to be downloaded from Clarity LIMS using OAuth (instead of Basic Authentication), which is required for NovaSeq 6000Dx.
The run recipe response sets the sample sheet URL to the link to download the file from this endpoint and sets the sampleSheetRequiresOAuth value to true.
The following steps outline the sequence of events that occurs when a flow cell is loaded onto the NovaSeq 6000Dx instrument.
The following sections describe the components (files, properties, reagent categories/label groups, reagent kits, and containers) that are installed by default as part of this integration.
Illumina NovaSeq 6000Dx Integration v1.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
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 NovaSeq 6000Dx Integration v1.2.0 Release Notes.
If NGS Extensions Package v5.23.0 or later is already installed, upgrade is not forced or required.
The following table lists the components installed by the RPM package.
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
TruSeq HT Adapters v2 (D7-D5)
Buffer Cartridge
Cluster Cartridge
DPX1
DPX2
DPX3
NaOH
Resuspension Buffer (RSB)
SBS Cartridge
Tris-HCl
Library Tube
SP
S1
S2
S4
This integration supports the following items:
Library tube with barcode provided in the following formats:
RUO mode: [A-Z]{2}[0-9]{7}-[A-Z]{3}
Example: AB1234567-LIB
DX mode: DX[0-9]{7}-[A-Z]{3}
Example: DX1234567-LIB
SP, S1, S2, or S4 flow cell with barcode provided in one of the following formats:
SP and S1 flow cell: [A-Z0-9]{5}DR[A-Z0-9]{2}
S2 flow cell: [A-Z0-9]{5}DM[A-Z0-9]{2}
S4 flow cell: [A-Z0-9]{5}DS[A-Z0-9]{2}
Example: H1991DMXX
For details on configuring the NovaSeq 6000Dx Operating Software (NVOS) for integration with Clarity LIMS, contact the Clarity LIMS Support team.
The requirements for the routing script functionality are as follows.
On the steps that use the routing script (Define Run Format (NovaSeqDx v1.2) and Dilute and Denature (NovaSeqDx v1.2)):
The Next Step for all samples must be set to Remove from workflow. A script sets this value. The value must not change in the Assign Next Steps screen.
In the protocol configuration screen, the following settings are required and must not be changed:
In the Next Steps section, for the last step in the protocol, the method of assigning the next step must be set to Automatic.
The 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.
Open the application.yml file at /opt/gls/clarity/extensions/sequencer-api/application.yml:
Edit the value of the autoCompleteOnlyAtSuccess property as required.
Save the file.
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
The workflow configuration contains several validation checks. To make sure that the calculations work properly, it is important that you do not disable any of this validation logic. The validation checks determine the following information:
Which samples, and how many, can enter each step together.
Which samples, and how many, can be pooled together.
The library tube ID must be unique. There must not be multiple library tube containers in the system with the same name.
Reagent labels (indexes) must be unique.
Only controls are permitted as unindexed samples. All other unindexed samples and pools are not permitted.
For sample sheet generation constraints, refer to the Bcl2fastq2 Sample Sheet Generation section in Illumina Instrument Sample Sheets (NGS v5.17 & later).
Do not manually start the AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2) step. This step is fully automated and the sequencing service may not update samples correctly if they have been manually started.
For the automated run to start successfully, the Validate Run Setup and Generate Sample Sheet button must be selected.
Do not add samples to the Ice Bucket or start the step. The integration starts the step automatically.
Create only one pool per step.
Validate Unique Indexes automation is not used. The Clarity LIMS configuration for pooling handles this functionality.
For accurate pipetting of each sample in a pool for sequencing, the Per Sample Volume (ul) value must be equal to or higher than the Minimum Per Sample Volume (ul). The default value (set at 5) can be edited.
The script definition portion of Validate Run Setup has been moved into the Validation Script custom field due to the 4000 character limit. If modification is required on Validate Run Setup script, perform the changes directly on the Validation Script custom field default value.
Create only one pool per step.
Validate Unique Indexes automation is not used. The Clarity LIMS configuration for pooling handles this functionality.
To ensure accurate pipetting of each sample in a pool for sequencing, the Per Sample Volume (ul) value must be equal to or higher than the Minimum Per Sample Volume (ul). The default value (set at 5) can be edited.
The script definition portion of Validate Run Setup has been moved into the Validation Script custom field due to the 4000 character limitation.
This step is fully automated. Do not add samples to the Ice Bucket or start the step manually. If steps are manually started, the sequencing service may not update the samples correctly.
Do not disable or modify this automation to ensure the Lane Number displays properly.
These global custom fields are configured on the Container entity, visible on each input, and must not be confused with per-lane metrics. All run metrics tracked in Clarity LIMS are overall metrics for the run. There are currently no per-lane metrics provided by NovaSeq 6000Dx Operating Software.
Configure the steps that are considered sequencing run steps in the 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 Components Installed.
If no matching container is found, or if the samples in the container are incorrectly queued, an error is thrown and the step is not started. This validation is also done during the run recipe request immediately prior, so this error case should not be encountered.
The NovaSeq 6000Dx v1.2.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.
Field Name
Field Type
Options
Additional Options and Dropdown Items
Comment
Multiline Text
None
Flowcell Type
Text Dropdown
Required Field
Custom Entries
Presets
SP
S1
S2
S4
Instruction
Text
Read Only
Default
Add Flowcell Type, Loading Workflow Type, and NovaSeqDx Run Mode
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
Field Name
Field Type
Options
Additional Options and Dropdown Items
Adjusted Per Sample Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Final Loading Concentration (pM)
Numeric Dropdown
Required Field
Custom Entries
Presets
225
400
Decimal places displayed = 0
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Minimum Molarity (nM)
Numeric
Decimal places displayed = 2
Normalized Molarity (nM)
Numeric
Decimal places displayed = 2
NovaSeqDx Run Mode
Text Dropdown
Required Field
Presets
DX
RUO
Per Sample Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Warning
Text Dropdown
Read Only
Custom Entries
Presets
The Normalized Molarity (nM) is too low.
n/a
Field Name
Field Type
Options
Additional Options and Dropdown Items
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Field Name
Field Type
Options
Additional Options and Dropdown Items
RSB Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Field Name
Field Type
Options
Additional Options and Dropdown Items
DPX1 Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
DPX2 Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
DPX3 Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
Field Name
Field Type
Options
Additional Options and Dropdown Items
BP Aliquot Volume (ul)
Numeric
Read Only
Decimal places displayed = 0
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Mastermix per Lane (ul)
Numeric
Read Only
Decimal places displayed = 0
NaOH Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Tris-HCl Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Field Name
Field Type
Options
Additional Options and Dropdown Items
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
Field Name
Field Type
Options
Additional Options and Dropdown Items
Current Cycle
Numeric
Read Only
Decimal places displayed = 0
Current Read
Numeric
Read Only
Decimal places displayed = 0
Firmware Version
Text
Read Only
Flow Cell Expiration Date
Date
Read Only
Flow Cell ID
Text
Read Only
Flow Cell Lot Number
Text
Read Only
Flow Cell Mode
Text
Read Only
Flow Cell Part Number
Text
Read Only
Flow Cell Side
Text
Read Only
Instrument Control Software Version
Text
Read Only
Instrument ID
Text
Read Only
Instrument Type
Text
Read Only
Lane Counter
Numeric
Read Only
Default
1
Hidden
Loading Workflow Type
Text
Read Only
Output Folder
Text
Read Only
RTA Version
Text
Read Only
Run Completion Date
Text
Read Only
Hidden
Run ID
Text
Read Only
Run Status
Text
Read Only
Sequencing Log
Multiline Text
Read Only
Field Name
Field Type
Options
Additional Options and Dropdown Items
% Aligned R1
Numeric
Read Only
Decimal places displayed = 2
% Aligned R2
Numeric
Read Only
Decimal places displayed = 2
% Bases >=Q30 R1
Numeric
Read Only
Decimal places displayed = 2
% Bases >=Q30 R2
Numeric
Read Only
Decimal places displayed = 2
% Error Rate R1
Numeric
Read Only
Decimal places displayed = 2
% Error Rate R2
Numeric
Read Only
Decimal places displayed = 2
% Phasing R1
Numeric
Read Only
Decimal places displayed = 3
% Phasing R2
Numeric
Read Only
Decimal places displayed = 3
% Prephasing R1
Numeric
Read Only
Decimal places displayed = 3
% Prephasing R2
Numeric
Read Only
Decimal places displayed = 3
%PF R1
Numeric
Read Only
Decimal places displayed = 2
%PF R2
Numeric
Read Only
Decimal places displayed = 2
Cluster Density (K/mm^2) R1
Numeric
Read Only
Cluster Density (K/mm^2) R2
Numeric
Read Only
Intensity Cycle 1 R1
Numeric
Read Only
Intensity Cycle 1 R2
Numeric
Read Only
Reads PF (M) R1
Numeric
Read Only
Decimal places displayed = 2
Reads PF (M) R2
Numeric
Read Only
Decimal places displayed = 2
Yield PF (Gb) R1
Numeric
Read Only
Decimal places displayed = 2
Yield PF (Gb) R2
Numeric
Read Only
Decimal places displayed = 2
Files Installed
Location
Description
Illumina#Sequencer#v2.war
/opt/gls/clarity/tomcat/current/webapps
War file for Sequencer API.
configure_sequencer_api_application.sh
/opt/gls/clarity/config/
Script that configures the Sequencer API application through its external application.yml file.
configure_sequencer_api_env.sh
/opt/gls/clarity/config/
Script that configures the Clarity LIMS Tomcat configuration to include Secret Util settings.
configure_sequencer_api_proxy.sh
/opt/gls/clarity/config/
Script that configures the proxy to allow communication with the Sequencer API application.
sequencer-api.conf
/etc/httpd/clarity/
Proxy setting to communicate with Clarity LIMS.
run.autoComplete property value
run.autoCompleteOnlyAtSuccess property value
Outcome
true
true
Step automatically completes only if the sequencing run is successful.
If run is not successful, the step does not automatically complete, and the run details are recorded in Clarity LIMS.
true
false
Step automatically completes, regardless of the run status.
false
true
Step does not automatically complete.
Run details are recorded in Clarity LIMS.
false
false
Step does not automatically complete.
Run details are recorded in Clarity LIMS.
Field Name
Field Type
Options
Additional Options and Dropdown Items
% PhiX (2.5 nM) Spike-In
Numeric
Range = 0–100
Bulk Pool Volume (ul)
Numeric
Decimal places displayed = 2
Number of Flowcells to Sequence
Numeric
Required Field
Range = 1–10
Decimal places displayed = 0
Minimum Per Sample Volume (ul)
Numeric
Required Field
Decimal places displayed = 2
Default
5
Number of Samples in Pool
Numeric
Decimal places displayed = 0
Default
0
PhiX Volume (ul)
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
Numeric
Decimal places displayed = 2
Default
0
Field Name
Field Type
Options
Additional Options and Dropdown Items
Flowcell Type
Text Dropdown
Required Field
Presets
SP
S1
S2
S4
Loading Workflow Type
Text Dropdown
Required Field
Presets
NovaSeq Standard
NovaSeq Xp
[Remove from workflow]
NaOH Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
RSB Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Tris-HCl Volume (ul)
Numeric
Read Only
Decimal places displayed = 2
Volume of Pool to Denature (ul)
Numeric
Read Only
Decimal places displayed = 0
Field Name
Field Type
Options
Additional Options and Dropdown Items
Analysis Software Version
Text
BaseSpace Sequence Hub Configuration
Text Dropdown
Required Field
Presets
Not Used
Run Monitoring Only
Run Monitoring and Storage
Custom Recipe Path
Text
Experiment Name
Text
Required Field
Index Read 1
Numeric Dropdown
Required Field
Custom Entries
Range = 0–20
Decimal places displayed = 0
Presets
0
6
8
Index Read 2
Numeric Dropdown
Required Field
Custom Entries
Range = 0–20
Decimal places displayed = 0
Presets
0
6
8
Output Folder
Text
Required Field
Override Cycles
Text
Paired End
Text Dropdown
Required Field
Presets
True
False
Read 1 Cycle
Numeric Dropdown
Required Field
Custom Entries
Range = 1–251
Decimal places displayed = 0
Presets
251
151
101
51
Read 2 Cycle
Numeric Dropdown
Required Field
Custom Entries
Range = 0–251
Decimal places displayed = 0
Presets
251
151
101
51
Run Mode
Text Dropdown
Read Only
Presets
SP
S1
S2
S4
Use Custom Index Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 2 Primer
Toggle Switch
Default
None Set
Use Custom Recipe
Toggle Switch
Required Field
Default
No
Validation Script
Multiline Text
Required Field
Read Only
Default value is provided in the drop-down section that follows the table.
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Custom
Field Name
Field Type
Options
Additional Options and Dropdown Items
% PhiX (0.25nM) Spike-in
Numeric
Range = 0– 100
Bulk Pool Volume (ul)
Numeric
Decimal places displayed = 2
Minimum Per Sample Volume (ul)
Numeric
Required Field
Default
5
Decimal places displayed = 2
Number of Lanes to Sequence
Numeric
Required Field
Decimal places displayed = 0
Number of Samples in Pool
Numeric
Default
0
Decimal places displayed = 0
PhiX Volume (ul)
Numeric
Decimal places displayed = 2
Total Sample Volume (ul)
Numeric
Default
0
Decimal places displayed = 0
Field Name
Field Type
Options
Additional Options and Dropdown Items
Analysis Software Version
Text
BaseSpace Sequence Hub Configuration
Text Dropdown
Required Field
Presets
Not Used
Run Monitoring Only
Run Monitoring and Storage
Custom Recipe Path
Text
Experiment Name
Text
Required Field
Index Read 1
Numeric Dropdown
Required Field
Custom Entries
Presets
0
6
8
Range = 0–20
Decimal places displayed = 0
Index Read 2
Numeric Dropdown
Required Field
Custom Entries
Presets
0
6
8
Range = 0–20
Decimal places displayed = 0
Library Tube Barcode
Text
Required Field
Output Folder
Text
Required Field
Override Cycles
Text
Paired End
Text Dropdown
Required Field
Presets
True
False
Read 1 Cycles
Numeric Dropdown
Required Field
Custom Entries
Range = 1–251
Decimal places displayed = 0
Presets
251
151
101
51
Read 2 Cycles
Numeric Dropdown
Required Field
Custom Entries
Range = 0–251
Decimal places displayed = 0
Presets
251
151
101
51
Run Mode
Text Dropdown
Read Only
Presets
SP
S1
S2
S4
Use Custom Index Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 1 Primer
Toggle Switch
Default
None Set
Use Custom Read 2 Primer
Toggle Switch
Default
None Set
Use Custom Recipe
Toggle Switch
Required Field
Default
No
Validation Script
Multiline Text
Required Field
Read Only
Default value provided in the drop-down section following the table.
Workflow
Text
Read Only
Default
GenerateFASTQ
Workflow Type
Text Dropdown
Required Field
Presets
No Index
Single Index
Dual Index
Custom
Property
Description
Default Value
spring.profiles.active
Tells the application that it is running deployed in Tomcat.
tomcat
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 (-).
- lotName: "Buffer" kitName: "Buffer Cartridge"
- lotName: "Cluster" kitName: "Cluster Cartridge"
- lotName: "SBS" kitName: "SBS Cartridge"
recipe.udfNames
Configures the names of the fields used in the run recipe. For more information, refer to the Run Recipe Contents section of NovaSeq 6000Dx Run.
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").
recipe.sampleSheet.outputName recipe.sampleSheet.notAvailableValue
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
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 Protocol 4: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
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
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 Protocol 4: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2).
run.autoComplete
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 Configure autoComplete Properties section.
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).
For more information, refer to Configuring autoComplete Properties.
true
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
Used in Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2) step only. Displays on Record Details screen and in the generated CSV file.
Value of 251 is only supported for SP flow cell type. For all other cell types, maximum value is 151.
Value of 251 is only supported for SP flow cell type. For all other cell types, maximum value is 151.
Not displayed in user interface
Do not remove this field as it is used by Validate Run Setup and Generate Sample Sheet automation script.
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
For calculation purposes, not displayed
Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151.
Value of 251 is only supported for SP flow cell type. For all other flow cell types, maximum value is 151.
Not displayed in user interface
Do not remove this field as it is used by Validate Run Setup and Generate Sample Sheet automation script.
Do not change
The name can differ in the NVOS request versus the Clarity LIMS configuration.