Document toolboxDocument toolbox

Integration ServiceOptimizer Common API Concepts Long Duration Jobs

Owned by Matthew Wren
Nov 24, 2022
2 min read

On This Page:

Long Duration Jobs

In general the assumption is that jobs booked into the system will have some duration less that the available shift time on a single day for any given operative. Where jobs require duration larger than this they will be split up (fragmented) into a number of parts, over multiple days/shifts, and are booked as a set of dependent jobs. Only certain jobs types may be booked in this way – these must be pre-defined.

It is necessary to define some rules for how such long-duration jobs are then to be split over the operative’s shift. Can they be split across: contiguous shifts; consecutive shifts; non-consecutive shifts? Options within the various interfaces allow for this configuration.

Additionally, a number of system parameters provide further guidance:

Long Job: Split ThresholdThe minimum Expected Duration (in minutes) of a job that can be fragmented.
Long Job: Minimum First FragmentThe minimum duration (in minutes) of the first fragment of a long job.  If not set, the same value as Long Job: Minimum Fragment (below) is used.
Long Job: Minimum FragmentThe minimum duration (in minutes) of the fragments of a long job other than the first and the last.
Long Job: Max Number of JobsThe total number of splits will not exceed this number
Long Job: Max Fragment GapThe maximum number of days (in days) between fragments (where fragmented jobs aren’t on consecutive shifts).

Each job is booked with an identifier made up from that provided on the call followed by a separator and then a number:

Long Job: JobID separator characterThe character used to create a unique job reference of the form jobID<separator>partNum.