Automations
  • Dark
    Light
  • PDF

Automations

  • Dark
    Light
  • 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:

  1. Click the Migrate option in the action dropdown menu:

    Figure 1: Migrate Existing Automation

01_migrate_existing_automation(9)

  1. Upon confirming the migration, you will be redirected to the newly-created Automation Details page in Operations Manager.

    Figure 2: Automation Details

02_automation_details_21.2

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

03_migrated_automation_trigger_table_21.2

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

04_opsManager_homePage

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. For further information, refer to the Jobs documentation.
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. For further information, refer to the Active Tasks documentation.
6 Jobs Tab Lists jobs and allows several common job management actions to be performed. For further information, refer to the Jobs documentation.

Icon Bar

The following table provides a brief description of the features accessible through the Operations Manager Icon Bar.

Icon Feature Description
25_create_icon Create Create a new automation.
26_import_icon Import Import an automation in .json file format.
27_home_icon Home Navigate to the Operations Manager home page.
28_search_icon Search Display the Automations Collection view.
29_job_metrics_icon 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

05_single_view_details(2)

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 delete the automation.
3 Trigger Button to show the Create Trigger modal.
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 in the table below.

Icon Description
06_save_icon(2) Save changes to the automation name and/or description.
07_clone_icon(4) Clone the current automation, and include any assigned triggers.
08_export_icon(4) Export the current automation and assigned triggers to a .json file.
09_run_icon(2) 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

10_metadata_access_control(2)

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 and/or 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

11_automation_collection_view(2)

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 box 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
21_refresh_icon(2) Refreshes the current automations in the grid.
19_create_automation_icon(2) Opens the create automation modal.
22_multi_select_icon(2) Selects or deselects all automations in the collection view.
07_clone_icon(4) Clones the selected automation.
08_export_icon(4) Exports the selected automation. One .json file is downloaded per automation selected to export.
23_delete_icon(2) 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

24_menu_options(2)

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.

Triggers

Triggers enable you to run automations in four different ways, each described in the table below. You can assign as many triggers as you like to an automation and have more than one of each type. You can find more details about each trigger type in the sections that follow.

Trigger Type Function
Manual Runs the automation using its play button, with an optionally assigned JSON Form.
API Endpoint Runs the automation from a unique endpoint using an HTTP POST call, optionally using the request body of the HTTP POST call as the assigned workflow's input.
Schedule Runs the automation at some point in the future at an optional repeating frequency. Also includes an optionally assigned JSON Form.
Event Runs the automation when a system event occurs.

Workflows initiated by triggers will mention Operations Manager in the Jobs job description.

Figure 9: Operations Manager in Job Description

12_triggers_job_manager(2)

Creating and Editing Triggers

To create a trigger:

  1. Click the + Trigger button on the automation details page.
  2. Enter a name for the trigger.
  3. Use the dropdown to select the trigger type you want to create.
  4. Complete the appropriate fields for the trigger type that was selected. More detail on each trigger type is presented below.
  5. Click save to retain all the inputs.

You can edit existing triggers from the Triggers Table UI. Click the menu icon (stacked dots) at the end of a trigger row and then select Edit from the list of menu actions.

Manual Triggers

Manual triggers run an automation using the play button.

Figure 10: Create Trigger Modal

13_create_manual_trigger(3)

Label UI Element Function
1 Enabled Toggle this switch to enable the trigger to run (or not run).
2 Name Add or change the trigger name.
3 Type Dropdown menu to select or change the type of the trigger to create.
4 Form Optional. Dropdown menu to select the JSON Form to run the assigned workflow with.
5 Create new form Click the plus (+) sign to open the Automation Studio create modal in a new tab to create a new JSON Form.
6 Current Form Data The assigned form data for the trigger. Contains the default values from the JSON Form or the form data from the last run.
7 Save Button to save the manual trigger and, if applicable, any assigned JSON Form data and its inputs.
8 Save and Run Button to save the manual trigger and, if applicable, any assigned JSON Form data and its inputs. Immediately runs the automation with the JSON Form data after saving.

Running Automations from Manual Triggers

To run an automation:

  1. Click the play button in the top left of the Automation Details page. The Run Automation modal opens.
  2. Select an enabled manual trigger to run the automation. You can also edit its optional JSON Form data.
  3. Click Run.

By having multiple manual triggers, you can more easily run an automation with different JSON Form data.

Figure 11: Manual Run Trigger Modal

14_manual_run_modal(3)

API Endpoint Triggers

API endpoint triggers run the automation they are assigned to whenever the API endpoint they are configured to listen on receives an HTTP POST request. When an API endpoint associated with an API endpoint trigger receives an HTTP POST request:

  • The body of the HTTP POST request (represented as a JSON object) is validated against the POST body schema defined in the API endpoint trigger.
  • If the body of the HTTP POST request is validated, it is sent to an optional JST defined in the API endpoint trigger.
  • After the JST is applied (if relevant), the keys and values of the HTTP POST request body are made available to the workflow and the automation is run.
  • The API endpoint that triggered the automation will respond to the client with information about the workflow that was started.

Note: If you wish to use keys and values from the body of the HTTP POST request in a workflow, you must reference them as job variables within the workflow itself. For further information, refer to the Variables section of the Tasks documentation in the IAP Automation Studio User Guide.

Each API trigger requires a unique route name. URLs for endpoint triggers use the following format:

/operations-manager/triggers/endpoint/:routeName

Figure 12: Create API Endpoint Trigger

15_create_api_trigger_21.2

Label UI Element Function
1 Action The HTTP type will always be POST.
2 Route Required name input. The unique route name for the endpoint. /operations-manager/triggers/endpoint/:routeName
3 JST (Optional) Select the JST to transform the POST body to the assigned workflow's input schema. For more information, refer to the JST Tool documentation in the IAP Automation Studio User Guide.
4 POST-body Schema The JSON schema the POST request body must match. For more information, refer to the POST Body Schema section.

POST Body Schema

The POST body schema is a JSON schema against which the body of the HTTP POST request is validated. If the HTTP POST request body is validated, the API trigger continues its preparations to run the automation. If the HTTP POST request body is not validated, the automation is not run.

The POST body schema uses the following syntax:

{
    "type": "object",
    "properties": {},
    "additionalProperties": true
}
Property Description
type Refers to the HTTP POST request body, which is represented as a JSON object.
properties This is where the variables the HTTP POST request body should be validated against are defined.
additionalProperties Allows variables not defined in the properties key of the POST body schema to be present in the HTTP POST request body without affecting validation. Default is true.

Schedule Triggers

Schedule triggers run the automation at some point in the future at an optional repeating frequency.

Note: The time and date selected in the modal and shown in the trigger table after saving is based on the user's current time and date.

Figure 13: Create Schedule Trigger

16_create_schedule_trigger_21.2

Label UI Element Function
1 Start On Required. Calendar icon to choose date for when to start running the automation.
2 Run At Required. Clock icon to choose time for when to start running the automation.
3 Repeat Every Optional. Select the frequency (how often) the trigger should run the automation.
4 Process Missed Runs Required. Should a scheduled item fail to run, this option sets whether or not Operations Manager should run all, none, or the most recently missed scheduled run.
5 Form Optional. Select the JSON Form to run the assigned workflow with.
6 Current Form Data View or edit the contents of the selected JSON Form.

Event Triggers

Event triggers run the automation they are assigned to whenever the event they are configured to listen for occurs. When an event occurs in Itential Automation Platform (IAP):

  • The event system of IAP publishes an event object, which is a representation of that event as a JSON object.
  • The payload key of the event object is validated against the payload schema filter defined in the event trigger.
  • If the payload passes validation, the event object is sent to an optional JST defined in the event trigger.
  • After the JST is applied (if relevant), the payload is made available to the workflow and the automation will run.

Note: If you wish to use keys and values from the event object in a workflow, you must reference them as job variables within the workflow itself.

For more information:

  • Refer to the Variables section of the Tasks documentation in the IAP Automation Studio User Guide.
  • Refer to the Event System documentation in the IAP Developer Guide to learn more about event objects.

Figure 14: Edit Event Trigger

17_create_event_trigger(2)

Label UI Element Function
1 Event Required. Select the event that should run the automation.
2 JST Optional. Select the JST to transform the event payload. For more information, refer to the JST Tool documentation in the IAP Automation Studio User Guide.
3 Payload Schema Filter The JSON schema that the event payload must conform to. For more information, refer to the Payload Schema Filter section (see below).

Payload Schema Filter

The payload schema filter is a JSON schema against which the payload key of an event object is validated. If the payload is validated, the event trigger continues its preparations to run the automation. If the payload is not validated, the automation is not run.

The payload schema filter uses the following syntax:

{
    "type": "object",
    "properties": {},
    "additionalProperties": true
}
Property Description
type Refers to the payload key of the event object, which is itself a JSON object.
properties This is where the event variables the payload should be validated against are defined.
additionalProperties Allows variables not defined in the properties key of the payload schema filter to be present in the payload without affecting validation. Default is true.


⚠Warning

It is possible to create an infinite job execution loop if an automation can activate its own event trigger. This is especially applicable when using the following events in an event trigger:

  • jobStart
  • jobCancel
  • jobError

When using an event trigger to run an automation, be sure the workflow executed by the automation cannot generate an event that will activate that event trigger.

Triggers UI

The triggers table is where to view an automation's triggers. You can view trigger names, trigger types, and check if they are enabled. If the trigger is a scheduled trigger, then the table also shows the date and time of the next scheduled run in your local time.

To edit or delete a trigger, hover over the menu button at the end of a row to view the trigger actions. If the trigger is a manual trigger, the option to run the trigger will be available. This will show the manual run modal, and behaves the same as the play button on the left of the Automation Details page and in the Automation Collections view.

Figure 15: Triggers Table

18_automation_detail_trigger_table_21.2


What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.