Update by Alternate ID Fields (Network Analyst)

Summary

Updates all the edge references in turn feature classes using an alternate ID field. This tool should be used after making edits to the input line features that are referenced by the turn features to synchronize the turn features based on the alternate ID fields.

Usage

  • This tool updates the Edge#FID field values on the turn feature class based on the alternate IDs stored on each turn feature. If the turn feature classes do not reference the edges based on alternate IDs, use the Populate Alternate ID Fields tool first to create and populate alternate ID fields.

Parameters

LabelExplanationData Type
Input Network Dataset

The network dataset whose turn feature classes are being updated by their alternate ID fields.

Network Dataset Layer
Alternate ID Field Name

The name of the alternate ID field on the edge feature sources of the network dataset. All edge feature sources referenced by turns must have the same name for the alternate ID field.

String

Derived Output

LabelExplanationData Type
Updated Input Network Dataset

The updated network dataset.

Network Dataset Layer

arcpy.na.UpdateByAlternateIDFields(in_network_dataset, alternate_ID_field_name)
NameExplanationData Type
in_network_dataset

The network dataset whose turn feature classes are being updated by their alternate ID fields.

Network Dataset Layer
alternate_ID_field_name

The name of the alternate ID field on the edge feature sources of the network dataset. All edge feature sources referenced by turns must have the same name for the alternate ID field.

String

Derived Output

NameExplanationData Type
out_network_dataset

The updated network dataset.

Network Dataset Layer

Code sample

UpdateByAlternateIDFields example 1 (Python window)

Run the tool using all parameters.

network = "C:/Data/SanFrancisco.gdb/Transportation/Streets_ND"
arcpy.na.UpdateByAlternateIDFields(network, "ID")
UpdateByAlternateIDFields example 2 (stand-alone script)

The following Python script demonstrates how to use the UpdateByAlternateIDFields tool in a stand-alone script.

# Name: UpdateByAlternateIDFields_ex02.py
# Description: Update the edge references in the turn feature classes using
#              alternate IDs and build the network dataset.
# Requirements: Network Analyst Extension

#Import system modules
import arcpy
from arcpy import env

#Set environment settings
env.workspace = "C:/data/SanFrancisco.gdb"

#Set local variables
inNetworkDataset = "Transportation/Streets_ND"
altIDFieldName = "ID"

#Update the edge references in the turn features using alternate ID fields
arcpy.UpdateByAlternateIDFields_na(inNetworkDataset, altIDFieldName)

#Since we have modified the edge references for turn sources, we should rebuild
#the network dataset so that the turn features are correctly interpreted by the
#network dataset
arcpy.BuildNetwork_na(inNetworkDataset)

print("Script completed successfully.")

Environments

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

Related topics