The Seven Bridges Knowledge Center

The Seven Bridges Platform is a simple solution for doing bioinformatics at industrial scale. But sometimes, everyone needs a little help.

Get Started

Set execution hints at node level

Via the visual interface

  1. Go to the Apps tab of your project dashboard.
  2. Click the pencil icon corresponding to the workflow you want to edit to open the Workflow Editor.
  3. In the Workflow Editor, click the node for which you want to set the hint. The node you select must represent a tool – you cannot set hints for input or output nodes.
  4. Click the ellipses icon corresponding to the node to see the settings for the step.
  5. Click the tab marked HINTS.
  6. Set the node-level instance in the HINTS tab:
    a. Enter the name of the hint you are setting in the Requirement class field, e.g. sbg:AWSInstanceType.
    b. Enter the value for the hint in the Requirement value field, e.g. c3.8xlarge. Instances that can use only attached EBS storage have just CPU and RAM information shown in brackets, while those that have their own storage also include information about the storage capacity.
    c. If needed, add or change the value in the Attached Storage field to define the size of storage attached to the computation instance.
  7. Click Save.

Via the API

  • To set node-level hints via the API, include those hints in the CWL specification of the workflow when adding a new app or adding a new revision of an app.
  • Node level hints should be placed in an array named hints at the top level of the appropriate step object in the workflow JSON file. Step objects themselves are contained in an array named steps at the top level of the workflow JSON.
  • A hint is represented by a JSON object with the following fields:
FieldDescription
classThe name of the hint to set
valueThe value to assign to this hint

AWS

{
  ...
  "steps": [
    ...
    {
      "hints": [
        {
          "class": "sbg:AWSInstanceType",
          "value": "c4.8xlarge;ebs-gp2;2000"
        }
      ],
      ...
    },
    ...
  ],
  ...
}

In this case, the node uses the c4.8xlarge instance with 2000 GB of attached EBS storage. The value of sbg:AWSInstanceType consists of the following three parts:

  • instance type, e.g. c4.8xlarge
  • attached disk type: ebs-gp2
  • attached disk size in GB

Updated 10 months ago

Set execution hints at node level


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.