LogoLogo
Illumina KnowledgeIllumina SupportSign In
  • Home
  • Overview
    • Welcome
    • What's New
      • Cloud Software Update
      • Local Software Update
  • Configure
    • Configuration
      • Custom Case Data
      • Pipeline and QC Configuration
      • Preferred Transcripts
      • Custom Annotations
      • Disease Configuration
      • Variant Filters
      • Variant Flag Groups
      • Actionability Classifications
      • Report Templates
        • Customizations
      • Report Automation
      • Test Definitions
      • Data Upload
        • Data Upload from User Storage (Connected Insights - Cloud and Connected Insights - Local)
        • Data Upload from ICA or BSSH (Connected Insights - Cloud)
        • Supported Pipelines
          • DRAGEN TruSight Oncology 500 Analysis Software v2.6.0 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.6.0
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.3 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.3
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.2 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.5.2
          • DRAGEN TruSight Oncology 500 Analysis Software v2.1.1 (with HRD)
          • DRAGEN TruSight Oncology 500 Analysis Software v2.1.1
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.6.1
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.6.0
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.5.0
          • DRAGEN TruSight Oncology 500 ctDNA Analysis Software v2.1.1
          • DRAGEN Amplicon v4.3
          • DRAGEN Amplicon v4.2
          • DRAGEN Amplicon v4.1
          • DRAGEN RNA v4.3
          • DRAGEN RNA v4.2
          • DRAGEN RNA v4.1
          • DRAGEN Enrichment v4.3
          • DRAGEN Enrichment v4.2
          • DRAGEN Enrichment v4.1
          • DRAGEN for Illumina cfDNA Prep with Enrichment v4.0.3
          • DRAGEN Somatic Whole Genome v4.3
          • DRAGEN Somatic Whole Genome v4.2
          • DRAGEN Somatic Whole Genome v4.1
          • TruSight Tumor 170 Local App v2.0.1
          • Local Run Manager TruSight Tumor 15 Analysis Module v2.1
        • Custom Pipeline Configuration
          • VCF Input Requirement
          • TMB, MSI, GIS Input Requirement
        • Custom Case Data Upload
    • Upload Assertions
    • Local Installation Guide
      • Overview
      • Prerequisites
      • Download Connected Insights Package
      • Install Connected Insights Software
      • Install License File
      • Sign In to Connected Insights
      • Installation Status Messages
      • Local Configurations
      • Administration Console (Connected Insights - Local)
      • Configure External Storage (Connected Insights - Local)
  • Manage cases
    • Cases Page
    • Cases List
      • Case Metadata Upload
  • Interpret and report
    • Case Page
    • Case Details
      • Merge Cases
    • Overview Tab
      • Classification & Risk Stratification Prediction
    • Visualize Tab
    • Variants Tab
      • Modify Columns
      • Apply Variant Filters
        • Filter by Variant Category
        • Variant Details Filters
        • Variant Quality Filters
        • Functional Impact Filters
        • Disease Association Filters
        • Variant Frequency Filters
        • Flags Filter
        • Filtering Logic
      • IGV Visualizations
    • Lab QC Tab
    • Report Tab
    • View Biomarker Details
      • Biological Classification
      • Actionability
      • Clinical Trials
      • Oncogenicity Prediction
      • Visualize
      • Variant Overview
      • Gene Overview
      • Cancer Datasets
      • Computer Predictors
      • Population
    • Interpret a Biomarker
      • Create Clinical Trials
      • Create Gene Descriptions
      • Manage Assertions
    • Variant Transcripts
    • Add Variant
  • Resources and References
    • Glossary
    • APIs
      • Ingest Cloud Analysis Data API (Connected Insights - Cloud Only)
      • Case APIs
      • Report APIs
      • Audit Log APIs
    • Troubleshooting
      • Overview
      • Audit Log
      • Data Backup (Connected Insights - Local)
      • Software Errors and Corrective Actions
      • How To
      • Technical Assistance
    • Pricing and Usage
    • Security and Compliance
    • Release Notes
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Overview
  2. What's New

Local Software Update

PreviousCloud Software UpdateNextConfiguration

Last updated 20 hours ago

Was this helpful?

The Software Update page allows you to manage updating or initial installation of Connected Insights - Local software and the dependent packages. It provides details into the currently installed versions of software packages. Additionally, this page manages license updates, providing details on the last installed license date and the current remaining Genome Equivalent Sample (GEs) balance.

The following packages are supported:

  • Connected Insights - Local software: Updates only

  • Illumina Connected Annotations: Updates or initial installation

  • Illumina Connected Insight Data Reference: Updates or initial installation

  • Knowledge base files: Updates or initial installation

  • License file: Updates only

For the initial installation of Connected Insights - Local software and the license file, see and , respectively.

Install or Update software and dependent package

To install or update software or its dependent packages, refer to the instructions below:

  1. From any page, click your username in the top right, select Administration Console, then Software Update. The Administration Console page is only accessible by Connected Insights - Local software users with an Administration role.

  2. On the right-side pane, choose one of the options below based on where the packages are available:

    • DRAGEN server v4 path /staging/icipackages/

    • Mounted external storage drive (e.g. NAS) located at /mnt/<ici_mount>/icipackages/

    • USB device connected and mounted to the DRAGEN server v4 (e.g., located in /media/usbinstall/)

    • Local computer (only for Knowledge Base files and the license file). For this method, proceed to subsections Update Knowledge Base from Local Computer and Update License from Local Computer below.

    ❗ Before starting installation or updates, ensure only Connected Insights - Local software package(s) are available in one of the supported package locations specified above.

  3. Click Check for Updates.

  4. The application displays the compatible Connected Insights - Local software package(s) with an Install Now button next to each. Additionally, there is an Install All button which installs or updates all the dependent packages available within the selected location.

    The Install All option is not provided when a higher version of Connected Insights - Local software package is available under the selected package location. In such cases, the Connected Insights - Local software must be installed followed by the dependent packages.

  5. Select Install Now or Install All based on the options provided.

  6. A confirmation pop-up will appear displaying the approximate time for installing or updating the selected package(s) and states the application will be inaccessible during this time.

  7. Click Install Now in the confirmation pop-up.

    ❗ The application checks for the conditions below and only proceeds when the validations are successful. If one or multiple are not met, a pop-up window appears indicating the error and installation/updating will be blocked. Select Close, fix the conditions below, and try again.

    • Package files integrity checks pass.

    • No Case processing is in progress.

    • /staging (on the DRAGEN server v4) has minimum of 200 GB free space.

If the validations above succeed, application starts the install or update process and displays the progress of package install/updates. During the install or update process, the application is inaccessible. After the install or update is completed, the screen refreshes to the Connected Insights - Local software login screen with a success message. Install or update any remaining packages if not done already.

If an update for an existing package fails, the application will automatically try to revert to the previous version of the package. You can then attempt to reinstall or re-upload the package from the Software Update page. If the rollback process also fails, the application will display an "Update Failed" message and restrict access to the application. For further troubleshooting contact Illumina Support.

Update Knowledge Base from Local Computer

The application allows you to install or update Knowledge Base files by uploading the files directly from user's personal computer. Refer to the instructions below:

  1. From any page, click your username in the top right, select Administration Console, then Software Update. The Administration Console page is only accessible by Connected Insights - Local software users with an Administration role.

  2. On the right-side pane, select the Local computer (only for Knowledge Base and license file) option.

  3. Select the Knowledge Base file from your personal computer.

  4. After the upload is complete, select Install.

  5. A confirmation pop-up will appear displaying the approximate time for installing or updating the selected Knowledge Base package and states the application will be inaccessible during this time.

  6. Click Install Now in the confirmation pop-up window.

❗ The application checks for the conditions below and only proceeds when the validations are successful. If one or multiple are not met, a pop-up window appears indicating the error and installation/updating will be blocked. Select Close, fix the conditions below, and try again.

  • Package files integrity checks pass.

  • No Case processing is in progress.

  • /staging (on DRAGEN server v4) has minimum of 200 GB free space.

If the validations above succeed, the application starts the install or update process and displays the progress. During the install or update process, the application is inaccessible. After the install or update is completed, the screen refreshes to the Connected Insights - Local software login screen with a success message.

Update License (ConnectedInsights-QuotaLicense.bin) from Local Computer

The application allows you to update Genome Equivalent Sample (GEs) balance by uploading the ConnectedInsights-local-QuotaLicense.bin file directly from user's personal computer. Download the license files sent by the Illumina Sales/Customer Support team on your personal computer and select ConnectedInsights-local-QuotaLicense.bin for this step. Refer to the instructions below:

  1. From any page, click your username in the top right, select Administration Console, then Software Update. The Administration Console page is only accessible by Connected Insights - Local software users with an Administration role.

  2. On the right-side pane, select the Local computer (only for Knowledge Base and license file) option.

  3. Select the ConnectedInsights-local-QuotaLicense.bin license file.

  4. After the upload is complete, select Install.

❗ The application checks for the conditions below when updating a license file and only proceeds when the validations are successful. If one or multiple are not met, a pop-up window appears indicating that the update cannot be installed. Select Close, fix the conditions below and try again.

  • The package file integrity checks pass.

  • The license file is intended for the target DRAGEN server v4.

If the above validation succeeds, the application proceeds to update the license and a success message is displayed. Upon successful License update, the amount of remaining GEs is refreshed to the current aggregated value under the License File section of the Software Update page.

Then, if not done already (mainly applies to first-time installation), follow the instructions in to further set up Connected Insights - Local software and to ingest cases from secondary analysis output data.

Install Connected Insights - Local software
Install License File
Configuration
Data Upload from User Storage (Connected Insights - Cloud and Connected Insights - Local)