Job Cancel Push Notifications
- Matthew Wren
Background
This Push Notification can be used to inform an external system whenever a job is cancelled in ServiceOptimizer.
Triggers
When configured (see below), a Job Cancel push notification is sent whenever a job is cancelled in ServiceOptimizer via the following APIs:
Configuring
Job Cancel push notifications can be enabled/disabled by setting the flag value shown below in the sp213_scheduler_parameters database table for the relevant FRU (or, enabled/disabled globally by setting the value in the sp083_system_parameters database table).Â
 Remember that before enabling Job Cancel push notifications, details of where to send the notifications also needs to be set up. Please see the Push Notifications page for details.
| Column Name | Type | Description |
|---|---|---|
notification_job_cancel | boolean | Defines if Job Cancel push notifications will be sent or not. |
In addition, when Job Cancel push notifications are enabled, the following flag value must also be set in the sp083_system_parameters database table.
| Column Name | Type | Description | Min. Value | Max. Value | Default Value |
|---|---|---|---|---|---|
| int | Defines the number of days that cancellation data will be retained in the system before being purged. | 2 | 2 | 2 |
Object Format
The Job Cancel push notification will send a JSON object to the configured API with the following format:
{
"Type": "-1",
"WorkItemType": "1",
"WorkItem": {
"Id": ""
"WorkStatus": ""
}
}
Object Properties
The Job Cancel push notification's JSON object has the following properties.
| Property | Type | Required? | Description | |
|---|---|---|---|---|
Type | string | Yes | The type of notification being sent. For a Job Cancel push notification, this value will always be -1 (minus one), indicating the notification represents a cancellation action. | |
WorkItemType | string | Yes | The type of work the notification is about. For a Job Cancel push notification, this value will always be 1 (one), indicating the notification is about a job. | |
WorkItem | object | Yes | ||
Id | string | Yes | ServiceOptimizer's unique ID for the job that the Job Cancel push notification is about. | |
WorkStatus | string | Yes | A DisStatus code, representing the status of the job at the time of the Job Cancel push notification. | |