Document toolboxDocument toolbox

14.1 Job Change Push Notifications

On This Page:

Related Pages:

Background

This Push Notification can be used to inform an external system whenever an appointment or confirmed SLA is manually moved via the ServiceGANTT UI, such that certain constraints are broken.

Triggers

When configured (see below), a Job Change push notification is sent whenever:

  • An appointment (regardless of whether it is confirmed or not) is manually moved via the ServiceGANTT UI such that:
    • The appointment is either before its appointment earliest value, or after its appointment latest value; and/or
    • A mandatory operative restriction is no longer met.
  • A confirmed SLA is manually moved via the ServiceGANTT UI such that:
    • The SLA is outside of defined service hours; and/or
    • A mandatory operative restriction is no longer met.

However, please note that:

  • If an appointment or confirmed SLA is moved to the unresourced tray (i.e. de-allocated), then no Job Change notification will be sent.

Configuring

Job Change 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). 

(warning) Remember that before enabling Job Change push notifications, details of where to send the notifications also needs to be set up. Please see the 14.1 Push Notifications page for details.

Column NameTypeDescription
notification_job_changed
boolean

Defines if Job Change push notifications will be sent or not.

Object Format

The Job Change push notification will send a JSON object to the configured API with the following format:

{
	"Type": "8",
	"WorkItemType": "1",
	"WorkItem": {
		"Id": ""
		"WorkStatus": ""
	}
}

Object Properties

The Job Change push notification's JSON object has the following properties.

PropertyTypeRequired?Description
TypestringYes

The type of notification being sent.

For a Job Change push notification, this value will always be 8 (eight), indicating the notification represents a change action.

WorkItemTypestringYes

The type of work the notification is about.

For a Job Change push notification, this value will always be 1 (one), indicating the notification is about a job.

WorkItemobjectYes

IdstringYesServiceOptimizer's unique ID for the job that the Job Change push notification is about.

WorkStatusstringYesDisStatus code, representing the status of the job at the time of the Job Change push notification.