- 18 Oct 2024
-
DarkLight
-
PDF
Automations
- Updated on 18 Oct 2024
-
DarkLight
-
PDF
Operations Manager ("Ops Manager") provides a single, unified view into all automations inside of Itential Automation Platform (IAP). The automations feature in Ops Manager allows users to control when, how, and with what data a workflow should run. Moreover, Ops Manager is designed to replace Automation Catalog at some point in the future. For that reason, users can migrate existing automations from Automation Catalog or create new automations within Operations Manager.
How to Migrate an Automation from Automation Catalog
To migrate an existing Automation Catalog automation:
-
Click the Migrate option in the action dropdown menu:
Figure 1: Migrate Existing Automation
-
After confirming the migration, you will be redirected to a newly-created Automation Details page in Operations Manager.
Figure 2: Automation Details
Migrating Automation Triggers
Each migrated automation will automatically have a manual trigger created. This preserves the existing manual run functionality in Automation Catalog using the play button.
If the migrated automation ran on a schedule, a scheduled trigger will also be created with the scheduled options for that migrated automation. Please note, the migrated schedule trigger must be enabled in Operations Manager post-migration. If form data was assigned to the scheduled automation, it will also be added to the newly-created scheduled trigger.
The migrated Automation Catalog item will be preserved in Automation Catalog. Make sure to delete the Automation Catalog item or turn off its schedule if no longer needed post-migration.
Figure 3: Migrated Automation Trigger Cards
Operations Manager UI
The main icons and features of the Operations Manager home page are referenced in the table below.
Figure 4: Operations Manager Home Page
Label | UI Element | Function |
---|---|---|
1 | Icon Bar | Shortcuts to commonly used actions and features. These are, from left to right: Create, Import, Home, Search, and Job Metrics. Further information is provided the Icon Bar section below. |
2 | Automations Menu | Lists available automations. For more detail, refer to the Automation Details section below. |
3 | Jobs Menu | Lists recently opened jobs and job category filters. |
4 | Quick Start Card | Contains links to finding an automation, creating a new automation, and searching Itential documentation. |
5 | Actionable Tasks Tab | Lists workable tasks and retryable tasks. |
6 | Jobs Tab | Lists jobs and allows several common job management actions to be performed. |
Icon Bar
The following table provides a brief description of the features accessible through the Operations Manager Icon Bar.
Icon | Feature | Description |
---|---|---|
Create | Create a new automation. | |
Import | Import an automation in .json file format. |
|
Home | Navigate to the Operations Manager home page. | |
Search | Displays the Automations Collection view. | |
Job Metrics | Displays the Job Metrics Overview window. |
Automation Details
The Automation Details view in Operations Manager is the hub for managing your automation and its associated triggers. To access this view, select any available automation listed in the Automations menu on the left.
Figure 5: Automation Details View
Label | UI Element | Function |
---|---|---|
1 | Workflow | Dropdown used to select and assign a workflow to the automation. |
2 | Menu Button | Displays action icons for the current automation. These icons (from top to bottom) are: Run Now, Clone, Export, and Delete. For more detail, see the next section on Action Icons for Automation Details. |
3 | Triggers Toolbar | Displays action icons to run automations using Triggers. These icons (from left to right) are: Create Trigger, Run Now, and Delete Selected Triggers. |
4 | Automation Properties | Panel used to display and edit automation properties. |
5 | Trigger Cards | Cards used to manage the Triggers to run an automation. |
6 | Save Changes | Saves any changes made to Automation Properties. |
7 | Undo Changes | Reverts any unsaved changes made to Automation Properties. |
Action Icons for Automation Details
Referenced below are the action icons within the Automation Details menu button perform operations on the current automation.
Icon | Description |
---|---|
Opens the Run Automation panel, from which you can select a manual trigger. | |
Clone the current automation, including any assigned triggers. | |
Export the current automation and assigned triggers to a .json file. |
|
Delete the current automation. |
Cloning an Automation with API Triggers
An important limitation must be recognized when cloning an automation with one or more API triggers; the routeName
property of an API trigger must be unique among enabled triggers. For this reason, Operations Manager will disable all API triggers when cloning an automation, and the user must manually choose new route names for the cloned API triggers in the new automation before they can be re-enabled.
Automation Properties
The Automation Properties panel provides an interface to view and edit detailed information about the automation along with updating permission groups for the automation.
Figure 6: Automation Properties Panel
Label | UI Element | Function |
---|---|---|
1 | Run Now | Opens the Run Automation panel, from which you can select a manual trigger to run the current automation. |
2 | Name | Input or edit the name of the automation. |
3 | Description | Optional. Add or change a description for the automation. |
4 | Read Group | Select Read permission groups for the automation. |
5 | Write Group | Select Write permission groups for the automation. |
6 | Save Changes | Save any changes made to Automation Properties. |
7 | Undo Changes | Revert any unsaved changes made to Automation Properties. |
Automations Collection View
The Automations Collection view is where you can view all of your automations, perform bulk actions, and run automations that have manual triggers. To access this view, click the search icon (magnifying glass) in the top-left toolbar of the Operations Manager UI.
Figure 7: Automations Collection View
Label | UI Element | Function |
---|---|---|
1 | Collection Toolbar | Action icons from within the Automation Collections view. These icons (from left to right) are: Refresh, Create, Select All, Clone, Export, and Delete. |
2 | Search Bar | Search and filter automations by name. |
3 | Sort Dropdown | Sort automation names in ascending or descending order. |
4 | Select Box | Checked when automation is selected by user. |
5 | Menu Button | Action icons from within the automation card menu button. These icons (from top to bottom) are: Run, View, Clone, Export, and Delete. |
Action Icons in Automations Collection
The action icons from the menu button within the Automations Collection view are referenced in the table below.
Icon | Description |
---|---|
Refreshes the current automations in the grid. | |
Opens the create automation modal. | |
Selects or deselects all automations in the collection view. | |
Clones the selected automation. | |
Exports the selected automation. One .json file is downloaded per automation selected to export. |
|
Deletes selected automations. |
Automation Card Menu Options
The actions available within the menu button (stacked dots icon) of the automation card are referenced in the table below.
Figure 8: Automation Card Menu Options
Menu Item | Description |
---|---|
Run | Runs the automation. |
View | Opens the Automation Details view for the automation. |
Clone | Clones the automation. |
Export | Exports the current automation and assigned triggers to a .json file. |
Delete | Deletes the automation. |