Background

This Push Notification can be used to inform an external system whenever a job is created in ServiceOptimizer.

Triggers

When configured (see below), a Job Create push notification is sent whenever a job is created in ServiceOptimizer via the following APIs:

• Book Appointment SOAP API
• Book Non-Appointment Job SOAP API
• Book Dependency Group Job SOAP API
• Book Split Dependency Group Jobs SOAP API

However, please note that:

• Long jobs are treated as a single job - only one Job Create push notification will be sent when long jobs are created.
• When booking with Dependency Groups, one Job Create push notification will be sent for each job that is created.

Also, please note that:

• Rebooking a job not is considered a job creation action, and will not result in a Job Create push notification being sent.
• ABS Allocate is not considered a job creation action, and will not result in a Job Create push notification being sent.

Configuring

Job Create 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 Create push notifications, details of where to send the notifications also needs to be set up. Please see the Push Notifications page for details.

Object Format

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

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

Object Properties

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