AllowEmpOT

The employees’ maximum allowed overtime should be included when making appointment offers.

CalltoFix

This option specifies that the job’s ETF will be used instead of its ETA to calculate its lateness (using its Service Hours), and will be used as well as its ETA to determine if it’s outside its access hours.

ConsecShift

This option requests the use of consecutive shifts (as well as allowing contiguous shifts) for splitting long duration jobs.

ContigShift

This option requests the use of only contiguous shift time splits for long duration jobs.

DupUseEmpID

When offerTextEmpID is also supplied, offers for different EmpIDs but that are otherwise identical may be returned.

If this option isn’t set, even though offerTextEmpID is supplied, offers that are for different EmpIDs but are otherwise identical are considered to be duplicates and only the lowest cost one may be returned.

If dupUseEmpID is set but offerTextEmpID isn’t, then dupUseEmpID is ignored.

FixtoEmp

This option will cause the chosen operative to effectively become mandatory.

NonConsecShift

Allows the use of non-consecutive shifts (as well as allowing contiguous and consecutive shifts) for splitting long duration jobs

OfferBestOnlyPerEmp

If supplied, then only the best set of offers for each available employee will be returned. The best offer is the earliest one whose PromType matches the supplied NumReqType. If not set, more than one set of offers for each employee can be returned.

OfferTextCost

Requests that the cost of the offer be returned as part of the OfferText. The cost returned will be the difference in travel cost between the job being in the position of the offer as opposed to it not being there.

OfferTextEmpID

The ID of the operative notionally given the job will be returned in the offer. However it should be remember if using this that ServiceOptimizer may optimize it to another operative at any time.

RemoveMandatory

This option will cause any previously specified mandatory operatives (1 or 2, ordered or not) to be removed from the job. An error won’t be returned if the job has no mandatory operatives. This option has no effect on preferred or excluded operatives.

RestrictSearch

The search for sets of offers biased towards those employees for whom the greater numbers of possible offers were found for the first jobs in the request.

ReqConfirm

This option will indicate on the Gantt that this job should be confirmed.

ServAsAccHours

This option makes the job’s access hours pattern the same as its service hours pattern. (If an access hours pattern is also supplied in an AccHoursPatts structure, SP_ACCHOURS_DUPLICATED (390) will be returned.)

SetConfirmed

This option sets the ConfirmedState of the job to Confirmed.

SetDispStatusBack

This option will cause the job’s dispatch status to be set to Tentative.

SetNotFixed

This option will remove the fixed flag from the job (if it were previously fixed).

SpareIgnVanStock

ThespareIgnVanStock option indicates to ServiceOptimizer that vehicle stock should be ignored when generating appointments. Any ReqSpares data supplied as part of the offer request will still be read in by ServiceOptimizer, but SP_SPAREID_INVALID (111) will not be returned if any of the supplied ReqSpares is not in the ServiceOptimizer database.

If spareIgnVanStock is set then the SpareForceGo (see ForceOptions) flag will be ignored.

SetUnEarmark

This option will cause an unearmark to be generated (should one be required).

UseAccessHours

This option's effect is to cause access hour overrides to be generated from the job’s existing access hours (which may be from an access hours pattern) that overlap the same operative day on which the job’s ETA is current scheduled. If the job has no access hours on that operative day, a single access hours override from the start of the operative day to the end will be set.

This option's effect is to, for jobs with a JobType that allows the job to be split, only use the supplied extraDuration field when calculating the total duration of the job parts - the duration from the JobType is ignored. However, for jobs with a JobType that does not allow the job to be split, the useExtraDuration option will be ignored.

When the useExtraDuration option is used:

• There is no minimum value for extraDuration, although it must be > 0.
• The parameters SJEDMax and SJTDMax will not be applied, however, there will be a maximum allowed: extraDuration < JobType duration.
• All other aspects of total duration of the job parts are unaffected; specifically, the extraOverhead and stdExtraDuration are added in the same way as normal.

This is a RESERVED option for internal use only. It allows the Rebook function in Gantt to prevent offers being filtered out by the API Agent when determining a list of FRU's that can accept the job.

It will ensure that the FRU string is used to ignore all other fields in the filter detecting uniqueness. Thus only
one offer from each responding FRUs should be returned. If used then the action of the following options will be ignored in the Apaigent but not in the FRU:

• OfferTextEmpID
• DupUseEmpID
• InTray