LogoLogo
  • Overview
  • publisher
    • Introduction
    • Getting Started
      • Logging in to Publisher
    • Data Sources
      • Connecting a Data Source
      • Managing a Data Source
      • Connectors
        • AWS S3 Permissions
        • Connecting to AWS S3 Storage
        • Google Cloud Storage (GCS) Permissions
        • Connecting to Google Cloud Storage
        • PostgreSQL Permissions
        • Connecting to PostgreSQL
        • PostgreSQL on Azure Permissions
        • Microsoft Azure Blob Storage Permissions
        • Connecting to Microsoft Azure Blob Storage
        • Connecting to HTTPS
        • Connecting to other sources via Trino
          • BigQuery
    • Collections
      • Creating a Collection
      • Sharing a Collection
      • Collection Filters
      • Editing Collection Metadata
      • Updating Collection Contents
    • Access Policies
      • Creating an Access Policy
      • Managing Access Policies
    • Questions
      • Adding Questions
      • Example Question
    • Settings
      • Viewing Current and Past Administrators
      • Adding an Administrator
      • Removing an Administrator
      • Setting Notification Preferences
  • Explorer
    • Introduction
    • Viewing a Collection
    • Browsing Collections
    • Asking Questions
    • Accessing a Private Collection
      • Requesting Access to a Private Collection
    • Filtering Data in Tables
      • Strings
      • Dates
      • Numbers
  • Workbench
    • Introduction
    • Getting Started
      • Logging into Workbench
      • Connecting an Engine
      • Finding or Importing a Workflow
      • Configuring Workflow Inputs
      • Running and Monitoring a Workflow
      • Locating Outputs
    • Engines
      • Adding and Updating an Engine
        • On AWS HealthOmics
        • On Microsoft Azure
        • On Google Cloud Platform
        • On Premises
      • Parameters
        • AWS HealthOmics
        • Google Cloud Platform
        • Microsoft Azure
        • On-Premises
        • Cromwell
        • Amazon Genomics CLI
    • Workflows
      • Finding Workflows
      • Adding a Workflow
      • Supported Languages
      • Repositories
        • Dockstore
    • Instruments
      • Getting Started with Instruments
      • Connecting a Storage Account
      • Using Sample Data in a Workflow
      • Running Workflows Using Samples
      • Family Based Analysis with Pedigree Information
      • Monitor the Workflow
      • CLI Reference
        • Instruments
        • Storage
        • Samples
        • OpenAPI Specification
    • Entities
    • Terminology
  • Passport
    • Introduction
    • Registering an Email Address for a Google Identity
  • Command Line Interface
    • Installation
    • Usage Examples
    • Working with JSON Data
    • Reference
      • workbench
        • runs submit
        • runs list
        • runs describe
        • runs cancel
        • runs delete
        • runs logs
        • runs tasks list
        • runs events list
        • engines list
        • engines describe
        • engines parameters list
        • engines parameters describe
        • engines health-checks list
        • workflows create
        • workflows list
        • workflows describe
        • workflows update
        • workflows delete
        • workflows versions create
        • workflows versions list
        • workflows versions describe
        • workflows versions files
        • workflows versions update
        • workflows versions delete
        • workflows versions defaults create
        • workflows versions defaults list
        • workflows versions defaults describe
        • workflows versions defaults update
        • workflows versions defaults delete
        • namespaces get-default
        • storage add
        • storage delete
        • storage describe
        • storage list
        • storage update
        • storage platforms add
        • storage platforms delete
        • storage platforms describe
        • storage platforms list
        • samples list
        • samples describe
        • samples files list
      • publisher
        • datasources list
  • Analysis
    • Python Library
    • Popular Environments
      • Cromwell
      • CWL Tool
      • Terra
      • Nextflow
      • DNAnexus
Powered by GitBook

© DNAstack. All rights reserved.

On this page
  • Parameter Sets
  • Viewing Parameter Sets
  • Creating a Parameter Sets
  • Default Preset
  • Deleting a Parameter Set

Was this helpful?

  1. Workbench
  2. Engines

Parameters

PreviousOn PremisesNextAWS HealthOmics

Last updated 3 months ago

Was this helpful?

Parameters are key-value pairs that modify engine behavior during workflow execution. While workflows typically don't interact with these parameters directly, users can set them when creating or updating engines, or when submitting workflow runs.

Each engine type supports different parameters that can:

  • Modify engine log levels

  • Specify output destinations

  • Configure other engine-specific behaviors

For detailed parameter options, see your engine's documentation:

Parameter Sets

Parameter sets allow you to save common engine configurations in . While not automatically applied to workflow runs, these sets can be selected during run submission from the engine tab.

You can create multiple parameter sets per engine, making it easy to switch between different configurations.

Viewing Parameter Sets

Since every engine has its own presets you will need to navigate to the engine you want to view the parameter sets for. You can follow these steps to view the parameter sets:

  1. Navigate to the

  2. Select the engine you want to view the presets for

  3. Click on the Parameters tab

  4. You will see a list of presets for the engine

  5. Click on a preset to view the parameter values or change the name of the preset

Creating a Parameter Sets

Every parameter set consists of a name and a set of key-value pairs that define the parameters for the engine. You can create a new preset by following these steps:

  1. Select the engine you want to create a preset for

  2. Click on the Parameters tab

  3. Click on the Add Parameter Set button

  4. Enter a name for the preset

  5. Enter the key-value pairs for the parameters you want to set as JSON in the editor

  6. click on the Save button

Default Preset

You can select on of the presets as the default preset. This preset will be automatically selected when submitting a workflow run form the User interface. It will not be applied automatically.

  1. Select the engine you want to set the default preset for

  2. Click on the Parameters tab

  3. Hover over the preset you want to set as the default

  4. Click on the star icon to set the preset as the default

Deleting a Parameter Set

You can easily delete a parameter set by following these steps:

  1. Select the engine you want to delete a preset for

  2. Click on the Parameters tab

  3. Hover over the preset you want to delete

  4. Click on the trash icon to delete the preset

Navigate to the

Navigate to the

Navigate to the

Google Cloud Platform
AWS HealthOmics
Microsoft Azure
On-Premises
Workbench
Engines Page
Engines Page
Engines Page
Engines Page