This user guide provides application information about the Automation Catalog application.
Accessing the Application
The primary ways to access the application are:
From the home screen, locate the Automation Catalog icon card.
Navigate to the Applications menu and select Automation Catalog.
After accessing Automation Catalog, a list of available automations will display in card format.
Edit an Automation
To view and edit an automation:
- Click the stacked dots button (lower-right corner).
- Select Edit.
Create New Automation
To create a new automation:
Click the + icon on the blank card.
Note: See the screenshot of the main canvas section Accessing the Application.
Provide a name for the new automation.
Modify Automation Details
Within an automation, you can change the following attributes.
| Attribute | Description |
|---|---|
| Groups | Write: Group of users that can modify the automation details. Read: Group of users that can view and run an automation. |
| Workflow | Select the workflow that will run when the automation is triggered. |
| Form | If a workflow needs input data (i.e., device name), select a form that will capture this data from users that trigger the automation. You can edit/create forms by clicking the corresponding buttons, which opens the JSON Forms application. |
| Run At | To schedule an automation to be triggered at a certain date and time, use the calendar (date) and clock (time) icon. |
| Repeats | Based on the date and time set in the Run At field, select a recurring interval for triggering the automation. |
Form Data
If you selected a form, it will display on the right side of the screen. For a scheduled automation, form data is required to start the workflow.
- Complete the form fields: name, description.
- Click Save Form Data.
The form data is passed into a workflow through a field called formData, 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.