Creating or editing a new Workflow in Terra currently requires working in the "Broad Methods Repository." This article includes step-by step instructions for how to create a new workflow, edit a workflow, and share or clone a workflow, as well as a Glossary of Terms.
1. Create a new workflow
1.1. Navigate to the Workflow tab in your workspace and click on the "Find a Workflow" card:
1.2. From the popup, click on the Broad Methods Repository at the bottom, under "Find Additional Workflows":
1.3. You will be redirected to the Broad Methods Repository, where you can click on the blue button at the top right corner to "Create New Method. +":
1.4. Clicking the 'Create New Method.. +" will open up a modal to set up your new Workflow
You will enter your Namespace* and the Name of your new Workflow followed by your WDL (enter manually or with "Load from file..."). Workflow names can include letters, numbers, underscores, dashes, and periods. Press "Upload" once you've filled in all the information.
Glossary of terms (expand)
Namespace* acts like a folder containing workflow and workflow configs. For example, if
Many analysts choose to put their name and/or institution in the namespace field. You can
You can permit others to use your namespace. This is great for labs who have multiple
In this case, we may add the namespace "SupportDocs" to any workflows that we create
Name is the name of the specific workflow you are creating. This can be any name as
Documentation is where you can add information about the WDL and what it does. We
Snapshot is a numerical value assigned to the WDL similar to a versioning system. From
1.5. Once you've finished uploading, you'll be directed to your new workflow
You can "Export to Workspace..." from the top right-hand corner:
1.6. The configuration lets you set inputs and save them to use again and again
You can select a configuration if one already exists or use a blank configuration:
1.7. Choose the destination workspace
This is the Terra workspace you were working in and would like to export your Workflow to. You should be prompted to go to the destination workspace, which will redirect you back to your Terra Workflows tab where you should see your new workflow:
Use FISS to upload to the Methods Repository (step-by-step)
1. Install FISS
You'll find instructions to do this in the readme of the FISS repo https://github.com/broadinstitute/fiss
2. To see the command line format and optional variables
3. To put a WDL into a certain namespace with a method_name
Run the following
fissfc meth_new -m method_name -n method_namespace -d path/to/local/wdl/file [-s desc of method] [-doc optional documentation] [-c optional snapshot comment]
-dinputs are required.
2. Edit a workflow in the Broad Methods Repository
2.1. Open your workflow in the Broad Methods Repository (Summary tab):
2.2. Press "Edit..." from the left-hand bar
This should bring up the same modal used to create your workflow:
2.3. You can edit directly in the WDL section window
The program will automatically recognize syntax errors when you press Upload. You can also change the snapshot comment depending on the changes that you made.
2.4. Press "Save as New Snapshot"
You can see that there are now 2 Snapshots. You will not need to export this workflow again to Terra. Just go to the Workflow tab to toggle between the snapshots when you click into the workflow.
3. Share or clone a workflow
You can duplicate (clone) a workflow within your workspace or export to a new workspace following these steps:
3.1. Go to the Workflows tab of your Terra Workspace
3.2. Click the three button icon for the workflow you want to share
3.3. Select "Duplicate" to clone the workflow within the workspace or select "Copy to Another Workspace" to copy (clone) to a different workspace