Workflow YAML
The Workflow YAML
contains all the information about the Workflow. Its name, description, runner, etc. It also includes a list of the Workflow’s Steps, and each step has a name, action, inputs, and a connection.
Any Workflow has a YAML
format representation which looks like this:
Viewing your Workflow in YAML format
- In the Workflow Editor, in the top-right corner, click the icon and then select the Edit YAML option . Your Workflow is presented in YAML format.
Workflow YAML Grammar
The Workflow YAML is used to describe the Workflow and is defined as YAML
. These attributes are present in the Workflow YAML
file:
-
name
- Name of the Workflow. -
type
- Can be either a Flow or Subflow Workflow. -
Workflow_type
- The Workflow type represents how the Workflow will be used:on_demand
,event
orscheduled
-
active
- True while the Workflow is running, false otherwise. -
desc
- Description of the Workflow. -
connections
- The Workflow’s connection, in the following format:connection-type:connection-name
. -
workflow
- The workflow representation. Workflow is built bysections
that contains aname
andsteps
-
steps
- There are two types of steps: Action and Text. Each type contains different attributes:Action
-
action
- The full name of the action. -
id
- ID of the step. -
name
- Name of the step. -
desc
- Description of the step. -
inputs
- The Action’s inputs, in the following format:input-field-name:value
Action inputs might be encapsulated, for example:
-
connections
- The connection of the step, in the following format:connection-type: connection-name
. -
steps
- Flow Control actions such asinternal.for
iterates over all thesteps
and executes them. -
transitions
- Flow control actions such asinternal.if
contains thetransitions
field built as following:
One of the steps
branches will execute depending on the evaluated condition, which is provided on the if
action.
Text
-
text
- Free text. (this is unrelated to the steps attribute.) -
counting_steps
- The number of steps in the Workflow.
YAML Format Examples
Example of Input and Output Parameters
Download YAML Format of a Workflow
-
In the Workflow Editor, in the top-right corner, click the
icon and then select the Download YAML option . -
It will automatically download a file containing the YAML format of your workflow.