KPI
This outbound attachment will be added to each task within a trip after the mobile worker has started or finalized the day (Start of the Day / End of the Day).
The extra information stored in the attachment contains the following information:
- The travel distance to the next stop (m)
- The travel duration to the next stop (min)
- The travel distance from the previous stop (m)
- The travel duration from the previous stop (min)
- The duration of the stop: estimated for startOfTheDay, actual for endOfTheDay (min)
- The waiting time due to opening hours or a fixed appointment where the travel time from the last stop is shorter than the available time between the stops (min)
- The pause duration during the travel (min)
- The pause during the execution of the travel (min)
- The geocode of the task
- The executing resource
- The position of the stop within the trip at the time of the calculation
- The consolidationId, i.e. the external identifier of the leading task when the task was processed within a collection.
It is assumed that there are no breaks within the trip.
| Attribute | Description | Optional | Example |
|---|---|---|---|
| attachmentType | The type of this attachment. Needs to be 1, which means text | no | 1 |
| subType | The sub-type of this attachment, being kpi | no | kpi |
| extra | KPI information for the task. | no | |
| reference | The info type of this attachment (startOfTheDay or endOfTheDay) | no | startOfTheDay |
For this attachment to be generated, the collectDashboardInfo and collectStopInfo preference must have value true.
SOD and EOD
An additional KPI attachment is created once the Start of the Day or End of the Day attachment has been received. This KPI attachment contains information about the trip. Use the device and format attributes of the attachment to determine the trip. Do not use the task reference.
The extra information stored in the trip-related KPI attachment contains the following information:
- The externalId of the trip's resource.
- The date of the trip.
- The travel distance of the entire trip (m).
- The travel duration of the entire trip (min).
- The overall duration of the trip, i.e. travel time + execution time including pauses + waiting time (min).
- The total waiting time of the trip (min), i.e. the time between stops, when the resource is not traveling.
- The total pause duration during the the travel (min).
- The total pause during the execution of the task (min).
- The total busy time of the trip, i.e. travel time + execution time including pauses (min).
- The idle time of the trip, i.e. the duration of the shift minus the busy time (min).
| Attribute | Description | Optional | Example |
|---|---|---|---|
| attachmentType | The type of this attachment. Needs to be 1, which means text | no | 1 |
| subType | The sub-type of this attachment, being kpi | no | kpi |
| extra | KPI information for the trip | no | <Data resource="2224" day="2021-06-13" travelDistance="5423" travelDuration="6.0" duration="260" waitingTime="32" pauseTimeTravel="40" pauseTimeOnSite="15" busyTime="535" idleTime="0"/> |
| reference | The info type of this attachment (startOfTheDay or endOfTheDay) | no | startOfTheDay |
| device | The externalId of the trip's resource | no | 10044 |
| format | The date of the trip | no | 2019-04-01 |