Return to Departure Point
OMD offers a web service to allow the creation of a Return to Departure Point task. It adds a new stop to the trip with - by default - the address of the departure. This web service can be used to create intermediate returns to a depot for further pick-up of goods.
The mobile worker can initiate this web service by holding the finger onto today's agenda. When selecting the Return to Departure Point Option menu option, the web service is called remotely and the task will be pushed to the device automatically (if push2Device
is set). Note that the web service is only available if the device has network coverage. The request is not buffered if the device is not online.
The returnToDeparturePointStatus
indicates the code of the status used for the newly created task. Note that this must indicate a Planned status. The name of the task is defined in returnToDeparturePointName
.
returnToDeparturePointStatus | ||
---|---|---|
Type | Default Value | Example |
String | Undefined | IP |
returnToDeparturePointName | ||
---|---|---|
Type | Default Value | Example |
String | Departure Point | Depot |
One may choose to deactivate inadequate preferences such as showBarcodecon
for this type of task.
Note that the address of the Return to Departure Point is determined by the departure-address of the resoure's work pattern, if existent, unless the preference returnToType
is set (see below). Otherwise, the default address of the mobile worker is used.
If a Return to Departure Point is preferred for each started trip, one may set the preference. This preference will create a Return to Departure Point task each time a Start of the Day is received from the device. This will enforce mobile workers to close the last visit to the depot before finalizing the trip with an End of the Day, providing a way to distinguish the time between arrival at the departure point and the time when finalizing the trip (End of the Day).
createReturnToDeparturePointOnSOD | ||
---|---|---|
Type | Default Value | Example |
Boolean | false | true |
The arrival- or a so-called base-address can be chosen for the new task, instead of the departure-address. The preference returnToType defines which address is used. Valid types are departure
, base
or arrival
.
returnToType | ||
---|---|---|
Type | Default Value | Example |
String | departure | arrival |
If the preference returnToInsertionPoint
is not defined, the task is inserted in the end of the current trip. This can be modified by the value to "start", which sets the insertion point to the beginning of the trip.
returnToInsertionPoint | ||
---|---|---|
Type | Default Value | Example |
String | end | start |
Note that the preferences returnToType
and returnToInsertionPoint
may also be defined as a resource-specific process flow preference.
If there is a need to automatically create multiple tasks at the start or end of the trip, the (resource process flow) preference can list the points of insertion, the kind of address to use and the designated name of each task multiple times. The list is comma-separated, and details for each task are stated, divided by colons. The name of the task is optional and can be omitted.
The new tasks will either be inserted before the first task (start) or after the last task on the trip (end). Note that other returnTo-tasks will be considered as task, too, while the list is sequentially processed.
Example:
start:arrival: 2. Depot A, start:base: 1. Depot B, end:departure: 3. Home, end:base: 4. Depot B
This results in the following sequence:
- Depot B
- Depot A ... regular tasks ...
- Home
- Depot B
If this list is defined, the other preferences returnToType
, returnToInsertionPoint
and returnToDeparturePointName
will be disregarded on start-of-the-day
.
returnToTypeList | ||
---|---|---|
Type | Default Value | Example |
String | Undefined | start:arrival:2. Depot A,start:base:1. Depot B,end:departure,end:base:4. Depot B |