Versions Compared

Key

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

...

Triggers

...

...

Asset creation

...

Job Creation

Job Status Change
e.g. changed to Assigned, Completed, Cancelled, etc.

...

Request creation

Request Status Change
i.e. changed to Submitted, Accepted and Rejected

...

...

Started from the Action Menu

Image Removed

Asset Connector

...

Status
colourPurple
titleEnterprise

...

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:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledecimal
excludeRelated articles
typelist
printabletrue

Triggers

Image Added

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

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

Image Added

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.

Image Added

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.

Image Added

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

Image Added Asset Connector

...

Operation

Description

Inputs

Outputs

Create Asset

Create a new Asset

Asset Form & details

Asset

/

Reference

Update Asset

Id

Update an existing Asset

Updates a value in the form data for this asset.Asset (already in the workflow)

Asset Reference & Form data

None

Generate Link to Asset

Generates

Generate a URL to an existing Asset

Asset Reference

URL

Read Asset

Read the details of an existing Asset

Asset Reference

Asset

(already in the workflow)

URL

...

Form & details

Read Asset User Details

Read the details of users associated with an existing Asset

Asset Reference

Asset creator & last modifying user details

Image Added Job Connector

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


Creates a job and workflow continues

Job Template details

Job / Generic Job Fields

Note

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

Note

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

Generates

Generate a URL to

a

an existing Job

Job

(already in the workflow)

Reference

URL

Perform Job

Creates

Create a

job and workflow waits for the job to be Completed before proceeding.

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

Job Template & details

Job

/ Generic

Reference

Read Job

Fields

Read the details of an existing Job

Job

(already in the workflow)

Generic Job Data
+

User chooses the forms related to this job and then all the data from the forms are available.

This is a snapshot of the data as it is when the read is done.

...

Request Connector

...

Operation

...

Inputs

...

Outputs

...

Create Request

...

Request Form details

...

Request / Request Id

...

General Link to Request

...

Request (already in the workflow)

...

URL

...

Read Request

...

Request (already in the workflow)

...

Generic Request Data
+

User chooses the form related to this request and then all the data from the form is available.

...

Accept Request
Reject Request

...

Request (already in the workflow)

...

None

...

Update Request

Updates a value in the form data for this request.

...

Request (already in the workflow)

...

None

...

Email Connector

...

Reference

Job Form(s) & details

Cancel Job

Cancel an existing Job

Note

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

Note

The Job must be in the Pending Review Status

Job Reference

None

Fail Review

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

Note

The Job must be in the Pending Review Status

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

Image Added Request Connector

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

Note

The Request must be in the Submitted Status

Request Reference

None

Reject Request

Set the Status of an existing Request to Rejected

Note

The Request must be in the Submitted Status

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

Image Added Email Connector

This connector contains a task to send an email to a user in the Workspace. The email has fixed text in the title and the body but you can attach a URL. You can set up the text and the URL on the input tab. The URL link will appear as a button at the end of the text.

The Email connector does not support HTML content.

If you want to embed the details from an asset, job or request, use the {{stepid.fieldname}} notation. See Sample Workflow Date Time Comparisons workflow for an example.

...

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’.

Note

The Body does not currently support HTML formatting

Inputs

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

  • Subject line

  • Body text

  • Action button label (optional)

  • Action button link (optional)

Parameter ScreenshotImage Added

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

A Generate Link Asset/Job/Request

connector

task must be further up in the

workflow

Workflow for this to work.

Image Removed
Image Added

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

The URL will need to start with http://, https://, ftp://

and

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

Image Modified

...

Parallel Branch

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

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

Image Modified

...

Exclusive Branch

Split the workflow 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.pngImage Added 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.

Note

Currently, loops will only run a maximum of 20 iterations. Attempting to run more than that will result in a failure at runtime. If you have a unique use case that requires more than 20 iterations, please raise a support ticket with us.

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

Filter by label (Content by label)
showLabelsfalse
max5
maxCheckboxfalse
showSpacefalse
reversefalse
cqllabel = "workflowstudio"

...