/
BookOptions.objects

BookOptions.objects

PropertyTypeDescriptionReq?Field Mapping: ServiceScheduling
AllowRebookAllBoolean

Pass through parameter to the ServiceScheduling "Book Dependency Group Jobs" API. 

When true, if the dependency group identified by MultiJobID is already in the ServiceOptimizer database then that whole dependency group, including all of the jobs in it (subject to the options below), will be cancelled first, after which sp:BookDependencyGroupRequest will work just as it does when AllowRebookAll is not set. This allows both the MultiJobID and all of the JobIDs in the dependency group to be reused. All of the jobs supplied must be in the same FRU as the jobs in the original DG, otherwise SP_DIFFERENT_FRUS (533) is returned.

If AllowRebookAll is set, but the supplied MultiJobID isn’t already in the ServiceOptimizer database, the call will continue (i.e AllowRebookAll is effectively ignored) as long as none of the supplied jobs (in SP_BDGJobSeq) already exist, in which case, SP_JOBID_EXISTS (23) is returned.

When AllowRebookAll is set, sp:BookDependencyGroupRequest is an atomic operation, i.e. it won’t return part way through with the existing dependency group cancelled but its replacement not booked.

If one or more of the existing JobIDs in the dependency group are outside the ServiceOptimizer memory horizon, the dependency group can’t be re-booked and will fail with SP_JOBID_OUTSIDE_HORIZON (626).

No

bookOptions.AllowRebookAll

DontCancelClearedBoolean

Pass through parameter to the ServiceScheduling "Book Dependency Group Jobs" API. 

When true, any jobs in the dependency group/split dependency group whose status is Cleared won’t be cancelled.

No

bookOptions.DontCancelCleared

DontCancelLoggedOffBoolean

Pass through parameter to the ServiceScheduling "Book Dependency Group Jobs" API. 

When true, any jobs in the dependency group/split dependency group whose status is Logged Off won’t be cancelled.

No

bookOptions.DontCancelLoggedOff

DontCancelLoggedOnBoolean

Pass through parameter to the ServiceScheduling "Book Dependency Group Jobs" API. 

When true, any jobs in the dependency group/split dependency group whose status is Logged On won’t be cancelled.

Related content

_API BookDependencyGroupRequest Definition
_API BookDependencyGroupRequest Definition
More like this
_API BookDependencyGroupRequest Definition
_API BookDependencyGroupRequest Definition
More like this
_API BookDependencyGroupRequest Definition
_API BookDependencyGroupRequest Definition
More like this