Label | Explanation | Data Type |
Input Network Analysis Layer | The network analysis layer to which the network analysis objects will be added. | Network Analyst Layer |
Sub Layer | The name of the sublayer of the network analysis layer to which the network analysis objects will be added. | String |
Input Locations | The feature class or table containing the locations to be added to the network analysis sublayer. | Table View |
Field Mappings (Optional) | The mapping between the input fields of the network analysis sublayer to which locations will be added and the fields in the input data or specified constants. Input sublayers of network analysis layers have a set of input fields that can be populated to modify or control analysis behavior. When adding locations to the sublayer, you can use this parameter to map field values from the input table to these fields in the sublayer. You can also use field mappings to specify a constant default value for each property. If neither the Field value nor the Default value is specified for a property, the resulting network analysis objects will have null values for that property. A complete list of input fields for each sublayer for each network analysis layer type is available in the documentation for each layer. For example, examine the Route layer's Stops sublayer's input fields. If the data being loaded contains precalculated network locations or location ranges based on the network data source and travel mode used for the analysis, choose the Use Network Location Fields option from the drop-down menu. Adding the network analysis objects using the network location fields is quicker than loading by geometry. Learn more about network location fields Note:ArcGIS Online and some ArcGIS Enterprise portals do not support using network location fields. For network analysis layers that use one of these portals as the network data source, all inputs will be located at solve time, and any mapped location fields will be ignored. | Network Analyst Class FieldMap |
Search Tolerance (Optional) | The maximum search distance that will be used when locating the input features on the network. Features that are outside the search tolerance will be left unlocated. The parameter includes a value and units. The default value for this parameter is determined based on location properties stored in the input network analysis layer. If the network analysis layer has location settings overrides for the selected sublayer, those settings will be used. Otherwise, the network analysis layer's default location settings will be used. Setting a nondefault value for this parameter updates the network analysis layer's location settings overrides for the selected sublayer. The parameter is not used when adding locations to sublayers with line or polygon geometry, such as Line Barriers and Polygon Barriers. This parameter is not used when adding locations using existing network location fields. Legacy:This parameter is not used when the network analysis layer's network data source is a portal running a version of ArcGIS Enterprise older than 11.0. | Linear Unit |
Sort Field (Optional) | The field on which the network analysis objects will be sorted as they are added to the network analysis layer. The default is the ObjectID field in the input feature class or table. | Field |
Search Criteria (Optional) | The edge and junction sources in the network dataset that will be searched when locating inputs on the network. For example, if the network dataset references separate feature classes representing streets and sidewalks, you can locate inputs on streets but not on sidewalks. The following are the available snap type choices for each network source:
The default value for this parameter is determined based on location properties stored in the input network analysis layer. If the network analysis layer has location settings overrides for the selected sublayer, those settings will be used. Otherwise, the network analysis layer's default location settings will be used. Setting a nondefault value for this parameter updates the network analysis layer's location settings overrides for the selected sublayer. This parameter is not used when adding locations using existing network location fields. This parameter is not used when the network analysis layer's network data source is ArcGIS Online. Legacy:This parameter is not used when the network analysis layer's network data source is a portal running a version of ArcGIS Enterprise older than 11.0. | Value Table |
Find Closest among All Classes (Optional) | Legacy:This parameter is deprecated and maintained only for backward compatibility. Inputs will always be matched to the closest network source among all the sources used for locating, corresponding to a parameter value of MATCH_TO_CLOSEST or True. | Boolean |
Append to Existing Locations (Optional) | Specifies whether new network analysis objects will be appended to existing objects.
| Boolean |
Snap to Network (Optional) | Specifies whether the inputs will be snapped to their calculated network locations or represented at their original geographic location. To use curb approach in the analysis to control which side of the road a vehicle must use to approach a location, do not snap the inputs to their network locations, or use a snap offset to ensure that the point remains clearly to one side of the road. The parameter is not used when adding locations to sublayers with line or polygon geometry, such as Line Barriers and Polygon Barriers. This parameter is not used when the input network analysis layer's network data source is a portal service.
| Boolean |
Snap Offset (Optional) | An offset distance that will be applied when snapping a point to the network. An offset distance of zero means the point will be coincident with the network feature (typically a line). To offset the point from the network feature, enter an offset distance. The offset is in relation to the original point location; that is, if the original point was on the left side, its new location will be offset to the left. If it was originally on the right side, its new location will be offset to the right. The default is 5 meters. However, this parameter is ignored if Snap to Network is unchecked. The parameter is not used when adding locations to sublayers with line or polygon geometry, such as Line Barriers and Polygon Barriers. This parameter is not used when the input network analysis layer's network data source is a portal service. | Linear Unit |
Exclude Restricted Portions of the Network (Optional) | Legacy:This parameter is deprecated and maintained only for backward compatibility. Analysis inputs will never be located on network elements that are restricted, corresponding to a parameter value of EXCLUDE or True. | Boolean |
Search Query
(Optional) | A query that restricts the search to a subset of the features within a source feature class. This is useful if you don't want to find features that may be unsuited for a network location. For example, if you don't want to locate on highway ramps, you can define a query to exclude them. A separate SQL expression can be specified per edge or junction source feature class of the network dataset. Any network source not explicitly specified in the Geoprocessing pane will have no query applied. The default value for this parameter is determined based on location properties stored in the input network analysis layer. If the network analysis layer has location settings overrides for the selected sublayer, those settings will be used. Otherwise, the network analysis layer's default location settings will be used. Setting a nondefault value for this parameter updates the network analysis layer's location settings overrides for the selected sublayer. This parameter is not used when adding locations using existing network location fields. This parameter is not used when the network analysis layer's network data source is ArcGIS Online. Legacy:This parameter is not used when the network analysis layer's network data source is a portal running a version of ArcGIS Enterprise older than 11.0. | Value Table |
Allow automatic relocating at solve time
(Optional) | Specifies whether inputs with existing network location fields can be automatically relocated at solve time to ensure valid, routable location fields for the analysis.
The default value for this parameter is determined based on location properties stored in the input network analysis layer. If the network analysis layer has location settings overrides for the selected sublayer, those settings will be used. Otherwise, the network analysis layer's default location settings will be used. Setting a nondefault value for this parameter updates the network analysis layer's location settings overrides for the selected sublayer. Even if the automatic relocating at solve time is not allowed, inputs with no location fields or incomplete location fields will be located at solve time. This parameter is not used when the network analysis layer's network data source is ArcGIS Online. This parameter is not used when the network analysis layer's network data source is an ArcGIS Enterprise portal that does not support using network location fields. Legacy:This parameter is not used when the network analysis layer's network data source is a portal running a version of ArcGIS Enterprise older than 11.0. | Boolean |
Derived Output
Label | Explanation | Data Type |
Updated Input Network Analysis Layer | The updated network analysis layer. | Network Analyst Layer |