# Compatibility

Document Version: 6

**Terminology**

* IPP = Illumina Preset Protocol
* IRM = Illumina Run Manager
* LRM = Local Run Manager
* CSW = Control Software
* OSW = Operating Software

## Instrument Integrations

{% hint style="danger" %}
It is strongly recommended to install the latest workflow version that is compatible with the integration.
{% endhint %}

### iScan

* Module = BaseSpaceLIMS-SIS-iScan

| **Version** | **Workflow version**           | **Clarity LIMS version** | **Other Compatibilities**                                                      |
| ----------- | ------------------------------ | ------------------------ | ------------------------------------------------------------------------------ |
| 1.2.0       | Multiple (iLASS Infinium v1.1) | 6.2.0 and above          | <ul><li>CSW 4.2.1</li><li>IPP 2.9.0 and above</li><li>SIS Core 2.4.0</li></ul> |
| 1.1.0       | Multiple (iLASS Infinium v1.0) | 6.2.0 and above          | <ul><li>CSW 4.2.1</li><li>IPP 2.6.0 and above</li><li>SIS Core 2.4.0</li></ul> |

### MiSeq

* Module = ClarityLIMS-Illumina-MiSeq-Package-v8

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                      |
| ----------- | -------------------- | ------------------------ | -------------------------------------------------------------- |
| 8.3.0       | 3.2                  | 6.2.0 and above          | <ul><li>CSW 4.0.0, 4.1.0</li><li>IPP 2.9.0 and above</li></ul> |
| 8.2.0       | 3.2                  | 6.2.0 **only**           | <ul><li>CSW 4.0.0, 4.1.0</li><li>IPP 2.6.0 and above</li></ul> |

### MiSeq i100 Series

**Hosted**

* Module = ClarityLIMS-SIS-MiSeqi100Series-Package

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                                                                                                                   |
| ----------- | -------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1.1.0       | 2.0                  | 6.2.0 and above          | <ul><li>CSW 1.1.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.11.0 and above</li><li>SIS Core 2.7.1</li><li>(Optional) UPA and UPA Script 1.5.0</li></ul> |
| 1.0.0       | 1.0                  | 6.2.0 and above          | <ul><li>CSW 1.0.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.10.0 and above</li><li>SIS Core 2.7.0</li><li>(Optional) UPA and UPA Script 1.4.0</li></ul> |

**On-Prem**

* Module = ClarityLIMS-MiSeqi100Series-OnPremise

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                                                                               |
| ----------- | -------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| 1.1.0       | 2.0                  | 6.2.0 and above          | <ul><li>CSW 1.1.0</li><li>IRM 1.9 and above</li><li>Clarity LIMS IRM Integration 1.1.0 and above</li><li>IPP 2.11.0 and above</li></ul> |
| 1.0.0       | 1.0                  | 6.2.0 and above          | <ul><li>CSW 1.0.0</li><li>IRM 1.8 and above</li><li>Clarity LIMS IRM Integration 1.0.0 and above</li><li>IPP 2.10.0 and above</li></ul> |

### MiSeqDx

* Module = BaseSpaceLIMS-miseqdx-sequencing-service, BaseSpaceLIMS-miseqdx-extensions

{% hint style="info" %}
Workflow is part of extensions RPM.
{% endhint %}

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                      |
| ----------- | -------------------- | ------------------------ | ---------------------------------------------- |
| 1.11.0      | 1.2                  | 6.2.0 and above          | <ul><li>OSW 1.1.7</li><li>NGS 5.23.0</li></ul> |
| 1.10.0      | 1.2                  | 6.2.0 **only**           | <ul><li>OSW 1.1.7</li><li>NGS 5.23.0</li></ul> |

### NextSeq 500/550

* Module = ClarityLIMS-Illumina-NextSeq-Package-v2

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                  |
| ----------- | -------------------- | ------------------------ | -------------------------------------------------------------------------- |
| 2.5.0       | 1.3                  | 6.2.0 and above          | <ul><li>CSW 4.2.0</li><li>LRM 4.0.0</li><li>IPP 2.10.0 and above</li></ul> |
| 2.4.0       | 1.2                  | 6.2.0 and above          | <ul><li>CSW 4.0.0</li><li>IPP v2.9.0</li></ul>                             |
| 2.3.0       | 1.1                  | 6.2.0 **only**           | <ul><li>CSW 4.0.0</li><li>IPP 2.6.0 and above</li></ul>                    |

### NextSeq 1000/2000

**Hosted**

* Module = BaseSpaceLIMS-SIS-Nextseq1k2k

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                                                                                                                                                |
| ----------- | -------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 2.6.0       | 2.5                  | 6.2.0 and above          | <ul><li>CSW 2.1.0</li><li>Requires BSSH (Personal/Professional/Enterprise)</li><li>IPP 2.12.0 and above</li><li>SIS Core 2.7.2 and above</li><li>(Optional) UPA and UPA Script 1.5.0 and above</li></ul> |
| 2.5.1       | 2.4                  | 6.2.0 and above          | <ul><li>CSW 1.5.0, 2.0.0</li><li>Requires BSSH (Personal/Professional/Enterprise)</li><li>IPP 2.8.0 and above</li><li>SIS Core 2.6.0</li><li>(Optional) UPA and UPA Script 1.3.1</li></ul>               |
| 2.5.0       | 2.4                  | 6.2.0 and above          | <ul><li>CSW 1.5.0</li><li>Requires BSSH (Personal/Professional/Enterprise)</li><li>IPP 2.8.0 and above</li><li>SIS Core 2.6.0</li><li>(Optional) UPA and UPA Script 1.2.0</li></ul>                      |
| 2.4.0       | 2.3                  | 6.2.0 and above          | <ul><li>CSW 1.5.0</li><li>Requires BSSH (Personal/Professional/Enterprise)</li><li>IPP 2.6.0 and above</li><li>SIS Core 2.4.0</li><li>(Optional) UPA and UPA Script 1.2.0</li></ul>                      |

**On-Prem**

* Module = BaseSpaceLIMS-SIS-Nextseq1k2k-OnPremise

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                      |
| ----------- | -------------------- | ------------------------ | -------------------------------------------------------------- |
| 1.1.0       | 1.1                  | 6.2.0 and above          | <ul><li>CSW 2.1.0</li><li>IPP 2.12.0 and above</li></ul>       |
| 1.0.0       | 1.0                  | 6.2.0 and above          | <ul><li>CSW 1.5.0, 2.0.0</li><li>IPP 2.8.0 and above</li></ul> |

### NovaSeq 6000

**API-based**

* Module = BaseSpaceLIMS-sequencer-api

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                                                                                           |
| ----------- | -------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| 3.7.1       | 3.8                  | 6.2.0 and above          | <ul><li>CSW 1.8.0 and above</li><li>IPP 2.6.0 and above</li><li>Sequencer API 2.7.1</li><li>(Optional) UPA and UPA Script 1.2.0 and above</li></ul> |
| 3.7.0       | 3.8                  | 6.2.0 and above          | <ul><li>CSW 1.8.0</li><li>IPP 2.6.0 and above</li><li>Sequencer API 2.7.0</li><li>(Optional) UPA and UPA Script 1.2.0</li></ul>                     |
| 3.6.0       | 3.8                  | 6.2.0 and above          | <ul><li>CSW 1.8.0</li><li>IPP 2.6.0 and above</li><li>Sequencer API 2.6.0</li><li>(Optional) UPA and UPA Script 1.2.0</li></ul>                     |

**File-based**

* Module = BaseSpaceLIMS-novaseq-sequencing-service, BaseSpaceLIMS-novaseq-extensions

{% hint style="info" %}
Workflow is part of extensions RPM.
{% endhint %}

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                |
| ----------- | -------------------- | ------------------------ | -------------------------------------------------------- |
| 2.6.0       | 2.3                  | 6.2.0 and above          | <ul><li>CSW 1.5.0 and above</li><li>NGS 5.23.0</li></ul> |
| 2.5.0       | 2.3                  | 6.2.0 **only**           | <ul><li>CSW 1.5.0</li><li>NGS 5.23.0</li></ul>           |

### NovaSeq 6000Dx

* Module = BaseSpaceLIMS-sequencer-api

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                           |
| ----------- | -------------------- | ------------------------ | ----------------------------------------------------------------------------------- |
| 1.3.0       | 1.2                  | 6.2.0 and above          | <ul><li>OSW 2.3.1</li><li>IPP 2.6.0 and above</li><li>Sequencer API 2.7.0</li></ul> |
| 1.2.0       | 1.2                  | 6.2.0 and above          | <ul><li>OSW 2.3.1</li><li>IPP 2.6.0 and above</li><li>Sequencer API 2.6.0</li></ul> |

### NovaSeq X Series

**Hosted**

* Module = BaseSpaceLIMS-SIS-NovaSeqXSeries

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                                                                                                                        |
| ----------- | -------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1.4.0       | 2.0                  | 6.2.0 and above          | <ul><li>CSW 1.4.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.12.0 and above</li><li>SIS Core 2.7.2</li><li>(Optional) UPA and UPA Script 1.5.0</li></ul>      |
| 1.3.0       | 1.2                  | 6.2.0 and above          | <ul><li>CSW 1.3.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.10.0 and above</li><li>SIS Core 2.7.0</li><li>(Optional) UPA and UPA Script 1.4.0</li></ul>      |
| 1.2.1       | 1.1                  | 6.2.0 and above          | <ul><li>CSW 1.0.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.7.0 and above</li><li>SIS Core 2.5.0</li><li>(Optional) UPA and UPA Script 1.3.1</li></ul>       |
| 1.2.0       | 1.1                  | 6.2.0 and above          | <ul><li>CSW 1.0.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.7.0 and above</li><li>SIS Core 2.5.0</li><li>(Optional) UPA 1.2.0 and UPA Script 1.2.1</li></ul> |
| 1.1.0       | 1.1                  | 6.2.0                    | <ul><li>CSW 1.0.0</li><li>Requires BSSH (Professional/Enterprise)</li><li>IPP 2.6.0 and above</li><li>SIS Core 2.4.0</li><li>(Optional) UPA and UPA Script 1.2.0</li></ul>       |

**On-Prem**

* Module = ClarityLIMS-NovaSeqXSeries-OnPremise

| **Version** | **Workflow version** | **Clarity LIMS version** | **Other Compatibilities**                                                                                                               |
| ----------- | -------------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| 1.1.0       | 2.0                  | 6.2.0 and above          | <ul><li>CSW 1.4.0</li><li>IRM 1.9 and above</li><li>Clarity LIMS IRM Integration 1.1.0 and above</li><li>IPP 2.12.0 and above</li></ul> |
| 1.0.0       | 1.0                  | 6.2.0 and above          | <ul><li>CSW 1.3.0</li><li>IRM 1.7 and above</li><li>Clarity LIMS IRM Integration 1.0.0 and above</li><li>IPP 2.10.0 and above</li></ul> |

## Other Integration Modules

### Illumina Preset Protocol

* Module = BaseSpaceLIMS-Illumina-Preset-Protocols

| **Version** | **Clarity LIMS version** | **Other Compatibilities** |
| ----------- | ------------------------ | ------------------------- |
| 2.12.0      | 6.2.0 and above          | NGS 5.25.0 and above      |
| 2.11.0      | 6.2.0 and above          | NGS 5.25.0 and above      |
| 2.10.0      | 6.2.0 and above          | NGS 5.25.0 and above      |
| 2.9.0       | 6.2.0 and above          | NGS 5.25.0 and above      |
| 2.8.0       | 6.2.0 and above          | NGS 5.25.0 and above      |
| 2.7.0       | 6.2.0 and above          | NGS 5.24.0 and above      |
| 2.6.0       | 6.2.0 and above          | NGS 5.23.0 and above      |

{% hint style="info" %}
The Library Prep Validation workflow in Illumina Preset Protocol is UPA-enabled and is compatible with UPA and UPA Script 1.2.0 and above. It is recommended to use the latest UPA version.
{% endhint %}

### Illumina Run Manager Integration

* Module = ClarityLIMS-Illumina-Run-Manager-Integration

| **Version** | **Clarity LIMS version** | **Other Compatibilities** |
| ----------- | ------------------------ | ------------------------- |
| 1.1.1       | 6.2.0 and above          |                           |
| 1.1.0       | 6.2.0 and above          |                           |
| 1.0.0       | 6.2.0 and above          |                           |

### NGS Extension

* Module = Clarity LIMS-NGS-Package-v5

| **Version** | **Clarity LIMS version** | **Other Compatibilities** |
| ----------- | ------------------------ | ------------------------- |
| 5.25.1      | 6.2.0 and above          |                           |
| 5.25.0      | 6.2.0 and above          |                           |
| 5.24.0      | 6.2.0 and above          |                           |
| 5.23.0      | 6.2.0 and above          |                           |

### Sequencer-API

* Module = BaseSpaceLIMS-sequencer-api

| **Version** | **Clarity LIMS version** | **Other Compatibilities** |
| ----------- | ------------------------ | ------------------------- |
| 2.7.1       | 6.2.0 and above          |                           |
| 2.7.0       | 6.2.0 and above          |                           |
| 2.6.0       | 6.2.0 and above          |                           |

### SIS-Core

* Module = BaseSpaceLIMS-SIS-Core

| **Version** | **CLIMS version** | **Other Compatibilities** |
| ----------- | ----------------- | ------------------------- |
| 2.7.2       | 6.2.0 and above   |                           |
| 2.7.1       | 6.2.0 and above   |                           |
| 2.7.0       | 6.2.0 and above   |                           |
| 2.6.0       | 6.2.0 and above   |                           |
| 2.5.0       | 6.2.0 and above   |                           |
| 2.4.0       | 6.2.0 and above   |                           |

### UPA

**UPA**

* Module = BaseSpaceLIMS-unified-product-analytics

| **Version** | **CLIMS version** | **Other Compatibilities** |
| ----------- | ----------------- | ------------------------- |
| 1.5.0       | 6.2.0 and above   |                           |
| 1.4.0       | 6.2.0 and above   |                           |
| 1.3.1       | 6.2.0 and above   |                           |
| 1.3.0       | 6.2.0 and above   |                           |
| 1.2.0       | 6.2.0 and above   |                           |

**UPA Script**

* Module = BaseSpaceLIMS-unified-product-analytics-scripts

| **Version** | **CLIMS version** | **Other Compatibilities** |
| ----------- | ----------------- | ------------------------- |
| 1.5.0       | 6.2.0 and above   | UPA v1.5.0                |
| 1.4.0       | 6.2.0 and above   | UPA v1.4.0                |
| 1.3.1       | 6.2.0 and above   | UPA v1.3.0                |
| 1.3.0       | 6.2.0 and above   | UPA v1.3.0                |
| 1.2.1       | 6.2.0 and above   | UPA v1.2.0                |
| 1.2.0       | 6.2.0 and above   | UPA v1.2.0                |

## Revision History

| **Version** | **Changes**                                                                                                                                                                                                                                                                                                                                                 |
| ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 6           | <ul><li><p>Updated compatibility</p><ul><li>NovaSeq 6000 (API-based and File-based)</li><li>NovaSeq X (Hosted and On-Prem)</li><li>NextSeq 1000/2000 (Hosted and On-Prem)</li><li>Illumina Preset Protocol</li><li>Illumina Run Manager Integration</li><li>Sequencer API</li><li>SIS-Core</li></ul></li></ul>                                              |
| 5           | <ul><li><p>Updated compatibility</p><ul><li>NextSeq 1000/2000 (Hosted and On-Prem)</li><li>MiSeq i100 Series (Hosted and On-Prem)</li><li>Illumina Preset Protocol</li><li>Illumina Run Manager Integration</li><li>SIS-Core</li><li>UPA</li></ul></li></ul>                                                                                                |
| 4           | <ul><li><p>Updated compatibility</p><ul><li>NGS Extension</li><li>Illumina Preset Protocol (Other Compatibilities)</li></ul></li></ul>                                                                                                                                                                                                                      |
| 3           | <ul><li><p>Updated compatibility</p><ul><li>NextSeq 500/550</li><li>NovaSeq X Series (Hosted)</li><li>Illumina Preset Protocols</li><li>SIS-Core</li><li>UPA</li></ul></li><li><p>Added new compatibility</p><ul><li>MiSeq i100 Series (Hosted and On-Prem)</li><li>NovaSeq X Series (On-Prem)</li><li>Illumina Run Manager Integration</li></ul></li></ul> |
| 2           | <ul><li>Updated compatibility of NextSeq 500/550.</li></ul>                                                                                                                                                                                                                                                                                                 |
| 1           | <ul><li>Initial release.</li></ul>                                                                                                                                                                                                                                                                                                                          |


---

# 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.connected.illumina.com/clarity-lims/instruments-and-integrations/compatibility.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.