LogoLogo
Illumina KnowledgeIllumina SupportSign In
Clarity LIMS Software
  • Home
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
  • Compatibility
  • Prerequisites
  • Installation
  • Install the RPM
  • Configure the Integration Properties
  • Start the Sequencing Service
  • Workflows, Protocols, and Steps Installed
  • Instrument Software
  • Instrument Integration
  • Validation

Was this helpful?

Export as PDF
  1. Instruments & Integrations
  2. MiSeq
  3. MiSeq v8.3.0

Installation

PreviousRelease NotesNextConfiguration

Last updated 4 months ago

Was this helpful?

The Illumina MiSeq Integration Package v8.3.0 supports the integration of Clarity LIMS to MiSeq instruments.

MiSeq Integration v8.3.0 runs as independent service and can be on the same server as other Clarity LIMS integrations. The integration is only required for MCS v4.0. If you are running MCS v3.0 or below, do not upgrade to this integration.

Compatibility

MiSeq Integration v8.3.0 is compatible with the following software:

  • Clarity LIMS v6.2.0 and later

  • Secret Util v1.0 and later

  • IPP v2.9 and later

  • MCS v4.0/LRM v3.0 and later

  • Oracle Linux (for compatibility, refer to )

Prerequisites

MiSeq Integration v8.3.0 has the following prerequisites:

  • Mount run data network-attached storage (NAS) share

  • IPP is installed

Prerequisite 1: Mount Run Data NAS Share

Mounting the NAS share of run data are needed to capture and generate files associated with the sequencing run. To mount NAS shares that contain data from the Clarity LIMS server, use Read/Write privileges as the glsjboss user. The following data can be mounted to the NAS share:

  • Run data (e.g., \\network-storage\run_data)

  • Clarity LIMS-created events triggered by the End Run event of the Illumina sequencing run (e.g., \\network-storage\illumina\gls_events)

With Read access, the Clarity LIMS server reads the following information in individual sequencing run data folders:

  • Run information metadata from these files

    <runFolderRoot>/RunInfo.xml
    <runFolderRoot>/runParameters.xml
  • Run statistics from

    <runFolderRoot>/InterOp/*.bin

The Clarity LIMS server generates the following files and information locally and stores them in Clarity LIMS:

  • Sample sheet (CSV file)

  • Run report (PDF file)

  • Run folder root link

The Clarity LIMS server copies and stores the following files from individual sequencing run data folders in Clarity LIMS:

<runFolderRoot>/RunInfo.xml
<runFolderRoot>/runParameters.xml
Prerequisite 2: IPP Installation

MiSeq Integration Package v8.3.0 depends on the QC Protocols configuration provided in IPP (v2.6 and later) for Clarity LIMS v6.2 and later.

If the base configuration is not installed, then install it on the Clarity LIMS server that is being used for the MiSeq integration. For details on IPP installation and configuration, refer to the Illumina Preset Protocols documentation.

If you are upgrading the base configuration, make sure that the IPP package is compatible with the version of Clarity LIMS you are installing.

If you do not have QC Protocols, then install them as follows.

  1. As a glsjboss user, run the following command to view the complete list of IPP workflows:

    /opt/gls/clarity/config/illumina-preset-protocols-installer.sh -o list
  2. To install the dependent QC Protocols, run the following command:

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

Installation

MiSeq Integration v8.3.0 is distributed as the ClarityLIMS-Illumina-MiSeq-Package-v8 RPM package that must be installed on the Clarity LIMS server. This package installs the following items:

  • Bash scripts used to run the service

  • The miseq-sequencing.jar file

  • The configure_extensions_miseq_sequencingservice.sh script

  • Smoke test directories

The following installation steps are required for the installation of MiSeq Integration v8.3.0.

The MiSeq RPM must be installed on the Clarity LIMS server. This is the same location where the AI node or Automation Worker is installed. The automations and sequencing service use the existing Automation Worker.

Install the RPM

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

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

    ℹ You must use the --enablerepo command line argument to enable the repo. For the repo file and the correct name to use, contact Illumina Support.

    yum install ClarityLIMS-Illumina-MiSeq-Package-v8 --enablerepo=< repo name info from support >
  3. Enter y to confirm that you want to proceed with the RPM installation.

    After confirmation, you are prompted to install the MiSeq workflow from the IPP script.

  4. Install the MiSeq workflow as follows.

    1. As the glsjboss user, run the following command to view the complete list of IPP workflows:

      /opt/gls/clarity/config/illumina-preset-protocols-installer.sh -o list
    2. Run the following command to install the MiSeq Sequencing v3.2 workflow configuration:

      /opt/gls/clarity/config/illumina-preset-protocols-installer.sh -o install Illumina_Instruments.miseq-v3.2

      The installer does the following tasks:

      • Validates the import of the workflow and provides the Warning/Error details in STDOUT, which allows you proceed with the import or cancel it.

      • Automatically detects the version of Clarity LIMS and imports the applicable workflow configuration.

      • Creates or updates the miseq.v8.seqservice.sequenceProcessBaseName database property, which can be verified with the omxProps-ConfigTool utility. This property shows the sequencing master step base display name. It can also use partial matching to look up the master step by the sequencing service. The default value is MiSeq Run (MiSeq v3.2).

    3. [Optional] Run the following command to install the Library Prep Validation v2.3.4 workflow that is used to validate the MiSeq Sequencing v3.2 workflow:

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

      The installer does the following tasks:

      • Validates the import of the workflow and provides the Warning/Error details in STDOUT, which allows you proceed with the import or cancel it.

      • Automatically detects the version of Clarity LIMS and imports the applicable workflow configuration.

  5. Run the following script to configure the service properties:

    /opt/gls/clarity/config/configure_extensions_miseq_sequencingservice-v8.sh

Configure the Integration Properties

Start the Sequencing Service

Run the following command to start the sequencing service:

systemctl start miseq_seqservice-v8

Workflows, Protocols, and Steps Installed

MiSeq Integration v8.3.0 works with the MiSeq Sequencing v3.2, which contains a single protocol with the same name. This protocol includes the following steps:

  • Library Pooling (MiSeq v3.2)

  • Denature and Dilute (MiSeq v3.2)

  • MiSeq Run (MiSeq v3.2)

Instrument Software

The MiSeq Control Software (MCS) is divided into the following modules:

  • MCS — Controls the instrument operation, including various configuration settings. This software is installed and runs on the instrument.

  • Local Run Manager — Analyzes sequencing data and integrates with MCS. This software can be accessed on the instrument through a web browser.

  • Real-Time Analysis (RTA) — Performs image processing and base calling (primary analysis). The software makes sure that data files are created and copied to the final destination folder and is installed and runs on the instrument.

Instrument Integration

The instrument integration must be performed and maintained by Illumina Support. Illumina Support requires remote access to the instrument while it is idle.

The support team has created batch files that use custom scripts during the key events of a sequencing run. When these batch files are used, they read the event information and write it in a TXT event file at the same network share location that the instrument uses to write the run data. Another process running on the Clarity LIMS server receives the event files and takes the appropriate actions.

The sequencing service monitors the end of the run event. This event is used to capture key step data and files and parse run statistics for output custom fields.

Configure Batch Files

When the instrument is running, the final destination for the run data are a network storage path. The software is configured with a network storage path root (e.g., \\network-storage\illumina). Each sequencing run generates a unique run ID, which is appended to create a unique data run directory (e.g., \\network-storage\illumina\110419_InstrumentName_0001_ARG1234567).

The Clarity LIMS batch files must be configured to write to a directory within the network storage path root. This directory is typically named gls_events, but the directory name can be different as long as no spaces are used. The batch file used for MiSeq Control Software v4.0 is gls_event_mcs_rta_lrm.bat.

Before configuring the batch files, do the following:

  1. Back up the MiSeq.Configuration.xml configuration file to

    C:\Illumina\RTA\Configs\
  2. Make sure that the instrument is idle.

  3. Shut down MiSeq Control Software.

  4. Set up the directory structure as follows.

    1. Create a directory (C:\Illumina\gls is recommended) on the local PC to hold the batch file.

      âš  For Windows 10, the folder must be under C:\Illumina instead of C:\Illumina\gls because of Windows software restriction policies. If the folder is not in that directory, the batch script does not run. For versions before Windows 10, C:\Illumina\gls is acceptable.

    2. Create a directory (e.g., gls_events) on the NAS to hold the event files.

Configure the batch files as follows

  1. Determine the site or instrument specific network storage path root.

  2. Make the following changes to the gls_event_mcs_rta_lrm.bat batch file:

    ℹ Make sure to include a trailing \ in the DESTINATION_PATH and DEFAULT_LOCAL_OUTPUT_PATH lines. Refer to the following examples:

    set DESTINATION_PATH=\\network-storage\illumina\gls_events\
    set DEFAULT_LOCAL_OUTPUT_PATH=D:\Illumina\MiSeqTemp\
    1. Change the DESTINATION_PATH line to the name of the event file directory.

    2. Change the DEFAULT_LOCAL_OUTPUT_PATH line to the name of the default local temp run folder directory.

      The default directory is

      D:\Illumina\MiSeqTemp\
  3. Copy the DESTINATION_PATH and paste it into the Windows Explorer address bar.

  4. Make sure that the network location is accessible and that it opens from the instrument.

    The batch file must be deployed to the MiSeq instrument. This file must be deployed to its own directory (C:\Illumina\gls\ is recommended) on the instrument computer so that it is not overwritten or removed during an instrument software update.

Deploy the batch file as follows

  1. From the Attachment section, download the batch file.

  2. Copy the file to the directory that you created on the instrument computer (e.g., C:\Illumina\gls).

  3. From the Command Prompt, run the following command to list the contents of the directory:

    dir C:\Illumina\gls\
  4. Make sure that the name of the batch file does not contain any special or hidden characters.

Connect Batch Files to Instrument Events

Update the MiSeq Control Software configuration files as follows

  1. Reboot the instrument.

  2. Make a backup copy of the RTA configuration XML file and name it MiSeq.Configuration.xml.

  3. Edit the file to connect to the RTA End Run event as follows.

    1. Open the MiSeq.Configuration.xml file at

      C:\Illumina\RTA\Configs\
    2. Update the following content within the <ProcessCompleteEventFile> tags:

      <ProcessCompleteEventFile>C:\Illumina\gls\gls_event_mcs_rta_lrm.bat</ProcessCompleteEventFile>
  4. Save the edited file.

  5. Validate the file as follows.

    1. From C:\Illumina\RTA, create a backup of the RTA.exe.config file and name it Backup_RTA.exe.config.

    2. Open RTA.exe.config and change the DefaultConfigFile value to MiSeq.Configuration.xml.

    1. Save the changes and close the file.

    2. From the Command Prompt, run the following command:

      C:\Illumina\RTA\RTA.exe "." processedfolder="."
    3. If the validation is successful, a warning message displays that says the output path cannot be placed into the run directory. Select OK.

    1. In the Command Prompt, make sure the following error message displays:

      RunInfo.xml does not exist: System.ApplicationException: Error in the application.,0,0
    1. Press Ctrl + C to terminate the RTA.exe application that is still running.

      If the configuration file has an error, the command returns specifics about the problem. Refer to the following example:

  6. After the validation is complete, go back to C:\Illumina\RTA and delete the current RTA.exe.config file.

    âš  Make sure that you rename the backup file. If you do not rename the file, it can cause the RTA not to work properly.

  7. Restore the backup file from a by renaming it RTA.exe.config.

  8. Start MiSeq Control Software.

  9. Open the MiSeq.Configuration.xml file and make sure that the changes were saved.

Validation

Sample Sheet Generation
Manual Invocation of Event Files

The manual invocation of an event file produces an output that contains the following information:

  • File name (e.g., event-EndRun-07295667.txt)

  • cycleNumber (e.g., 318)

  • runFolder (e.g., "D:\Illumina\MiSeqTemp\230815_M99999_0028_FC1234567-ABCDE")

  • netFolder (e.g., \\network-folder\Run_Data\230815_M99999_0028_FC1234567-ABCDE)

  • readType (e.g., 4)

  • eventType (e.g., EndRun)

  • softwareType (e.g., MCS)

  • finishDate (e.g., 2023-08-15)

If an event file is triggered automatically during a MiSeq run, then the completion event does not appear until the run has completed and RTA completes primary analysis.

Instrument Sequencing Run

The instrument sequencing run test validates that the Clarity LIMS batch file is connected properly and invoked on the instrument events. Before validating the batch file, make sure that the following prerequisites are met:

  • You have access to the NAS share.

  • The default configuration has been successfully imported.

  • Manual invocation of the event files has been validated. This validation checks for the following information:

    • The DESTINATION_PATH and DEFAULT_LOCAL_OUTPUT_PATH are configured correctly.

    • The instrument computer can access and write to the DESTINATION_PATH.

    • There are no syntax errors in the Clarity LIMS batch script.

The sequencing service processes and archives event files, which can cause validation issues while the service is running. You can make the following changes to avoid losing the event files that you are attempting to validate:

  • Modify the FINAL_EXTENSION value in the Clarity LIMS batch file so that the file extension is .test instead of .txt. The service only processes and archives TXT files. Make sure that you change FINAL_EXTENSION back to .txt after manual validation.

  • Monitor the MiSeqIntegrator.log file, which logs the file name and contents of each event file that is processed. The log file is at

    /opt/gls/clarity/extensions/Illumina_MiSeq/v8/SequencingService

Validate the sequencing run as follows

  1. During the run, monitor the contents of the gls_events directory.

  2. After the run is completed and the RTA completes primary analysis, make sure that a final EndRun event displays (e.g., event-EndRun-11043279.txt).

ℹ The following steps assume that the QC protocols from the IPP package have been installed. For more information, refer to Prerequisite 2: IPP Installation in .

The script creates the configuration properties in the database. For a list of the configured 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 descriptions of the protocol and the steps, refer to . For instructions on using the Library Prep Validation v2.3.4 workflow to validate the automated sample sheet generation, refer to .

For more information on MCS, refer to the MiSeq documentation at .

For instructions on how to validate the automated sample sheet generation, refer to .

For instructions on validating the creation of event files, refer to .

For more information on event file validation, refer to .

MiSeq Integration v8.3.0 Release Notes
MiSeq Integration v8.3.0 Configuration
MiSeq Integration v8.3.0 User Interaction, Validation and Troubleshooting
support.illumina.com
MiSeq Integration v8.3.0 User Interaction, Validation and Troubleshooting
MiSeq Integration v8.3.0 User Interaction, Validation and Troubleshooting
MiSeq Integration v8.3.0 User Interaction, Validation and Troubleshooting
Prerequisites
Integration Properties Details
Integration Properties Details