Tasks & Trips
When using server-side trip calculation - such as appointment booking and server-side scheduling - it can be useful to persist trips. Use this preference with care since it will increase the numbers of transactions when updating schedules.
webPersistTrips | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
Triggering a message about a change in a trip can be useful for clients listening to changing events. If set to true, a message is sent to an MQTT topic.
pushTripChanges | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
The collectDashboardInfo
preference stores aggregated statistics. It will also produce KPI attachments on stop level for Business Intelligence purposes.
collectDashboardInfo | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
In case KPI information on stop level is not required for Business Intelligence or analysis purposes, set the preference collectStopInfo
to false. If the preference is not set or if the preference is set to true
, KPI attachments are created automatically if the collectDashboardInfo
is set to true
.
collectStopInfo | ||
---|---|---|
Type | Default Value | Example |
Boolean | true | false |
During the upload of tasks from external systems, OMD can verify the length of opening hours specifications on the task. When the checkOpeningHoursLength
is set, any task containing an invalid length of openingHours
will be refused.
checkOpeningHoursLength | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
Special processing of new tasks with the value 0 in field positionInTrip
can be activated by the preference checkForPositionInTrip
. Such tasks are reinserted into the same trip to allow automatic rescheduling of tasks for new customers, which the ERP system has booked on a resource without knowing the correct position. If no rescheduling is possible the task remains on the same time.
Note that this preference alternatively can be defined per resource, as process flow preference, but without a specific process flow. This enables to selectively use the feature per tour.
checkForPositionInTrip | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
So called replicate tasks can be sent from an ERP system to OMD, in order to prevent planning for the time span covered by this task. However, if there are scheduled tasks already, that are overlapped by this new replicate task, and the preference unplanUnavailabilityOverlaps
is set, then all of the overlapping tasks are unplanned automatically and the trip is normalized.
unplanUnavailabilityOverlaps | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
hg
To use another code than AB, adapt the AbsenceStatusCode
preference accordingly.
AbsenceStatusCode | ||
---|---|---|
Type | Default Value | Example |
String | AB | BRK |
In case the preference copyAttachmentsWithFollowOn
is set to true
and a mobile worker initiates a follow-on for a task, all itemsPlanned task attachments are copied to the new task.
copyAttachmentsWithFollowOn | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
Breaks uploaded by the Scheduler can be transformed and stored as tasks with a status code derived from the absenceStatusCode
by setting the transformBreaksToTasks
preference to true
.
Note that this will send an agenda entry to the mobile device of the mobile worker.
transformBreaksToTasks | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
If a trip contains one or more tasks with a fixed
task type, the trip cannot be optimized. Define a preference FixedTaskTypes
with the list of these task types, delimited with a semi-colon.
FixedTaskTypes | ||
---|---|---|
Type | Default Value | Example |
String | empty |
FIX;NOOPT |
If a trip is optimized, using either an algorithm (job), API call or the OMD Scheduler, a tripOptimized
attachment will be created if the preferences createTripOptimizedAttachments
and webPersistTrips
are set. This allows for an external system to keep track of succesful and unsuccesful optimization attempts.
createTripOptimizedAttachments | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
The remoteResult
task attachment's format TeamReporting
may result in a process of copying signature
attachments to other closed tasks, not having a signature
yet. Set the preferences teamReportingClearSignatureImage
and teamReportingSignatureContent
to customize this process.
When a signature
is copied, the preference teamReportingClearSignatureImage
controls whether or not the image of the signature
is deleted from the copy.
teamReportingClearSignatureImage | ||
---|---|---|
Type | Default Value | Example |
Boolean | true | false |
When a signature
is copied, the preference teamReportingSignatureContent
controls what content should be set in the copy.
teamReportingSignatureContent | ||
---|---|---|
Type | Default Value | Example |
String | empty | Sammelmeldung |
Check if the provided territory differs from the territory of the resource. If this is the case, update the territory of the task to reflect the territory of the resource instead.
checkForTerritory | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |