Clarity LIMS
Illumina Connected Software
Clarity LIMS Software
Clarity LIMS Software
  • Announcements
  • Clarity LIMS
    • Clarity & LabLink
  • API and Database
    • API Portal
      • REST
        • REST General Concepts
        • REST Web Services
        • HTTP Response Codes and Errors
        • XML UTF-8 Character Encoding
        • Requesting API Version Information
        • Viewing Paginated List Resources
        • Filtering List Resources
        • Working with User-Defined Fields (UDF) and Types (UDT)
        • Traversing a Genealogy
        • Working with Batch Resources
      • Getting Started with API
        • Understanding API Terminology (LIMS v5 and later)
        • API-Based URIs (LIMS v4 and later)
        • Development Prerequisites
        • Structure of REST Resources
        • The Life Cycle of a Sample: Stages Versus Steps
        • Integrating Scripts
      • Automation
        • Automation Triggers and Command Line Calls
        • Automation Execution Environment
        • Supported Command Line Interpreters
        • Automation Channels
        • Error Handling
        • Automation Tokens
          • Derived Sample Automation Tokens
          • Step Automation Tokens
          • Project Automation Tokens
        • Automation Testing
        • Troubleshooting Automation
      • Tips and Tricks
        • Accessing Step UDFs from a different Step
        • Obfuscating Sensitive Data in Scripts
        • Integrating Clarity LIMS with Upstream Sample Accessioning Systems
        • Creating Samples and Projects via the API
        • Displaying Files From an Earlier Step
        • Transitioning Output Artifacts into the Next Step
        • Determining the Workflow(s) to Which a Sample is Assigned
        • Standardizing Sample Naming via the API
        • Copying UDF Values from Source to Destination
        • Updating Preset Value of a Step UDF through API
        • Automating BCL Conversion
        • Finding QC Flags in Aggregate QC (Library Validation) via REST API
        • Setting the Value of a QC Flag on an Artifact
        • Creating Notifications When Files are Added via LabLink
        • Remote HTTP Filestore Setup
      • Cookbook
        • Get Started with the Cookbook
          • Tips and Troubleshooting
          • Obtain and Use the REST API Utility Classes
        • Work with EPP/Automation and Files
          • Automation Trigger Configuration
          • Process Execution with EPP/Automation Support
        • Work with Submitted Samples
          • Adding Samples to the System
          • Renaming Samples
          • Assigning Samples to Workflows
          • Updating Sample Information
          • Show the Relationship Between Samples and Analyte Artifacts (Derived Samples)
        • Work with Containers
          • Add an Empty Container to the System
          • Find the Contents of a Well Location in a Container
          • Filter Containers by Name
        • Work with Derived Sample Automations
          • Remove Samples from Workflows
          • Requeue Samples
          • Rearray Samples
        • Work with Process/Step Outputs
          • Update UDF/Custom Field Values for a Derived Sample Output
          • Rename Derived Samples Using the API
          • Find the Container Location of a Derived Sample
          • Traverse a Pooled and Demultiplexed Sample History/Genealogy
          • View the Inputs and Outputs of a Process/Step
        • Work with Projects and Accounts
          • Remove Information from a Project
          • Add a New Project to the System with UDF/Custom Field Value
          • Get a Project Name
          • Find an Account Registered in the System
          • Update Contact (User and Client) Information
        • Work with Multiplexing
          • Find the Index Sequence for a Reagent Label
          • Demultiplexing
          • Pool Samples with Reagent Labels
          • Apply Reagent Labels with REST
          • Apply Reagent Labels When Samples are Imported
          • Apply Reagent Labels by Adding Reagents to Samples
        • Working with User Defined Fields/Custom Fields
          • About UDFs/Custom Fields and UDTs
          • Performing Post-Step Calculations with Custom Fields/UDFs
        • Work with Processes/Steps
          • Filter Processes by Date and Type
          • Find Terminal Processes/Steps
          • Run a Process/Step
          • Update UDF/Custom Field Information for a Process/Step
          • Work with the Steps Pooling Endpoint
        • Work with Batch Resources
          • Introduction to Batch Resources
          • Update UDF/Custom Field Information with Batch Operations
          • Retrieve Multiple Entities with a Single API Interaction
          • Select the Optimal Batch Size
        • Work with Files
          • Attach a File with REST and Python
          • Attach Files Located Outside the Default File Storage Repository
          • Attach a File to a File Placeholder with REST
        • Work with Controls
          • Automated Removal of Controls from a Workflow
      • Application Examples
        • Python API Library (glsapiutil.py) Location
        • Scripts That Help Automate Steps
          • Route Artifacts Based Off a Template File
          • Invoking bcl2fastq from BCL Conversion and Demultiplexing Step
          • Email Notifications
          • Finishing the Current Step and Starting the Next
          • Adding Downstream Samples to Additional Workflows
          • Advancing/Completing a Protocol Step via the API
          • Setting a Default Next Action
          • Automatic Placement of Samples Based on Input Plate Map (Multiple Plates)
          • Automatic Placement of Samples Based on Input Plate Map
          • Publishing Files to LabLink
          • Automatic Pooling Based on a Sample UDF/Custom Field
          • Completing a Step Programmatically
          • Automatic Sample Placement into Existing Containers
          • Routing Output Artifacts to Specific Workflows/Stages
          • Creating Multiple Containers / Types for Placement
          • Starting a Protocol Step via the API
          • Setting Quality Control Flags
          • Applying Indexing Patterns to Containers Automatically
          • Assignment of Sample Next Steps Based On a UDF
          • Parsing Metadata into UDFs (BCL Conversion and Demultiplexing)
        • Scripts That Validate Step Contents
          • Validating Process/Step Level UDFs
          • Checking That Containers Are Named Appropriately
          • Checking for Index Clashes Based on Index Sequence
          • Validating Illumina TruSeq Index Adapter Combinations
        • Scripts Triggered Outside of Workflows/Steps
          • Repurposing a Process to Upload Indexes
          • Adding Users in Bulk
          • Moving Reagent Kits & Lots to New Clarity LIMS Server
          • Programatically Importing the Sample Submission Excel File
          • Generating an MS Excel Sample Submission Spreadsheet
          • Assigning Samples to New Workflows
        • Miscellaneous Scripts
          • Illumina LIMS Integration
          • Generating a Hierarchical Sample History
          • Protocol-based Permissions
          • Self-Incremental Counters
          • Generic CSV Parser Template (Python)
          • Renaming Samples to Add an Internal ID
          • Creating Custom Sample Sheets
          • Copying Output UDFs to Submitted Samples
          • Parsing Sequencing Meta-Data into Clarity LIMS
          • Submit to a Compute Cluster via PBS
          • Downloading a File and PDF Image Extraction
        • Resources and References
          • Understanding LIMS ID Prefixes
          • Container States
          • Useful Tools
          • Unsupported Artifact Types
          • Unsupported Process Types
          • Suggested Reading
          • API Training Videos
  • Illumina Preset Protocols
    • IPP v2.10
      • Release Notes
      • Installation and User Configuration
      • Manual Upgrade
    • IPP v2.9
      • Release Notes
      • Installation and User Configuration
    • IPP v2.8
      • Release Notes
      • Installation and User Configuration
      • Manual Upgrade
    • IPP v2.7
      • Release Notes
      • Installation and User Configuration
    • IPP v2.6
      • Release Notes
      • Installation and User Configuration
      • Manual Upgrade
  • Sample Prep
    • QC and Sample Prep
      • DNA Initial QC 5.1.2
      • RNA Initial QC 5.1.2
      • Library Validation QC 5.1.2
  • Library Prep
    • AmpliSeq for Illumina
      • BRCA Panel
        • Library Preparation v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Cancer HotSpot Panel v2
        • Library Preparation v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Childhood Cancer Panel
        • DNA Library Prep v1.1
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Comprehensive Cancer Panel
        • Library Preparation v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Comprehensive Panel v3
        • DNA Library Prep v1.1
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Custom DNA Panel
        • Library Preparation v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Focus Panel
        • DNA Library Prep v1.1
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Immune Repertoire Panel
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Immune Response Panel
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
      • Myeloid Panel
        • DNA Library Prep v1.1
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
      • TCR beta-SR Panel
        • DNA Library Prep v1.1
        • RNA Library Prep v1.1
      • Transcriptome Human Gene Expression Panel
        • RNA Library Prep v1.1
        • Equalizer v1.1
        • Standard v1.1
    • Library Prep Validation
    • Nextera
      • Nextera Mate Pair v1.0
      • Nextera Rapid Capture Custom Enrichment v2.0
      • Nextera XT v2.0
    • Targeted Enrichment
      • Illumina DNA Prep with Enrichment (S) Tagmentation v1.2
      • Illumina RNA Prep with Enrichment (L) Tagmentation v1.1
    • TruSeq
      • TruSeq ChIP-Seq v1.0
      • TruSeq Custom Amplicon v1.0
      • TruSeq DNA Exome v2.0
      • TruSeq DNA PCR-Free v2.0
      • TruSeq Methyl Capture EPIC v2.0
      • TruSeq Nano DNA v1.0
      • TruSeq RNA Access v2.0
      • TruSeq RNA Exome v1.0
      • TruSeq Small RNA v1.0
      • TruSeq Stranded mRNA v2.0
    • TruSight
      • TruSight Oncology 500 ctDNA v1.1
      • TruSight Oncology 500 HT v1.1
      • TruSight Oncology 500 v1.1
      • TruSight Tumor 170 v2.0
    • Other DNA Protocols
      • Illumina DNA PCR-Free Library Prep Manual v1.1
      • Illumina DNA Prep (M) Tagmentation v1.0
    • Other RNA Protocols
      • Illumina Stranded mRNA Prep Ligation 1.1
      • Illumina Stranded Total RNA Prep Ligation with Ribo-Zero Plus v1.1
  • iLASS & Infinium Arrays
    • iLASS
      • iLASS Infinium Genotyping v1.1
        • iLASS Infinium Batch DNA v1.1
        • iLASS Infinium Genotyping Assay v1.1
        • iLASS Infinium Genotyping with PGx Assay v1.1
      • iLASS Infinium Genotyping v1.0
        • iLASS Infinium Genotyping Assay v1.0
        • iLASS Infinium Genotyping with PGx Assay v1.0
    • Infinium Arrays
      • Infinium HD Methylation Assay Manual v1.2
      • Infinium HTS Assay Manual v1.2
      • Infinium LCG Assay Manual v1.2
      • Infinium XT Assay Manual v1.2
      • GenomeStudio v1.0
  • Applications
    • IGA
      • IGA v2.1
        • IGA Library Prep Automated v2.1
        • IGA NovaSeq Sequencing v2.1
    • Viral Pathogen Protocols
      • CDC COVID-19 RT-PCR
        • Sort Specimens to Extraction v1.1
        • Qiagen QIAamp DSP Viral RNA Mini Kit v1.1
        • Qiagen EZ1 Advanced XL v1.1
        • Roche MagNA Pure LC v1.1
        • Roche MagNA Pure Compact v1.1
        • Roche MagNA Pure 96 v1.1
        • bioMerieux NucliSENS easyMAG Instrument v1.1
        • bioMerieux EMAG Instrument v1.1
        • Real-Time RT-PCR Prep v1.1
      • Illumina COVIDSeq v1.6
      • Respiratory Virus Panel v1.0
  • Instruments & Integrations
    • Compatibility
    • Integration Properties
      • Integration Properties Details
    • Clarity LIMS Product Analytics
      • Supported Workflows
      • Workflow Customization
      • Clarity LIMS Product Analytics v1.4.0
        • Configuration
      • Clarity LIMS Product Analytics v1.3.1
        • Configuration
      • Clarity LIMS Product Analytics v1.3.0
        • Configuration
      • Clarity LIMS Product Analytics v1.2.0
        • Configuration
    • Illumina Run Manager
      • Illumina Run Manager v1.0.0
        • Installation and User Interaction
    • iScan
      • iScan System
      • iScan v1.2.0
        • Release Notes
        • BeadChip Accessioning, Imaging, and Analysis
      • iScan v1.1.0
        • Release Notes
        • BeadChip Accessioning, Imaging, and Analysis
      • iScan System v1.0
    • iSeq 100 Run Setup v1.0
    • MiniSeq v1.0
    • MiSeq
      • MiSeq v8.3.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
      • MiSeq v8.2.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
        • Manual Upgrade
    • MiSeq i100 (On-Prem)
      • MiSeq i100 On-Prem v1.0.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • MiSeq i100 (Hosted)
      • MiSeq i100 v1.0.0
        • Release Notes
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • MiSeqDx
      • MiSeqDx Sample Sheet Generation (v1.11.0 and later)
      • MiSeqDx v1.11.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
      • MiSeqDx v1.10.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
        • Sample Sheet Generation
        • Manual Upgrade
    • Next Generation Sequencing Package
      • Release Notes
        • NGS Extensions v5.25.0
        • NGS Extensions v5.24.0
        • NGS Extensions v5.23.0
      • Accession Kit Lots
      • Auto-Placement of Reagent Indexes
      • Compute Replicate Average
      • Copy UDFs
      • Initialize Artifact UDFs
      • Label Non-Labeled Outputs
      • Linear Regression Calculation
      • Normalization Buffer Volumes
      • Process Summary Report
      • Routing Script
      • Set UDF
      • Validate Complete Plate
      • Validate Sample Count
      • Validate Unique Indexes
    • NextSeq 500/550
      • NextSeq 500/550 v2.5.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
        • Manual Upgrade
      • NextSeq 500/550 v2.4.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
      • NextSeq 500/550 v2.3.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • NextSeq 1000/2000 (Hosted)
      • NextSeq 1000/2000 v2.5.1
        • Release Notes
      • NextSeq 1000/2000 v2.5.0
        • Release Notes
        • Configuration
        • User Interaction, Validation and Troubleshooting
        • Manual Upgrade
      • NextSeq 1000/2000 v2.4.0
        • Release Notes
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • NextSeq 1000/2000 (On-Prem)
      • NextSeq 1000/2000 On-Prem v1.0.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • NovaSeq 6000 (API-based)
      • NovaSeq 6000 API-based v3.7.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
      • NovaSeq 6000 API-based v3.6.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
        • Manual Upgrade
    • NovaSeq 6000 (File-based)
      • NovaSeq 6000 File-based v2.6.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
      • NovaSeq 6000 File-based v2.5.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • NovaSeq 6000Dx (API-based)
      • NovaSeq 6000Dx API-based v1.3.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
      • NovaSeq 6000Dx API-based v1.2.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • NovaSeq X Series (Hosted)
      • NovaSeq X Series v1.3.0
        • Release Notes
        • Configuration
        • Manual Upgrade
      • NovaSeq X Series v1.2.1
        • Release Notes
      • NovaSeq X Series v1.2.0
        • Release Notes
        • Configuration
        • User Interaction, Validation and Troubleshooting
        • Manual Upgrade
      • NovaSeq X Series v1.1.0
        • Release Notes
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • NovaSeq X Series (On-Prem)
      • NovaSeq X Series On-Prem v1.0.0
        • Release Notes
        • Installation
        • Configuration
        • User Interaction, Validation and Troubleshooting
    • References
      • Configure Multiple Identical netPathPrefixSearch Values
      • Configure Support for Samples Having Duplicate Names with Different Indexes
      • Illumina Instrument Sample Sheets
      • Terminology
  • Integration Toolkits
    • Lab Instrument Toolkit
      • Template File Generator
        • Creating Template Files
        • Template File Contents
        • Template File Generator Troubleshooting
      • Add Blank Lines
      • Convert CSV to Excel
      • Parse CSV
      • Name Matching XML Parser
      • Sample Placement Helper
    • Lab Logic Toolkit
      • Working with Lab Logic Toolkit
        • Data Collection Entities
        • Failing a Script
        • Mapping Field Types
        • Non-UDF/Custom Field Properties
        • Setting QC Flags
        • Setting Next Actions
        • Specifying Custom Fields
        • Working with Submitted Samples
        • Working with Containers
      • Lab Logic Toolkit Script Examples
        • Comparing Stop/Start Dates and Times with LLTK
      • Lab Logic Toolkit FAQ
  • Known Issues
    • Integration
      • Sample Sheet Generation Issue and CLPA Issues When Samples Have Been Assigned QC Flag Prior to Entering Steps
  • Security Bulletin
    • Investigation of OpenSSH vulnerability with Clarity LIMS
  • Resources
    • Third Party Software Information
  • Others
    • Revision History
Powered by GitBook
On this page
  • Prerequisites
  • Sequencer API RPM Installation Components
  • Sequencer API WAR
  • Configuration File
  • Configuration Scripts
  • Installation Steps
  • Workflows, Protocols, and Steps Installed
  • Library Prep Validation v2.3.4 Workflow
  • NovaSeqDx v1.2 Workflow
  • Instrument Software
  • Instrument Integration Configuration

Was this helpful?

Export as PDF
  1. Instruments & Integrations
  2. NovaSeq 6000Dx (API-based)
  3. NovaSeq 6000Dx API-based v1.3.0

Installation

PreviousRelease NotesNextConfiguration

Last updated 4 months ago

Was this helpful?

The Illumina NovaSeq 6000Dx Integration v1.3.0 supports the integration between Clarity LIMS and the NovaSeq 6000Dx instrument. The integration includes the following changes:

  • Compatibility with Oracle Linux. For compatibility, refer to .

  • Security fixes. This document provides instructions for installing NovaSeq 6000Dx Integration v1.3.0 and describes the components that are installed in the default configuration.

If the user is new to the NovaSeq 6000Dx integration, then follow the instructions provided in this section. If the user has installed NovaSeq 6000Dx Integration v1.1.0, then note that there are no user-facing changes in the configured workflow between NovaSeq 6000Dx Integration v1.1.0 and NovaSeq 6000Dx Integration v1.3.0. It is safe to use the existing NovaSeq 6000Dx v1.1 workflow installed with IPP v2.5.0 and reconfigure the integration for this workflow instead. For more information, refer to [Optional] Configure Properties in .

Prerequisites

Prerequisite 1: Secret Utility Configuration

If Clarity LIMS Secret Utility is not installed or configured, use the following information to configure Secret Utility:

Installation on a hosted system with Clarity LIMS (v6.3 or later)

The Clarity LIMS installation tooling configures this installation. No additional configuration is necessary.

Installation on an on-premise Clarity LIMS instance (v6.3 or later)

The installation requires the following passwords:

  • Tenant DB Password

  • Clarity DB Password

  • FTP password

  • LDAP manager password (if LDAP is enabled)

  • LabLink DB password

  • Reporting DB password (if installed)

  • RabbitMQ password

For more information on Secret Utility configuration, refer to the .

Prerequisite 2: Illumina Preset Protocols (IPP) v2.9

The Illumina NovaSeq 6000Dx Integration Package v1.3.0 depends on the configuration provided in Illumina Protocols (IPP) v2.9.

The installation procedure provided in this document includes steps that install the following IPP configurations on the server used for the NovaSeq 6000Dx integration installation:

  • QC Protocols Base configuration

  • NovaSeqDx configuration

  • Library Prep Validation configuration (optional, but recommended)

For details on IPP v2.9 installation and configuration, refer to the Illumina Preset Protocols documentation.

Prerequisite 3: Proxy Update (Illumina Cloud Hosted Installation Only)

The Illumina cloud hosted installation configures an additional include directive for /etc/httpd/conf.d/clarity.conf in the proxy configuration. Additional proxy configuration files for the Sequencer API service are expected to be placed in the /etc/httpd/conf.d/clarity folder.

Sequencer API RPM Installation Components

NovaSeq 6000Dx Integration v1.3.0 is distributed as the BaseSpaceLIMS-sequencer-api RPM package. This package must be installed on the Clarity LIMS server.

The BaseSpaceLIMS-sequencer-api RPM installs the following files and scripts:

  • Sequencer API WAR file

  • application.yml configuration file

  • configure_sequencer_api_proxy.sh configuration script

  • configure_sequencer_api_env.sh configuration script

  • configure_sequencer_api_application.sh configuration script

Sequencer API WAR

The RPM installs the Sequencer API WAR file into the same Tomcat container as Clarity LIMS. The WAR file is installed to the following location:

/opt/gls/clarity/tomcat/current/webapps/Illumina#Sequencer#v2##2.7.0.0.war

The version number can differ.

The WAR file is deployed automatically when Clarity LIMS launches. Because the RPM installs a new WAR file, Clarity LIMS is automatically stopped during installation of the RPM. Restart Clarity LIMS before installing the NovaSeq and Library Prep Validation workflow configuration from the IPP.

Configuration File

The application.yml configuration file is installed to the following location:

/opt/gls/clarity/extensions/sequencer-api/application.yml

The file properties are configured with a script during the installation process.

Configuration Scripts

The scripts in the following table are installed to the following location:

/opt/gls/clarity/config

During installation, the RPM runs these scripts as they are needed.

Script Name

User

Description

configure_sequencer_api_proxy.sh

root

  • Adds configuration to the proxy to allow communication with the Sequencer API after Tomcat has been started.

  • Run this script in the following scenarios:

    • When the Sequencer API is first installed.

    • When reconfiguring the Clarity LIMS proxy. This process happens until a version of Clarity LIMS that includes the necessary configuration files from /etc/httpd/clarity/*.conf is available.

ℹ Not required for Illumina cloud hosted installations.

configure_sequencer_api_env.sh

root

  • Adds Secret Management setting into the Clarity LIMS Tomcat configuration.

  • Run this script when the Sequencer API is first installed on a Secret Util-enabled Clarity LIMS.

configure_sequencer_api_application.sh

glsjboss

  • Configures the installed application.yml file.

  • Sets the Clarity LIMS URL and the key to use when signing access tokens.

âš  Run this script when the Sequencer API is first installed. If you run the script multiple times, the script reconfigures each setting to its default. The only exception is the signing key. For this setting, you are asked if you want a reset. If the reset is done, all previously issued tokens are no longer valid.

Installation Steps

[Optional] Install QC Protocols

If you are using PhiX control, install the base configuration of the QC Protocols from IPP as follows.

  1. Log in as the root user on the server being used to install the integration.

  2. Use the following yum command to install the IPP RPM:

    yum install BaseSpaceLIMS-Illumina-Preset-Protocols --enablerepo=<< repo name info from support >>

    The --enablerepo command-line argument must be included to enable the repo. The Illumina Support team can provide you with the repo file with the appropriate naming convention.

  3. Enter y to confirm that you want to proceed with the RPM and package installation.

  4. Make sure that NGS Extension Package v5.25.0 is installed.

    If this package is not installed, you must install it or upgrade the existing package.

  5. As the glsjboss user, install the QC_Protocols.qc-protocols configuration from the following location:

    /opt/gls/clarity/config/illumina-preset-protocols-installer.sh -o install QC_Protocols.qc-protocols

For information on IPP installer commands, parameters, and options, refer to the Illumina Preset Protocols documentation.

Install Sequencer API

Install the Sequencer API as follows.

  1. On the Clarity LIMS server, log in as the root user.

  2. Use the following yum command to install the RPM:

    yum install BaseSpaceLIMS-sequencer-api --enablerepo=< repo name info from support >

    The --enablerepo command-line argument must be included to enable the repository. The Illumina Support team can provide you with the repo file with the appropriate naming convention.

  3. Enter y to confirm that you want to proceed with the RPM installation.

  4. If necessary, install the Secret Utility Package.

  5. As the glsjboss user, run configure_sequencer_api_application.sh from the following location:

    bash /opt/gls/clarity/config/configure_sequencer_api_application.sh
  6. Enter values for the presented as follows.

    • Would you like to use the apiuser user for communication with Clarity? [Y]

    • Enter required value for Token Expiry (hours) [88]

  7. Update the Clarity LIMS proxy for the Sequencer API as follows.

    • For an on-premise system, run the following command:

      bash /opt/gls/clarity/config/configure_sequencer_api_proxy.sh
    • For an Illumina cloud hosted system, make sure that the proxy has been updated as follows. Place the sequencer-api.include file in /etc/httpd/conf.d/clarity.

      ProxyPass ajp://localhost:9009/Illumina/Sequencer/v2
      ProxyPassReverse ajp://localhost:9009/Illumina/Sequencer/v2
  8. Update the Clarity LIMS Tomcat configuration as follows.

    1. Make sure that Secret Utility is installed and configured. For more information, refer to Prerequisite 1: Secret Utility Configuration.

    2. Run the following command to add the Secret Utility configuration to Clarity LIMS:

      bash /opt/gls/clarity/config/configure_sequencer_api_env.sh

      ℹ This script modifies /opt/gls/clarity/tomcat/current/bin/setenv.sh for Clarity LIMS Tomcat to load the Secret Utility environment variable file (/etc/profile.d/claritysecret.sh) during startup.

    3. Use the following command to Start Clarity LIMS:

      /opt/gls/clarity/bin/run_clarity.sh start
Install NovaSeqDx and Library Prep Validation Workflow Configuration

Install the NovaSeqDx and Library Prep workflow configuration from IPP as follows.

  1. As the glsjboss user, run the following command to install the NovaSeq 6000Dx v1.2 workflow configuration:

    bash /opt/gls/clarity/config/illumina-preset-protocols-installer.sh -o install Illumina_Instruments.novaseqdx-v1.2

    ℹ The installer validates the import of the workflow and provides the Warning/Error details in STDOUT, which allows you to either proceed with the import or cancel it.

  2. [Optional] Run the following command to install the Library Prep Validation v2.3.4 workflow:

    /opt/gls/clarity/config/illumina-preset-protocols-installer.sh -o install Illumina_Instruments.Library-Prep-Validation-v2.3

    This step is optional, but recommended. The Library Prep Validation v2.3.4 workflow allows you to validate the NovaSeqDx v1.2 workflow.

Check Sequencer API

Make sure that the Sequencer API is working as follows.

  1. Visit https://<< Clarity LIMS URL >>/Illumina/Sequencer/v2/sequencing-run/login. This page returns the following URL string:

    https://<< Clarity LIMS URL >>/Illumina/Sequencer/v2/oauth/authorize?client_id=illumina_sequencer&redirect_uri=../sequencer_login&response_type=token
  2. Copy and paste the URL string into the browser. The Clarity LIMS Sign In page opens.

  3. Enter sign in credentials.

  4. Select Sign In. A Successfully Authenticated message displays.

[Optional] Configure Properties

Configuring integration-related properties is optional.

Workflows, Protocols, and Steps Installed

NovaSeq 6000Dx Integration v1.3.0 includes the following workflows, protocols, and steps listed below. These workflows can be found in IPP v2.9.

Library Prep Validation v2.3.4 Workflow

Protocol: Library Prep Validation v2.3.4

Steps:

  1. Library Prep Validation v2.3.4

NovaSeqDx v1.2 Workflow

Protocol 1: Run Format (NovaSeqDx v1.2)

Steps:

  1. Define Run Format (NovaSeqDx v1.2)

Protocol 2: NovaSeqDx Standard (NovaSeqDx v1.2)

Steps:

  1. Make Bulk Pool for NovaSeqDx Standard (NovaSeqDx v1.2)

  2. Dilute and Denature (NovaSeqDx v1.2)

Protocol 3: NovaSeqDx Xp (NovaSeqDx v1.2)

Steps:

  1. Make Bulk Pool for NovaSeqDx Xp (NovaSeqDx v1.2)

  2. Dilute, Denature & ExAmp (NovaSeqDx v1.2)

  3. Load to Flowcell (NovaSeqDx v1.2)

Protocol 4: AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)

Steps:

  1. AUTOMATED - NovaSeqDx Run (NovaSeqDx v1.2)

Instrument Software

The NovaSeq 6000Dx instrument software includes the following components:

  • NovaSeq 6000Dx Operating Software (NVOS) — Contains the user interface for setting up the sequencing run. Responsible for controlling the instrument and acquiring the images.

  • Real-Time Analysis v3 (RTA3) — Takes the images generated by the first module, processes, and analyzes them. Makes sure that data files are created and copied to the final destination folder.

  • Sequencing Analysis Viewer (SAV) — Displays the important quality metrics generated by the RTA3 software.

  • NovaSeq 6000Dx recipes — Provides system operation instructions for use with NovaSeq 6000Dx reagent kits for SP, S1, S2, and S4 flow cells.

  • Universal Copy Service — Copies output files to destinations such as final destination folder and/or BSSH (when the instrument is configured for use with BSSH).

Instrument Integration Configuration

For the NovaSeq 6000Dx API integration to work, the instrument must be able to communicate with Clarity LIMS through the API. Complete the following steps to configure the NVOS and confirm that you can access Clarity LIMS from the instrument.

  1. Launch NVOS and wait for the initialization process to complete.

  2. On the NVOS Instrument Settings page, do as follows.

    1. Select the Global Settings tab.

    2. Under Instrument Mode, select one of the following modes:

      • Allow users to switch between IVD and RUO

      • IVD Only

      • RUO Only

  3. If you selected IVD Only instrument mode, select the IVD Settings tab and complete the following steps:

    1. Configure Run Setup as follows.

      • Select the Select runs from the LIMS server option.

      • Enter the Clarity LIMS URL (e.g., https://yourserver.claritylims.com).

    2. [Optional] Under Output Location, enter the output folder location. You can also specify the output folder location when setting up a run in NVOS.

  4. If you selected RUO Only instrument mode, select the RUO Settings tab and complete the following steps:

    1. Configure Run Setup as follows.

      • Select the Select runs from the LIMS server option.

      • Enter the Clarity LIMS URL(e.g., https://yourserver.claritylims.com).

    2. Configure Default Work Type as follows.

      • [Optional] If selection support between NovaSeq Xp or NovaSeq Standard is required for the workflow, select the Enable workflow selection checkbox.

      • Select the required default workflow type: NovaSeq Standard or NovaSeq Xp.

    3. [Optional] Configure Output Location as follows.

      • [Optional] Enter the output folder location. You can also specify the output folder location when setting up a run in NVOS.

      • [Optional] To upload and store run data in the cloud server, select the BSSH checkbox. Select a Configuration option (Run Monitoring and Storage or Run Monitoring Only) and select your Hosting Location from the drop-down list.

  5. Select Save to complete the configuration.

  6. On the NVOS home page, you can now select Sequence to log into Clarity LIMS and start a run. nova

For a complete list of all properties included in the application.yml file and the properties installed into database, refer to .

If running the sequencing service and Automation Worker on the same instance, the instance must also be running a compatible version of the Oracle Linux operating system. For compatibility, refer to .

For more information on this package, refer to .

You can also press Enter to accept the default values in the application.yml configuration file. For more information about the application.yml properties, refer to .

For more information on the configurable integration properties that enable capture and generation of files associated with the sequencing run, refer to

For detailed descriptions of the steps and automations included in each protocol, and details on other components in the configuration, refer to .

For instructions on using the Library Prep Validation v2.3.4 protocol, refer to .

NovaSeq 6000Dx Integration v1.3.0 Release Notes
NovaSeq 6000Dx Integration v1.3.0 Configuration
NovaSeq 6000Dx Integration v1.3.0 User Interaction, Validation and Troubleshooting
NovaSeq 6000Dx Integration v1.3.0 Release Notes
Clarity LIMS (Clarity & LabLink Reference Guide) documentation
Installation Steps
Prerequisite 1: Secret Utility Configuration
Integration Properties Details
Integration Properties Details
Integration Properties Details