Upon successful execution, the service returns the solution to the specified vehicle routing problem. The solution is composed of the output parameters described below.
out_stops
This provides information about stops made at depots, orders, and breaks. The information includes which routes make the stops, the arrival and departure times, and the stop sequence.
Note:
When the Populate Stop Shapes parameter is set to True, this parameter is a feature class. Otherwise, it is a table.
The parameter supports the following fields:
Field | Description |
---|---|
Name | The name of the stop. The value of this field is the same as the Name field from the input orders, depots, or breaks. You can use the StopType field to determine if the Name field value refers to a depot, an order, or a break. |
StopType | Indicates whether the stop represents a depot, an order, or a break. The field value is an integer that can be interpreted in the following ways:
|
PickupQuantities | The amount of cargo or number of people to be picked up from a stop. If multiple dimensions are delivered to a stop, each quantity is separated by a space. The units for the value of this field aren't stored. You should interpret the units according to the way you specified the Capacities field on the input routes and the PickupQuantities and DeliveryQuantities fields on the input orders. |
DeliveryQuantities | The amount of cargo or number of people to be delivered to a stop. If multiple dimensions are delivered to a stop, each quantity is separated by a space. The units for the value of this field aren't stored. You should interpret the units according to the way you specified the Capacities field on the input routes and the PickupQuantities and DeliveryQuantities fields on the input orders. |
RouteName | The name of the route to which the stop is assigned. |
Sequence | The relative sequence in which the assigned route visits the stop. |
FromPrevTravelTime | The elapsed travel time from the route's previous stop to the current stop. The value is in the units specified by the Time Units parameter. |
FromPrevDistance | The distance along the route from the previous stop to the current stop. The value is in the units specified by the Distance Units parameter. |
ArriveCurbApproach | Indicates the side of the vehicle the curb is on when arriving at the stop. A value of 1 means the right side of the vehicle; a value of 2 means the left side. |
DepartCurbApproach | Indicates the side of the vehicle the curb is on when departing from the stop. A value of 1 means the right side of the vehicle; a value of 2 means the left side. |
ArriveTime | The time of day the route arrives at the stop. The time of day value for this field is in the time zone in which the stop is located. |
DepartTime | The time of day the route departs from the stop. The time of day value for this field is in the time zone in which the stop is located. |
ArriveTimeUTC | The time of day the route arrives at the stop. This value is in coordinated universal time (UTC). |
DepartTimeUTC | The time of day the route departs from the stop. This value is in coordinated universal time (UTC). |
WaitTime | The wait time or layover at the stop. For example, a wait time is incurred when a route must wait at an order for a time window to open. The value is in the units specified by the Time Units parameter. |
ViolationTime | The amount of time elapsed from the end of the stop's time window to the arrival of the route vehicle. The value is in the units specified by the Time Units parameter. |
ORIG_FID | The ObjectID of the input order, depot, or break. This field can be used to join attributes from input features. |
out_routes
This provides access to the drivers, vehicles, and route paths of a vehicle routing problem analysis.
The Populate Route Lines and Route Line Simplification Tolerance parameters influence the shape of the output routes.
The parameter supports the following fields:
Field | Description |
---|---|
Name | The name of the route. The values for this field are copied from the Name field on the input routes. |
ViolatedConstraints | Legacy:This field is deprecated and is replaced by the four individual fields ViolatedConstraint_1 through ViolatedConstraint_4. |
| These fields contain a summary of violated constraints and are set after a solve operation. Each field will contain one violation. If an order has more than one violation, the next ViolatedConstraint_# field will be used. These show a single violated constraint per field.
|
OrderCount | The number of orders assigned to the route. |
TotalCost | The total operating cost of the route, which is the sum of the following field values: FixedCost, RegularTimeCost, OvertimeCost, and DistanceCost. |
RegularTimeCost | The cost of regular work time, excluding any unpaid breaks. |
OvertimeCost | The cost of overtime work, excluding any unpaid breaks. |
DistanceCost | The distance cost component obtained by multiplying the TotalDistance and CostPerUnitDistance field values. |
TotalTime | The total route duration. This includes travel times as well as service and wait times at orders, depots, and breaks. The TotalTime value is the sum of the following attribute fields:
The value is in the units specified by the Time Units parameter. |
TotalOrderServiceTime | The total service time spent at all orders on the route. The value is in the units specified by the Time Units parameter. |
TotalBreakServiceTime | The total service time spent at all breaks on the route. The value is in the units specified by the Time Units parameter. |
TotalTravelTime | The total travel time for the route. The value is in the units specified by the Time Units parameter. |
TotalDistance | The total travel distance for the route. The value is in the units specified by the Distance Units parameter. |
StartTime | The starting time of the route. The route may start before the beginning of its start depot's time window, in which case there is a wait time at the starting depot. The time of day value for this attribute is in the time zone in which the starting depot is located. |
EndTime | The ending time of the route. The route ends upon completion of service at the ending depot. The time of day value for this attribute is in the time zone in which the ending depot is located. |
StartTimeUTC | The start time of the route in coordinated universal time (UTC). |
EndTimeUTC | The end time of the route in coordinated universal time (UTC). |
TotalWaitTime | The total wait time at all orders, depots, and breaks on the route. The value is in the units specified by the Time Units parameter. |
TotalViolationTime | The total violation time at all orders and breaks on the route. The value is in the units specified by the Time Units parameter. |
RenewalCount | For a route with renewals, this is equal to the number of visits to depots for the purpose of renewing a vehicle, that is, loading or unloading a vehicle. |
TotalRenewalServiceTime | For a route with renewals, this is the total service time spent at all renewal visits on the route. The value is in the units specified by the Time Units parameter. |
out_directions
This provides access to the turn-by-turn directions for each resulting route.
The Directions Language, Directions Distance Units, and Directions Style Name parameters influence the travel directions. The parameter returns empty features if the Populate Directions parameter is False.
The following table lists the fields that are returned for output directions:
Field | Description |
---|---|
RouteName | The name of the route to which the driving action applies. This value is the same as the Name field of the output routes. |
ArriveTime | The time of day to initiate the given driving action. If the route spans multiple days, the date and time of day are displayed. |
Type | The type of maneuver that the directions feature represents or the type of the directions text. To determine whether Type refers to a maneuver type or a directions string type, check the value of the SubItemType field. Type can be used, for example, to assign an icon for direction text based on the maneuver type, or it can use a formatting style based on the directions string type when displaying the driving directions in your application. The Type value is an integer from the Maneuver Types or Directions String Types lists below. Maneuver Types
Directions String Types
|
SubItemType | Specifies whether the Type field refers to an integer from the Directions String Types table or the Maneuver Types table.
|
Text | A text description of the travel directions. |
ElaspsedTime | The time elapsed in minutes from when the current driving direction starts until the next one starts, or until the route ends for the last driving direction. |
DriveDistance | The distance from where the current driving direction occurs to where the next one occurs, or to where the route ends for the last driving direction. The value is in the units specified by the Directions_Distance_Units parameter. This value is zero for driving directions that occur at the same location where the next one begins. For example, the DriveDistance is 0 for the directions text at the start of the route. |
out_unassigned_stops
This provides access to the orders that couldn't be visited by any routes. You can also determine why the orders couldn't be visited and make the necessary changes to correct the problem.
Note:
When the Populate Stop Shapes parameter is set to True, this parameter is a feature class. Otherwise, it is a table.
The parameter supports the following fields:
Field | Description |
---|---|
StopType | Indicates whether the stop represents a depot, an order, or a break. The field value is an integer that can be interpreted in the following ways:
|
Name | The name of the stop. The value of this field is the same as the Name field from input orders, depots, or breaks. You can use the StopType field to determine if the Name field value refers to a depot, an order, or a break. |
ViolatedConstraints | Legacy:This field is deprecated and is replaced by the four individual fields ViolatedConstraint_1 through ViolatedConstraint_4. |
| These fields contain a summary of violated constraints and are set after a solve operation. Each field will contain one violation. If an order has more than one violation, the next ViolatedConstraint_# field will be used. These show a single violated constraint per field.
|
Status | Indicates the status of the point with respect to its location on the network and the outcome of the analysis. The possible values are the following:
|
solve_succeeded
Use this parameter to determine if the analysis was successful.
output_result_file
Use this parameter to access the results from the analysis as a .zip file containing one or more files for each output. The format of the individual file is specified by the Output Format parameter. The parameter value is not populated when the Output Format parameter is set to Feature Set.
When a file-based output format—such as JSON File or GeoJSON File—is specified, no outputs are added to the display, since the application (such as ArcMap or ArcGIS Pro) does not draw the contents of the result file. Instead, the result file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Result File parameter value in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Result File parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
output_route_data
Use this parameter to access a .zip file that contains a file geodatabase containing the inputs and outputs of the analysis in a format that can be used to share route layers with ArcGIS Online or Portal for ArcGIS. The parameter value is populated only when the Save Route Data parameter is set to True.
The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Route Data parameter value in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Route Data parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
output_network_analysis_layer
Use this parameter to access the network analysis layer file that stores the analysis settings and the inputs and outputs used for the analysis. The parameter value is populated only when the Save Output Network Analysis Layer parameter is set to True.
The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Network Analysis Layer parameter value in the entry corresponding to the tool execution in the geoprocessing history of your project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu on the Output Network Analysis Layer parameter in the entry corresponding to the tool execution in the Geoprocessing Results window.
Note:
You cannot work directly with this file even when you open the file in an ArcGIS Desktop application such as ArcMap since its data source will not be valid. The file is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool.