Document toolboxDocument toolbox

Admin ServiceOptimizer System Configuration Push Notifications Job Reminder

Owned by Matthew Wren
Last updated: Jun 13, 2023Version comment
3 min read

On This Page:

Related Pages:

Background

This Push Notification can be used to send a "reminder" (that a job is about to start) to an external system whenever a job's Notification Job Reminder Window (or NJRW) is reached in ServiceOptimizer.

The NJRW for a job occurs is a defined number of minutes before the expected start time of a job in ServiceOptimizer.

Triggers

When configured (see below), a Job Reminder push notification is sent under the following circumstances.

SituationResult

A Job Reminder push notification is sent when the time "now" reaches a job's NJRW - provided that a Job Reminder push notification has not already been sent for the job (see details below).

A Job Reminder push notification is sent when the time "now" is between the job's NJRW and the job's expected start time only if:

  • As part of the FRU startup process, whenever the FRU has been restarted; and
  • A Job Reminder push notification for the job has not previously been sent.

This ensures that any Job Reminder notifications that should have been sent while an FRU is being restarted will be sent as soon as possible after the FRU has been restarted.

Please note, however, that:

  • If a job is created such that the time "now" is already after the job's NJRW, then a Job Reminder push notification will not be sent.
  • If a job is rebooked such that the time "now" is already inside the job's NJRW, then a Job Reminder push notification will not be sent.
  • If a Job Reminder push notification has already been sent for a job, then no additional Job Reminder push notification will ever be sent, even if:
    • The job is moved such that, at some point in the future, the time "now" will reach the job's NJRW; or
    • The configured value of the NJRW is changed such that, at some point in the future, the time "now" will reach the job's NJRW.


Configuring

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

In addition, when Job Reminder push notifications are enabled for an FRU, the notification_reminder_windows value must be set for that FRU, to define the NJRW.

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

Column NameTypeDescription

notification_job_reminder

boolean

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

notification_reminder_windowsintegerDefines the NJRW in terms of the number of minutes before the job's expected start time.

Object Format

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

{
	"Type": "6",
	"WorkItemType": "1",
	"WorkItem": {
		"Id": "ServiceOptimizer_Job_ID",
		"WorkStatus": ""
	}
}

Object Properties

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

PropertyTypeRequired?Description
TypestringYes

The type of notification being sent.

For a Job Reminder push notification, this value will always be 6 (six), indicating the notification represents a job reminder.

WorkItemTypestringYes

The type of work the notification is about.

For a Job Reminder 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 Reminder push notification is about.

WorkStatusstringYes

A DisStatus code, representing the status of the job at the time of the Job Reminder push notification.