Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

User Inputs

Setting a Required or Optional any Input to ‘user given’ indicates that this parameter is a required input from must be supplied by the user who executes this workflow.  This parameter must be supplied for the workflow to run, regardless of whether the step where it is introduced is ever executed.

When the ‘user given’ option is selected the form changes to show an additional field where this variable can be named.  These variable names are global in scope, and the same name used multiple times will refer to the same variable, and will be requested from the user only once.  For example if your variable is ‘customer_name’ and it is used in three separate steps, the workflow will only request ‘customer_name’ once and use it in all three instances.

...

The ‘Conditions & Routes’ section examines the data returned as the result of a workflow step and decides which step is next.  The workflow creator can define an unlimited number of separate conditions leading to different next steps, and each condition can consist of an unlimited number of individual comparisons.  The system evaluates each condition in order, from top to bottom, and immediately proceeds when it finds a match.

The “add condition” button in the upper-left is used to create a new condition.  Each Conditions & Routes section can have an unlimited number of routes defined. Individual routes can be removed by clicking the trashcan icon at the right, and the route can be renamed by clicking on the existing name in the header.

...

Each routing section is evaluated in order, from top to bottom, until a match is found.  Once a match is found the system proceeds to the indicated step without evaluating further conditions.  Multiple matches are not checked for. If no next-route is found, the workflow errors, possiblly triggering possibly triggering a rollback.

Initially each condition consists of a single comparison clause.  All comparison clauses consist of a ‘left value,’ which indicates source data, an ‘operator,’ which defines the nature of the comparison, and a ‘right value,’ which denotes the comparison data.

...

  1. http code:  uses the HTTP code returned by the API call in the step.
  2. body:  accesses some value in the body of the API request.  Parameters are accessed by name, and arrays are accessed by “$index.parameter” as elsewhere.  (ex: the name of the first object in an array would be ‘0.name’)
  3. default value:  a static, default value defined by the workflow creator
  4. user given:  a value which must be supplied when the workflow is invoked
  5. workflow link:  a reference to data obtained in a previous step
  6. function:  indicates that the data for this field is the output of a data-processing function.  These functions are described in greater detail later in this document.


The ‘operators’ are largely self-explanatory boolean comparators, but a few require special syntax:

...