What to expect when you submit a workflow

Allie Cliffe
  • Updated

Learn what to look for and how to keep tabs on your workflow for each submission.

Successful workflows

You can look for outputs in the data table (in the Data tab) if you configured outputs to write to the data table (this.X).

Remember “this” refers to what data entity you are running your workflow on (i.e., what table contains links to the input data files). If you chose participant and called an output this.participant_file, a new column (participant_file) with links to the output will display in the participant table. The actual output files will be saved to workspace storage (i.e., Google bucket).

You can also view outputs from the Job Manager page from the Job History page by clicking on the succeeded submission (far left in the Job History list page)

1. Select Succeeded from the Submission status dropdown. 

2. Click on the Job Manager icon at the right.

Screenshot of Job History tab with 1. a circle highlighting the suceeded workflows - in the dropdown beside the search field and 2. a circle around the icons for the backend log, dashboard and backend log directory icons at the far right of the row corresponding to data entity NA12878: Troubleshooting_Job-History-details-succeeded-Screen_shot.png

3. In the Job Manager page, access Outputs by selecting the icon under Outputs (1). You can also access details in the backend log and execution directory by selecting from the icons at the right (2).

Screenshot of the list view for a successful run of the ProcessingForVariantDiscovery workflow on the Job Manager page with a circle and number one highlighting the inputs and outputs and a circle and number two highlighting the backend log and execution log icons in the links column of the row for the successful CreateSequenceGrouping task

Failed workflows

A red triangle icon means your workflow submission failed to run or complete for some reason. Never fear! It happens to everyone. To learn more about how to troubleshoot errors and achieve successful submissions, see Troubleshooting workflows: Tips and tricks

Screenshot of the job history page for a failed workflow. The red exclamation point failed icon is in the status column of the HG00187 (sample) row and there is an arrow pointing to the icons for the backend log, dashboard and backend log directory icons at the far right of the row

Submissions: what happens behind the scenes

When you launch a workflow, there are a lot of subsystems working together to make sure your submission completes successfully and quickly, no matter how big or small. To learn more about what happens on the backend, see Overview: How the workflow system works

Get notified about your workflow via email

Now, when you launch a workflow on Terra, you will receive emails that tell you if your submission succeeded, aborted, or failed. The goal of these emails is to free you from checking your workspace to figure out what’s going on with your submission. These notifications are activated by default.

If you prefer not to receive notifications, you can go to your profile page in Terra and disable them. To toggle notifications on/off, check per workspace to make sure the opt-in boxes work best for you.

What to expect

If your submission succeeds, you will get a message like this.
Screenshot of message titled 'a submission that you launched recently has succeeded' that includes details about the workspace name, submission ID, final status (succeeded), date submitted, workflow configuration, data entity, number of workflows, and comments

Or, if your submission aborts, you will get a message that looks like this.
Screenshot of message titled 'a submission that you launched recently has been aborted' that includes details about the workspace name, submission ID, final status (aborted), date submitted, workflow configuration, data entity, number of workflows, and comments

Or if your submission fails, you will get an email that looks like this.
Screenshot of message titled 'a submission that you launched recently has failed' that includes details about the workspace name, submission ID, final status (failed), date submitted, workflow configuration, data entity, number of workflows, and comments

Do you find these emails help you concentrate on other work? Send us a message at https://support.terra.bio/hc/en-us/community/topics.

 

Was this article helpful?

1 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.