How to find a workflow

Allie Cliffe
  • Updated

Once you start the workflows engine in the Workflows tab (see How to set up and run a workflow), you can select from a number of curated workflows directly in Terra or import workflows from GitHub or Dockstore. 

1. In a workspace's Workflows tab, click on Find & add workflows on the left-hand panel.

Screenshot showing the Workflows tab of an example workspace. An orange rectangle highlights the 'Find & add workflows' option on the left-hand panel.

If you don't see the Find a Workflow button in your Cromwell workflows tabThis feature is only available if you are using a new Terra Billing project (created after August 2, 2023). To be able to take advantage of the most up-to-date functionality in Terra on Azure, we recommend creating a new Azure-backed Terra Billing project and making clones of workspaces you regularly use.

Option 1: Browse featured workflows

1.1. Click on Featured workflows. You will see a list of curated workflows available on Terra.

1.2. To add a workflow to your workspace, click Add to workspace.

What to expect

It may take Terra about 30 seconds to add a workflow to your workspace. Once it's been added, you will have to option to view the workflow, start configuring it, or continue browsing other featured workflows.

Option 2: Add a workflow link (GitHub)

2.1. Select Import a workflow.

2.2. Fill in the GitHub link and workflow name in the blank fields and click the Add to Workspace button (the button will be disabled if every field is not filled in).

Screenshot showing the menu used to add a workflow directly from GitHub to an example workspace. Orange rectangles highlight the 'Import a Workflow' button on the left-hand panel and the 'Github link' and 'workflow name' fields used to import the workflow.

How to find the workflow link

You can access the correct GitHub link in three ways: from Terra, from Dockstore, and directly from GitHub.

  • 2.3. If you've already imported an earlier version of the workflow into your Terra workspace, open the workflow from the workspace's Workflows tab. 

    2.4. Click on the Source link in the workflow's configuration menu. This will surface the source link for the workflow.

    Screenshot of the workflow configuration page for an example workflow on Terra. An orange rectangle highlights the Source link, which is just below the Version drop-down menu.

  • 2.3. Go directly to dockstore.org

    2.4. Log in and click on My Dockstore.

    Screenshot of the Dockstore homepage. An orange rectangle highlights the My Dockstore button with a speedometer icon at the top right of the page.

    2.5. Select Workflows from the left-hand panel of the My Dockstore dashboard.

    2.6. Choose your workflow.

    2.7. Click on the workflow's Info tab and then click on the Source code link under the Workflow Information section to find the GitHub source link.

    Screenshot showing an example My Dockstore screen on the Dockstore website. Orange rectangles highlight (1) the Workflows button on the left-hand panel, (2) an individual workflow, and (3) the Source Code link for that workflow. Click (1) and (2) in order to see (3).

  • 2.3. Go directly to github.com.

    2.4. Log in and navigate to your repositories.

    2.5. Select the repository used for the workflow.

    2.6. Right-click on your workflow's file and select copy link.

Option 3: Browse Dockstore

3.1. Click on the Dockstore link, which will open Dockstore.

Screenshot showing the Workflows tab of an example workspace. An orange rectangle highlights the Dockstore link, which appears after clicking the 'Find & add workflows' button on the left-hand panel.

3.2. Log into Dockstore, then browse and filter within Dockstore to find a workflow.

3.3. Click on the link under the Name and Description column. 

3.4. Click the Terra icon in the Launch with section at the right. 

Screenshot showing the Dockstore dashboard for an example workflow. An orange rectangle and arrow highlight the 'Terra' button, used to export the workflow to a Terra workspace.

3.5. Enter the workflow name, and choose the destination workspace in the popup. Click Import

Screenshot showing the screen used to export a workflow from Dockstore to Terra.

You can only export workflows to existing Azure workspaces You can export Dockstore workflows to an existing Google-backed workspace, or you can create a new workspace while exporting the workflow. Currently, you can only export Dockstore workflows to an existing Azure-backed workspace. If you want to export the workflow to a new Azure workspace, create the workspace first through Terra, then export the workflow to that new workspace.

What to expect

Once you add a workflow, you will be directed to the submission configuration form in your workspace, where you can set up and run your workflow.

Any time you go to the Workflows tab, you will see the new workflow in the list. 

Was this article helpful?

0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.