Workflow Reference Guide

Enterprise


This article provides a comprehensive breakdown of all of the triggers, connectors, and flow control structures available within Workflow Studio. If you’re just getting started with Workflow Studio, consider checking out this article first: Workflow Studio.

Jump to a section on this page:

Triggers

Asset

Asset Created
A new asset was created with the specified Form.

Asset Updated
An existing asset created with the specified Form was updated.

Job

Job Created
A new Job was created with the specified Job Template.

Job Updated
An existing Job created with the specified Job Template was updated (including Status changes).

Job Status Changed
An existing Job created with the specified Job Template progressed to a new Status. You can select one or more Status to trigger the Workflow.

Request Created
A new Request was created with the specified Form.

Request Updated
An existing Request created with the specified Form was updated (including Status changes).

Request Status Changed
An existing Request created with the specified Form progressed to a new Status. You can select one or more Status to trigger the Workflow.

Manual Trigger
Workflows with this trigger won’t run automatically. You can run them by selecting ‘Run Workflow’ from the action menu on the manager page.

Connectors

Asset Connector

Operation

Description

Inputs

Outputs

Operation

Description

Inputs

Outputs

Create Asset

Create a new Asset

Asset Form & details

Asset Reference

Update Asset

Update an existing Asset

Asset Reference & Form data

None

Generate Link to Asset

Generate a URL to an existing Asset

Asset Reference

URL

Read Asset

Read the details of an existing Asset

Asset Reference

Asset Form & details

Read Asset User Details

Read the details of users associated with an existing Asset

Asset Reference

Asset creator & last modifying user details

Job Connector

Operation

Description

Inputs

Outputs

Operation

Description

Inputs

Outputs

Create Job

Create a new Job

Job Template & details

Job Reference

Update Job Pre-Work Form Data

Update the Pre-Work Form data of an existing Job

The Job Form must have a Pre-Work Form configured, and the Job must be in the Draft, Unassigned, Queued, Rejected, In Progress, or Pending Review Status

Job Reference & Form data

None

Update Job Work Form Data

Update the Work Form data of an existing job

The Job must be in the In Progress or Pending Review Status

Job Reference & Form data

None

Read Job User Details

Read the details of users associated with an existing Job

Job Reference

Job creator, last modifying user, and checked in user (if checked in) details

Generate Link to Job

Generate a URL to an existing Job

Job Reference

URL

Perform Job

Create a new Job and pause the Workflow until the Job has been completed

Job Template & details

Job Reference

Read Job

Read the details of an existing Job

Job Reference

Job Form(s) & details

Cancel Job

Cancel an existing Job

The Job must not be in the Completed or Cancelled Status

Job Reference & cancellation reason

None

Pass Review

Pass the review of an existing Job, moving it to Completed

Job Reference

None

Fail Review

Fail the review of an existing Job, moving it back to Queued

Job Reference

None

Job Status Changed (Event)

Pause the Workflow until an existing Job has entered a specific Status

Job Reference & Job Status(es)

Job Reference & Status

Request Connector

Operation

Description

Inputs

Outputs

Operation

Description

Inputs

Outputs

Create Request

Create a new Request

Request Form & details

Request Reference

Read Request

Read the details of an existing Request

Request Reference

Request Form & details

Read Request User Details

Read the details of users associated with an existing Request

Request Reference

Request creator, last modifying user, and ‘submitted on behalf of’ details

Generate Link to Request

Generate a URL to an existing Request

Request Reference

URL

Accept Request

Set the Status of an existing Request to Accepted

Request Reference

None

Reject Request

Set the Status of an existing Request to Rejected

Request Reference

None

Update Request

Update an existing Asset

Request Reference & Form data

None

Request Status Changed (Event)

Pause the Workflow until an existing Request has entered a specific Status

Request Reference & Request Status(es)

Request Reference & Status

Email Connector

This connector contains a task to send an email to a user in the Workspace. In addition to sending text information, you can optionally attach a URL to create an action button at the bottom of the email.

To include parameters in the Subject & Body of the email, you can use Handlebars syntax. For example: {{ request1234.form.controlA }} would be transformed into the text content of the control with ID ‘controlA’.

Inputs

  • One or more recipient email addresses (must be a Workspace member)

  • Subject line

  • Body text

  • Action button label (optional)

  • Action button link (optional)

 

To link to an Asset/Job/Request Link select Parameter from the Action Button Link dropdown

A Generate Link Asset/Job/Request task must be further up in the Workflow for this to work.

 

To link to a static URL select String from the Action Button Link dropdown.

The URL will need to start with http://, https://, ftp:// or ftps://. http(s) is used for a regular web page and ftp(s) is used for an FTP server for file download.

Flow Control Structures

Parallel Branch

Split the Workflow into 2 or more branches with each branch running at the same time. All branches must run and complete before they come back to one point and then the Workflow can continue.

This structure is useful for improving performance of large Workflows where multiple tasks can run simultaneously.

Exclusive Branch

Split the Workflow into 2 or more branches with only one branch being executed depending on a predefined condition. This is a decision point, equivalent to a ‘diamond’ shape in flow-chart syntax.

To test multiple conditions, you can nest another exclusive branch inside of an outer one.

loop collection.png Loop

Iterate over data (any array type) and perform a set of actions for each data item. Alternatively, you can set an iteration count to perform a set of actions a fixed number of times.

There are 2 drop areas for connectors in the structure:

  • The first (inner) drop area is where you place tasks that should run for each iteration of the loop

  • The second (outer) drop area is where you place tasks that should run after every iteration of the loop has completed

Unlike other control flow structures, loops have a handful of outputs that you can use:

  • ‘Current Value’ is only available to tasks inside the loop - it represents the current data item in the array that we are iterating

  • ‘Current Iteration’ is only available to tasks inside the loop - it represents the current iteration count that we are at (starting from 0)

  • ‘Iteration Outputs’ are available both inside and outside of the loop - it is an array of all of the task outputs from within the loop, where each entry is an object that represents the outputs of a particular iteration

Related articles

Â