Vehicle Routing Problem Analysis—Help | ArcGIS Desktop

ObjectID

The system-managed ID field.

Shape

The geometry field indicating the geographic location of the network analysis object.

Name

The name of the network analysis object.

The name must be unique.

This field acts as a primary key and is used as a foreign key to refer to orders in the OrderPairs table. Order names are case insensitive and cannot be empty, even if the order is excluded from the solve operation.

Description

The descriptive information about the order. This can contain any textual information for the order and has no restrictions for uniqueness. You may want to store a client's ID number in the Name field and the client's actual name or address in the Description field.

ServiceTime

This property specifies how much time will be spent at the network location when the route visits it; that is, it stores the impedance value for the network location. A zero or null value indicates the network location requires no service time.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TimeWindowStart1

The beginning time of the first time window for the network location. This field can contain a null value; a null value indicates no beginning time.

(See the note below this table of properties for more information.)

TimeWindowEnd1

The ending time of the first window for the network location. This field can contain a null value; a null value indicates no ending time.

(See the note below this table of properties for more information.)

TimeWindowStart2

The beginning time of the second time window for the network location. This field can contain a null value; a null value indicates that there is no second time window.

If the first time window is null as specified by the TimeWindowStart1 and TimeWindowEnd1 fields, the second time window must also be null.

If both time windows are nonnull, they can't overlap. Also, the second time window must occur after the first.

(See the note below this table of properties for more information.)

TimeWindowEnd2

The ending time of the second time window for the network location. This field can contain a null value.

When TimeWindowStart2 and TimeWindowEnd2 are both null, there is no second time window.

When TimeWindowStart2 is not null but TimeWindowEnd2 is null, there is a second time window that has a starting time but no ending time. This is valid.

(See the note below this table of properties for more information.)

MaxViolationTime1

A time window is considered violated if the arrival time occurs after the time window has ended. This field specifies the maximum allowable violation time for the first time window of the order. It can contain a zero value but can't contain negative values. A zero value indicates that a time window violation at the first time window of the order is unacceptable; that is, the first time window is hard. On the other hand, a null value indicates that there is no limit on the allowable violation time. A nonzero value specifies the maximum amount of lateness; for example, a route can arrive at an order up to 30 minutes beyond the end of its first time window.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

Time window violations can be tracked and weighted by the solver. Because of this, you can direct the VRP solver to take one of three approaches:

• Minimize the overall violation time, regardless of the increase in travel cost for the fleet.
• Find a solution that balances overall violation time and travel cost.
• Ignore the overall violation time; instead, minimize the travel cost for the fleet.

By assigning an importance level for the Time Window Violation setting of the analysis layer, you are essentially choosing one of these three approaches. In any case, however, the solver will return an error if the value set for MaxViolationTime1 is surpassed.

MaxViolationTime2

The maximum allowable violation time for the second time window of the order. This field is analogous to the MaxViolationTime1 field.

InboundArriveTime

Defines when the item to be delivered to the order will be ready at the starting depot.

The order can be assigned to a route only if the inbound arrive time precedes the route's latest start time value; this way, the route cannot leave the depot before the item is ready to be loaded onto it.

This field can help model scenarios involving inbound-wave transshipments. For example, a job at an order requires special materials that are not currently available at the depot. The materials are being shipped from another location and will arrive at the depot at 11:00 a.m. To ensure a route that leaves before the shipment arrives isn't assigned to the order, the order's inbound arrive time is set to 11:00 a.m. The special materials arrive at 11:00 a.m., they are loaded onto the vehicle, and the vehicle departs from the depot to visit its assigned orders.

Notes:

• The route's start time, which includes service times, must occur after the inbound arrive time. If a route begins before an order's inbound arrive time, the order cannot be assigned to the route. The assignment is invalid even if the route has a start-depot service time that lasts until after the inbound arrive time.

• This time field can contain a time-only value or a date and time value. If a time-only value is set (for example, 11:00 AM), the date is assumed to be the date specified by the Default Date property of the analysis layer. The default date is ignored, however, when any time field in Depots, Routes, Orders, or Breaks includes a date with the time. In that case, specify all such fields with a date and time (for example, 7/11/2015 11:00 AM).

• The VRP solver honors InboundArriveTime regardless of the DeliveryQuantities value.

• If an outbound depart time is also specified, its time value must occur after the inbound arrive time.

OutboundDepartTime

Defines when the item to be picked up at the order must arrive at the ending depot.

The order can be assigned to a route only if the route can visit the order and reach its end depot before the specified outbound depart time.

This field can help model scenarios involving outbound-wave transshipments. For instance, a shipping company sends out delivery trucks to pick up packages from orders and bring them into a depot where they are forwarded on to other facilities, en route to their final destination. At 3:00 p.m. every day, a semitrailer stops at the depot to pick up the high-priority packages and take them directly to a central processing station. To avoid delaying the high-priority packages until the next day's 3:00 p.m. trip, the shipping company tries to have delivery trucks pick up the high-priority packages from orders and bring them to the depot before the 3:00 p.m. deadline. This is done by setting the outbound depart time to 3:00 p.m.

Notes:

• The route's end time, including service times, must occur before the outbound depart time. If a route reaches a depot but doesn't complete its end-depot service time prior to the order's outbound depart time, the order cannot be assigned to the route.

• This time field can contain a time-only value or a date and time value. If a time-only value is set (for example, 11:00 AM), the date is assumed to be the date specified by the Default Date property of the analysis layer. The default date is ignored, however, when any time field in Depots, Routes, Orders, or Breaks includes a date with the time. In that case, specify all such fields with a date and time (for example, 7/11/2015 11:00 AM).

• The VRP solver honors OutboundDepartTime regardless of the PickupQuantities value.

• If an inbound arrive time is also specified, its time value must occur before the outbound depart time.

DeliveryQuantities

The size of the delivery. You can specify size in any dimension you want, such as weight, volume, or quantity. You can even specify multiple dimensions, for example, weight and volume.

If the order requires 2,000 pounds of goods, the Capacity Count parameter in the analysis layer's Layer Properties dialog box should be set to 1, and DeliveryQuantities should be set to 2000.

If there are multiple capacities, as specified by the Capacity Count property of the analysis layer, the DeliveryQuantities values are separated by a space.

For instance, when both weight and volume are known, the Capacity Count in the analysis layer's Layer Properties dialog box should be set to 2. If the order requires 2,000 pounds of goods, which occupy 100 cubic feet, DeliveryQuantities should be set to 2000 100.

An empty string or null value is equivalent to all dimensions being zero. If the string has an insufficient number of values in relation to the capacity count, or dimensions being tracked, the remaining values are treated as zeros. Delivery quantities can't be negative.

PickupQuantities

The size of the pickup. You can specify size in any dimension you want, such as weight, volume, or quantity. You can even specify multiple dimensions, for example, weight and volume. You cannot, however, use negative values. This field is analogous to the DeliveryQuantities field of Orders.

Note:

Revenue

The income generated if the order is included in a solution. This field can contain a null value—a null value indicates zero revenue—but it can't have a negative value.

Revenue is included in optimizing the objective function value but is not part of the solution's operating cost. That is, the TotalCost field in the route class never includes revenue in its output; however, revenue weights the relative importance of servicing orders.

SpecialtyNames

A space-separated string containing the names of the specialties required by the order. A null value indicates that the order doesn't require specialties.

This field is a foreign key to the Name field in the Specialties table. Specialty objects must exist before they will appear in the SpecialtyNames drop-down list. For instance, a lawn care company may need to service an order with a pesticide that requires an applicator license. The company could create a Specialty object named License and set this property to License.

AssignmentRule

This field specifies the rule for assigning the order to a route. It is constrained by a domain of values, which are listed below (their coded values are shown in parentheses).

• Exclude (0)—The order is to be excluded from the subsequent solve operation.
• Preserve route and relative sequence (1)—The solver must always assign the order to the preassigned route and at the preassigned relative sequence during the solve operation. If this assignment rule can't be followed, it results in an order violation.

  With this setting, only the relative sequence is maintained, not the absolute sequence. To illustrate what this means, imagine there are two orders: A and B. They have sequence values of 2 and 3, respectively. If you set their AssignmentRule field values to Preserve route and relative sequence, A's and B's actual sequence values may change after solving because other orders, breaks, and depot visits could still be sequenced before, between, or after A and B. However, B cannot be sequenced before A.

• Preserve route (2)—The solver must always assign the order to the preassigned route during the solve operation. A valid sequence must also be set even though the sequence may or may not be preserved. If the order can't be assigned to the specified route, it results in an order violation.
• Override (3)— The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route and sequence to the order so as to minimize the overall value of the objective function. This is the default value.
• Anchor first (4)— The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route to the order, and makes it the first order on that route, so as to minimize the overall value of the objective function.
• Anchor last (5)— The solver ignores the route and sequence preassignment (if any) for the order during the solve operation. It assigns a route to the order, and makes it the last order on that route, so as to minimize the overall value of the objective function.

This field can't contain a null value.

Network location fields

• SourceID
• SourceOID
• PosAlong
• SideOfEdge

Together, these four properties describe the point on the network where the object is located.

Learn more about network location fields

CurbApproach

The CurbApproach property specifies the direction a vehicle may arrive at and depart from the network location. There are four choices (their coded values are shown in parentheses):

• Either side of vehicle (0)—The vehicle can approach and depart the network location in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the stop or if it can pull into a driveway or parking lot and turn around.
• Right side of vehicle (1)—When the vehicle approaches and departs the network location, the curb must be on the right side of the vehicle. A U-turn is prohibited.
• Left side of vehicle (2)—When the vehicle approaches and departs the network location, the curb must be on the left side of the vehicle. A U-turn is prohibited.
• No U-Turn (3)—When the vehicle approaches the network location, the curb can be on either side of the vehicle; however, the vehicle must depart without turning around.

Learn more about U-turn policies

RouteName

The name of the route to which the order is assigned.

As an input field, this field is used to preassign an order to a specific route. It can contain a null value, indicating that the order is not preassigned to any route, and the solver determines the best possible route assignment for the order. If this is set to null, the sequence field must also be set to null.

The RouteName field is a foreign key to the Name field in the Routes class. Route objects must exist before they will appear in the RouteName list.

After a solve operation, if the order is routed, the RouteName field contains the name of the route that the order is assigned to.

Sequence

This indicates the sequence of the order on its assigned route.

As an input field, this field is used to specify the relative sequence for an order on the route. This field can contain a null value specifying that the order can be placed anywhere along the route. A null value can only occur together with a null RouteName value.

The input sequence values are non-negative and unique for each route (shared across depot visits, orders, and breaks), but do not need to start from 0 or be contiguous.

After a solve operation, the Sequence field contains the sequence value of the order on its assigned route. Output sequence values for a route are shared across depot visits, orders, and breaks; start from 1 (at the starting depot); and are consecutive. So the smallest possible output sequence value for a routed order is 2, since a route always begins at a depot.

Status

This field is constrained by a domain of values, which are listed below (their coded values are shown in parentheses).

• OK (0)—The network location is valid.
• Not located (1)—The location on the network can't be determined.
• Network element not located (2)—The network element that the network location is supposed to be on can't be found. This can occur when a network edge is deleted and the network location is not recalculated.

After a solve operation, the status can be modified using one of the following status values:

• OK (0)—The network location was successfully evaluated.
• Element not traversable (3)—The network element that the network location is on is not traversable. This can occur when the network element is restricted by a restriction attribute.
• Invalid field values (4)—The field values of the network location fall outside the analysis layer's coded or range domains. For example, a negative number may exist where positive numbers are required.
• Not reached (5)—The network location can't be arrived at by the solver.

If time windows are used and the route arrives early or late, the value changes to Time window violation (6).

ViolatedConstraints

This field contains a summary of violated constraints and is set after a solve operation. A combination of one or more of the violations listed below could be assigned to the field if assigning the order to any of the routes would cause a constraint to be violated.

Dive-in:

The coded value that represents the text description is shown in the list below in parentheses. Notice that the coded values are part of a geometric sequence that increases by doubling the last value. This allows various combinations of violations to be coded. For instance, the combination of Capacities exceeded (2) and Hard route zone (128) is coded as 130 (2 +128).

• MaxOrderCount exceeded (1)—The order can't be assigned to a route since the assignment would exceed the route's MaxOrderCount field value. If the maximum order count is exceeded, the solution is still generated, but it will leave some orders unserviced. In this case, the VRP solver includes the largest number of orders possible given the constraints.
• Capacities exceeded (2)—The order can't be assigned to a route since assigning the order would exceed the route's Capacities field value.
• MaxTotalTime exceeded (4)—The order can't be assigned to a route since assigning the order would exceed the route's MaxTotalTime field value.
• MaxTotalTravelTime exceeded (8)—The order can't be assigned to a route since assigning the order would exceed the route's MaxTotalTravelTime field value.
• MaxTotalDistance exceeded (16)—The order can't be assigned to a route since assigning the order would exceed the route's MaxTotalDistance field value.
• Hard time window (32)—The order has a hard time window and can't be assigned to a route without encountering a time window violation. (A hard time window is specified by assigning a value of 0 to the MaxViolationTime1 or MaxViolationTime2 field.)
• Unmatched specialty (64)—The specialties required by the order are not found on the target route.
• Hard route zone (128)—The order does not fall within a hard route zone. If all the routes have hard route zones and an order falls outside a zone, the order is assigned this violated constraint.
• Order pair MaxTransitTime exceeded (256)—The order belongs to an order pair, and assigning the order would exceed the maximum transit time as specified by the order pair's MaxTransitTime field value.
• Order pair violation (512)—An order belongs to an order pair and can't be assigned to a route because the other order has some violation. For example, suppose orders O1 and O2 are paired, and order O1 is located on a network element with negative impedances, but there are no violation issues with order O2. The solver returns Unreachable for order O1 and Order pair violation for O2, since both orders can't be assigned to a route.
• Unreachable (1024)—The order is located on a network element that cannot be reached by any routes. This is often caused by an order being located on a disjoint portion of the network.
• Cannot insert required break (2048)—A break for the route has a null sequence value in the presence of preassigned orders, and the break can't be inserted anywhere without introducing other violations.
• Cannot insert required renewal (4096)—A route exceeds its capacity and needs to visit a route renewal; however, the associated route renewal has a null sequence value in the presence of preassigned orders and can't be inserted anywhere without introducing other violations.

• MaxTravelTimeBetweenBreaks exceeded (8192)—The solver was unable to insert a break within the time specified by the break's MaxTravelTimeBetweenBreaks field. This is often caused by preassigning a sequence to a break such that it can't be reached within the maximum travel time.

• Break MaxCumulWorkTime exceeded (16384)—The solver was unable to insert a break within the time specified by the break's MaxCumulWorkTime field. This is often caused by preassigning a sequence to a break such that it can't be reached within the maximum work time.
• InboundArriveTime or OutboundDepartTime order violation (32768)—The order couldn't be serviced within the inbound arrive time or output depart time constraints. This violation occurs when all the routes' LatestStartTime field values precede the InboundArriveTime values or none of the routes can reach a depot before the order's OutboundDepartTime value.
• Cannot anchor first/last (65536)— The order has an Anchor first or Anchor last assignment rule, but the solver was not able to honor this constraint. This violation occurs when the number of Anchor first orders or the number of Anchor last orders is greater than the number of available routes.

Learn more about troubleshooting network analyses

Note:

The ViolatedConstraints value of an unrouted order may or may not describe all its violations. If the violation is severe enough to immediately exclude the order from further consideration, the solver does so, which prevents any other violations from being discovered for that order. If a violation is encountered that doesn't automatically stop a solution from being generated, the violation is noted in ViolatedConstraints, and the solver continues to consider the order. Any further violations like these are added to the ViolatedConstraints field until either (a) the solver finds a violation that prematurely stops the solve process for that particular order or (b) the solver finds an overall solution to the problem.

FromPrevTravelTime

The travel time from the preceding visit on the route to the order.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

FromPrevDistance

The travel distance from the preceding visit on the route to the order.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

CumulTravelTime

The cumulative travel time for the route up to arrival at the order.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulDistance

The cumulative travel distance for the route up to arrival at the order.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

CumulTime

The cumulative route duration up to and including the order. The cumulative duration includes travel times as well as service and wait times at orders.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ArriveCurbApproach

Indicates which side of the vehicle the curb is on when the vehicle approaches the network location. If the network location's CurbApproach value is set to Right side of vehicle, the ArriveCurbApproach after solving is Right side of vehicle. However, if the CurbApproach value is set to Either side of vehicle or No U-Turn, the ArriveCurbApproach could be on the right or left side depending on which produces the overall shortest path.

DepartCurbApproach

Indicates which side of the vehicle the curb is on when the vehicle departs the network location. If the network location's CurbApproach value is set to Right side of vehicle, the DepartCurbApproach after solving is Right side of vehicle. However, if the CurbApproach value is set to Either side of vehicle or No U-Turn, the DepartCurbApproach could be on the right or left side depending on which produces the overall shortest path.

ArriveTime

The date and time value indicating the arrival time at the order.

The route may arrive at the order before the beginning of one of the order's time windows, in which case there is a wait time at the order. For an order with soft time windows, the route may also arrive at the order after the end of one of the time windows, in which case there is a violation time at the order.

When using traffic data that covers multiple time zones, the time zone for this time-of-day value is taken from the network element on which the order is located.

DepartTime

The date and time value indicating the departure time from the order. The route departs from the order upon completion of service.

When using traffic data that covers multiple time zones, the time zone for this time-of-day value is taken from the network element on which the order is located.

WaitTime

The wait time or layover at the order. For example, you get a wait time value if a route must wait at the order for a time window to open.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ViolationTime

The amount of time elapsed between the end of the order's time window and the arrival of the route vehicle.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulWaitTime

The cumulative wait time from the beginning of the route up to and including the order.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulViolationTime

The cumulative violation time from the beginning of the route up to and including the order.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ObjectID

The system-managed ID field.

Shape

The geometry field indicating the geographic location of the network analysis object.

Name

The name of the network analysis object.

This field is a primary key and is used as a foreign key in the Routes feature layer, RouteRenewals table, and Depot Visits feature layer to refer to depots. Depot names are case insensitive and have to be nonempty and unique.

Description

The descriptive information about the network analysis object. This can contain any textual information and has no restrictions for uniqueness.

Perhaps you want to note what region a depot is in or the depot's address and telephone number; you could enter this information here rather than in the Name field.

TimeWindowStart1

The beginning time of the first time window for the network location. This field can contain a null value; a null value indicates no beginning time.

(See the note below this table of properties for more information.)

TimeWindowEnd1

The ending time of the first window for the network location. This field can contain a null value; a null value indicates no ending time.

(See the note below this table of properties for more information.)

TimeWindowStart2

The beginning time of the second time window for the network location. This field can contain a null value; a null value indicates that there is no second time window.

If the first time window is null as specified by the TimeWindowStart1 and TimeWindowEnd1 fields, the second time window must also be null.

If both time windows are nonnull, they can't overlap. Also, the second time window must occur after the first.

(See the note below this table of properties for more information.)

TimeWindowEnd2

The ending time of the second time window for the network location. This field can contain a null value.

When TimeWindowStart2 and TimeWindowEnd2 are both null, there is no second time window.

When TimeWindowStart2 is not null but TimeWindowEnd2 is null, there is a second time window that has a starting time but no ending time. This is valid.

(See the note below this table of properties for more information.)

Network location fields

• SourceID
• SourceOID
• PosAlong
• SideOfEdge

Together, these four properties describe the point on the network where the object is located.

Learn more about network location fields

CurbApproach

The CurbApproach property specifies the direction from which a vehicle may arrive at and depart from the depot. It is useful for vehicles that need to approach and depart a depot from a specific direction or avoid making U-turns. You can accommodate these requirements by choosing one of the following four values for CurbApproach:

• Either side of vehicle (0)—The vehicle can approach and depart the network location in either direction. U-turns are allowed. You should choose this setting if your vehicle can make a U-turn at the stop or if it can pull into a driveway or parking lot and turn around.
• Right side of vehicle (1)—When the vehicle approaches and departs the network location, the curb must be on the right side of the vehicle. A U-turn is prohibited.
• Left side of vehicle (2)—When the vehicle approaches and departs the network location, the curb must be on the left side of the vehicle. A U-turn is prohibited.
• No U-Turn (3)—This option is not allowed with depots. An error message is returned during the solve process if No U-Turn is used. Nonetheless, U-turns can still be avoided by choosing Right or Left side of vehicle.

Learn more about U-turn policies

Status

This field is constrained by a domain of values, which are listed below (their coded values are shown in parentheses).

• OK (0)—The network location is valid.
• Not located (1)—The location on the network can't be determined.
• Network element not located (2)—The network element that the network location is supposed to be on can't be found. This can occur when a network edge is deleted and the network location is not recalculated.

After a solve operation, the status can be modified using one of the following status values:

• OK (0)—The network location was successfully evaluated.
• Element not traversable (3)—The network element that the network location is on is not traversable. This can occur when the network element is restricted by a restriction attribute.
• Invalid field values (4)—The field values of the network location fall outside the analysis layer's coded or range domains. For example, a negative number may exist where positive numbers are required.
• Not reached (5)—The network location can't be arrived at by the solver.

If time windows are used and the routed vehicle arrives early or late, the value changes to Time window violation (6).

ObjectID

The system-managed ID field.

Name

The name of the network analysis object.

This field is the primary key and is used as a foreign key in the Orders feature layer, Breaks table, Route Zones feature layer, Route Seed Points feature layer, Route Renewals table, and Depot Visits feature layer. Route names are case insensitive and cannot be empty, even if the route is not part of the solve operation. The name must be unique.

Description

The descriptive information about the network analysis object. This can contain any textual information and has no restrictions for uniqueness.

StartDepotName

The name of the starting depot for the route. This field is a foreign key to the Name field in the Depots class. Depot objects must exist before they will appear in the StartDepotName drop-down list.

If the StartDepotName 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 your problem. However, when StartDepotName is null, EndDepotName cannot also be null.

If the route is making deliveries and StartDepotName is null, it is assumed the cargo is loaded on the vehicle at a virtual depot before the route begins. For a route that has no renewal visits, its delivery orders (those with nonzero DeliveryQuantities values in the Orders class) are loaded at the start depot or virtual depot. For a route that has renewal visits, only the delivery orders before the first renewal visit are loaded at the start depot or virtual depot.

EndDepotName

The name of the ending depot for the route. This field is a foreign key to the Name field in the Depots class. Depot objects must exist before they will appear in the EndDepotName drop-down list.

StartDepotServiceTime

The service time at the starting depot. This can be used to model the time spent for loading the vehicle. This field can contain a null value; a null value indicates zero service time.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

Note:

The service times at the start and end depots are fixed values (given by the StartDepotServiceTime and EndDepotServiceTime field values) and do not take into account the actual load for a route. For example, the time taken to load a vehicle at the starting depot may depend on the size of the orders. As such, the depot service times could be given values corresponding to a full truckload or an average truckload, or you could make your own time estimate.

EndDepotServiceTime

The service time at the ending depot. This can be used to model the time spent for unloading the vehicle. This field can contain a null value; a null value indicates zero service time.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

Note:

The service times at the start and end depots are fixed values (given by the StartDepotServiceTime and EndDepotServiceTime field values) and do not take into account the actual load for a route. For example, the time taken to load a vehicle at the starting depot may depend on the size of the orders. As such, the depot service times could be given values corresponding to a full truckload or an average truckload, or you could make your own time estimate.

EarliestStartTime

The earliest allowable starting time for the route. This is used by the solver in conjunction with the time window of the starting depot for determining feasible route start times.

This field can't contain null values and has a default time-only value of 8:00 AM; the default value is interpreted as 8:00 a.m. on the date given by the Default Date property of the analysis layer.

The default date is ignored when any time window field includes a date with the time. To avoid an error in this situation, format all time windows in Depots, Routes, Orders, and Breaks to also include the date with the time.

When using network datasets with traffic data across multiple time zones, the time zone for EarliestStartTime is the same as the time zone of the edge or junction on which the starting depot is located.

LatestStartTime

The latest allowable starting time for the route. This field can't contain null values and has a default time-only value of 10:00 AM; the default value is interpreted as 10:00 a.m. on the date given by the Default Date property of the analysis layer.

The default date is ignored when any time window field includes a date with the time. To avoid an error in this situation, format all time windows in Depots, Routes, Orders, and Breaks to also include the date with the time.

When using network datasets with traffic data across multiple time zones, the time zone for LatestStartTime is the same as the time zone of the edge or junction on which the starting depot is located.

This field stores the amount of travel time needed to accelerate the vehicle to normal travel speeds, decelerate it to a stop, and move it off and on the network (for example, in and out of parking). By including an ArriveDepartDelay value, the VRP solver is deterred from sending many routes to service physically coincident orders.

The cost for this property is incurred between visits to noncoincident orders, depots, and route renewals. For example, when a route starts from a depot and visits the first order, the total arrive/depart delay is added to the travel time. The same is true when traveling from the first order to the second order. If the second and third orders are coincident, the ArriveDepartDelay value is not added between them since the vehicle doesn't need to move. If the route travels to a route renewal, the value is added to the travel time again. Although a vehicle needs to slow down and stop for a break and accelerate afterwards, the VRP solver cannot add the ArriveDepartDelay value for breaks. This means that if a route leaves an order, stops for a break, and continues to the next order, the arrive/depart delay is added only once, not twice.

Say there are five coincident orders in a high-rise building, and they are serviced by three different routes. This means three arrive/depart delays would be incurred; that is, three drivers would need to find parking places and enter the same building. However, if the orders could be serviced by just one route instead, only one driver would need to park and enter the building—only one arrive/depart delay would be incurred. Since the VRP solver tries to minimize cost, it will try to limit the arrive/depart delays and thus choose the single-route option. (Note that multiple routes may need to be sent when other constraints—such as specialties, time windows, or capacities—require it.)

The unit for this field value is specified by the Time Field Units property of the analysis layer.

Capacities

The maximum amount (for instance, volume, weight, quantity) that can be carried by the vehicle. If a vehicle can carry a maximum of 40,000 pounds, Capacity Count on the Layer Properties dialog box of the analysis layer should be set to 1, and Capacities should be set to 40000. Similarly, if a vehicle can carry 1,000 cubic feet, Capacity Count should be set to 1, and Capacities should be set to 1000.

Caution:

The VRP solver only performs a simple Boolean test to determine whether capacities are exceeded. If a route's capacity value is greater than or equal to the total quantity being carried, the VRP solver will assume the cargo fits in the vehicle. This could be incorrect, depending on the actual shape of the cargo and the vehicle. For example, the VRP solver allows you to fit a 1,000-cubic-foot sphere into a 1,000-cubic-foot truck that is 8 feet wide. In reality, however, since the sphere is 12.6 feet in diameter, it won't fit in the 8-foot wide truck.

If there are multiple capacities, as specified by the Capacity Count parameter of the analysis layer, the values of Capacities are separated by a space. For instance, when both the maximum weight and volume of the vehicle are used, Capacity Count on the Layer Properties dialog box of the analysis layer should be set to 2; if the vehicle can carry a weight of 40,000 pounds and a volume of 2,000 cubic feet, Capacities should be set to 40000 2000.

An empty string or null value is equivalent to all values being zero. Capacity values can't be negative.

If the Capacities string has an insufficient number of values in relation to the capacity count, the remaining values are treated as zero.

FixedCost

A fixed monetary cost that is incurred only if the route is used in a solution (that is, it has orders assigned to it). This field can contain null values; a null value indicates zero fixed cost. This cost is part of the total route operating cost.

CostPerUnitTime

The monetary cost incurred—per unit of work time—for the total route duration, including travel times as well as service times and wait times at orders, depots, and breaks. This field can't contain a null value and has a default value of 1.0.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CostPerUnitDistance

The monetary cost incurred—per unit of distance traveled—for the route length (total travel distance). This field can contain null values; a null value indicates zero cost.

The distance unit is specified by the Distance Field Units property of the analysis layer.

The solver will return an error if this field is given a value and the Distance Attribute property is not specified for the analysis layer.

OvertimeStartTime

The duration of regular work time before overtime computation begins. This field can contain null values; a null value indicates that overtime does not apply.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

For example, if the driver is to be paid overtime pay when the total route duration extends beyond eight hours, OvertimeStartTime is specified as 8 if the Time Field Units property of the analysis layer is set to Hours.

CostPerUnitOvertime

The monetary cost incurred per time unit of overtime work. This field can contain null values; a null value indicates that the CostPerUnitOvertime value is the same as the CostPerUnitTime value.

MaxOrderCount

The maximum allowable number of orders on the route. This field can't contain null values and has a default value of 30.

MaxTotalTime

The maximum allowable route duration. The route duration includes travel times as well as service and wait times at orders, depots, and breaks. This field can contain null values; a null value indicates that there is no constraint on the route duration.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

MaxTotalTravelTime

The maximum allowable travel time for the route. The travel time includes only the time spent driving on the network and does not include service or wait times.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

This field can contain null values; a null value indicates there is no constraint on the maximum allowable travel time. This field value can't be larger than the MaxTotalTime field value.

MaxTotalDistance

The maximum allowable travel distance for the route.

The unit for the total distance is specified by the Distance Field Units property of the analysis layer.

This field can contain null values; a null value indicates that there is no constraint on the maximum allowable travel distance.

The solver will return an error if this field is given a value and the Distance Attribute property is not specified for the analysis layer.

SpecialtyNames

A space-separated string containing the names of the specialties supported by the route. A null value indicates that the route does not support any specialties. This field is a foreign key to the Name field in the Specialties table. Specialty objects must exist before they will appear in the SpecialtyNames list.

AssignmentRule

This specifies whether or not the route can be used when solving the problem. This field is constrained by a domain of values, and the possible values are the following:

• Include—The route is included in the solve operation. This is the default value.
• Exclude—The route is excluded from the solve operation.

Shape

The line shape of the route. If the Output Shape Type property of the analysis layer is set to None, no shape is returned. Setting the Output Shape Type property to Straight Line returns straight route lines that connect each pair of consecutive visits. True Shape with measures and True Shape both return lines that trace their corresponding routes on the network, the difference being that True Shape with measures returns a line that is already linearly referenced by time.

ViolatedConstraints

This field contains a summary of violated constraints and is set after a solve operation. If a route causes a constraint to be violated, a combination of one or more of the violations listed below could be assigned to the field.

Dive-in:

The coded value that represents the text description is shown in the list below in parentheses. Notice that the coded values are part of a geometric sequence that increases by doubling the last value. This allows various combinations of violations to be coded. For instance, the combination of Capacities exceeded (2) and Hard route zone (128) is coded as 130 (2 +128).

• MaxOrderCount exceeded (1)—The preassigned orders can't be assigned to the route since assigning the orders would exceed the maximum number of orders that can be assigned to the route as specified by the route's MaxOrderCount field value.
• Capacities exceeded (2)—The preassigned orders can't be assigned to the route since assigning the orders would exceed the total route capacity as specified by the route's Capacities field value.
• MaxTotalTime exceeded (4)—The travel time from the start depot to the end depot plus the service and wait times at both depots and any break exceeds the total time for the route as specified by the route's MaxTotalTime field value.
• MaxTotalTravelTime exceeded (8)—The travel time from the start depot to the end depot exceeds the total travel time for the route as specified by the route's MaxTotalTravelTime field value.
• MaxTotalDistance exceeded (16)—The travel distance from the start depot to the end depot exceeds the total travel distance for the route as specified by the route's MaxTotalDistance field value.
• Hard time window (32)—There is a hard time window violation on the start depot, end depot, or break associated with the route.
• Unmatched specialty (64)—The specialties required by an order are not found on the target route.
• Hard route zone (128)—An order that was preassigned to the route does not fall within a hard route zone.
• Order pair MaxTransitTime exceeded (256)—There is an order pair preassigned to the route, and assigning the orders in the order pair would exceed the maximum transit time for the order pair as specified by the order pair's MaxTransitTime field value.
• Order pair violation (512)—An order belongs to an order pair and can't be assigned to the preassigned route.
• Unreachable (1024)—A preassigned order is located on a network element that cannot be reached by the route.
• Cannot insert required break (2048)—A break for the route has a null sequence value in the presence of preassigned orders, and the break can't be inserted anywhere without introducing other violations.
• Cannot insert required renewal (4096)—A route exceeds its capacity and needs to visit a route renewal; however, the associated route renewal has a null sequence value in the presence of preassigned orders and can't be inserted anywhere without introducing other violations.

• MaxTravelTimeBetweenBreaks exceeded (8192)—The solver was unable to insert a break within the time specified by the break's MaxTravelTimeBetweenBreaks field. This is often caused by preassigning a sequence to a break such that it can't be reached within the maximum travel time.

• Break MaxCumulWorkTime exceeded (16384)—The solver was unable to insert a break within the time specified by the break's MaxCumulWorkTime field. This is often caused by preassigning a sequence to a break such that it can't be reached within the maximum work time.

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
• 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. This field value is null if the Distance Attribute property is not specified for the analysis layer.

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 field values:

• StartDepotServiceTime
• EndDepotServiceTime
• TotalOrderServiceTime
• TotalBreakServiceTime
• TotalRenewalServiceTime
• TotalWaitTime
• TotalTravelTime

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TotalOrderServiceTime

The total service time spent at all orders on the route.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TotalBreakServiceTime

The total service time spent at all breaks on the route.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TotalTravelTime

The total travel time for the route.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TotalDistance

The total travel distance for the route.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

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.

When using traffic data that covers multiple time zones, the time zone for this time-of-day value is taken from the network element that the starting depot is located on.

EndTime

The ending time of the route. The route ends upon completion of service at the ending depot.

When using traffic data that covers multiple time zones, the time zone for this time-of-day value is taken from the network element that the ending depot is located on.

TotalWaitTime

The total wait time at all orders, depots, and breaks on the route.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TotalViolationTime

The total violation time at all orders and breaks on the route.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

RenewalCount

For a route with renewals, this is equal to the number of visits to depots for renewing.

TotalRenewalServiceTime

For a route with renewals, the total service time spent at all renewal visits on the route.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ObjectID

The system-managed ID field.

Shape

The geometry field indicating the geographic location of the network analysis object.

DepotName

The name of the visited depot. This field is a foreign key to the Name field in the Depots network analysis class.

If the route uses a virtual depot, which means the route starts or ends at an order instead of a depot, DepotName is null.

RouteName

The name of the route containing this visit. This field is a foreign key to the Name field in the Routes feature layer.

Sequence

Indicates the sequence of the visited depot on the route. The output sequence values for a route are shared across depot visits, orders, and breaks; start from 1 (at the starting depot); and are consecutive.

VisitType

The reason this depot was visited. This field is constrained by a domain of values:

• Start depot
• End depot
• Renewal depot

ServiceTime

The service time (such as loading or unloading) at the depot.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

FromPrevTravelTime

The travel time from the preceding visit on the route to the depot.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

FromPrevDistance

The travel distance from the preceding visit on the route to the depot.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

CumulTravelTime

The cumulative travel time for the route up to the arrival at this depot.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulDistance

The cumulative travel distance for the route up to the arrival at this depot.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

CumulTime

The cumulative route duration up to and including the depot. The cumulative duration includes travel times as well as service and wait times at orders, depots, and breaks.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ArriveTime

The arrival time at the depot. The route may arrive at the depot before the beginning of the depot's time window, in which case there is wait time at the depot.

When using traffic data that covers multiple time zones, the time zone for this time-of-day value is the same as the network element that the depot is located on.

DepartTime

The departure time from the depot.

When using traffic data that covers multiple time zones, the time zone for this time-of-day value is the same as the network element that the depot is located on.

WaitTime

The wait time at the depot.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulWaitTime

The cumulative wait time from the beginning of the route up to and including the depot.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulViolationTime

The cumulative violation time from the beginning of the route up to and including the depot.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

TotalLoadedQuantities

The amount (for instance, volume, weight, quantity) being loaded at the depot. If there are multiple capacities, as specified by the Capacity Count property of the analysis layer, they are separated by a space. For example, in case of deliveries, the value for the TotalLoadedQuantities field indicates the actual quantity of goods delivered by the vehicle before returning to a depot. This value is less than or equal to the Capacities field value for a given route, indicating that the route performs one truckload of deliveries.

TotalUnloadedQuantities

The amount (for example, volume, weight, quantity) being unloaded at the depot. If there are multiple capacities, as specified by the Capacity Count property of the analysis layer, they are separated by a space. For example, in case of pickups or routes with renewals, the value for the TotalUnloadedQuantities field indicates the actual quantity of goods picked up by the vehicle and brought to the depot. This value is less than or equal to the Capacities field value for a given route, indicating that the route performs one truckload of pickups.

ObjectID

The system-managed ID field.

TimeWindowStart

The starting time of the break's time window.

If this field is null and TimeWindowEnd has a valid time-of-day value, the break is allowed to start anytime before the TimeWindowEnd value.

If this field has a value, MaxTravelTimeBetweenBreaks and MaxCumulWorkTime must be null; moreover, all other breaks in the analysis layer must have null values for MaxTravelTimeBetweenBreaks and MaxCumulWorkTime.

An error will occur at solve time if a route has multiple breaks with overlapping time windows.

The time window fields in breaks can contain a time-only value or a date and time value. If a time field, such as TimeWindowStart, has a time-only value (for example, 12:00 PM), the date is assumed to be the date specified by the Default Date property of the analysis layer. Using date and time values (for example, 7/11/2012 12:00 PM) allows you to specify time windows that span two or more days. This is especially beneficial when a break should be taken sometime before and after midnight.

The default date is ignored when any time window field includes a date with the time. To avoid an error in this situation, format all time windows in Depots, Routes, Orders, and Breaks to also include the date with the time.

When you use network datasets with traffic data across multiple time zones, the time zone for TimeWindowStart and TimeWindowEnd is assumed to be the same as the time zone of the edge or junction on which the starting depot is located.

TimeWindowEnd

The ending time of the break's time window.

If this field is null and TimeWindowStart has a valid time-of-day value, the break is allowed to start anytime after the TimeWindowStart value.

If this field has a value, MaxTravelTimeBetweenBreaks and MaxCumulWorkTime must be null; moreover, all other breaks in the analysis layer must have null values for MaxTravelTimeBetweenBreaks and MaxCumulWorkTime.

The default date is ignored when any time window field includes a date with the time. To avoid an error in this situation, format all time windows in Depots, Routes, Orders, and Breaks to also include the date with the time.

See the description for TimeWindowStart (above) for more information.

MaxTravelTimeBetweenBreaks

The maximum amount of travel time that can be accumulated before the break is taken. The travel time is accumulated either from the end of the previous break or, if a break has not yet been taken, from the start of the route.

If this is the route's final break, MaxTravelTimeBetweenBreaks also indicates the maximum travel time that can be accumulated from the final break to the end depot.

This property is designed to limit how long a person can drive until a break is required. For instance, if the Time Field Units property of the analysis layer is set to Minutes, and MaxTravelTimeBetweenBreaks has a value of 120, the driver will get a break after two hours of driving. To assign a second break after two more hours of driving, the second break's MaxTravelTimeBetweenBreaks property should be 120.

If this field has a value, TimeWindowStart, TimeWindowEnd, MaxViolationTime, and MaxCumulWorkTime must be null for an analysis to solve successfully.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

MaxCumulWorkTime

The maximum amount of work time that can be accumulated before the break is taken. Work time is always accumulated from the beginning of the route.

Work time is the sum of travel time and service times at orders, depots, and breaks. Note, however, that this excludes wait time, which is the time a route (or driver) spends waiting at an order or depot for a time window to begin.

This property is designed to limit how long a person can work until a break is required. For instance, if the Time Field Units property of the analysis layer is set to Minutes, MaxCumulWorkTime has a value of 120, and ServiceTime has a value of 15, the driver will get a 15-minute break after two hours of work.

Continuing with the last example, assume a second break is needed after three more hours of work. To specify this break, you would enter 315 (five hours and 15 minutes) as the second break's MaxCumulWorkTime value. This number includes the MaxCumulWorkTime and ServiceTime values of the preceding break, along with the three additional hours of work time before granting the second break. To avoid taking maximum-work-time breaks prematurely, remember that they accumulate work time from the beginning of the route and that work time includes the service time at previously visited depots, orders, and breaks.

If this field has a value, TimeWindowStart, TimeWindowEnd, MaxViolationTime, and MaxTravelTimeBetweenBreaks must be null for an analysis to solve successfully.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

RouteName

The name of the route that the break applies to. Although a break is assigned to exactly one route, many breaks can be assigned to the same route.

This field is a foreign key to the Name field in the Routes class and can't have a null value.

Route objects must exist before they will appear in the RouteName drop-down list.

Precedence

Precedence values sequence the breaks of a given route. Breaks with a precedence value of 1 occur before those with a value of 2, and so on.

All breaks must have a precedence value, regardless of whether they are time-window, maximum-travel-time, or maximum-work-time breaks.

ServiceTime

The duration of the break. This field can contain null values; a null value indicates no service time.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

MaxViolationTime

This field specifies the maximum allowable violation time for a time-window break. A time window is considered violated if the arrival time falls outside the time range.

A zero value indicates the time window cannot be violated; that is, the time window is hard. A nonzero value specifies the maximum amount of lateness; for example, the break can begin up to 30 minutes beyond the end of its time window, but the lateness is penalized as per the Time Window Violations property of the analysis layer.

This property can be null; a null value with TimeWindowStart and TimeWindowEnd values indicates that there is no limit on the allowable violation time. If MaxTravelTimeBetweenBreaks or MaxCumulWorkTime has a value, MaxViolationTime must be null.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

IsPaid

A Boolean value indicating whether the break is paid or unpaid. A True value indicates that the time spent at the break is included in the route cost computation and overtime determination. A False value indicates otherwise. The default value is True.

Sequence

As an input field, this indicates the sequence of the break on its route. This field can contain null values. The input sequence values are positive and unique for each route (shared across renewal depot visits, orders, and breaks) but need not start from 1 or be contiguous.

The solver modifies the sequence field. After solving, this field contains the sequence value of the break on its route. Output sequence values for a route are shared across depot visits, orders, and breaks; start from 1 (at the starting depot); and are consecutive.

RelativePosition

The relative position of the break. Breaks are taken somewhere between two network locations (orders or depots). A value of 0.0 indicates that the break is taken right after service completion at the preceding network location; a value of 1.0 indicates the break is taken right before starting service at the subsequent network location; and a value in between indicates where along the path from the first to the second network location the break is taken. For instance, 0.25 indicates the break is taken a quarter of the way from the previous network location to the next network location.

No matter how many breaks occur between two network locations, the relative position is always reported relative to the network locations, not the other breaks.

FromPrevTravelTime

The travel time from the preceding order, depot, or break to this break.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

FromPrevDistance

The travel distance from the preceding order, depot, or break to this break.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

CumulTravelTime

The cumulative travel time for the route up to arrival at the break.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulDistance

The cumulative travel distance for the route up to arrival at the break.

The unit for this field value is specified by the Distance Field Units property of the analysis layer. This field is null if the Distance Attribute property is not specified in analysis parameters.

CumulTime

The cumulative route duration up to and including the break. The cumulative duration includes travel times as well as service and wait times at orders, depots, and breaks.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ArriveTime

The actual arrival time of the break. The route may arrive at the break before the beginning of the break's time window, in which case there is a wait time at the break. For a break with soft time windows, the route may also arrive at the break after the end of the time window, in which case there is a violation time at the break.

If using traffic data with multiple time zones, the time is reported in the time zone of the associated route's starting depot.

DepartTime

The time the break is completed.

If using traffic data with multiple time zones, the time is reported in the time zone of the associated route's starting depot.

WaitTime

The wait time at the break.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ViolationTime

The violation time at the break.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulWaitTime

The cumulative wait time from the beginning of the route up to and including the break.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

CumulViolationTime

The cumulative violation time from the beginning of the route up to and including the break.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

ObjectID

The system-managed ID field.

Shape

The geometry field indicating the geographic location of the network analysis object.

RouteName

The name of the route to which this zone applies. A route zone can have a maximum of one associated route. This field can't contain null values, and it is a foreign key to the Name field in the Routes feature layer.

Route objects must exist before they will appear in the RouteName list.

IsHardZone

A Boolean value indicating a hard or soft route zone. A True value indicates that the route zone is hard; that is, an order that falls outside the route zone polygon can't be assigned to the route. The default value is True (1). A False value (0) indicates that such orders can still be assigned, but the cost of servicing the order is weighted by a function that is based on the Euclidean distance from the route zone. Basically, this means that as the straight-line distance from the soft zone to the order increases, the likelihood of the order being assigned to the route decreases.

ObjectID

The system-managed ID field.

RouteName

The name of the route that this seed point applies to. There is at most one route seed point per route. This field can't contain null values and is a foreign key to the Name field in the Routes class. Route objects must exist before they will appear in the RouteName list.

SeedPointType

The type of seed point. This field is constrained by a domain of values, and the possible values are Static and Dynamic. This field has a default value of Static.

In the case of static seed points, you specify where the route seed point is, and the solver tries to cluster the route around the seed point location. In the case of dynamic seed points, you add the seed point anywhere on the map, orders are clustered during the solve process, and then the seed point is relocated to the centroid of the route's orders.

Shape

As an input field, it indicates the location of a route seed point. For a static seed point, its input point shape is left intact throughout the solve process.

On the other hand, the input shape is ignored for a dynamic seed point, and the solver modifies the Shape field during the solve process to show its new location.

ObjectID

The system-managed ID field.

DepotName

The name of the depot where this renewal takes place. This field can't contain a null value and is a foreign key to the Name field in the Depots feature layer.

Depot objects must exist before they will appear in the DepotName list.

RouteName

The name of the route that this renewal applies to. This field can't contain a null value and is a foreign key to the Name field in the Routes feature layer.

Route objects must exist before they will appear in the RouteName list.

ServiceTime

The service time for the renewal. This field can contain a null value; a null value indicates zero service time.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

Note:

The time taken to load a vehicle at a renewal depot may depend on the size of the vehicle and how full or empty the vehicle is. However, the service time for a route renewal is a fixed value and does not take into account the actual load. As such, the renewal service time should be given a value corresponding to a full truckload, an average truckload, or another time estimate of your choice.

Sequences

As an input field, specifies a space-separated string of sequence values of visits to the renewal depot. This field can contain a null value and is used to preassign visits to the renewal depot.

As an output field, the solver may modify and store the sequence here. After solving, this field contains the sequence values of the visits to this renewal depot for the related route. If more than one renewal visit occurs at that depot on a single route, the sequence values are separated by a space. Output sequence values for a route are shared across depot visits, orders, and breaks; start from 1 (at the starting depot); and are consecutive. So if a route starts at a depot, visits two orders, makes a renewal visit, and continues, the sequence value at the renewal is 4.

ObjectID

The system-managed ID field.

Name

The name of the network analysis object.

This field is the primary key and is used as a foreign key in the Orders and Routes feature layers to refer to specialties.

Specialty names have to be unique and can't be empty. They also can't contain spaces. So, for example, a senior technician specialty should be entered as SeniorTechnician.

The no-spaces requirement is necessary because orders and routes that are associated with multiple specialties list specialty names separated by spaces; for example, SeniorTechnician Lift.

Description

The descriptive information about the network analysis object. This can contain any textual information and has no restrictions for uniqueness.

ObjectID

The system-managed ID field.

FirstOrderName

The name of the first order of the pair. This field is a foreign key to the Name field in the Orders feature layer.

Order objects must exist before they will appear in the FirstOrderName list.

SecondOrderName

The name of the second order of the pair. This field is a foreign key to the Name field in the Orders feature layer.

Order objects must exist before they will appear in the SecondOrderName list.

The first order in the pair must be a pickup order; that is, the value for its DeliveryQuantities field is null. The second order in the pair must be a delivery order; that is, the value for its PickupQuantities field is null. The quantity that is picked up at the first order must agree with the quantity that is delivered at the second order. As a special case, both orders may have zero quantities for scenarios where capacities are not used.

Note:

The order quantities are not loaded or unloaded at depots.

MaxTransitTime

The maximum transit time for the pair. The transit time is the duration from the departure time of the first order to the arrival time at the second order. This constraint limits the time-on-vehicle, or ride time, between the two orders. When a vehicle is carrying people or perishable goods, the ride time is typically shorter than that of a vehicle carrying packages or nonperishable goods. This field can contain null values; a null value indicates that there is no constraint on the ride time.

The unit for this field value is specified by the Time Field Units property of the analysis layer.

Excess transit time (measured with respect to the direct travel time between order pairs) can be tracked and weighted by the solver. Because of this, you can direct the VRP solver to take one of three approaches: (1) minimize the overall excess transit time, regardless of the increase in travel cost for the fleet; (2) find a solution that balances overall violation time and travel cost; and (3) ignore the overall excess transit time and, instead, minimize the travel cost for the fleet. By assigning an importance level for the Excess Transit Time setting of the analysis layer, you are in effect choosing one of these three approaches. Regardless of the importance level, the solver will always return an error if the MaxTransitTime value is surpassed.