.png?sv=2022-11-02&spr=https&st=2024-11-19T14%3A38%3A13Z&se=2024-11-19T14%3A48%3A13Z&sr=c&sp=r&sig=r8x06GdUg2gk3hMwgnpkpyWdQ9Xp%2BMIyoMX83UeThOo%3D){kind=logo}
Automation Builder Generations
- 28 Jun 2024
-
DarkLight
-
PDF
Automation Builder Generations
- Updated on 28 Jun 2024
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Workflow Design
Within Itential Automation Platform (IAP) is Automation Builder for defining and building the automations that may be used by applications in the system. Automation Builder provides a graphical user interface for arranging and connecting tasks and transitions on a canvas to create a flow-based workflow.
Helpful terminology applicable to Automation Builder and workflow design in IAP is referenced in the table below.
| Term | Description |
|---|---|
| Automation | An automation (also known as a workflow) is a collection of tasks in a logical order beginning and ending with terminator tasks (start/end). |
| Job | A job is an instance of an automation. It takes a snapshot of the associated automation to create its existence. |
| Metrics | Metrics are measurements of job execution statistics for automations and tasks. |
| Queue | Tasks live in queues where operators with the appropriate permissions can locate available, claimed, scheduled, and completed tasks. |
| Scheduler | The job scheduler is the process within IAP that scans for automated tasks to be invoked. |
| Task | A task is a functional block within an automation and can be either automated or manual. Automated tasks are shown as green boxes and return one value. With automated tasks, you configure a window of time and when the task starts, it checks the time against that window of time and if the time is within that window, the task will run. Manual tasks are shown as blue boxes, can return multiple values, and are assigned to groups to restrict who is authorized to work them. |
| Transitions | A transition connects one task to another. Transitions can be defined by error (red), success (green), or failure (red) routes and can follow a standard (solid line) route or a revert (dashed line) route. Reverts should be used when transitioning backwards in the automation. |
| Variable | A value that can change, depending on the information (data) that is passed between applications running on a network. |
Automation Builder Generations
Itential's Automation Builder "New Canvas" was released with IAP 2023.1 and offers a clean, modern user experience to automation designers. Workflows created on the older Gen 1 and Gen 2 Canvases can be imported into the New Canvas, however starting in IAP 2023.2, they automatically be converted on to the New Canvas. The table below provides IAP versions versus Automation Builder Canvas type:
Table 1: Automation Builder Canvas Types
| New Canvas | Gen 1 Canvas | Gen 2 Canvas | |
|---|---|---|---|
| IAP 2023.2 | Full Functionality | Import Only | Import Only |
| IAP 2023.1 | Full Functionality | Full Functionality | Import Only |
| IAP 2022.2 | Not Available | Full Functionality | Full Functionality |
New Canvas
Itential's New Canvas and UI for Automation Builder is shown in Figure 1.
Figure 1: New Canvas Automation Builder
Task Types
An automation (job) in the New Canvas will consist of:
- An automatic task denoted by green.
- A manual task denoted by grey.
- The start/end terminators denoted by grey and black.
- An operational task denoted by purple.
Figure 2: New Canvas Tasks
The arrows in Figure 2 represent transitions and show the direction of the workflow. Automation Builder also provides optional role-based access control (RBAC) by restricting task ownership to authorized groups. Users are assigned to groups, and automation tasks can be restricted to specific groups. Only group members are authorized to work tasks. Groups will play a part in task assignment and work queues.
Figure 3 below shows an end-to-end automation (workflow) in the new canvas designed to perform automated and manual tasks using success and failure transitions with revert capabilities. Transitions are identified by two properties:
- The exit status of the leading task.
- The direction of the transition (standard or revert).
Different transitions allow automations to correct anomalies, repeat parts of an automation, skip tasks, manually intervene, or follow the planned execution path.
Figure 3: New Canvas Automation Workflow
Gen 1
Note: The Gen 1 Canvas is available with IAP 2022.1 and IAP 2023.1. Workflows created using the Gen 1 Canvas can be imported into IAP 2023.2, but they will automatically be converted to using the New Canvas.
The first generation canvas and UI for Automation Builder is shown in Figure 4.
Figure 4: Gen 1 Automation Builder
Task Types
An automation (job) in Gen 1 will consist of:
- An automated task denoted by green.
- A manual task denoted by blue.
- The start/end terminators denoted by pink.
- An operation task denoted by purple.
Figure 5: Gen 1 Tasks
Transitions in the Gen 1 Canvas and workflow processes operate in a similar manner to those found in the New Canvas.
Gen 2
The second generation canvas and UI for Automation Builder is shown in Figure 6.
Note: The Gen 2 Canvas is only available with IAP 2022.1. Workflows created using the Gen 2 Canvas can be imported into both IAP 2023.1 and IAP 2023.2, but they will automatically be converted to using the New Canvas.
Figure 6: Gen 2 Automation Builder
In the workflow presented below (Figure 7), an example automation was built in the next generation builder (Gen 2) to demonstrate high-level differences in layout and structure. Note that while the above example from the Generation 1 Builder uses reverts and evaluations to branch and handle runtime errors, the Generation 2 example uses the decision task to decide a single path when multiple options are available, and uses dedicated handlers to process errors.
Figure 7: Gen 2 Workflow
Was this article helpful?
