Details and Examples: Routing Run Result Fields Data Set
You can extract the details of the fields for all the routing runs and rollbacks in the application for an extraction period.
Routing Run Result Fields are exported in the Daily Extract file for which you must select 'Routing Run Result Fields' as the entity.
You can change the list of exported properties and fields any time by removing or adding fields, according to your requirements.
You can retrieve data as one or more XML files consisting of 'routing_run_results' root element, which contains the 'routing_run_result' elements. 'routing_run_result' elements are sets of 'Field' elements, whose attributes are the names of the fields defined for the description of the routing run and whose contents are their corresponding values.
This table provides the label and description for the fields that can be configured:
Sl. No. | Name | Label | Description |
---|---|---|---|
1 | Routing Run Id | routing_run_result.routingRunId | The unique ID of the specific routing run. |
2 | Routing Plan Name | routing_run_result.routingPlan | The name of the routing plan that was run. This is not unique. |
3 | Routing Plan Id | routing_run_result.routingPlanId | The unique ID of the routing plan that was run. |
4 | Routing Plan Label | routing_run_result.routingPlanLabel | The label of the routing plan. |
5 | Routing Profile Name | routing_run_result.routingProfile | The name of the routing profile that the routing plan belongs to. Is not unique. |
6 | Routing Profile Id | routing_run_result.routingProfileId | The unique ID of the routing profile that the routing plan belongs to. |
7 | Routing Profile Label | routing_run_result.routingProfileLabel | The label of the routing profile. |
8 | Start Type | routing_run_result.startType |
Type of routing start:
|
9 | Resource Id | provider.pid | The internal ID of the routing bucket. |
10 | Target Date | routing_run_result.targetDate | The date for which the activities are routed. The format is 'YYYY-MM-DD'. |
11 | Number Of Days | routing_run_result.numberOfDays | For a single day routing, the value is 1. For multi-day routing, the value is the number of days routed, starting from 'targetDate' and going into the future. |
12 | Result | routing_run_result.result |
|
13 | Message | routing_run_result.message | The field contains the error description when 'result' is 'failed' or 'skipped'. |
14 | Routing Run Duration | routing_run_result.routingRunDuration | The duration (in seconds) of the routing run. |
15 | Activities Matched | routing_run_result.activitiesMatched | The number of activities and pre-existing activity segments matching the routing plan filters. |
16 | Activities In Routes Before Routing | routing_run_result..activitiesInRoutesBeforeRouting | The number of activities and pre-existing activity segments that were in routes of resources before the routing run. |
17 | Activities Routed | routing_run_result.activitiesRouted | The number of activities scheduled and assigned by the routing run. |
18 | Activities Not Routed | routing_run_result.activitiesNotRouted | The number of activities matching the routing plan filters but not routed. |
19 | Resources Matched | routing_run_result.resourcesMatched | The number of resources matching the routing plan filters. |
20 | Resources Used | routing_run_result.resourcesUsed | The number of resources with assigned or removed activities by the routing run. |
21 | Average Working Time | routing_run_result.averageWorkingTime | The average working time of the resources (in minutes). |
22 | Average Overtime | routing_run_result.averageOvertime | The average overtime time of the resources (in minutes). |
23 | Average Travel Time | routing_run_result.averageTravelTime | The average travel time of the resources (in minutes). |
24 | Average Downtime | routing_run_result.averageDowntime | The average downtime time of the resources (in minutes). |
25 | Extended Status | routing_run_result.extendedStatus |
The additional information on the type and result of the routing
run. The field includes:
|
26 | Average Mileage | routing_run_result.averageMileage | The average travel mileage of the resources (in miles or km). |
27 | Reoptimized Activities | routing_run_result.reoptimizedActivities | The number of activities re-optimized by the routing run. |
28 | Created Activities | routing_run_result.createdActivities | The number of activities were created automatically for the routing run. |
29 | Removed Activities routing_run_result.removedActivities The number of removed activities (which may be warehouse visits or activity segments) | Removed Activities routing_run_result.removedActivities The number of removed activities (which may be warehouse visits or activity segments) | The number of removed activities (which may be warehouse visits or activity segments) |
30 | Start Time | routing_run_result.startTime | The time when the routing run started in UTC time zone. The time format is YYYY-MM-DD HH:MM:SS. |
31 | Assurance Percentage | routing_run_result.assurancePercentage | The assurance of routing result, from 0 to 100. The lesser assurance is, the less confident is the result, which, in most cases, may be connected to sub-optimal results. Typically, for good results one may expect assurance 85 or more. |
32 | Consumed Time | routing_run_result.consumedTime | Actual time (in seconds) that was consumed by SLR and routing engine during the routing run. |
33 | Routing Plan Time Limit | routing_run_result.routingPlanTimeLimit | Time limit for the routing plan (in seconds). |
34 |
Routing Plan Optimization Goal |
routing_run_result.routingPlanOptimizationGoal |
If there is an optimization goal at the routing run, the field
shows the goal. May be one of the following:
|
35 | Routing Plan Time Limit SLR Percentage | routing_run_result.routingPlanTimeLimitSlrPercentage | Part of total time limit which is time limit for SLR service |
36 | Not Assigned Due To Validation Issues Count | routing_run_result.notAssignedDueToValidationIssuesCount | Configuration / Data validation errors |
37 | Not Assigned Due To Changes While Routing Was Running Count | routing_run_result.notAssignedDueToChangesWhileRoutingWasRunningCount | The assignment is impossible due to changes that happened while routing was running. |
38 | Not Assigned Due To Activity Configuration Count | routing_run_result.notAssignedDueToActivityConfigurationCount | Not-assignment reason: configuration of an activity. |
39 | Not Assigned Due To Resources Configuration Count | routing_run_result.notAssignedDueToResourcesConfigurationCount | Not-assignment reason: configuration of resources |
40 | Not Assigned Needs Manual Assignment Count | routing_run_result.notAssignedNeedsManualAssignmentCount | Not-assignment reason: the constraint violation. Try to assign the activity manually |
41 | Not Assigned Other Issues Count | routing_run_result.notAssignedOtherIssuesCount | Other Not-Assignment Reasons. |
42 | Partially Assigned Segmentable Activities Count | routing_run_result.partiallyAssignedSegmentableActivitiesCount | Partially assigned segmentable activities. |
43 | Not Assigned Due To Dynamic Mode Restrictions Count | routing_run_result.notAssignedDueToDynamicModeRestrictionsCount | Activities were not assigned in accordance with the routing plan dynamic mode settings. |
44 | Not Assigned Due To Cost Settings Count | routing_run_result.notAssignedDueToCostSettingsCount | Not-assignment reason: routing plan and/or resource type cost settings may be suboptimal. |
45 | Not Assigned Due To Travel Restrictions Count | routing_run_result.notAssignedDueToTravelRestrictionsCount | Not-assignment reason: activity locations and routing plan travel settings prohibits assignment. |
46 | Not Assigned Due To Optimization Criteria Count | routing_run_result.notAssignedDueToOptimizationCriteriaCount | Activities were not assigned in accordance with the optimization criteria chosen. |
47 | Resource Blocked Due To Routing Schedule Count | routing_run_result.resourceBlockedDueToRoutingScheduleCount | Resources are blocked by another run because of sub-optimal routing plan schedule. |
48 | Not Assigned Needs Overtime Overdue Rules Relaxation Count | routing_run_result.notAssignedNeedsOvertimeOverdueRulesRelaxationCount | Not-assignment reason: the overtime/overdue constraint violation. Try to assign manually with relaxed constrains or just relax business rules on overdue/overtime for the routing plan. |
49 | Subcategory | routing_run_result.subcategory | Reserved for future needs |
50 | Resource External Id | provider.external_id | The external ID of the routing bucket. |
51 | Routing Rollback Run Id | routing_run_result.routingRollbackRunId | The unique ID of the routing run which were rolled back. |
52 | Type of Routing Run | Run routing_run_result.type | The type of the routing run. The field is obsolete. |
Example: Routing Run Result Fields file
- The number of activities and pre-existing activity segments that were in routes of resources before the routing run, for example, ACTIVITIES_IN_ROUTES_BEFORE
- The number of activities and pre-existing activity segments matching the routing plan filters, for example, ACTIVITIES_MATCHED_FILTERS
- The assurance of routing result, for example, ASSURANCE_OF_ROUTING_RESULT
- The average downtime time of the resources (in minutes), for example, AVERAGE_IDLE_TIME
- The average travel mileage of the resources, for example, AVERAGE_MILEAGE
- The average overtime time of the resources (in minutes), for example, AVERAGE_OVERTIME
- The average travel time of the resources (in minutes), for example, AVERAGE_TRAVEL_TIME
- The average working time of the resources (in minutes), for example, AVERAGE_WORKING_TIME"
- The number of cases when resource are blocked by another run as of sub-optimal routing plan schedule, for example, BLOCKED_RESOURCES
- Actual time (in seconds) that was consumed by SLR and routing engine during the routing run, for example, CONSUMED_TIME
- The number of activities were created automatically for the routing run, for example, CREATED_ACTIVITIES
- The additional information on type and result of the routing run, for example, EXTENDED_STATUS
- The error description when 'result' is 'failed' or 'skipped'., for example, FAILURE_MESSAGE
- The number of not-assignment reasons: configuration of an activity, for example, NOT_ASSIGNED_ACTIVITY_CONFIG
- The number of not-assignment reasons: the constraint violation when manual assignment is possible, for example, NOT_ASSIGNED_ASSIGN_MANUAL
- The number of not-assignment reasons: routing plan and/or resource type cost settings may be suboptimal, for example, NOT_ASSIGNED_COSTS_SETTINGS
- The number of cases when activities were not assigned in accordance with routing plan dynamic mode settings, for example, NOT_ASSIGNED_DYNAMIC_MODE
- The number of other not-assignment reasons, for example, NOT_ASSIGNED_OTHER
- The number of not-assignment reasons: the overtime/overdue constraint violation, for example, NOT_ASSIGNED_OVERTIME_OVERDUE
- The number of not-assignment reasons: configuration of resources, for example, NOT_ASSIGNED_RESOURCES_CONFIG
- The number of not-assigned activities when the assignment is impossible due to changes that happened while routing was running, for example, NOT_ASSIGNED_ROUTING_RUNNING
- The number of cases when activities were not assigned in accordance with the optimization criteria, for example, NOT_ASSIGNED_THRESHOLDS
- The number of not-assignment reasons: travel settings prohibits assignment, for example, NOT_ASSIGNED_TRAVEL_SETTINGS
- The number of not-assigned activities due to the Configuration / Data validation errors, for example, NOT_ASSIGNED_VALIDATION
- The number of activities matching the routing plan filters but not routed, for example, NOT_ROUTED_ACTIVITIES
- The number of days routed, for example, NUMBER_OF_DAYS_ROUTED
- The optimization goal at the routing run, for example, OPTIMIZATION_GOAL
- The number of cases when segmentable activities were partially assigned, for example, PARTIALLY_ASSIGNED
- Part of total time limit which is time limit for SLR service, for example, PERCENTS_OF_TIME_LIMIT_FOR_SLR
- The number of removed activities (which may be warehouse visits or activity segments), for example, REMOVED_ACTIVITIES
- The number of activities re-optimized by the routing run, for example, REOPTIMIZED_ACTIVITIES
- The number of resources matching the routing plan filters, for example, RESOURCES_MATCHED_FILTERS
- The number of resources with assigned or removed activities by the routing run, for example, RESOURCES_WITH_CHANGES
- The external ID of the routing bucket, for example, RESOURCE_EXTERNAL_ID
- The internal identifier of the routing bucket, for example, RESOURCE_INTERNAL_ID
- The number of activities scheduled and assigned by the routing run, for example, ROUTED_ACTIVITIES
- The unique identifier of the routing plan that was run, for example, ROUTING_PLAN_ID
- The label of the routing plan, for example, ROUTING_PLAN_LABEL
- The name of the routing plan that was run, for example, ROUTING_PLAN_NAME
- The unique identifier of the routing profile that the routing plan belongs to, for example, ROUTING_PROFILE_ID
- The label of the routing profile, for example, ROUTING_PROFILE_LABEL
- The name of the routing profile that the routing plan belongs to, for example, ROUTING_PROFILE_NAME
- The result of the routing run (succeeded, stopped or failed), for example, ROUTING_RESULT
- The duration (in seconds) of the routing run, for example, ROUTING_RUN_DURATION
- The unique identifier of the specific routing run, for example, ROUTING_RUN_ID
- The time when the routing run started in UTC time zone, for example, ROUTING_RUN_START_TIME
- The date for which the activities are routed, for example, ROUTING_TARGET_DATE
- The unique ID of the routing run which were rolled back if any, for example, RUN_ID_ROLLED_BACK
- The field that currently is reserved for future needs, for example, SUBCATEGORY
- Time limit for the routing plan (in seconds), for example, TIME_LIMIT
- The type of routing start (manual or automatic), for example, TYPE_OF_ROUTING_START
- The type of the routing run, for example, TYPE_OF_THE_RUN
<?xml version="1.0" encoding="UTF-8"?>
<routing_run_results>
<routing_run_result>
<Field name="CONSUMED_TIME">0</Field>
<Field name="EXTENDED_STATUS">routing-bulk</Field>
<Field name="ASSURANCE_OF_ROUTING_RESULT">99.900000000000006</Field>
<Field name="AVERAGE_IDLE_TIME">0</Field>
<Field name="AVERAGE_OVERTIME">0</Field>
<Field name="AVERAGE_MILEAGE">0</Field>
<Field name="AVERAGE_TRAVEL_TIME">0</Field>
<Field name="AVERAGE_WORKING_TIME">45</Field>
<Field name="NOT_ASSIGNED_ROUTING_RUNNING">0</Field>
<Field name="NOT_ASSIGNED_DYNAMIC_MODE">0</Field>
<Field name="NOT_ASSIGNED_THRESHOLDS">0</Field>
<Field name="BLOCKED_RESOURCES">0</Field>
<Field name="ROUTING_TARGET_DATE">2023-01-11</Field>
<Field name="ROUTING_RUN_DURATION">0</Field>
<Field name="RESOURCE_EXTERNAL_ID">RollbackBucketOAC</Field>
<Field name="RESOURCE_INTERNAL_ID">RollbackBucketOAC</Field>
<Field name="ROUTING_PLAN_LABEL"/>
<Field name="ROUTING_PROFILE_LABEL"/>
<Field name="FAILURE_MESSAGE"/>
<Field name="ROUTING_PLAN_NAME">RoutingEventOACplan</Field>
<Field name="ROUTING_PROFILE_NAME">RoutingEventOACprofile</Field>
<Field name="CREATED_ACTIVITIES">0</Field>
<Field name="REOPTIMIZED_ACTIVITIES">0</Field>
<Field name="ROUTED_ACTIVITIES">1</Field>
<Field name="NOT_ROUTED_ACTIVITIES">1</Field>
<Field name="ACTIVITIES_MATCHED_FILTERS">1</Field>
<Field name="ACTIVITIES_IN_ROUTES_BEFORE">0</Field>
<Field name="NOT_ASSIGNED_VALIDATION">0</Field>
<Field name="NUMBER_OF_DAYS_ROUTED">1</Field>
<Field name="NOT_ASSIGNED_ACTIVITY_CONFIG">0</Field>
<Field name="NOT_ASSIGNED_RESOURCES_CONFIG">0</Field>
<Field name="NOT_ASSIGNED_ASSIGN_MANUAL">0</Field>
<Field name="NOT_ASSIGNED_OVERTIME_OVERDUE">0</Field>
<Field name="NOT_ASSIGNED_COSTS_SETTINGS">0</Field>
<Field name="NOT_ASSIGNED_TRAVEL_SETTINGS">0</Field>
<Field name="NOT_ASSIGNED_OTHER">0</Field>
<Field name="PARTIALLY_ASSIGNED">0</Field>
<Field name="REMOVED_ACTIVITIES">0</Field>
<Field name="RESOURCES_MATCHED_FILTERS">1</Field>
<Field name="RESOURCES_WITH_CHANGES">1</Field>
<Field name="OPTIMIZATION_GOAL">balanced</Field>
<Field name="PERCENTS_OF_TIME_LIMIT_FOR_SLR">50</Field>
<Field name="SUBCATEGORY">0</Field>
<Field name="ROUTING_RESULT">succeeded</Field>
<Field name="TIME_LIMIT">30</Field>
<Field name="TYPE_OF_THE_RUN">manual</Field>
<Field name="TYPE_OF_ROUTING_START">manual</Field>
<Field name="ROUTING_RUN_START_TIME">2023-01-11 12:34:54</Field>
<Field name="ROUTING_PLAN_ID">174</Field>
<Field name="ROUTING_PROFILE_ID">115</Field>
<Field name="ROUTING_RUN_ID">1018809</Field>
<Field name="RUN_ID_ROLLED_BACK"/>
</routing_run_result>
<routing_run_result>
<Field name="CONSUMED_TIME">0</Field>
<Field name="EXTENDED_STATUS">routingRollback</Field>
<Field name="ASSURANCE_OF_ROUTING_RESULT">0</Field>
<Field name="AVERAGE_IDLE_TIME">0</Field>
<Field name="AVERAGE_OVERTIME">0</Field>
<Field name="AVERAGE_MILEAGE">0</Field>
<Field name="AVERAGE_TRAVEL_TIME">0</Field>
<Field name="AVERAGE_WORKING_TIME">0</Field>
<Field name="NOT_ASSIGNED_ROUTING_RUNNING">0</Field>
<Field name="NOT_ASSIGNED_DYNAMIC_MODE">0</Field>
<Field name="NOT_ASSIGNED_THRESHOLDS">0</Field>
<Field name="BLOCKED_RESOURCES">0</Field>
<Field name="ROUTING_TARGET_DATE">2023-01-11</Field>
<Field name="ROUTING_RUN_DURATION">0</Field>
<Field name="RESOURCE_EXTERNAL_ID">RollbackBucketOAC</Field>
<Field name="RESOURCE_INTERNAL_ID">RollbackBucketOAC</Field>
<Field name="ROUTING_PLAN_LABEL"/>
<Field name="ROUTING_PROFILE_LABEL"/>
<Field name="FAILURE_MESSAGE"/>
<Field name="ROUTING_PLAN_NAME">RoutingEventOACplan</Field>
<Field name="ROUTING_PROFILE_NAME">RoutingEventOACprofile</Field>
<Field name="CREATED_ACTIVITIES">0</Field>
<Field name="REOPTIMIZED_ACTIVITIES">0</Field>
<Field name="ROUTED_ACTIVITIES">0</Field>
<Field name="NOT_ROUTED_ACTIVITIES">0</Field>
<Field name="ACTIVITIES_MATCHED_FILTERS">1</Field>
<Field name="ACTIVITIES_IN_ROUTES_BEFORE">0</Field>
<Field name="NOT_ASSIGNED_VALIDATION">0</Field>
<Field name="NUMBER_OF_DAYS_ROUTED">1</Field>
<Field name="NOT_ASSIGNED_ACTIVITY_CONFIG">0</Field>
<Field name="NOT_ASSIGNED_RESOURCES_CONFIG">0</Field>
<Field name="NOT_ASSIGNED_ASSIGN_MANUAL">0</Field>
<Field name="NOT_ASSIGNED_OVERTIME_OVERDUE">0</Field>
<Field name="NOT_ASSIGNED_COSTS_SETTINGS">0</Field>
<Field name="NOT_ASSIGNED_TRAVEL_SETTINGS">0</Field>
<Field name="NOT_ASSIGNED_OTHER">0</Field>
<Field name="PARTIALLY_ASSIGNED">0</Field>
<Field name="REMOVED_ACTIVITIES">0</Field>
<Field name="RESOURCES_MATCHED_FILTERS">1</Field>
<Field name="RESOURCES_WITH_CHANGES">1</Field>
<Field name="OPTIMIZATION_GOAL">balanced</Field>
<Field name="PERCENTS_OF_TIME_LIMIT_FOR_SLR">50</Field>
<Field name="SUBCATEGORY">0</Field>
<Field name="ROUTING_RESULT">succeeded</Field>
<Field name="TIME_LIMIT">30</Field>
<Field name="TYPE_OF_THE_RUN">manual</Field>
<Field name="TYPE_OF_ROUTING_START">manual</Field>
<Field name="ROUTING_RUN_START_TIME">2023-01-11 12:35:30</Field>
<Field name="ROUTING_PLAN_ID">174</Field>
<Field name="ROUTING_PROFILE_ID">115</Field>
<Field name="ROUTING_RUN_ID">1018810</Field>
<Field name="RUN_ID_ROLLED_BACK"/>
</routing_run_result>
</routing_run_results>