@itentialopensource/workflow-error-event-demo NPM

Workflow Error Event Demo

Overview
Installation Prerequisites
Features
How to Install
How to Run
Additional Information

Overview

This Pre-Built demonstrates how to utilize the Operations Manager event-base trigger (Workflow Error specifically).
The Pre-Built consist of the following:
1. An Operations Manager item named run-on-workflow-error that includes a workflow-error event base trigger. This trigger is configured to fire only when the following conditions are met:

A job changed status from running state to error
The job description is error (using payload schema filter)

Entry point Operations Manager item named generate-workflow-error. This entrypoint is controlled by JSON Form that can result new job in 4 different outcomes:
- Job finish successfully - no event trigger fired
- Job finish successfully w/ job description error - no event trigger fired
- Job goes into error state - no event trigger fired (schema mis-match)
- Job goes into error state w/ job description error - event trigger fires (schema match)
Once the trigger fires successfully, a new job starts and displays context information to the user:

Estimated Run Time: less than a minute

Installation Prerequisites

Users must satisfy the following pre-requisites:

Itential Automation Platform
- ^2023.1

Features

The main benefits and features of the Pre-Built are outlined below.

Demoes a workflow error event trigger
Able to run four different outcomes
Gives context on the name of the workflow that errored, the ID of the workflow that errored, what the user inputted for the formData, who initiated the automation, and the error message

How to Install

To install the Pre-Built:

Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Installation Prerequisites section in order to install the Pre-Built.
The Pre-Built can be installed from within App-Admin_Essential. Simply search for the name of your desired Pre-Built and click the install button (as shown below).

install

How to Run

Use the following to run the Pre-Built:

This Pre-Built runs in Operations Manager by filling out the formData and clicking Run. The user will be presented with the form to select options for how they wish the workflow to run.

run