Versions Compared

Key

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

...

Workflows are represented as a series of steps (see ‘Getting Started 3. Connecting Steps’ from the examples library).  Step headers in blue are initiators, and are candidates for being the first step executed first when the workflow is runinvoked.  

Step headers in green are dependant steps dependent steps and may or may not be executed depending on the specific routing logic built into the workflow.

...

Clicking on any step header will expand the step to reveal the individual sections which the it uses to a long list of step details, separated into sectionsdefine its behavior.  The step header also has a series of buttons on the right which allow you to move the step up in the workflow-order, move the step down in the workflow-order, execute this step in isolation (useful for debugging), and to delete this step from the workflow entirely.

The first section is ‘General Options,’ and it contains a field where you can add a description of what the step is trying to accomplish.  You can also customize the name of the step, and there is a ‘test step’ button which will attempt to run this single API call in isolation.  This is useful for debugging.

The second section is ‘iteration options,’ which deals with how to loop over array responses.  This section will be covered in more detail later.

section also provides a list of user-given inputs used in this step. 

The second The third section is for ‘Required Inputs.’  These are the variables that must be set for the API call to proceed.  This section is not always present, as not all API calls have required parameters.

The fourth third section is for ‘Optional Inputs,’ which are those parameters that the API call might make use of which are not explicitly required.  Some APIs are flexible and allow you to add additional optional parameters. To allow for this, the ‘add input’ button will allow you to define an additional optional input to complete the API call.

...

If there are no optional inputs for a given API call, the entire section is hidden.

After the ‘output’ section appears after the ‘optional inputs sectionThe fourth section is ‘iteration options,’ which deals with how to loop over array responses.  This section shows an example return of the API endpoint, for use in establishing Workflow Linkswill be covered in more detail later.

The ‘Sub Steps’ section describes how to iterate over an array of return objects, similar to the ‘iteration options’ previously.  This will be described in more detail later.

Lastly, the The ‘Conditions & Routes’ section describes the flow-control by which the ACP system chooses what step is next.  The logic involved is complicated and receives its own section later in this document.

Lastly, the ‘Output’ section shows an example return of the API endpoint, for use in establishing Workflow Links.


Links Between Steps

Setting a Required Input or an Optional Input to be a ‘workflow link’ will indicate that this parameter is to be taken from the results of a previous step.  The result can come from any previous step so long as it has run.  

...