Automation Catalog

On this page:

User Guide

This user guide provides application information about Automation Catalog.

Accessing the Application

The primary ways to access the application are:

  • From the home screen, locate the Automation Catalog icon card.

    Automation Catalog Card

  • Navigate to the Applications menu and select Automation Catalog.

    Applications Menu

After accessing Automation Catalog, a list of automations will display in card format with searching and sorting options available in the top right.

Automations

UI Label UI Element Description
1a plus (+) icon Create new automation from side navigation.
1b plus (+) icon Create new automation from blank card.
2 collection icon Navigate back to the collection view.
3 automation title Click to view/edit automation detail.
4 stacked dots Click to open modal to view/edit automation detail.
5 play button Click to run the automation.

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

Note: A dialog will prompt you to enter a name and description for your automation. Please see the image of the main canvas above in Accessing the Application.

  1. Click the collection icon in the sidebar to navigate back to the collection view (2).

Edit an Automation

There are three ways to view and 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.

Automation Details

UI Label Description
1 Access management. Used to set automation permissions. For more information, see Automation Permissions below.
2 Actions to delete or export an automation.
3 Required. The Automation bound to the item .
4 Optional. The Form bound to the item .
5 View and edit the current form assigned to this automation in Form Builder.
6 Create a new form in Form Builder.
7 Save changes to the automation.
8 Activate this switch to run an automation on a schedule. For more information, see Schedule an Automation below.
9 Run the automation (outside of a scheduled run). Note: Can also run the automation from the play button in the collection view.

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

Automation Permissions

Press the cog icon in the toolbar to display the access management panel which will allow you to assign groups to read or write to an automation.

By default each automation is open (no groups assigned).

Automation Permissions

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

Automation Permissions 2

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.

    Automation Run from Menu

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

    Automation Form-data

Schedule an Automation

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

Property Description
Start on Required. This will be the date of the first instance. Must be set in the future.
Run At Required. Must be set in conjunction with the Start on property. This is the time to run the first instance.
Repeat Optional. Set this property to run the automation on a repeat schedule.
Form Data Optional. Set this property if you want the schedule to pass in formData to the automation.

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"
  }
}

Schedule options

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.

Example

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

Canvas example