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 the Workflows tab, click on the Find a Workflow button to surface the modal below.

ToA_Workflows-tab_Screenshot.png

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 suggested workflows

1.1. Click on Browse suggested workflows.

1.2. Click on one of the curated workflows.

1.3. Click Add to workspace.

What to expect

Once you click on a suggested workflow, you will see it in the Workflows tab

Option 2: Add a workflow link (GitHub)

2.1. Select the Add a Workflow link.

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).

ToA_Find-a-workflow_Add-a-workflow-link_Screenshot.png

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.

Option 3: Browse Dockstore

3.1. Click on the Dockstore tab and then the Go to Dockstore button to open Dockstore. 

3.2. 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. 

Terra-on-Azure_Find-a-workflow_Export-from-Dockstore_Screenshot.png

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

Terra-on-Azure_Find-a-workflow_Import-from-Dockstore-popup_Screenshot.png

What to expect

Once you add a workflow (using either the Browse workflows, add a workflow link, or Dockstore option), you will be directed to the submission configuration form, 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?

Comments

0 comments

Please sign in to leave a comment.