/
batchInfo
Document toolboxDocument toolbox

batchInfo

Owned by Mickey Bushman
Last updated: Oct 02, 2023 by Jason AndrewVersion comment

Used to determine which jobs are candidates for batch dispatch. If DispatchMode is set to RealTime, this is ignored.

batchInfo SOAP 
<batchInfo>
	<jobsMax>?</jobsMax>
	<rangeType>?</rangeType>
	<rangeStart>?</rangeStart>
	<rangeEnd>?</rangeEnd>
</batchInfo>
batchInfo Description
FieldTypeDescriptionRequiredValidated

jobsMax

int

is the maximum number of jobs to be dispatched, per operative.

This specifies the number of jobs per operative, within the time range specified, that are considered for dispatch, the jobs being considered in chronological order.  Thus, for example, if JobsMax were set to 2, the first 2 jobs starting within the time range specified would be considered for dispatch: if both were already at status Earmarked or above, then neither would actually be dispatched.

If JobsMax is omitted then there is no limit to the number of jobs to be dispatched per operative.

If Earmark Same-site Jobs Together is true, JobsMax will be ignored jobs so that jobs in a same-site group may be dispatched together.

Breaks are not included in the count for JobsMax.

(error)

 

rangeType

 dispRangeTypes

Jobs

Dispatch date/time range refers to jobs within the range

Shifts

Dispatch date/time range refers to shifts falling within the range

determines how RangeStart and RangeEnd are interpreted.

If RangeType is set to Jobs, then all jobs that start between RangeStart and RangeEnd are candidates for dispatch.

If RangeType is set toShifts, then all jobs that start on an operative day that contains a shift that starts between RangeStart and RangeEnd are candidates for dispatch.  If an operative day does not contain a shift, then jobs on that day are not dispatched.  If the shift start has been overridden, then it is the new shift start that must be between RangeStart and RangeEnd.

(tick)

 

rangeStart

spDateTime

If RangeStart is not supplied, ServiceOptimizer will use a default value of start-of-day today.

(error)

 

rangeEnd

spDateTime 

If RangeEnd is not supplied, ServiceOptimizer will use a default value of end-of-day on RangeStart (which may have defaulted to today).

(error)