Automation Catalog UI

Automation Catalog UI

The main user interface (UI) for Automation Catalog is described below along with summary descriptions for various features and functionality.

Create New Automation

There are two ways to create an automation.

1. Click the plus (+) icon in the side navigation (1a).
2. Click the plus (+) icon on the blank card (1b).

After clicking the (+) icon, the Create Automation dialog will open. Once you to enter a name and description for your automation, click the Create button. You will be redirected to the collection view and the automation will be added to the collection list in the left sidebar.

Edit an Automation

There are three ways to edit automation details.

1. Click the title of the automation (3).
2. Click the stacked dots button to edit details (4).
3. Click the name of your automation in the left side navigation.

Modify Automation Details

Within an automation, you can change multiple attributes.

Note: If working to access your form data from the automation canvas, please see Querying Form Data below.

Automation Permissions

Click the cog icon at the top of the Automation Details page to open the Access Management panel, which allows you to assign user groups authorized to change and/or view an automation. By default, no group permissions are assigned, which grants all users permission to change, view, and execute an automation.

• To assign Read-Write permissions to a group, use the search bar to locate the appropriate group. Once all group selections are made, click Save.
• Groups with Write permissions are authorized to change, view, and execute an automation while Read-only groups have permission only to view and execute.
• If a Write group or Read-only group is set, then the counterpart group must also be defined; in other words, a Write group cannot be configured without at least one group specified as Read-only and vice versa.

Note: A warning message will appear if modifying these permissions will negatively impact the current user.

Run an Automation

There are two ways to run an automation.

Method 1

1. Press the Run Manually button (see image above).

Method 2

1. From the Automations page, click the stacked dots menu button.

2. Select Run.

   

3. Input the form data, if required. Then click Run.

   

Schedule an Automation

To run an automation on a schedule, activate the Schedule switch slider. Once the switch is activated, set the schedule properties.

Example

The following is an automation that runs every evening at 10:30pm (from July 4th onward) and passes in the following data to an automation.

{
  "formData": {
    "name": "paul"
  }
}

Querying Form Data

The form data is passed into a workflow through a formData field, which is available as a job variable in Workflow Builder. You can use the query task in Workflow Builder to access data that is stored in different containers within the formData object.

Of note, the formData object will not appear as a job variable option initially.

It must be added manually using the EDIT button to the right of the job options.

Once the formData option is added manually, it will be available as a job option in other tasks throughout the automation.

Example

The following is an example of querying form data on the automation canvas.