Job Status Push Notifications
- Matthew Wren
Background
This Push Notification can be used to inform an external system whenever a job's status is updated in ServiceOptimizer.
Triggers
When configured (see below), a Job Status push notification is sent whenever a job is created in ServiceOptimizer via the Change Work Item Status SOAP API.
However, please note that:
- A Job Status push notification will not be sent when a job's status is updated via the ServiceGANTT UI.
Configuring
Job Status 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 Status 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_status | boolean | Defines if Job Status push notifications will be sent or not. |
Object Format
The Job Status push notification will send a JSON object to the configured API with the following format:
{
"Type": "5",
"WorkItemType": "1",
"WorkItem": {
"Id": ""
"WorkStatus": ""
}
}
Object Properties
The Job Status 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 Status push notification, this value will always be 5 (five), indicating the notification represents a status update action. | |
WorkItemType | string | Yes | The type of work the notification is about. For a Job Status 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 Status push notification is about. | |
WorkStatus | string | Yes | A DisStatus code, representing the status of the job at the time of the Job Status push notification. | |