After successful execution of SolveLocationAllocation, the service returns the chosen facilities, participating demand points, connecting lines between demand points and the facilities to which they were assigned, and the status of whether the analysis was successful. This information is output in the output parameters described below.
output_facilities
This provides access to the chosen, required, and competitor facilities, as well as any candidate facilities that were not chosen.
This parameter supports the fields listed below. In addition to these fields, the parameter also includes all the fields from the input facilities used for the analysis.
Field | Description |
---|---|
Name | The name of the facility. The values for this field are copied from the Name field on the input facilities. |
FacilityOID | The ObjectID value of the corresponding input facility feature. This field is often used to join information from the input facilities. |
FacilityType | The best facilities, or those that are chosen in the analysis, are indicated in this field. The facility types are as follows:
|
Weight | The relative weighting of the facility, which is used to rate the attractiveness, desirability, or bias of one facility compared to another. The values for this field are copied from the Weight field on the input facilities. |
Capacity | The amount of weighted demand the facility is capable of supplying. The values for this field are copied from the Capacity field on the input facilities. |
DemandCount | A count of demand points allocated to the facility. A value other than zero means the facility was part of the solution, either as a required, competitor, or chosen facility. |
DemandWeight | The sum of the effective weight from all demand points that were allocated to the facility. The value is the sum of all the weight values from the demand points that were allocated to the facility. In the case of the Maximize Attendance and Market Share problem types, the value is an apportioned sum of the Weight field values, since these problem types allow demand to decay with distance or be split among many facilities. |
Total_Minutes | The sum of travel time in minutes between the facility and each of the demand points that were allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is time based. Note:An additional field, Total_[TimeUnits], is included if the Measurement Units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the Measurement Units parameter. |
TotalWeighted_Minutes | This field stores the cumulative weighted cost in minutes for a facility. The weighted cost for a demand point is its weight multiplied by the least-cost path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility. For example, if a demand point with a weight of 2 is allocated to a facility 10 minutes away, the TotalWeighted_Minutes value is 20 (2 x 10). If another demand point with a weight of 3 is allocated to the same facility and is 5 minutes away, the TotalWeighted_Minutes value increases to 35 (3 x 5 + 20). This field is included only if the travel mode set for the analysis has an impedance attribute that is time based. Note:An additional field, TotalWeighted_[TimeUnits], is included if the Measurement Units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the Measurement Units parameter. |
Total_Miles | The sum of travel distance in miles between the facility and each of the demand points that were allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is distance based. Note:An additional field, Total_[DistanceUnits], is included if the Measurement Units parameter is distance based and its value is not set to Miles or Kilometers. The field values are in the units specified by the Measurement Units parameter. |
TotalWeighted_Miles | This field stores the cumulative weighted cost in miles for a facility. The weighted cost for a demand point is its weight multiplied by the least-cost path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility. For example, if a demand point with a weight of 2 is allocated to a facility 10 miles away, the TotalWeighted_Miles value is 20 (2 x 10). If another demand point with a weight of 3 is allocated to the same facility and is 5 miles away, the TotalWeighted_Miles value increases to 35 (3 x 5 + 20) This field is included only if the travel mode set for the analysis has an impedance attribute that is distance based. Note:An additional field, TotalWeighted_[DistanceUnits], is included if the Measurement Units parameter is distance based and its value is not set to Miles or Kilometers. The field values are in the units specified by the Measurement Units parameter. |
Total_Kilometers | This field is analogous to the Total_Miles field, except values are in kilometers instead of miles. |
TotalWeighted_Kilometers | This field is analogous to the TotalWeighted_Miles field, except values are in kilometers instead of miles. |
Total_Other | A sum of travel cost in unknown units between the facility and each of the demand points that were allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is neither time based nor distance based. |
TotalWeighted_Other | This field stores the cumulative weighted cost in unknown units for a facility. The weighted cost for a demand point is its weight multiplied by the least-cost path between the facility and the demand point. The weighted cost for a facility is the sum of all the weighted costs of demand points that are allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is neither time based nor distance based. |
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 direction a vehicle may depart from or arrive at the facility. The values for this field are copied from the CurbApproach field on the input facilities. |
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:
|
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. |
output_demand_points
This provides access to the demand points that participated in the analysis: those that were and were not allocated to facilities.
This parameter supports the fields listed below. In addition to these fields, the parameter also includes all the fields from the input feature class used as facilities for the analysis.
Field | Description |
---|---|
Name | The name of the demand point. The values for this field are copied from the Name field on the input demand points. |
FacilityOID | The ObjectID value of the facility to which this demand point is allocated. The field value is Null if the demand point is not allocated to any facility. This field is often used to join information from the input facilities to the output demand points. |
DemandOID | The ObjectID value of the corresponding input demand point feature. This field is often used to join information. |
Weight | The relative weighting of the demand point. The values for this field are copied from the Weight field on the input demand points. |
AllocatedWeight | Specifies the amount of demand allocated to chosen and required facilities. The value excludes demand allocated to competing facilities. The value options are as follows:
|
GroupName | The name of the group of which the demand point is a part. The values for this field are copied from the GroupName field on the input demand points. |
ImpedanceTransformation | The values for this field are copied from the ImpedanceTransformation field on the input demand points. |
ImpedanceParameter | The values for this field are copied from the ImpedanceParameter field on the input demand points. |
Cutoff | The demand point can't be allocated to a facility that is beyond the value indicated here. The values for this field are copied from the Cutoff field on the input demand points. |
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 direction a vehicle may depart from or arrive at the demand point. The values for this field are copied from the CurbApproach field on the input facilities. |
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:
|
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 demand points. |
BearingTol | The values for this field are copied from the BearingTol field on the input demand points. |
NavLatency | The values for this field are copied from the NavLatency field on the input demand points. |
output_allocation_lines
This provides access to the lines that connect demand points to the facilities to which they are allocated. Such lines are referenced in the documentation as allocation lines. These allocation lines include data about the demand allocated from each demand point to the associated facility.
The parameter supports the following fields:
Field | Description |
---|---|
Name | The name of the allocation line that includes the names of the demand point and facility to which the demand point is allocated. The name of the allocation line is based on the names of the associated facility and demand point. The facility name is first if the Travel Direction parameter value is set to Facility To Demand. For example, Facility 5 - Demand 3 indicates that the route travels from Facility 5 to Demand 3. If Demand To Facility is specified as the Travel Direction parameter value, the demand point name is first, for example, Demand 3 — Facility 5. |
Weight | The weight assigned from the connected demand point to the connected facility. |
FacilityOID | The ObjectID value of the corresponding input facility feature. This field is often used to join information from the facilities to the allocation lines. |
DemandOID | The ObjectID value of the corresponding input demand point feature. This field is often used to join information from the demand points to the allocation lines. |
Total_Minutes | The travel time in minutes between the facility and the demand point. Although the allocation lines have either straight or null geometries, the cost always refers to travel times as measured on a transportation network, not straight-line distances. Note:An additional field, Total_[TimeUnits], is included if the Measurement Units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the Measurement Units parameter. Note:Additional fields, Total_[AccumulateAttributeName]_[TimeUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
TotalWeighted_Minutes | The weighted cost of traveling between the facility and the demand point in minutes. This is the Total_Minutes value multiplied by the weight of the demand point allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is time based. Note:An additional field, TotalWeighted_[TimeUnits], is included if the Measurement Units parameter is time based and its value is not set to Minutes. The field values are in the units specified by the Measurement Units parameter. |
Total_Miles | The travel distance in miles between the facility and the demand point. Although the allocation lines have either straight or null geometries, the cost always refers to travel distances as measured on a transportation network, not straight-line distances. Note:An additional field, Total_[DistanceUnits], is included if the Measurement Units parameter is distance based and its value is not set to Miles or Kilometers. The field values are in the units specified by the Measurement Units parameter. Note:Additional fields, Total_[AccumulateAttributeName]_[DistanceUnits], are included for each time-based cost attribute that is accumulated during the analysis. |
Total_Kilometers | The travel distance in kilometers between the facility and the demand point. Although the allocation lines have either straight or null geometries, the cost always refers to travel distances as measured on a transportation network, not straight-line distances. |
TotalWeighted_Miles | The weighted cost of traveling between the facility and the demand point in miles. This is the Total_Miles value multiplied by the weight of the demand point allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is distance based. Note:An additional field, TotalWeighted_[DistanceUnits], is included if the Measurement Units parameter is distance based and its value is not set to Miles or Kilometers. The field values are in the units specified by the Measurement Units parameter. |
TotalWeighted_Kilometers | The weighted cost of traveling between the facility and the demand point in kilometers. This is the Total_Kilometers value multiplied by the weight of the demand point allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is distance based. |
Total_Other | The travel cost in unknown units between the facility and the demand point. Although the allocation lines have either straight or null geometries, the cost always refers to travel cost as measured on a transportation network, not straight-line distances. 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. Note:Additional fields, Total_[AccumulateAttributeName]_Other, are included for each cost attribute that is neither time based nor distance based and accumulated during the analysis. |
TotalWeighted_Other | The weighted cost of traveling between the facility and the demand point in unknown units. This is the Total_Cost value multiplied by the weight of the demand point allocated to the facility. This field is included only if the travel mode set for the analysis has an impedance attribute that is neither time based nor distance based. |
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.