The Illumina Preset Protocols (IPP) v2.8 support the integration of Clarity LIMS with established lab protocols.
The integration provides preconfigured workflows that map to lab protocols and steps, and support Illumina library prep kits, reagent kits, assays, and instruments.
This guide provides instructions and describes the components installed in the default configuration of IPP.
IPP Integration v2.8 is distributed as the BaseSpaceLIMS-Illumina-Preset-Protocols RPM package. The RPM package installs the following components:
The illumina-preset-protocols-installer.sh script for configuration slices.
Templates for the following uses:
Sample sheet generation
Sample placement pattern
Covid testing setup and reporting
Illumina Genomics Architecture (IGA)
Automation scripts, including scripts to support IGA and Clarity LIMS Product Analytics (CLPA) automation.
Configuration slices.
Workflows for applicable instrument integrations.
IPP Integration v2.8 provides protocols that contain configuration slices. These configuration slices are used to install other workflows and protocols.
QC_Protocols configuration component contains the qc-protocols base slice. This configuration does not contain any workflows, but it does provide the following protocols that are used by other workflows:
DNA Initial QC
Library Validation QC
RNA Initial QC
The following table shows the components that are installed with the QC_Protocols configuration.
Components Installed with QC_Protocols
The following table shows the AmpliSeq_for_Illumina_Protocols configuration slices and the workflows that are installed with IPP Integration v2.8.
AmpliSeq_for_Illumina_Protocols Configuration Slices and Workflows
The following table shows additional configuration slices and workflows that are installed with IPP Integration v2.8.
Additional Configuration Slices and Workflows
The BaseSpaceLIMS-Ilumina-Preset-Protocols RPM package provides instructions for locating and running the /opt/gls/clarity/config/illumina-preset-protocols-installer.sh bash script that launches the IPP configuration installer.
The RPM package automatically installs template files that are used with Template File Generator (TFG) and Sample Placement Helper. These template files are accessible after the applicable configuration is installed. The files are installed at the following locations:
/opt/gls/clarity/extensions/conf/driverfiletemplates
/opt/gls/clarity/extensions/conf/infinium/placementpatterns
/opt/gls/clarity/extensions/conf/covid
The RPM package automatically installs the CLPA automation that is used for the CLPA integration. This automation is installed at the following location:
If this is a new Clarity LIMS installation, you must install the QC_Protocols before the preconfigured workflows. The base configuration is included in the standard installation process.
After you have selected a workflow, the installer validates the import of that workflow and provides Warning/Error details in STDOUT. This process allows you to proceed with the import or cancel it.
The IPP Integration v2.8 installer uses parameters and operations to assist with the configuration installation.
You must run the installer as the glsjboss user. The following table describes the parameters that are available for use with the installer.
IPP Installer Parameters
Run the installer with the list operation for a list of all configuration installation options in a two-column format. The first column shows the IPP workflow identifier (or Id) that the installer uses when running the install operation. The second column shows the name of the configuration associated with the identifier. As the glsjboss user, run the following command to view the list of IPP workflows:
Use the install operation to install the configuration slices. Specify both the name of the parent item and the name of the configuration slice, separated by a period, as follows:
For example, to install the qc-protocols slice, run the following command:
The all operation is a special option that is available at the top level and parent item level.
At the top level, use the operation to install every configuration package from IPP Integration v2.8. To use the all operation at this level, run the following command:
At the parent item level, use the operation to install the workflows associated with a specific parent item. For example, run the following command to install the workflows associated with the AmpliSeq_for_Illumina_Protocols parent item:
Headless mode allows the install operation to complete without prompting for input. Use this mode if you want to automate the installation. When running the installation in headless mode, the process still runs through the validation phase before importing the configuration. However, if a conflict is found, the configuration causing the conflict is skipped automatically.
The IPP installer validates the configuration import. If conflicts are found during the validation, a warning message displays. This message provides the following options:
f/Import anyway
s/Skip this workflow
a/Abort
The f/Import anyway option runs the import command of the config slicer tool. It also allows the tool to handle conflicts. This option does not run the config slicer tool in importAndOverwrite mode.
The s/Skip this workflow option does not import workflows where conflicts were found, but continues to import the other selected slices.
The a/Abort option aborts all import operations. The conflicts found are captured in the log files and can be reviewed.
The IPP installer tracks the installation process in the installhistory table and generates log files that can be reviewed after the installation is complete.
There are some expected conflicts when upgrading from IPP Integration v2.7.
In IPP v2.8, the on-premise NextSeq 1000/2000 is now supported and can cause a conflict with the Sequencing Instrument derived sample custom field. The following workflows can be affected:
Illumina DNA Prep (M) Tagmentation v1.0.7
Nextera Mate Pair v1.0.8
Nextera XT DNA v2.0.8
TruSeq DNA PCR-Free v2.0.8
TruSeq Nano DNA v1.0.8
Library Prep Validation v2.3.2
TruSeq ChIP-Seq v1.0.8
TruSeq Methyl Capture EPIC v2.0.9
TruSeq Small RNA v1.0.8
TruSeq Stranded mRNA v2.1.8
TruSeq Custom Amplicon (TSCA) v1.0.8
Nextera Rapid Capture Custom Enrichment v2.0.9
TruSeq DNA Exome v2.0.8
TruSeq RNA Exome v1.0.5
TruSeq RNA Access v2.0.8
TruSight Tumor 170 v2.0.8
To resolve these conflicts, perform the following actions:
When the expected conflicts are encountered during the IPP workflow installation, enter f to import the workflow when prompted. An example of the prompt is as follows.
After the workflow is installed, resolve the conflicts as follows.
From Configuration, select the Custom Fields tab, and then select the Global Fields tab.
Search for Sequencing Instrument.
For Additional Options, add NextSeq 1000/2000 On-Prem to the Dropdown Items list.
There is no all option available for QC_Protocols and Targeted_Amplicon_Protocols as they each contain only one configuration slice. Including all in the install command for these items generates an error.
Component
Items Installed
Protocols
DNA Initial QC 5.1.2
Library Validation QC 5.1.2
RNA Initial QC 5.1.2
Master Steps
Add Multiple Reagents
Adenylate ends & Ligate Adapters (TruSeq DNA) 5.1
Pool Samples
Aggregate QC (DNA) 5.1.2
Aggregate QC (Library Validation) 5.1.2
Aggregate QC (RNA) 5.1.2
Bioanalyzer QC (DNA) 5.1.2
Bioanalyzer QC (RNA) 5.1.2
CaliperGX QC 5.1.2
NanoDrop QC (DNA) 5.1.2
NanoDrop QC (RNA) 5.1.2
PicoGreen QC (DNA) 5.1.2
PicoGreen QC (RNA) 5.1.2
Qubit QC (DNA) 5.1.2
Qubit QC (RNA) 5.1.2
Tapestation QC (DNA) 5.1.2
Tapestation QC (RNA) 5.1.2
qPCR QC 5.1.2
Container types
384 well plate
96 well plate
BioAnalyzer DNA 1000 Chip
BioAnalyzer DNA High Sensitivity Chip
BioAnalyzer RNA Nano Chip
BioAnalyzer RNA Pico Chip
Tube
Label groups/reagent categories
TruSeq Custom Amplicon Adapters (A7-A5)
TruSeq DNA LT Adapters (AD series)
TruSeq Stranded mRNA LT Adapters (AR series)
TruSeq HT Adapters (D7-D5)
Nextera Enrichment & Rapid Capture Adapters (N7-E5)
Nextera DNA Adapters (N7-N5, S7-S5)
NoIndex
TruSeq Small RNA Adapters (RPI series)
Reagent kits
TruSeq DNA PCR-Free Kit - Adapter Plate Box
TruSeq DNA PCR-Free Kit - Core Reagents Box
TruSeq DNA PCR-Free Kit - SP Beads Box
Controls
Endogenous Positive Control
Exogenous Positive Control
No Amplification Control
No Reverse Transcriptase Control
No Template Control
PhiX v3
Sample custom fields
Application
Pooling
Progress
Reference Genome
Sample Buffer
Sample Conc.
Units
Volume (ul)
Read Length
Sample Type
Sequencing Coverage
Sequencing Method
Container custom fields
Container Name
LIMS ID (Container)
Well
Project custom fields
Project Name
Derived sample custom fields
A260/280 ratio
Conc. Units
Concentration
Sample Name
Waiting
Workflow
Measurement custom fields
28s/18s ratio
A260
A260/230 ratio
A260/280 ratio
BA Sample Name
Conc. Units
Concentration
MW Units
Molarity Units
Number of Peaks found
Number of Regions found
Peak 1% Integrated Area
Peak 1 Conc.
Peak 1 MW
Peak 1 Molarity
Peak 1 Size - bp
Peak 2% Integrated Area
Peak 2 Conc.
Peak 2 MW
Peak 2 Molarity
Peak 2 Size - bp
Peak 3% Integrated Area
Peak 3 Conc.
Peak 3 MW
Peak 3 Molarity
Peak 3 Size - bp
Peak 4% Integrated Area
Peak 4 Conc.
Peak 4 MW
Peak 4 Molarity
Peak 4 Size - bp
Peak 5% Integrated Area
Peak 5 Conc.
Peak 5 MW
Peak 5 Molarity
Peak 5 Size - bp
RIN
RNA Area
Region 1% of Total
Region 1 Average Size - bp
Region 1 Conc.
Region 1 Molarity
Region 2% of Total
Region 2 Average Size - bp
Region 2 Conc.
Region 2 Molarity
Region 3% of Total
Region 3 Average Size - bp
Region 3 Conc.
Region 3 Molarity
Region 4% of Total
Region 4 Average Size - bp
Region 4 Conc.
Region 4 Molarity
Region 5% of Total
Region 5 Average Size - bp
Region 5 Conc.
Region 5 Molarity
Sample Comment
Size (bp)
Configuration Slice
Workflows
AmpliSeq-Illumina-BRCA-Panel-v1.1
Equalizer Workflow AmpliSeq for Illumina BRCA Panel v1.1
Library Prep AmpliSeq for Illumina BRCA Panel v1.1
Standard Workflow AmpliSeq for Illumina BRCA Panel v1.1
AmpliSeq-Illumina-Cancer-HotSpot-Panel-V2-v1.1
Library Prep AmpliSeq for Illumina Cancer HotSpot Panel V2 v1.1
Standard Workflow AmpliSeq for Illumina Cancer HotSpot Panel V2 v1.1
AmpliSeq-Illumina-Childhood-Cancer-Panel-v1.1
DNA Library Prep AmpliSeq for Illumina Childhood Cancer Panel v1.1
Equalizer Workflow AmpliSeq for Illumina Childhood Cancer Panel v1.1
RNA Library Prep AmpliSeq for Illumina Childhood Cancer Panel v1.1
Standard Workflow AmpliSeq for Illumina Childhood Cancer Panel v1.1
AmpliSeq-Illumina-Comprehensive-Cancer-Panel-v1.1
Equalizer Workflow AmpliSeq for Illumina Comprehensive Cancer Panel v1.1
Library Prep AmpliSeq for Illumina Comprehensive Cancer Panel v1.1
Standard Workflow AmpliSeq for Illumina Comprehensive Cancer Panel v1.1
AmpliSeq-Illumina-Comprehensive-Panel-v3-v1.1
DNA Library Prep AmpliSeq for Illumina Comprehensive Panel v3 v1.1
Equalizer Workflow AmpliSeq for Illumina Comprehensive Panel v3 v1.1
RNA Library Prep AmpliSeq for Illumina Comprehensive Panel v3 v1.1
Standard Workflow AmpliSeq for Illumina Comprehensive Panel v3 v1.1
AmpliSeq-Illumina-Custom-DNA-Panel-v1.1
Equalizer Workflow AmpliSeq for Illumina Custom DNA Panel v1.1
Library Prep AmpliSeq for Illumina Custom DNA Panel v1.1
Standard Workflow AmpliSeq for Illumina Custom DNA Panel v1.1
AmpliSeq-Illumina-Focus-Panel-v1.1
DNA Library Prep AmpliSeq for Illumina Focus Panel v1.1
Equalizer AmpliSeq for Illumina Focus Panel v1.1
RNA Library Prep AmpliSeq for Focus Panel v1.1
Standard Workflow AmpliSeq for Illumina Focus Panel v1.1
AmpliSeq-Illumina-Immune-Repertoire-Panel-v1.1
Equalizer AmpliSeq for Illumina Immune Repertoire Panel v1.1
RNA Library Prep AmpliSeq for Illumina Immune Repertoire Panel v1.1
Standard Workflow AmpliSeq for Illumina Immune Response Panel v1.1
AmpliSeq-Illumina-Immune-Response-Panel-v1.1
Equalizer Workflow AmpliSeq for Illumina Immune Response Panel v1.1
RNA Library Prep AmpliSeq for Illumina Immune Response Panel v1.1
Standard Workflow AmpliSeq for Illumina Immune Response Panel v1.1
AmpliSeq-Illumina-Myeloid-Panel-v1.1
DNA Library Prep AmpliSeq for Illumina Myeloid Panel v1.1
Equalizer Workflow AmpliSeq for Illumina Myeloid Panel v1.1
RNA Library Prep AmpliSeq for Illumina Myeloid Panel v1.1
Standard Workflow AmpliSeq for Illumina Myeloid Panel v1.1
AmpliSeq-Illumina-TCR-beta-SR-Panel-v1.1
DNA Library Prep AmpliSeq for Illumina TCR beta-SR Panel v1.1
RNA Library Prep AmpliSeq for Illumina TCR beta-SR Panel v1.1
AmpliSeq-Illumina-Transcriptome-Human-Gene-Expression-Panel-v1.1
Equalizer Workflow AmpliSeq for Illumina Transcriptome Human Gene Expression Panel v1.1
RNA Library Prep AmpliSeq for Illumina Transcriptome Human Gene Expression Panel v1.1
Standard Workflow AmpliSeq for Illumina Transcriptome Human Gene Expression Panel v1.1
Parameter
Description
Example Command
--operation, -o
Specifies the run mode for the installer. Supported modes are as follows:
help
list
install
--headless, -h
Run the installer in headless mode. Used for the install operation only.
--log, -l
Sets the log file name and destination. The default value is ipp-installer.log.
Configuration Slice
Workflows
Covid
CDC COVID-19 RT PCR v1.1
Qiagen EZ1 Advanced XL CDC COVID-19 RT-PCR v1.1
Qiagen QIAamp DSP Viral RNA Mini Kit CDC COVID-19 RT-PCR v1.1
Roche MagNA Pure 96 CDC COVID-19 RT-PCR v1.1
Roche MagNA Pure Compact CDC COVID-19 RT-PCR v1.1
Roche MagNA Pure LC CDC COVID-19 RT-PCR v1.1
Sort Specimens to Extraction CDC COVID-19 RT-PCR v1.1
bioMerieux EMAG Instrument CDC COVID-19 RT-PCR v1.1
bioMerieux NucliSENS easyMAG Instrument CDC COVID-19 RT-PCR v1.1
Illumina COVIDSeq Workflow v1.6
Respiratory Virus Panel v1.0
DNA_Protocols
ILASS TruSight Whole Genome Assay v1.2
Illumina DNA PCR-Free Library Prep Manual v1.0.3
Illumina DNA Prep (M) Tagmentation v1.0.8
Nextera Mate Pair v1.0.9
Nextera XT DNA v2.0.9
TruSeq DNA PCR-Free v2.0.9
TruSeq Nano DNA v1.0.9
IGA
Illumina Genomics Architecture - Library Prep Automated v2.1
Sample Selection (IGA v2.1)
Sample Plating (IGA v2.1)
Blood Extraction (IGA v2.1)
Saliva Extraction (IGA v2.1)
Illumina DNA PCR-Free (IGA v2.1)
Illumina DNA with Enrichment (IGA v2.1)
Sequencing Platform Selection (IGA v2.1)
Illumina Genomics Architecture - NovaSeq Sequencing v2.1
Run Format (IGA v2.1)
NovaSeq Standard (IGA v2.1)
NovaSeq Xp (IGA v2.1)
AUTOMATED - NovaSeq Run (IGA v2.1)
Infinium_Array
GenomeStudio v1.0
ILASS Infinium Genotyping Assay v1.0
ILASS Infinium Genotyping with PGx v1.0
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
Methylation_Protocols
TruSeq ChIP-Seq v1.0.9
TruSeq Methyl Capture EPIC v2.0.10
RNA_Protocols
Illumina Stranded mRNA Prep Ligation v1.1
Illumina Stranded Total RNA Prep Ligation with Ribo-Zero Plus v1.1
TruSeq Small RNA v1.0.9
TruSeq Stranded mRNA v2.1.9
Targeted_Amplicon_Protocols
TruSeq Custom Amplicon v1.0.9
Targeted_Enrichment_Protocols
Illumina DNA Prep with Enrichment (S) Tagmentation v1.2
Illumina RNA Prep with Enrichment (L) Tagmentation v1.1
Nextera Rapid Capture Custom Enrichment v2.0.10
TruSeq DNA Exome v2.0.9
TruSeq RNA
TruSeq RNA Access v2.0.9
TruSeq RNA Exome v1.0.5
TruSight_Oncology_Protocols
TruSight Oncology 500 ctDNA v1.1
TruSight Oncology 500 HT v1.1
TruSight Oncology 500 v1.1
TruSight Tumor 170 v2.0.9
IGA workflows require additional installation steps. For assistance, contact Illumina Technical Support. Note also that Illumina Genomics Architecture - NovaSeq Sequencing v2.1 workflow is not the same workflow as NovaSeq 6000 v3.8.