Label | Explanation | Data Type |
Input Vehicle Routing Problem Layer
| The vehicle routing problem, last mile delivery, or waste collection analysis layer to which routes will be added. | Network Analyst Layer |
Number of Routes
(Optional) | The number of routes that will be added. | Long |
Route Name Prefix
(Optional) | A qualifier that will be added to the name of every route. For example, a route name prefix of WeekdayRoute would be used as the starting text for every route’s name with an incrementing numerical suffix appended to it (for example, WeekdayRoute1, WeekdayRoute2, and so on). | String |
Start Depot Name
(Optional) | The name of the starting depot for the route. If this value is null, the route will begin from the first order assigned. Omitting the start depot is useful when the vehicle's starting location is unknown or irrelevant to the problem. For vehicle routing problem layers, when this value is null, the End Depot Name parameter value cannot also be null. Both start and end depots can be null for last mile delivery and waste collection layers. Virtual start depots are not allowed if orders or depots are in multiple time zones. | String |
End Depot Name
(Optional) | The name of the ending depot for the route. If this value is null, the route will end at the last order assigned. For vehicle routing problem layers, when this value is null, the Start Depot Name parameter value cannot also be null. Both start and end depots can be null for last mile delivery and waste collection layers. | String |
Earliest Start Time
(Optional) | The earliest allowable start time for the route in a vehicle routing problem layer. This parameter is used by the solver in conjunction with the time window of the starting depot provided in the Depots sublayer by the TimeWindowStart field for determining feasible route start times. This parameter has a default time-only value of 8:00:00 a.m., which is interpreted as 8:00:00 a.m. on the date provided by the Default Date property of the analysis layer. If no value is specified, the default value is used. This parameter is only applicable if the input layer is a vehicle routing problem layer. It is hidden if the input layer has a different solver type. | Date |
Latest Start Time
(Optional) | The latest allowable start time for the route in a vehicle routing problem layer. This parameter has a default time-only value of 10:00:00 a.m., which is interpreted as 10:00:00 a.m. on the date provided by the Default Date property of the analysis layer. If no value is specified, the default value is used. This parameter is only applicable if the input layer is a vehicle routing problem layer. It is hidden if the input layer has a different solver type. | Date |
Max Order Count
(Optional) | The maximum allowable number of orders on the route. The default value is 30 for vehicle routing problem layers and null for last mile delivery layers. If no value is specified, the default value is used. This parameter is not applicable and is hidden if the input layer is a waste collection layer. | Long |
Capacities
(Optional) |
The maximum amount (volume, weight, quantity, and so on) that can be carried by the vehicle. A null value is the same as zero. A maximum of nine capacity fields are allowed, but use only the number necessary to model the needs of the vehicles. This parameter is not applicable and is hidden if the input layer is a waste collection layer. | Value Table |
Route Constraints (Optional) |
The constraints that will be placed on routes to limit total time, total travel time, and total distance.
This parameter is not applicable and is hidden if the input layer is a waste collection layer. | Value Table |
Costs (Optional) | The costs that may be incurred by the route in a solution.
This parameter is not applicable and is hidden if the input layer is a waste collection layer. | Value Table |
Additional Route Time (Optional) |
Additional route time options.
This parameter is not applicable and is hidden if the input layer is a waste collection layer. | Value Table |
Append To Existing Routes
(Optional) | Specifies whether new routes will be appended to the existing routes attribute table.
| Boolean |
Date and Time (Optional) |
Additional date and time properties for a last mile delivery layer.
Although you can specify both a date and a time for the Earliest Route Start Date and Earliest Route Start Time properties, only the date portion is used for Earliest Route Start Date, and only the time portion is used for Earliest Route Start Time. This parameter is only applicable if the input layer is a last mile delivery layer. It is hidden if the input layer has a different solver type. | Value Table |
Capacities (Optional) |
The capacities for routes in a waste collection layer.
This parameter is only applicable if the input layer is a waste collection layer. It is hidden if the input layer has a different solver type. | Value Table |
Start Time (Optional) |
Additional date and time properties for a waste collection layer.
Although you can specify both a date and a time for the Start Time property, only the time portion is used. This parameter is only applicable if the input layer is a waste collection layer. It is hidden if the input layer has a different solver type. | Value Table |
Route Constraints (Optional) |
The constraints that will be placed on routes to limit total time and distance.
This parameter is only applicable if the input layer is a waste collection layer. It is hidden if the input layer has a different solver type. | Value Table |
Additional Route Time (Optional) |
Additional route time properties.
This parameter is only applicable if the input layer is a waste collection layer. It is hidden if the input layer has a different solver type. | Value Table |
Derived Output
Label | Explanation | Data Type |
Output Vehicle Routing Problem Layer | The updated network analyst layer. | Network Analyst Layer |