IPP Integration v2.5 Package Installation

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:

The RPM package automatically installs the Clarity LIMS Product Analytics automation that is used for Clarity LIMS Product Analytics integration. This automation is installed at the following location:

/opt/gls/clarity/extensions/unified-product-analytics/automation.

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.

Prerequisites

Before installing the RPM package, make sure that the following software is installed:

•

Clarity LIMS v5.1, v5.2, v5.3, v5.4 or v6.x

•

NGS-Package v5.22 or later

•

SecretUtil v1.2 (installed and configured). For more information, refer to Secret Util Configuration.

Secret Util Configuration

IPP Integration v2.5 requires that Clarity LIMS Secret Util is installed and configured.

If Clarity LIMS Secret Util is not installed or configured, configure Secret Util as follows.

•

Illumina cloud hosted system with Clarity LIMS v5.4 or later: The Clarity LIMS installation tooling configures this installation. No additional configuration is necessary.

•

Installation on Clarity LIMS v5.3 or earlier. The installation includes the following:

–

Tenant DB Password

–

Clarity DB Password

–

FTP password

–

LDAP manager password (if LDAP is enabled)

–

LabLink database password (for Clarity LIMS v5.3 LabLink only)

–

Reporting database password (if Clarity LIMS Reporting is installed)

–

RabbitMQ password

For details on Secret Utility configuration and modes, refer to Guide to Secret Management in the Clarity LIMS Core Functionality documentation.

RPM Installation

1.

On the server used for the IPP RPM installation, log in as the root user.

2.

Use the yum command to install the RPM. The command line is as follows.

The --enablerepo piece of the command line must be included to enable the repo. The Illumina Support team provides the repo file and the appropriate name to use.

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

3.

When you are prompted to proceed with the RPM package installation, enter y to confirm.

For information on running the installer and supported commands, parameters, and options, refer to Installer Parameters and Operations.