Workflow variables

In v2.0 workflow variables follow the same structure as Job variables. They are used by the workflow engine to identify input files (located in the Project directory) and workflow outputs. We won't go into detail here, that needs to be reserved for the Job schema documentation, but we'll cover sections that are specifically used by the workflow engine.

Workflow inputs (project files)

Workflow inputs are files that are expected in the Project directory that are linked to step instance directories. These are of type file (or files) in the workflow variables inputs section. Here's an excerpt illustrating an input file declaration: -

variables:
  inputs:
    type: object
    properties:
      candidateMolecules:
        type: file

In order to process a project file a step needs to declare it as being required. You can read more on this subject in the Accessing files section.

Workflow outputs

Workflow outputs are files generated by steps that are expected to be linked into the Project directory from their presence in a step's instance directory once the step has finished. These are of type file in the workflow variables outputs section. Here's an excerpt illustrating an output file declaration: -

variables:
  outputs:
    type: object
    properties:
      clusteredMolecules:
        type: file