LogoLogo
Illumina Connected Software
  • Introduction
  • Get Started
    • About the Platform
    • Get Started
  • Home
    • Projects
    • Bundles
    • Event Log
    • Metadata Models
    • Docker Repository
    • Tool Repository
    • Storage
      • Connect AWS S3 Bucket
        • SSE-KMS Encryption
  • Project
    • Data
      • Data Integrity
    • Samples
    • Activity
    • Flow
      • Reference Data
      • Pipelines
        • Nextflow
        • CWL
        • XML Input Form
        • 🆕JSON-Based input forms
          • InputForm.json Syntax
          • JSON Scatter Gather Pipeline
        • Tips and Tricks
      • Analyses
    • Base
      • Tables
        • Data Catalogue
      • Query
      • Schedule
      • Snowflake
    • Bench
      • Workspaces
      • JupyterLab
      • 🆕Bring Your Own Bench Image
      • 🆕Bench Command Line Interface
      • 🆕Pipeline Development in Bench (Experimental)
        • Creating a Pipeline from Scratch
        • nf-core Pipelines
        • Updating an Existing Flow Pipeline
      • 🆕Containers in Bench
      • FUSE Driver
    • Cohorts
      • Create a Cohort
      • Import New Samples
      • Prepare Metadata Sheets
      • Precomputed GWAS and PheWAS
      • Cohort Analysis
      • Compare Cohorts
      • Cohorts Data in ICA Base
      • Oncology Walk-through
      • Rare Genetic Disorders Walk-through
      • Public Data Sets
    • Details
    • Team
    • Connectivity
      • Service Connector
      • Project Connector
    • Notifications
  • Command-Line Interface
    • Installation
    • Authentication
    • Data Transfer
    • Config Settings
    • Output Format
    • Command Index
    • Releases
  • Sequencer Integration
    • Cloud Analysis Auto-launch
  • Tutorials
    • Nextflow Pipeline
      • Nextflow DRAGEN Pipeline
      • Nextflow: Scatter-gather Method
      • Nextflow: Pipeline Lift
        • Nextflow: Pipeline Lift: RNASeq
      • Nextflow CLI Workflow
    • CWL CLI Workflow
      • CWL Graphical Pipeline
      • CWL DRAGEN Pipeline
      • CWL: Scatter-gather Method
    • Base Basics
      • Base: SnowSQL
      • Base: Access Tables via Python
    • Bench ICA Python Library
    • API Beginner Guide
    • Launch Pipelines on CLI
      • Mount projectdata using CLI
    • Data Transfer Options
    • Pipeline Chaining on AWS
    • End-to-End User Flow: DRAGEN Analysis
  • Reference
    • Software Release Notes
      • 2025
      • 2024
      • 2023
      • 2022
      • 2021
    • Document Revision History
      • 2025
      • 2024
      • 2023
      • 2022
    • Known Issues
    • API
    • Pricing
    • Security and Compliance
    • Network Settings
    • ICA Terminology
    • Resources
    • Data Formats
    • FAQ
Powered by GitBook
On this page
  • Prepare Source Project
  • Creating a New Project Connector
  • Filter Expression Examples

Was this helpful?

Export as PDF
  1. Project
  2. Connectivity

Project Connector

PreviousService ConnectorNextNotifications

Last updated 7 months ago

Was this helpful?

The platform GUI provides the Project Connector utility which allows data to be linked automatically between projects. This creates a one-way dynamic link for files and samples from source to destination, meaning that additions and deletions of data in the source project also affect the destination project. This differs from or which create editable copies of the data. In the destination project, you can delete data which has been moved or copied and unlink data which has been linked.

one-way
files
folders
erases source data
propagate source edits
editable on destination

move

x

x

x

x

x

copy

x

x

x

x

manual link

x

x

x

project connector

x

x

x

Prepare Source Project

  1. Select the source project (project that will own the data to be linked) from the Projects page (Projects > your_source_project).

  2. Select Project Settings > Details.

  3. Select Edit

  4. Under Data Sharing ensure the value is set to Yes

  5. Select Save

Creating a New Project Connector

  1. Select the destination project (the project to which data from the source project will be linked) from the Projects page (Projects > your_destination_project).

  2. From the projects menu, select Project Settings > Connectivity > Project Connector

  3. Select + Create and complete the necessary fields.

    • Check the box next to Active to ensure the connector will be active.

    • Name (required) — Provide a unique name for the connector.

    • Type (required) — Select the data type that will be linked (either File or Sample)

    • Source Project - Select the source poject whose data will be linked to.

    • Tags (optional) — Add tags to restrict what data will be linked via the connector. Any data in the source project with matching tags will be linked to the destination project.

Filter Expression Examples

The examples below will link Files based on the Format field.

  • Only Files with Format of FASTQ will be linked:

    [?($.details.format.code == 'FASTQ')]

  • Only Files with Format of VCF will be linked:

    [?($.details.format.code == 'VCF')]

The examples below will restrict linked Files based on a filenames.

  • Exact match to 'Sample-1_S1_L001_R1_001.fastq.gz':

    [?($.details.name == 'Sample-1_S1_L001_R1_001.fastq.gz')]

  • Ends with '.fastq.gz':

    [?($.details.name =~ /.*\.fastq.gz/)]

  • Starts with 'Sample-':

    [?($.details.name =~ /Sample-.*/)]

  • Contains '_R1_':

    [?($.details.name =~ /.*_R1_.*/)]

The examples below will link Samples based on User Tags and Sample name, respectively.

  • Only Samples with the User Tag 'WGS-Project-1'

    [?('WGS-Project-1' in $.tags.userTags)]

  • Only Samples with the name 'BSSH_Sample_1':

  • Link a Sample with the name 'BSSH_Sample_1':

    [?($.name == 'BSSH_Sample_1')]

Filter Expression (optional) — Enter an expression to restrict which files will be linked via the connector (see below)

Filter Expression Examples
copying
moving
Project Connector Setup