# Installation

The Illumina MiSeq i100 Series On-Prem Integration Package v1.1.0 supports the integration of Clarity LIMS to MiSeq i100 Series instruments that are on-premise via Illumina Run Manager.

## **Prerequisites**

<details>

<summary>Prerequisite 1: Clarity LIMS v6.2 or later with SecretUtil v1.5.0.12 or later</summary>

The MiSeq i100 Series On-Prem integration v1.1.0 relies on secret management util version 1.5.0.12 or later to store the access token to Illumina Run Manager and its related secrets.

> ℹ If using Vault, ensure that the appropriate ACL policies are added. Refer to Authentication ACL Policies under On-Premise Deployments > Configure Your HashiCorp Vault in [Clarity LIMS (Clarity & LabLink Reference Guide) documentation](broken://pages/uuLbwpVZQxsGtVStdfOD).

</details>

<details>

<summary>Prerequisite 2: Illumina Run Manager Integration Service v1.1.0 or later</summary>

Illumina Run Manager Integration Service v1.1.0 or later is required for this integration.

</details>

<details>

<summary>Prerequisite 3: Illumina Preset Protocols (IPP) v2.11 with NGS Commons Package v5.25 or later</summary>

Illumina Preset Protocols (IPP) v2.11 package contains the workflow configuration and template files required to enable the MiSeq i100 Series On-Prem workflow to run properly.

Install the workflow configurations below on the same server on which you intend to install the MiSeq i100 Series On-Prem integration.

* MiSeq i100 Series Sequencing v2.0 workflow
* Library Prep Validation v2.3.6 workflow (optional, but recommended)

NGS Commons Package v5.25 or later is required for Step Automation to work properly.

</details>

## **Installation Steps**

Steps:

1. Install / Upgrade Clarity LIMS
2. Install and Configure Illumina Run Manager Integration Service
3. Install MiSeq i100 Series On-Prem Integration RPM
4. Install Illumina Preset Protocols (IPP) v2.11 RPM and Import Required IPP Workflows.

### **Step 1: Install / Upgrade Clarity LIMS**

Install or upgrade to Clarity LIMS v6.2 or later. If you are using an older version of Clarity LIMS, please contact Illumina Support (<techsupport@illumina.com>) to schedule for upgrade.

### **Step 2: Install Illumina Run Manager Integration Service**

Refer to [Illumina Run Manager v1.1.0 Installation](/instruments-and-integrations/irm/illumina-run-manager-v1.1.0/irm-v1.1.0-installation.md) for details.

### **Step 3: Install MiSeq i100 Series On-Prem Integration RPM**

Install ClarityLIMS-MiSeqi100Series-OnPremise RPM using yum or your preferred package manager.

Example with YUM:

{% code overflow="wrap" %}

```markup
yum install ClarityLIMS-MiSeqi100Series-OnPremise
```

{% endcode %}

Example with RPM:

{% code overflow="wrap" %}

```markup
rpm -i ClarityLIMS-MiSeqi100Series-OnPremise-{version}.86_64.rpm
```

{% endcode %}

### **Step 4: Install Illumina Preset Protocols (IPP) v2.11 and Import Required IPP Workflows**

Install BaseSpaceLIMS-Illumina-Preset-Protocols RPM using yum or your preferred package manager.

Example with YUM:

{% code overflow="wrap" %}

```markup
yum install BaseSpaceLIMS-Illumina-Preset-Protocols
```

{% endcode %}

Example with RPM:

{% code overflow="wrap" %}

```markup
rpm -i BaseSpaceLIMS-Illumina-Preset-Protocols-{version}.86_64.rpm
```

{% endcode %}

Upon successful installation of IPP v2.11, install the following workflow configurations:

* MiSeq i100 Series Sequencing v2.0 workflow
* (Optional) Library Prep Validation v2.3.6 workflow

For detailed options and steps on how to install IPP workflows and protocols, [Installer Parameters and Operations section of Illumina Preset Protocols v2.11 Installation and User Configuration](/illumina-preset-protocols/ipp-v2.11/ipp-v2.11.0-installation-and-user-configuration.md#installer-parameters-and-operations).


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.claritylims.illumina.com/instruments-and-integrations/miseq-i100/miseqi100-onprem/miseqi100-onprem-v1.1.0/miseqi100-onprem-v1.1.0-installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.