_API DispInitRequest Definition

<sp:DispInitRequest>

<FRUs>?</FRUs>

RUID

is a list of Final Responsibility Units (FRUs) for which jobs are to be dispatched to the connected client.  FRUs are separated by the ‘;’ character.

If FRUs is “” and Teams (below) is “”and EmpID (below) is “” then all FRUs and teams are included. 

For batch mode dispatch, either FRUs or Teams or EmpID can be specified, but not any combination of them.

For real-time mode dispatch, only FRUs can be specified.

<teams>?</teams>

is a list of teams for which jobs are to be dispatched to the connected client (batch only).  Teams are separated by the ‘;’ character.

<empID>?</empID>

EmpID

is the Id of a single operative to be dispatched (batch only).

<timezone>?</timezone>

specifies the timezone which the times (DateTime, ETS, ETA, ETF) returned by DispatchRequest are to be local to. It must be a POSIX timezone string that appears in the sp-56 table in the database, for example:

EST5EDT,M4.1.0,M10.5.0  or  IST-5.30

If not supplied, the database parameter tz_disp_api will be used.

<mode>?</mode>

1      SpareSource

DisMode

specifies whether real-time dispatch of jobs is required, or whether a batch run is required.  In batch mode, dispatch completes one scan and then exits.

For batch mode only, BatchInfo (below) must be populated.

<batchInfo>

determines which jobs are candidates for dispatch.

If DispatchMode is set to RealTime, this parameter is ignored.

<jobsMax>?</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.

<rangeType>?</rangeType>

DispRangeTypes

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.

<rangeStart>?</rangeStart>

spDateTime

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

<rangeEnd>?</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).

</batchInfo>

</sp:DispInitRequest>