Automation Builder

On this page:

User Interface

Automation Builder provides a graphical user interface for arranging and connecting tasks on a canvas to create a flow-based automation. The main view displays a list of all automations in the system.

Viewing and creating automations

Automations View

Create Automation View

Note: For advanced information of this view, see the Automation Studio Overview.

Editing automations (canvas view)

Canvas View

Label UI Element Function
1 Collection view Advanced list view for seeing multiple automations.
2 Search Search for available automations in the system.
3 Applications menu Applications that comprise the Automation Studio suite.
4 Sidebar control Allows the user to shrink or expand the sidebar navigation.
5 Automation title bar Buttons (from left to right) for Settings, Start Job, Clone, Delete
6 Transition toolbar Functions (from left to right) include Transition selector (T key), Transition binding, Transition action
7 Task toolbar Buttons (from left to right) to Increase font size, Decrease font size, Fit automation, Copy task, Delete task.
8 Save Save the current automation if any changes have been detected.
9 Task search Search for available tasks.
10 Deprecated task toggle Shows or hides deprecated tasks.
11 Task list Available tasks for the automation.
12 Task list controls Allows user to shrink or expand the task navigation.

Rename an Automation

  1. Click the Settings button Settings Button in the title bar. Automation Builder will open the Automation Settings dialog.
  2. Type the new automation name into the Automation Name field.
  3. Click SAVE.

Figure: Automation Settings Dialog

Automation Settings Dialog

Automation Groups

As an option, automation groups restrict who is authorized to start jobs from an automation. When automation groups are assigned, only group members can start jobs from the automation.

Automation groups are a similar concept to task groups that restrict who is authorized to work a manual task.

To set optional automation groups:

  1. Click the Settings button Settings Button in the title bar. Automation Builder will open the Automation Settings dialog.
  2. Begin typing the name of a group in the Automation Groups field. Matching group names will appear in a list after you begin typing.
  3. Click the correct group name to add that group to the automation groups. The group will not be added unless it is selected from the list. Add as many groups to the automation groups as desired.
  4. Click SAVE.

See the Automation Settings Dialog figure above.

Resize Automation to Fit Window

  1. Click the Fit Window button Fit Window Button in the upper right corner of the Automation Builder canvas. The automation will be reduced to fit within the visible area of the canvas.
  2. Click SAVE

Clone an Automation

  1. Click the Clone button Clone Button in the title bar. Automation Builder will open the Clone Automation dialog.

  2. Type a name for the cloned automation.

  3. Click SAVE.

    Figure: Clone Automation Dialog

    Clone Automation Dialog

Start an Automation

  1. Click the Start button Start Button in the title bar to open the Job Description dialog (see figure below).

  2. Enter a description for the job (optional).

  3. Click START.

    Figure: Job Description

    Job Description Dialog

    Automation Builder will analyze the automation and find all job variables. If an automation requires job variables, Automation Builder will display the Set Variables dialog box where you can see the required job variables set to null values (see figure below).

  4. Enter the desired values with the required data types, e.g., "device": "er1.wdc".

  5. Click START.

    Figure: Set Variables Dialog

    Set Variables Dialog

Troubleshooting Automations

Q: What happens if my automation is incomplete or has an error?

A: When an automation is incomplete or has an error, it is saved as a draft. The "DRAFT" indicator appears on the bottom-right corner of the canvas, with the number of errors in the automation. An error modal also displays with a description of the errors. You can close the modal by clicking CLOSE. To see the errors again, click DRAFT.