- 31 May 2023
-
DarkLight
-
PDF
Automations
- Updated on 31 May 2023
-
DarkLight
-
PDF
The automations feature in Operations Manager allows users to control when, how, and with what data a workflow should run. It is designed to replace Automation Catalog at some point in the future. At this time, however, Operations Manager is a purely additive application. You can migrate existing automations from Automation Catalog or create new automations within Operations Manager.
Migrating an Automation from Automation Catalog
To migrate an existing Automation Catalog item:
-
Click the Migrate option in the action dropdown menu:
Figure 1: Migrate Existing Automation
-
Upon confirming the migration, you will be redirected to the 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: Table of Migrated Automation Triggers
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 | Contains shortcuts to commonly used actions and features. These are, from left to right: Create, Import, Home, Search, and Job Metrics. For further information, refer to the Icon Bar section below. |
2 | Automations Accordion | Lists available automations. |
3 | Jobs Accordion | Lists recently opened jobs and job category filters. Refer to the Jobs documentation for more information. |
4 | Quick Start Card | Contains links to important features within Operations Manager such as finding an automation, creating a new automation, and searching Itential documentation. |
5 | Actionable Tasks Tab | Lists workable tasks and retryable tasks. Refer to the Active Tasks documentation for more information. |
6 | Jobs Tab | Lists jobs and allows several common job management actions to be performed. Refer to the Jobs documentation for more information. |
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 | Display the Automations Collection view. | |
Job Metrics | Display 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.
Figure 5: Automation Details View
Label | UI Element | Function |
---|---|---|
1 | Toolbar | Action icons from within the Automation Details view. These icons (from left to right) are: Save, Clone, Export, and Run. |
2 | Menu | Menu button to show the automation metadata, or to delete the automation. |
3 | Trigger | Button to show the Create Trigger modal. Refer to Triggers for more information. |
4 | Workflow | Dropdown used to select and assign a workflow to the automation. |
Action Icons for Automation Details
The action icons within the Automation Details view are referenced below.
Icon | Description |
---|---|
Save changes to the automation name and/or description. | |
Clone the current automation, and include any assigned triggers. | |
Export the current automation and assigned triggers to a .json file. |
|
Open a modal to choose an enabled manual trigger to run. If the automation does not have an enabled manual trigger, then an option is shown to create one. |
Cloning an Automation
An important caveat 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 Metadata
The metadata view shows detailed information about the automation and is where you can update permission groups for the automation.
Figure 6: Metadata Access Controls
Label | UI Element | Function |
---|---|---|
1 | Read Group Input | Select Read permission groups for automation. |
2 | Write Group Input | Select Write permission groups for automation. |
3 | Metadata Actions | Menu options to delete the automation, save changes to read/write groups, or cancel and hide the metadata information. |
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.
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, Multi-select, 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 Checkbox | Checked when automation is selected. |
5 | Menu Button | Automation card actions from within the menu button. These actions (from top to bottom) are: Run, Edit, Clone, Export, and Delete. |
Action Icons in Automations Collection
The action icons 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. |
Edit | Opens the Automation Details page for changes to be made. |
Clone | Clones the automation. |
Export | Exports the current automation and assigned triggers to a .json file. |
Delete | Deletes the automation. |