Apply Event Behaviors (Location Referencing Tools)

Summary

Updates the event locations for all event feature classes registered with the input network based on the route edit performed.

The events are updated according to the configured event behavior.

Learn more about configuring event behavior in ArcGIS Pipeline Referencing or configuring event behavior in ArcGIS Roads and Highways.

Illustration

Apply Event Behaviors tool illustration

Usage

An LRS dataset is required to run this tool.
- Learn more about creating an LRS dataset in ArcGIS Pipeline Referencing
- Learn more about creating an LRS dataset in ArcGIS Roads and Highways
This tool will process all event behaviors for all event feature classes registered with the input network.
If the Input Route Features parameter value is a feature service, this tool will process edits that have not been processed earlier in the named version in use. Once the event behavior for a particular route edit is processed, it is marked as processed.

Note:

Selection sets or definition queries used to filter the route or event records in the map are ignored to keep events in sync with route edits.

Caution:

This tool modifies the event records in the event feature classes. See Tools that do not create output datasets for more information and strategies to avoid unwanted data changes.
When conflict prevention is enabled and route edits (including create, realign, reassign, retire, extend, calibrate, and cartographic realignment) are made in a named version, run this tool before posting that version. If the route edits are made in the default version, you must run this tool before any named version can be reconciled with the default version.
This tool supports conflict prevention and will attempt to acquire and transfer locks.

Learn more about conflict prevention in ArcGIS Pipeline Referencing or conflict prevention in ArcGIS Roads and Highways.
This tool automatically regenerates intersection features if all of the following criteria are met:
- The edit log contains a cartographic realignment record for an LRS Network.
- The cartographically realigned network has at least one LRS event that is a referent to an intersection associated with the network.
- The LRS event to be updated is configured with the Honor Referent Location event behavior rule.
  
  Learn more about event behavior for cartographic realignment in Pipeline Referencing or event behavior for cartographic realignment in Roads and Highways.

Label	Explanation	Data type
Input Route Features	The LRS Network for which event locations will be updated. This must be a feature layer registered as a network with the LRS.	Feature Layer

Derived output

Label	Explanation	Data type
Output Event Layers	The updated event layers.	Feature Layer
Output Details File	A text file that details changes made by the tool.	Text File

arcpy.locref.ApplyEventBehaviors(in_route_features)

Name	Explanation	Data type
in_route_features	The LRS Network for which event locations will be updated. This must be a feature layer registered as a network with the LRS.	Feature Layer

Derived output

Name	Explanation	Data type
out_event_layers	The updated event layers.	Feature Layer
out_details_file	A text file that details changes made by the tool.	Text File

Code sample

ApplyEventBehaviors example 1 (stand-alone script)

Demonstrates how to use the ApplyEventBehaviors function as a stand-alone Python script.

# Name: ApplyEventBehaviors_Pro_ex1.py
# Description: Processes event behaviors for events impacted by edits to the LRS Network in a stand-alone script.
# Requirements: ArcGIS Pipeline Referencing

# Import arcpy module
import arcpy

# Tool variables
in_route_features = r"C:\Data\UPDM.gdb\LRS\P_StationSeriesNetwork"

# Run the tool
arcpy.locref.ApplyEventBehaviors(in_route_features)

ApplyEventBehaviors example 2 (Python window)

Demonstrates how to use the ApplyEventBehaviors function in the Python window.

# Name: ApplyEventBehaviors_ex2.py
# Description: Process event behaviors for events impacted by edits to the LRS Network in the Python window.
# Requires: ArcGIS Location Referencing

# Set tool variables
in_route_features = "Station_Series_Network"

# Set current workspace
arcpy.env.workspace = r"C:\Data\Outputs.gdb"

# Run the tool
arcpy.locref.ApplyEventBehaviors(in_route_features)

ApplyEventBehaviors example 3 (stand-alone script)

Demonstrates how to use the ApplyEventBehaviors function as a stand-alone Python script in a feature service.

# Name: ApplyEventBehaviors_Pro_ex3.py
# Description: Processes event behaviors using a feature service. It is recommended to work in a version and post it into the default version.
# Requires: ArcGIS Location Referencing

# Import arcpy module
import arcpy

## Input LRS route network is in feature service.  Signing in portal is required to access the feature service.
arcpy.SignInToPortal('https://yourdomain.com/portal', 'username', 'password')

## Map the LRS network from the feature service. Here, 1 corresponds to the LRS network.
in_route_features = r"https://yourdomain.com/server/rest/services/FeatureServiceName/FeatureServer/1"

# Run the tool
arcpy.locref.ApplyEventBehaviors(in_route_features)

Environments

Current Workspace

Licensing information

Basic: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)
Standard: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)
Advanced: Requires ArcGIS Location Referencing (ArcGIS Pipeline Referencing or ArcGIS Roads and Highways)

Apply Event Behaviors (Location Referencing Tools)

Summary

Illustration

Usage

Note:

Caution:

Parameters

Derived output

Environments

Licensing information

Related topics