Itential Platform publishes events using an internal Event System.
To subscribe to an event topic, a source and event handler need to be provided. The format is source, topic, handler as illustrated in this example:
eventSystem.subscribe("@itential/app-workflow_engine", “jobStart”, jobStartHandler);
Job Events
Event topics published to the Itential Platform environment are referenced in the table below.
| Event Source | Event Topic | Description | Payload |
|---|---|---|---|
@itential/app-workflow_engine |
jobStart |
Publishes on job start. | Started job |
@itential/app-workflow_engine |
jobComplete |
Publishes on job complete. | Completed job |
@itential/app-workflow_engine |
jobError |
Publishes on job error. | Error job |
@itential/app-workflow_engine |
jobFix |
Publishes on job revert. | Reverted job |
@itential/app-workflow_engine |
jobPause |
Publishes on job pause. | Paused job |
@itential/app-workflow_engine |
jobResume |
Publishes on job resume. | Resumed job |
@itential/app-workflow_engine |
jobCancel |
Publishes on job cancel. | Canceled job |
@itential/app-workflow_engine |
jobSlaBreach |
Publishes on breach of job SLA. | Job SLA |
@itential/adapter-nso |
ncs-alarms |
Publishes on alarm encountered in NSO. | NSO alarm object |
@itential/adapter-nso |
ncs-events |
Publishes on NSO events. | NSO events object |
@itential/adapter-nso |
device-notifications |
Publishes on NSO device notifications. | NSO notifications object |
@itential/adapter-nso |
service-state-changes |
Publishes on NSO service state changes. | NSO service state changes object |
Job SLA Events
FOR DEV 2023.1 & 2023.2
There are two main avenues for the events defined above to be used within the platform: Operations Manager Triggers and the EventListenerJob Task within a workflow. Users can therefore build automations in Operations Manager that are triggered to fire an event when a job breaches its service level agreement (SLA). The event payload will contain the following:
{ job, runTime, slaDelta: runTime - job.sla, }
Configuration for the EventListenerJob task to receive the jobSlaBreach event is depicted in Figure 1.
Figure 1: Task Configuration
For additional SLA information, refer to Setting Job Metrics.