LastMileDelivery output data types

The output data types containing the results from a last mile delivery analysis are described below.

Orders

The output is a copy of the input Orders table with additional information about which route served each order, the arrival and departure times, and the order sequence.

The output Orders table includes all fields from the input Orders table. Fields that are updated or added to the output are listed in the following table:

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

RouteName

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

This field corresponds to the Name field in the output Routes table.

Text

Sequence

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

Output sequence values for a route are shared across depot visits and orders. The sequences start from 0 at the starting depot and are consecutive. The smallest possible output sequence value for a routed order is 1. This is the case even if the route begins at a virtual depot.

Long

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.

  • MaxOrderCount exceeded (0)—The preassigned orders cannot be assigned to the route since assigning the orders will exceed the maximum number of orders that can be assigned to the route as specified by the route's MaxOrderCount field value.
  • Capacities exceeded (1)—The preassigned orders cannot be assigned to the route since assigning the orders will exceed the total route capacity as specified by the route's Capacities field value.
  • MaxTotalTime exceeded (2)—The travel time from the start depot to the end depot plus the service and wait times at both depots exceeds the total time for the route as specified by the route's MaxTotalTime field value.
  • MaxTotalTravelTime exceeded (3)—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 (4)—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 (5)—There is a hard time window violation on the start depot, end depot, or break associated with the route.
  • Unmatched specialty (6)—The specialties required by an order are not found on the target route.
  • Hard route zone (7)—An order that was preassigned to the route does not fall within a hard route zone.
  • Unreachable (10)—A preassigned order is located on a network element that cannot be reached by the route.
  • InboundArriveTime or OutboundDepartTime order violation (15)—The order couldn't be serviced within the inbound arrive time or outbound 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 (16)—The order has an Anchor first or Anchor last assignment rule, but the solver could not honor this constraint. This violation occurs when the number of Anchor first orders or Anchor last orders is greater than the number of available routes.

Learn more about troubleshooting network analyses

Note:

The violated constraint field 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 violated constraint fields, and the solver continues to consider the order. Any further violations such as these are added to the violated constraint fields until either the solver finds a violation that prematurely stops the solve process for that particular order, or the solver finds an overall solution to the problem.

Long

FromPrevTravelTime

The elapsed travel time from the previous stop to the current stop.

The value is in the units specified by the timeUnits property of the analysis object.

Double

FromPrevDistance

The distance along the route from the previous stop to the current stop.

The value is in the units specified by the distanceUnits property of the analysis object.

Double

ArriveCurbApproach

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.

Long

DepartCurbApproach

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.

Long

ArriveTime

The time of day the route arrives at the order.

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

This arrival time reflects the travel times that were used during the optimization by the solver. For a network with traffic data, traffic conditions for specific times of day are not used; rather, the solver uses the time neutral average travel times for this optimization phase.

The time zone for the ArriveTime field value is derived from the network element on which the order is located.

Timestamp Offset

DepartTime

The time of day the route departs from the order. The route departs from the order upon completion of service.

This departure time reflects the travel times that were used during the optimization by the solver. For a network with traffic data, traffic conditions for specific times of day are not used; rather, the solver uses the time neutral average travel times for this optimization phase.

The time zone for the DepartTime field value is derived from the network element on which the order is located.

Timestamp Offset

WaitTime

The wait time or layover at the order. 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 timeUnits property of the analysis object.

Double

ViolationTime

The amount of time elapsed from the end of the order's time window to the arrival of the route vehicle.

The value is in the units specified by the timeUnits property of the analysis object.

Double

Status

Specifies 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:

  • 0 (OK)—The point was located on the network.
  • 1 (Not Located)—The point was not located on the network and was not included in the analysis.
  • 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.

Long

Network location fields

  • SourceID
  • SourceOID
  • PosAlong
  • SideOfEdge
  • SnapX
  • SnapY
  • SnapZ
  • DistanceToNetworkInMeters

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

Learn more about locating inputs on a network

Depots

The output is a copy of the input Depots table with additional information about how the depots were located on the network.

The output Depots table includes all fields from the input Depots table. Only fields that are added to the output are listed in the following table:

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

Status

Specifies 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:

  • 0 (OK)—The point was located on the network.
  • 1 (Not Located)—The point was not located on the network and was not included in the analysis.
  • 2 (Network element not located)—The network element identified by the point's network location fields can't be found. This can occur when a network element where the point should be was deleted, and the network location was not recalculated.
  • 3 (Element not traversable)—The network element that the point is located on is not traversable. This can occur when the element is restricted by a restriction attribute.
  • 4 (Invalid Field Values)—Field values fall outside a range or coded-value domain. For example, a negative number exists where positive numbers are required.
  • 5 (Not Reached)—The point can't be reached by the solver. The point may be on a separate, disconnected area of the network from the other inputs, or barriers or restrictions prevent travel to or from the point.
  • 6 (Time window violation)—The point could not be reached within the designated time windows. This status only applies to network analysis types that support time windows.
  • 7 (Not located on closest)—The closest network location to the point is not traversable because of a restriction or barrier, so the point has been located on the closest traversable network feature instead.

Long

Network location fields

  • SourceID
  • SourceOID
  • PosAlong
  • SideOfEdge
  • SnapX
  • SnapY
  • SnapZ
  • DistanceToNetworkInMeters

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

Learn more about locating inputs on a network

DepotVisits

When a route starts or ends at a depot, a depot visit is created. Depot visits provide information regarding why a route visited a depot and what happened there. The quantity of goods loaded on or unloaded from a vehicle at the depot is recorded in the properties of a depot visit. Additional information that is useful in interpreting the analysis solution is also included.

The data type supports the following fields:

FieldDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

DepotName

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

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

Text

VisitType

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

  • 1—Start depot
  • 2—End depot

Long

RouteName

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

Text

Sequence

The sequence of the visited depot on the route.

Output sequence values for a route are shared across depot visits and orders. The sequences start from 0 at the starting depot and are consecutive.

Long

ServiceTime

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

The value is in the units specified by the timeUnits property of the analysis object.

Double

FromPrevTravelTime

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

The value is in the units specified by the timeUnits property of the analysis object.

Double

FromPrevDistance

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

The value is in the units specified by the distanceUnits property of the analysis object.

Double

ArriveTime

The arrival time at the depot.

The arrival time reflects the travel times that were used during the optimization by the solver. For a network with traffic data, traffic conditions for specific times of day are not used; rather, the solver uses the time neutral average travel times for this optimization phase.

The time zone for the ArriveTime field value is derived from the network element on which the depot is located.

Timestamp Offset

DepartTime

The departure time from the depot.

The departure time reflects the travel times that were used during the optimization by the solver. For a network with traffic data, traffic conditions for specific times of day are not used; rather, the solver uses the time neutral average travel times for this optimization phase.

The time zone for the DepartTime field value is derived from the network element on which the depot is located.

Timestamp Offset

  • LoadedQuantity_1
  • LoadedQuantity_2
  • LoadedQuantity_3
  • LoadedQuantity_4
  • LoadedQuantity_5
  • LoadedQuantity_6
  • LoadedQuantity_7
  • LoadedQuantity_8
  • LoadedQuantity_9

The amount (for example, volume, weight, quantity) being loaded at the depot. If there are multiple capacities, the amounts in the LoadedQuantity_1 through LoadedQuantity_9 fields correspond to the matching Capacity_1 through Capacity_9 fields in the Routes input table.

Double

  • UnloadedQuantity_1
  • UnloadedQuantity_2
  • UnloadedQuantity_3
  • UnloadedQuantity_4
  • UnloadedQuantity_5
  • UnloadedQuantity_6
  • UnloadedQuantity_7
  • UnloadedQuantity_8
  • UnloadedQuantity_9

The amount (for example, volume, weight, quantity) being unloaded at the depot. If there are multiple capacities, the amounts in the UnloadedQuantity_1 through UnloadedQuantity_9 fields correspond to the matching Capacity_1 through Capacity_9 fields in the Routes input table.

Double

Routes

This provides access to the drivers, vehicles, and route paths of the last mile delivery analysis.

The output Routes table includes all fields from the input Routes table as well as additional fields describing how each route serviced the orders. Only fields that are added to the output are listed below.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

Describes constraints violated by the route. The constraints are given as integers as described in the table below.

  • MaxOrderCount exceeded (0)—The preassigned orders cannot be assigned to the route since assigning the orders will exceed the maximum number of orders that can be assigned to the route as specified by the route's MaxOrderCount field value.
  • Capacities exceeded (1)—The preassigned orders cannot be assigned to the route since assigning the orders will exceed the total route capacity as specified by the route's Capacities field value.
  • MaxTotalTime exceeded (2)—The travel time from the start depot to the end depot plus the service and wait times at both depots exceeds the total time for the route as specified by the route's MaxTotalTime field value.
  • MaxTotalTravelTime exceeded (3)—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 (4)—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 (5)—There is a hard time window violation on the start depot, end depot, or break associated with the route.
  • Unmatched specialty (6)—The specialties required by an order are not found on the target route.
  • Hard route zone (7)—An order that was preassigned to the route does not fall within a hard route zone.
  • Unreachable (10)—A preassigned order is located on a network element that cannot be reached by the route.
  • InboundArriveTime or OutboundDepartTime order violation (15)—The order couldn't be serviced within the inbound arrive time or outbound 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 (16)—The order has an Anchor first or Anchor last assignment rule, but the solver could not honor this constraint. This violation occurs when the number of Anchor first orders or Anchor last orders is greater than the number of available routes.

Long

OrderCount

The number of orders assigned to the route.

Long

TotalCost

The total operating cost of the route, which is the sum of the following field values: FixedCost, RegularTimeCost, OvertimeCost, and DistanceCost.

Double

RegularTimeCost

The cost of regular work time.

Double

OvertimeCost

The cost of overtime work.

Double

DistanceCost

The distance cost component obtained by multiplying the TotalDistance and CostPerUnitDistance field values.

Double

TotalTime

The total route duration. This includes travel times as well as service and wait times at orders and depots. The TotalTime value is the sum of the following attribute fields:

  • StartDepotServiceTime
  • EndDepotServiceTime
  • TotalOrderServiceTime
  • TotalWaitTime
  • TotalTravelTime

The value is in the units specified by the timeUnits property of the analysis object.

Double

TotalOrderServiceTime

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

The value is in the units specified by the timeUnits property of the analysis object.

Double

TotalTravelTime

The total travel time for the route.

The value is in the units specified by the timeUnits property of the analysis object.

Double

TotalDistance

The total travel distance for the route.

The value is in the units specified by the distanceUnits property of the analysis object.

Double

StartTime

The starting time of the route.

The time zone for the StartTime field value is derived from the network element on which the starting depot is located or the first order if the route starts at a virtual depot.

Timestamp Offset

EndTime

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

The time zone for the EndTime field value is derived from the network element on which the ending depot or final order is located.

Timestamp Offset

TotalWaitTime

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

The value is in the units specified by the timeUnits property of the analysis object.

Double

TotalViolationTime

The total violation time at all orders on the route.

The value is in the units specified by the timeUnits property of the analysis object.

Double

DirectionPoints

This is the output turn-by-turn directions for the routes calculated in the analysis, represented as point locations along the routes where specific direction events or maneuvers occur.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

RouteID

The ObjectID value of the output Routes feature with which this direction point is associated.

Long

Sequence

The sequence of the direction points for the route, starting with 1.

Long

DirectionPointType

Specifies the type of direction event or maneuver described by the point, designated by one of the values below.

  • Header (1)
  • Arrive (50)
  • Depart (51)
  • Straight (52)
  • On Ferry (100)
  • Off Ferry (101)
  • Central Fork (102)
  • Roundabout (103)
  • U-Turn (104)
  • Door (150)
  • Stairs (151)
  • Elevator (152)
  • Escalator (153)
  • Pedestrian Ramp (154)
  • Left Fork (200)
  • Left Ramp (201)
  • Clockwise Roundabout (202)
  • Left-handed U-turn (203)
  • Bear left (204)
  • Left Turn (205)
  • Sharp Left (206)
  • Left Turn and immediate Left Turn (207)
  • Left Turn and immediate Right Turn (208)
  • Right Fork (300)
  • Right Ramp (301)
  • Counter-Clockwise Roundabout (302)
  • Right-handed U-turn (303)
  • Bear right (304)
  • Right Turn (305)
  • Sharp Right (306)
  • Right Turn and immediate Left Turn (307)
  • Right Turn and immediate Right Turn (308)
  • Up Elevator (400)
  • Up Escalator (401)
  • Up Stairs (402)
  • Down Elevator (500)
  • Down Escalator (501)
  • Down stairs (502)
  • General Event (1000)
  • Landmark (1001)
  • Time Zone Change (1002)
  • Traffic Event (1003)
  • Scaled Cost Barrier Event (1004)
  • Boundary Crossing (1005)
  • Restriction Violation (1006)
  • Lane (1007)

Long

OrderID

The ObjectID value of the output Orders feature with which this direction point is associated.

Long

DepotVisitID

The ObjectID value of the output DepotVisits feature with which this direction point is associated.

Long

BreakVisitID

Note:

This field is not used for last mile delivery analyses.

Long

DisplayText

The directions text that will be displayed in the consuming application.

Text

ArrivalTime

The time the direction event occurs in coordinated universal time (UTC).

Date

ArrivalUTCOffset

The difference in minutes between the local time at the maneuver location and UTC time shown in the ArrivalTime field.

Double

Name

The name of the direction point.

Text

ExitName

The highway exit name that appears in the directions instruction.

Text

AlternateName

The alternate source name that appears in the directions instruction.

Text

IntersectingName

The name of the intersecting or cross street that appears in the directions instruction.

Text

BranchName

The signpost branch name that appears in the directions instruction.

Text

TowardName

The signpost toward destination name that appears in the directions instruction.

Text

Level

The building level at which this direction event occurs. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long

ShortVoiceInstruction

The short text that will be used as voice guidance text in the consuming application.

Text

VoiceInstruction

The additional text, including expanded abbreviations and plurals, that will be used as voice guidance text in the consuming application.

Text

Azimuth

The bearing in degrees of the vehicle departing this point. Zero indicates north.

Double

DirectionLines

This is the output route lines calculated in the analysis sliced to represent each route segment between DirectionPoints events or maneuver locations.

Field nameDescriptionData type

ObjectID

The object ID of the feature.

ObjectID

DirectionPointID

The ObjectID value of the feature in the DirectionPoints table with which this line is associated.

Long

RouteID

The ObjectID value of the output Routes feature with which this direction line is associated.

Long

DirectionLineType

Specifies the type of direction situation described by this line, designated by one of the following values:

  • Unknown (0)
  • Segment (1)
  • Maneuver Segment (2)
  • Restriction violation (3)
  • Scaled Cost Barrier (4)
  • Heavy Traffic (5)
  • Slow Traffic (6)
  • Moderate Traffic (7)

Long

Meters

The length of the line segment measured in meters.

Double

Minutes

The travel time along the line segment in minutes.

Double

FromLevel

The building level at which this direction event begins. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long

ToLevel

The building level at which this direction event ends. This value corresponds to the Level property defined in the network dataset used for the analysis.

Long