Output from Origin Destination Cost Matrix

Upon successful execution, the service returns the lines connecting each origin-destination pair, the output origins, the output destinations, and the status of whether the analysis was successful. This information is output in the output parameters described below.

output_origin_destination_lines

This provides access to the lines connecting the origins to the destinations.

The lines include information such as the total travel time and the travel distance between a given origin-destination pair.

The parameter supports the following fields:

FieldDescription

OriginID

The unique identifier of the associated origin that is automatically generated by the analysis.

OriginOID

The ObjectID value of the corresponding input origin feature. This can be used to join additional attributes between the input origins and the origin destination lines.

DestinationID

The unique identifier of the associated destination that is automatically generated by the analysis.

DestinationOID

The ObjectID value of the corresponding input destination feature. This can be used to join additional attributes between the input destinations and the origin destination lines.

DestinationRank

The rank of the destination among all destinations found for the associated origin. The destination that is closest to the origin has a rank of 1.

Total_Time

The travel time along the street network between the associated origin and destination.

The field value is in the units specified by the Time Units parameter

Note:

Additional fields, Total_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis.

Total_Distance

The travel distance along the street network between the associated origin and destination.

The field value is in the units specified by the Distance Units parameter.

Note:

Additional fields, Total_[AccumulateAttributeName]_[DistanceUnits], are included for each distance-based cost attribute that is accumulated during the analysis.

Total_Other

The travel cost in unknown units along the street network between the associated origin and destination.

This field is included only when the travel mode used for the analysis has an impedance attribute that is neither time based nor distance based.

OriginName

The name of the corresponding input origin feature. This field is included only if the Name field is specified on input origins and at least one of the origins has a valid name. If the name is not provided for some of the origins, an automatically generated name prefixed with Location is created for those origins.

DestinationName

The name of the corresponding input destination feature. This field is included only if the Name field is specified on input destinations and at least one of the destinations has a valid name. If the name is not provided for some of the destinations, an automatically generated name prefixed with Location is created for those destinations.

output_origins

This provides information about the origins used in the analysis such as the total number of destinations reached from a given origin, or the origins that could not be included in the analysis.

The parameter supports the following fields. In addition to these fields, the parameter also includes all the fields from the input origins used in the analysis.

Field

Description

Name

The name of the origin. If the name of the origin was provided as part of the Name field, this field has the same value. Otherwise, it includes an automatically generated value prefixed with Location.

OriginOID

The ObjectID value of the corresponding input origin feature. This can be used to join additional attributes from the input origins.

DestinationCount

A count of destinations that were reached from the origin.

TargetDestinationCount

The value of the TargetDestinationCount field in the corresponding input origins.

SourceID

The numeric identifier of the network dataset source feature class on which the input point is located.

SourceOID

The ObjectID of the feature in the source on which the input point is located.

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

CurbApproach

The value of the CurbApproach field in the corresponding input origins.

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.

SnapX

The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

SnapY

The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

SnapZ

The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ field is 0 if the network is two dimensional.

DistanceToNetworkInMeters

The distance in meters between the point's geographic location and the position where it was located on the network.

Cutoff

The value of the Cutoff field in the corresponding input origins.

TargetDestinationCount

The value of the TargetDestinationCount field in the corresponding input origins.

Bearing

The values for this field are copied from the Bearing field on the input facilities.

BearingTol

The values for this field are copied from the BearingTol field on the input facilities.

NavLatency

The values for this field are copied from the NavLatency field on the input facilities.

output_destinations

This provides information about the destinations used in the analysis such as the total number of origins that were reached from a given origin, or the destinations that could not be included in the analysis.

The parameter supports the following fields. In addition to these fields, the parameter also includes all the fields from the input destinations used for the analysis.

Field

Description

Name

The name of the destination. If the name for the origin was provided as part of the Name field, this field has the same value. Otherwise, it includes an automatically generated value prefixed with Location.

DestinationOID

The ObjectID value of the corresponding input destination feature. This can be used to join additional attributes from the input destinations.

OriginCount

The number of origins that reached the destination.

SourceID

The numeric identifier of the network dataset source feature class on which the input point is located.

SourceOID

The ObjectID of the feature in the source on which the input point is located.

PosAlong

The position along the digitized direction of the source line feature. This value is stored as a ratio. This field is null if the network location references a junction.

SideOfEdge

The side of the edge in relation to the digitized direction of the line feature. This field is limited to a domain of two values: Right Side (1) and Left Side (2).

CurbApproach

The value of the CurbApproach field in the corresponding input destinations.

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.

SnapX

The x-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

SnapY

The y-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset.

SnapZ

The z-coordinate of the position on the network dataset where the point was located, in the coordinate system of the network dataset. The SnapZ field is 0 if the network is two dimensional.

DistanceToNetworkInMeters

The distance in meters between the point's geographic location and the position where it was located on the network.

Bearing

The values for this field are copied from the Bearing field on the input facilities.

BearingTol

The values for this field are copied from the BearingTol field on the input facilities.

NavLatency

The values for this field are copied from the NavLatency field on the input facilities.

solve_succeeded

Use this parameter to determine if the analysis was successful.

output_result_file

Use this parameter to access the results from the analysis as a .zip file containing one or more files for each output. The format of the individual file is specified by the Output Format parameter. The parameter value is not populated when the Output Format parameter is set to Feature Set.

When a file-based output format—such as JSON File or GeoJSON File—is specified, no outputs are added to the display, since the application (such as ArcMap or ArcGIS Pro) does not draw the contents of the result file. Instead, the result file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Result File parameter value in the entry corresponding to the tool operation in the geoprocessing history of the project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu of the Output Result File parameter in the entry corresponding to the tool operation in the Geoprocessing Results window.

output_network_analysis_layer

Use this parameter to access the network analysis layer file that stores the analysis settings and the inputs and outputs used for the analysis. The parameter value is populated only when the Save Output Network Analysis Layer parameter is set to True.

The file is downloaded to a temporary directory on your machine. In ArcGIS Pro, the location of the downloaded file can be determined by viewing the Output Network Analysis Layer parameter value in the entry corresponding to the tool operation in the geoprocessing history of the project. In ArcMap, the location of the file can be determined by accessing the Copy Location option in the shortcut menu of the Output Network Analysis Layer parameter in the entry corresponding to the tool operation in the Geoprocessing Results window.

Note:

You cannot work directly with this file even when you open the file in an ArcGIS Desktop application such as ArcMap since its data source will not be valid. The file is meant to be sent to Esri Technical Support to diagnose the quality of results returned from the tool.