LogoLogo
Illumina KnowledgeIllumina SupportSign In
  • Home
  • Start Here
  • Overview
    • Software Overview
    • What's New
    • FAQ
    • Technical Assistance
    • Release Notes
    • Data Model
    • Account Types
    • Professional Services
  • Automate
    • Data Automation Overview
    • Automatic Data Flow
    • Automatic Data Aggregation
      • Unlock Biosamples
      • Correct Aggregation
    • Request A Lab Requeue
    • Yield
    • Yield Examples
      • Example 1
      • Example 2
      • Example 3
    • Automate Lane QC
    • Manual QC
    • Statuses
  • Manage Data
    • Import Demo Data
    • Delete Data
    • Import Data Into Projects
      • FastQ Upload Requirements
    • Download Data
      • Download Individual Files
      • Download Datasets
      • Download Run Files
      • Download Project Files
      • Download Analysis Files
      • Download Samples
    • Copy Datasets
    • Transfer Ownership
    • Archival Storage
    • Automatic Data Deletion
  • Sequence
    • Sample Sheets
      • Mapping Sequencing Runs to Biosamples
    • Fix Indexes
    • Plan Runs
      • Plan a NextSeq 1000/2000 Run
        • Set up NextSeq 1000/2000 Secondary Analysis
        • Custom Noise Baseline File
      • Plan a NovaSeq X Series Run
        • Set up NovaSeq X Series Secondary Analysis
        • NovaSeq X Series Custom Reference File
      • Create a Custom Index Adapter Kit
      • Import samples
      • Requeue a Planned Run
      • Analysis Configuration Template
      • Prep Tab
        • Create Biological Samples
        • Import Biological Samples
        • Prep Libraries
        • Import Sample Libraries
        • Set Up a Custom Library Prep Kit
        • Pool Libraries
        • Plan Run Using Prep Tab
        • Neo Prep
          • Configure
          • Assign Wells
          • Review
  • Microarray
    • Getting Started
      • Troubleshooting iScan Integration
    • Analysis Setup
    • Data Management
  • Analyze
    • Analyze Data
    • Launching Apps
    • Analysis Workflows
    • Re-Launch Analysis
    • Auto Analysis QC
    • Basespace Apps
  • Collaborate
    • Sharing Data
    • Access Shared Data
    • Share with Collaborators
      • Share Analyses
      • Track Analysis Delivery Status
      • Share By Link
      • Share By Email
      • Manage Collaborator Access
      • Data Access After Share / Transfer
    • Workgroups
    • Manage Workgroups
      • Access Workgroups
      • Create a Workgroup and Assign Admins
      • Rename a Workgroup
      • Add Users to a Workgroup
      • Remove Users from a Workgroup
      • Add Admins to a Workgroup
      • Remove Admins from a Workgroup
      • Manage User Access
  • Manage Your Account
    • Change Password
    • iCredits and Billing
    • Generate Usage Reports
    • Manage Enterprise Domains
    • Global Regions
  • Developer Tools
    • Basespace API
    • Developer Tools
  • Files Used By Basespace
    • Biosample Workflow Files
    • BAM Files
    • FastQ Files
    • Quality Scores
    • VCF Files
    • gVCF Files
  • Data
    • View Data
      • View Runs
        • View Run Summary
        • View Run Biosamples
        • View Run Samples
        • View Run Charts
        • View Run Metrics
        • View Run Indexing QC
        • View Run Samplesheet
        • View Run Files
      • View Projects
      • View Analyses
      • View Biosamples
  • Projects
    • Create a Project
    • Edit Project Details
  • Runs
    • Fix Sample Sheet
    • Automated Run Zipping
  • Biosamples
    • Biosample Overview
    • Manage Biosamples
    • Biosample Workflow
      • Add Biosamples
      • Add Prep Requests
      • Add Analysis Workflows to an Existing Biosample
      • Schedule Multiple Analysis Workflows for a Biosample
      • Schedule Analysis Workflow - Multiple Biosamples
    • Associating Biosamples with Projects
  • Samples
    • Combine Samples
    • Copy Samples
  • Cmd Line Interfaces
    • Basespace CLI
      • Introduction to Basemount
  • Additional Resources
    • Additional Resources
      • Informatics Blog
      • Coverage Calculator
      • Support Bulletins
      • Training
      • Security Model
      • Data Streaming
      • AWS
  • Releases
    • Previous Releases
      • 2025
        • 7.33.0 - Shared BCL Convert Section
        • 7.32.0 - File Preview in Search
        • 7.31.0 - Usage Explorer
        • 7.30.0 - Prep Tab Deprecation
      • 2024
        • 7.29.0 - Improved Analysis Error Reporting
        • 7.28.0 - MiSeq i100 Support
        • 7.27.0 - App Store Upgrade
        • 7.26.0 - Prep Tab Obsolescence Notification
        • 7.25.0 - Project Column in the Analysis Files Tab
        • 7.24.0 - Requeue Improvements
        • 7.23.0 - BaseSpace CLI v1.6.0
        • 7.22.0 - Analysis Autolaunch for NovaSeq X Manual Mode Runs
        • 7.21.0 - Improved Look and Feel
        • 7.20.0 - Analysis List Improvements
        • 7.19.0 - Transfer of NovaSeq X Projects
        • 7.18.0 - Custom Kit Deletion
      • 2023
        • 7.17.0 - Deletion of Biosample Default Projects
        • 7.16.0 - Transfer of NovaSeq X Runs
        • 7.15.0 - Compatibility Filtering in Run Planning
        • 7.14.0 - Native App Engine Update
        • 7.13.0 - Sharing for NovaSeq X Runs and Analyses
        • 7.12.0 - Combined New and Classic Modes
        • 7.11.0 - NovaSeq X Analysis Requeue
        • 7.10.0 - NovaSeq X Analysis Autolaunch Improvements
        • 7.9.0 - Multi-Analysis Run Planning
        • 7.8.0 - Performance Improvements
      • 2022
        • 7.7.0 - NovaSeqX Support
        • 7.6.0 - Custom Configuration Files in Microarray Analysis Setup
        • 7.5.0 - Performance Enhancements
        • 7.4.0 - Run Planning Enhancements
        • 7.3.0 - Improve App Launch Performance
        • 7.2.0 - FastQ Generation and other Bug Fixes
        • 7.1.0 - FastQ Related Fixes and Performance Improvements
        • 7.0.0 - Datasets and Apps Performance
        • 6.19.0 - ICA Integration Enhancements
        • 6.18.0 - ICA Integration with BCL Convert
        • 6.17.0 - Preliminary ICA Integration
      • 2021
        • 6.16.0
        • 6.15.0
        • 6.14.0
        • 6.13.0
        • 6.12.0
        • 6.11.0
        • 6.10.0
        • 6.9.0
        • 6.8.0
        • 6.7.0
        • 6.6.0
        • 6.5.0
      • 2020
        • 6.4.0
        • 6.3.0
        • 6.2.0
        • 6.1.0
        • 6.0.0
        • 5.46.0
        • 5.45.0
        • 5.44.0
        • 5.43.0
        • 5.42.0
      • 2019
        • 5.41.0
        • 5.40.0
        • 5.39.0
        • 5.38.0
        • 5.37.0
        • 5.36.0
        • 5.35.0
        • 5.34.0
        • 5.33.0
        • 5.32.0
        • 5.31.0
        • 5.30.0
      • 2018
        • 5.29.0
        • 5.28.0
        • 5.27.0
        • 5.26.0
        • 5.25.0
        • 5.24.0
        • 5.23.0
        • 5.22.0
        • 5.21.1
        • 5.21.0
        • 5.20.0
        • 5.19.0
        • 5.18.0
        • 5.17.0
        • 5.16.0
        • 5.15.0
        • 5.14.0
        • 5.13.0
        • 5.12.0
        • 5.11.0
      • 2017
        • 5.10.0
        • 5.9.0
        • 5.8.0
        • 5.7.0
        • 5.6.0
        • 5.5.0
        • 5.4.0
        • 5.3.0
        • 5.2.0
        • 5.1.0
        • 5.0.0
        • 4.27.0
        • 4.26.0
        • 4.25.0
        • 4.24.0
        • 4.23.0
        • 4.22.0
        • 4.21.0
        • 4.20.0
        • 4.19.0
        • 4.18.0
        • 4.17.0
        • 4.16.0
        • 4.15.0
      • 2016
        • 4.14.0
        • 4.13.0
        • 4.12.0
        • 4.11.0
        • 4.10.0
        • 4.9.0
        • 4.8.0
        • 4.7.0
        • 4.6.0
        • 4.5.0
        • 4.4.0
        • 4.3.0
        • 4.2.0
        • 4.1.0
        • 4.0.4
        • 4.0.3
        • 4.0.2
        • 4.0.1
        • 4.0.0
      • 2015
        • 3.23.2
        • 3.23.1
        • 3.23.0 Issues
        • 3.23.0
        • 3.20.4
        • 3.20.3
        • 3.20.0
        • 3.19.1
        • 3.19.0
        • 3.18.0
        • 3.17.1
        • 3.17.0
        • 3.16.2
        • 3.16.0
        • 3.15.2
        • 3.15.1
    • Release notifications
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Files Used By Basespace

Biosample Workflow Files

PreviousBasespace APINextBAM Files

Last updated 1 year ago

Was this helpful?

Biosample Workflow Files The biosample workflow file is a comma-delimited file that is used to add biosamples in bulk. The file includes a list of biosamples with the following information for each:

  • Custom metadata

  • Library preparation instructions

  • Analysis workflows to be launched after sequencing data files have been received

To make sure that run data are associated with the correct biosample information, upload the biosample workflow file before adding the sample sheet.

Biosample Workflow File Format

Biosample workflow fields are grouped into the following types:

  • Biosample Data - Lists information about the biosample and default project. See .

  • Prep Request Instructions - Instructions about the library preparation for a new or existing biosample. See .

  • Analysis Workflow - Schedules an analysis workflow for a biosample and lists additional instructions for grouping biosamples and delivering results. See .

  • Biosample Metadata - Adds custom metadata to the biosample. See .

Biosample Data Fields

Field

Requirements

Description

Biosample Name

  • Required

  • Can include letters, numbers, dashes, and underscores

  • Can only be listed one time

  • Not case‑sensitive

The unique identifier for the source DNA.

The default project and biosample metadata cannot be changed.

To correctly associate run data with the biosample, the Sample ID and project used in a sample sheet must exactly match the biosample name and default project. Use unique Sample ID and project name combinations in sample sheets to prevent aggregating multiple samples to a single biosample.

Default Project

  • Required for new biosamples.

The default project in which the biosample analysis data are stored. If the default project does not exist, BaseSpace Sequence Hub creates the project and adds the biosample to it. If you are modifying an existing biosample in the project, this column is ignored.

Container Name

This column is optional. It is typically used to define the source DNA plate barcode. If you are modifying an existing biosample, this column is ignored.

Container Position

  • Required if Container Name is defined.

Container Position is typically used to define the well location of the DNA plate defined in the Container Name column. If you are modifying an existing biosample, this column is ignored.

Analysis Workflow Fields

Analysis Workflow fields do not overwrite existing scheduled workflows. If you import the same biosample workflow file twice, you duplicate the analysis requests in the file and the analysis is performed a second time.

Field

Requirements

Description

Analysis Workflow

  • The user uploading the biosample workflow must have permission to use the analysis workflow.

  • The name of the Analysis Workflow.

  • If you are scheduling more than one analysis workflow for a biosample, separate the names of the workflows with a pipe character "

Analysis Group

Must be unique within the biosample workflow file.

Groups multiple biosamples and applies a single analysis workflow to the biosamples in the group.

Sample Label

Must be unique within the Analysis Group in the biosample workflow file.

Labels the analysis workflow inputs that must be distinguished. For example, the Tumor-Normal Analysis Workflow requires that the Isaac Analysis inputs are labeled as 'Normal' and 'Tumor'. Labels are case-sensitive.

Delivery Mode

  • Values allowed: 'Deliver' or 'Do Not Deliver'

  • Must be the same for biosamples within an Analysis Group

Assigns an optional delivery status for an analysis. For example, you can mark R&D or test analyses biosamples as Do Not Deliver.

In the following example, columns E—H specify the following information:

  • The analysis workflows to perform.

  • The analysis group and sample labels for a pair of samples analyzed with the Tumor Normal workflow.

  • Delivery mode.

Prep Request Fields

You can use the optional prep request fields to do the following:

  • Specify prep request instructions for a new biosample

  • Add a prep request to an existing biosample

  • Change the required yield for an existing prep request

Field

Requirements

Description

Prep Request

Must match a Prep Request in the system

Specifies which library prep to use.

Required Yield Gbp

Required if Prep Request is entered. Numeric value between 0–1000; use fractions to specify units of Mbp or Kbp)

Enter a value between 0–1000 to specify the sequencing yield (in Gbp) the lab is required to produce before the planned BaseSpace App can be launched.

If the prep request already exists for the biosample, the Required Yield is updated with the new value.

In the following example, columns J—K specify the library prep and required yield.

Metadata Fields

Use metadata fields to add custom information about the biosample. Do not enter patient identifying information in metadata fields.

Biosample metadata is listed on the biosample details page.

In the following example, columns L—N add genome, tissue source, and customer barcode metadata.

File Validation

BaseSpace Sequence Hub performs validation on the field requirements and the following general requirements:

  • Maximum 100 fields

  • Field headers must be 4–60 characters

  • No special characters in field headers

  • Field entries limited to 5000 characters

The biosample data fields define the biosamples you are adding or updating. A biosample and default project combination can only be listed in one row of the manifest. For information about scheduling more than one analysis for a biosample, see .

The analysis workflow fields specify the analysis workflow to launch automatically when sequencing data has been received. For more information, see .

For information about scheduling more than one workflow for a biosample, see .

For information about scheduling an analysis workflow for more than one biosample, see .

For more information about scheduling Tumor Normal workflows, see and .

Metadata can be applied to new biosamples in a biosample workflow file. To add or edit metadata for existing biosamples, use the BaseSpace Sequence Hub API. For more information, see the developer documentation at .

Schedule Multiple Analysis Workflows For a Single Biosample
Analysis Workflows
Schedule Multiple Analysis Workflows For a Single Biosample
Schedule An Analysis Workflow Using Data From Multiple Biosamples
Schedule Multiple Analysis Workflows For a Single Biosample
Schedule An Analysis Workflow Using Data From Multiple Biosamples
developer.basespace.illumina.com
Biosample Data Fields
Prep Request Fields
Analysis Workflow Fields
Metadata Fields
Example Metadata Fields