Configure External Event Behaviors With LRS (Location Referencing)

Available with Location Referencing license.

Summary

Configures an external event in an LRS without connecting to an external event system.

Usage

• The geodatabase where the external event is created and in which the LRS resides must be an enterprise geodatabase.

• This tool can also be used to modify the name, geometry type, and event behaviors of the existing configured external events.

• The following event behavior rules are set by default:

  Activity	Rule
  Calibrate Route	Stay Put
  Retire Route	Stay Put
  Extend Route	Stay Put
  Reassign Route	Stay Put
  Realign Route	Stay Put
  Reverse Route	Stay Put
  Carto Realign Route	Honor Route Measure

• To update external events, provide required route and event information in the web service.

  Learn more about updating external events

Parameters

Dialog

Label	Explanation	Data Type
LRS Event Name	The name of the external event or table that will be registered to the LRS.	String
Parent LRS Network	The LRS Network to which the event will be registered.	Feature Layer
Geometry Type (Optional)	Specifies the geometry type that will be used for the external event or table. Point—The geometry type of the external event or table will be point. This is the default. Line—The geometry type of the external event or table will be polyline.	String
Calibrate Rule (Optional)	Specifies the event behavior rule that will be used for the calibrate activity. Stay put— The geographic location of the event will be preserved, and measures may change. This is the default. Retire—Both measure and geographic location will be preserved, and the event will be retired. Move—The measures of the event will be preserved, and the geographic location may change.	String
Retire Rule (Optional)	Specifies the event behavior rule that will be used for the retire activity. Stay put— The geographic location of the event will be preserved, and measures may change. This is the default. Retire— Both measure and geographic location will be preserved, and the event will be retired. Move— The measures of the event will be preserved, and the geographic location may change. Snap—The geographic location of the event will be preserved by snapping the event to a concurrent route, and measures may change.	String
Extend Rule (Optional)	Specifies the event behavior rule that will be used for the extend activity. Stay put— The geographic location of the event will be preserved, and measures may change. This is the default. Retire— Both measure and geographic location will be preserved, and the event will be retired. Move— The measures of the event will be preserved, and the geographic location may change. Cover—The geometric location and measure of a line event will be modified to include a new or newly modified section.	String
Reassign Rule (Optional)	Specifies the event behavior rule that will be used for the reassign activity. Stay put— The geographic location of the event will be preserved, and measures may change. This is the default. Retire— Both measure and geographic location will be preserved, and the event will be retired. Move— The measures of the event will be preserved, and the geographic location may change. Snap— The geographic location of the event will be preserved by snapping the event to a concurrent route, and measures may change.	String
Realign Rule (Optional)	Specifies the event behavior rule that will be used for the realign activity. Stay put— The geographic location of the event will be preserved, and measures may change. This is the default. Retire— Both measure and geographic location will be preserved, and the event will be retired. Move— The measures of the event will be preserved, and the geographic location may change. Snap—The geographic location of the event will be preserved by snapping the event to a concurrent route, and measures may change. Cover—The geometric location and measure of a line event will be modified to include a new or newly modified section.	String
Reverse Rule (Optional)	Specifies the event behavior rule that will be used for the reverse activity. Stay put— The geographic location of the event will be preserved, and measures may change. This is the default. Retire— Both measure and geographic location will be preserved, and the event will be retired. Move— The measures of the event will be preserved, and the geographic location may change.	String
Carto Realign Rule (Optional)	Specifies the event behavior rule that will be used for the cartographic realign activity. Honor Route Measure—The measure of the event will be preserved or changed proportionally to the route's measure change. This is the default.	String

Derived Output

Label	Explanation	Data Type
Updated LRS Workspace	The updated LRS workspace.	Workspace

Python

arcpy.locref.ConfigureExternalEventBehaviorsWithLRS(event_name, parent_network, {geometry_type}, {calibrate_rule}, {retire_rule}, {extend_rule}, {reassign_rule}, {realign_rule}, {reverse_rule}, {carto_realign_rule})

Name	Explanation	Data Type
event_name	The name of the external event or table that will be registered to the LRS.	String
parent_network	The LRS Network to which the event will be registered.	Feature Layer
geometry_type (Optional)	Specifies the geometry type that will be used for the external event or table. POINT—The geometry type of the external event or table will be point. This is the default. LINE—The geometry type of the external event or table will be polyline.	String
calibrate_rule (Optional)	Specifies the event behavior rule that will be used for the calibrate activity. STAY_PUT— The geographic location of the event will be preserved, and measures may change. This is the default. RETIRE—Both measure and geographic location will be preserved, and the event will be retired. MOVE—The measures of the event will be preserved, and the geographic location may change.	String
retire_rule (Optional)	Specifies the event behavior rule that will be used for the retire activity. STAY_PUT— The geographic location of the event will be preserved, and measures may change. This is the default. RETIRE— Both measure and geographic location will be preserved, and the event will be retired. MOVE— The measures of the event will be preserved, and the geographic location may change. SNAP—The geographic location of the event will be preserved by snapping the event to a concurrent route, and measures may change.	String
extend_rule (Optional)	Specifies the event behavior rule that will be used for the extend activity. STAY_PUT— The geographic location of the event will be preserved, and measures may change. This is the default. RETIRE— Both measure and geographic location will be preserved, and the event will be retired. MOVE— The measures of the event will be preserved, and the geographic location may change. COVER—The geometric location and measure of a line event will be modified to include a new or newly modified section.	String
reassign_rule (Optional)	Specifies the event behavior rule that will be used for the reassign activity. STAY_PUT— The geographic location of the event will be preserved, and measures may change. This is the default. RETIRE— Both measure and geographic location will be preserved, and the event will be retired. MOVE— The measures of the event will be preserved, and the geographic location may change. SNAP— The geographic location of the event will be preserved by snapping the event to a concurrent route, and measures may change.	String
realign_rule (Optional)	Specifies the event behavior rule that will be used for the realign activity. STAY_PUT— The geographic location of the event will be preserved, and measures may change. This is the default. RETIRE— Both measure and geographic location will be preserved, and the event will be retired. MOVE— The measures of the event will be preserved, and the geographic location may change. SNAP—The geographic location of the event will be preserved by snapping the event to a concurrent route, and measures may change. COVER—The geometric location and measure of a line event will be modified to include a new or newly modified section.	String
reverse_rule (Optional)	Specifies the event behavior rule that will be used for the reverse activity. STAY_PUT— The geographic location of the event will be preserved, and measures may change. This is the default. RETIRE— Both measure and geographic location will be preserved, and the event will be retired. MOVE— The measures of the event will be preserved, and the geographic location may change.	String
carto_realign_rule (Optional)	Specifies the event behavior rule that will be used for the cartographic realign activity. HONOR_ROUTE_MEASURE—The measure of the event will be preserved or changed proportionally to the route's measure change. This is the default.	String

Derived Output

Name	Explanation	Data Type
out_workspace	The updated LRS workspace.	Workspace

Code sample

ConfigureExternalEventBehaviorsWithLRS example 1 (Python window)

The following script demonstrates how to use the ConfigureExternalEventBehaviorsWithLRS function to configure an external point event in the Python window.

# Name: Configure_Externaleventbehaviors_LRS_ex1.py
# Description: Configure an external point event in an LRS Network in the Python window.
# Requires: ArcGIS Location Referencing

# Tool variables
event_name = "PointEvent"
parent_network = "C:\\Networkdata.sde\\Network1"
geometry_type = "POINT"
calibrate_rule = "STAY_PUT"
retire_rule = "STAY_PUT"
extend_rule = "STAY_PUT"
reassign_rule = "STAY_PUT"
realign_rule = "STAY_PUT"
reverse_rule = "STAY_PUT"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Set current workspace
arcpy.env.workspace = "C:\\Networkdata.sde"

# Execute the tool
arcpy.locref.ConfigureExternalEventBehaviorsWithLRS(event_name, parent_network, geometry_type, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)

ConfigureExternalEventBehaviorsWithLRS example 2 (Python window)

The following script demonstrates how to use the ConfigureExternalEventBehaviorsWithLRS function to configure an external line event with different event behaviors in the Python window.

# Name: Configure_Externaleventbehaviors_LRS_ex2.py
# Description: Configure an external line event in an LRS Network in the Python window.
# Requires: ArcGIS Location Referencing

# Tool variables
event_name = "LineEvent"
parent_network = "C:\\Networkdata.sde\\Network1"
geometry_type = "LINE"
calibrate_rule = "STAY_PUT"
retire_rule = "RETIRE"
extend_rule = "COVER"
reassign_rule = "SNAP"
realign_rule = "COVER"
reverse_rule = "MOVE"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Set current workspace
arcpy.env.workspace = "C:\\Networkdata.sde"

# Execute the tool
arcpy.locref.ConfigureExternalEventBehaviorsWithLRS(event_name, parent_network, geometry_type, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)

ConfigureExternalEventBehaviorsWithLRS example 3 (Python window)

The following script demonstrates how to use the ConfigureExternalEventBehaviorsWithLRS function to modify an existing external line event in the Python window.

# Name: Configure_Externaleventbehaviors_LRS_ex3.py
# Description: Modify an existing external line event in an LRS Network in the Python window. Event name and optional parameter fields are updated.
# Requires: ArcGIS Location Referencing

# Tool variables
event_name = "LineEvent"
parent_network = "C:\\Networkdata.sde\\Network1"
geometry_type = "LINE"
calibrate_rule = "RETIRE"
retire_rule = "RETIRE"
extend_rule = "RETIRE"
reassign_rule = "RETIRE"
realign_rule = "RETIRE"
reverse_rule = "STAY_PUT"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Set current workspace
arcpy.env.workspace = "C:\\Networkdata.sde"

# Execute the tool
arcpy.locref.ConfigureExternalEventBehaviorsWithLRS(event_name, parent_network, geometry_type, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)

ConfigureExternalEventBehaviorsWithLRS example 4 (stand-alone script)

The following stand-alone script demonstrates how to use the ConfigureExternalEventBehaviorsWithLRS function to configure an external line event that spans routes in an LRS Network.

# Name: Configure_Externaleventbehaviors_LRS_ex4.py
# Description: Configure an external line event in an LRS Network using a stand-alone Python script.
# Requires: ArcGIS Location Referencing

# Import arcpy module
import arcpy

# Check out license
arcpy.CheckOutExtension("LocationReferencing")

# Tool variables
event_name = "LineEvent"
parent_network = "C:\\Networkdata.sde\\Network1"
geometry_type = "LINE"
calibrate_rule = "STAY_PUT"
retire_rule = "STAY_PUT"
extend_rule = "STAY_PUT"
reassign_rule = "STAY_PUT"
realign_rule = "STAY_PUT"
reverse_rule = "STAY_PUT"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Set current workspace
arcpy.env.workspace = "C:\\Networkdata.sde"

# Execute the tool
arcpy.locref.ConfigureExternalEventBehaviorsWithLRS(event_name, parent_network, geometry_type, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)     

# Check in license
arcpy.CheckInExtension("LocationReferencing")

ConfigureExternalEventBehaviorsWithLRS example 5 (stand-alone script)

The following stand-alone script demonstrates how to use the ConfigureExternalEventBehaviorsWithLRS function to modify an existing external point event in an LRS Network.

# Name: Configure_Externaleventbehaviors_LRS_ex5.py
# Description: Modify an existing external point event of an LRS Network using a stand-alone Python script. Event name and optional parameter fields are updated.
# Requires: ArcGIS Location Referencing

# Import arcpy module
import arcpy 

# Check out license
arcpy.CheckOutExtension("LocationReferencing")

# Tool variables
event_name = "PointEvent"
parent_network = "C:\\Networkdata.sde\\Network1"
geometry_type = "POINT"
calibrate_rule = "RETIRE"
retire_rule = "RETIRE"
extend_rule = "RETIRE"
reassign_rule = "RETIRE"
realign_rule = "RETIRE"
reverse_rule = "STAY_PUT"
carto_realign_rule = "HONOR_ROUTE_MEASURE"

# Set current workspace
arcpy.env.workspace = "C:\\Networkdata.sde"

# Execute the tool
arcpy.locref.ConfigureExternalEventBehaviorsWithLRS(event_name, parent_network, geometry_type, calibrate_rule, retire_rule, extend_rule, reassign_rule, realign_rule, reverse_rule, carto_realign_rule)     

# Check in license
arcpy.CheckInExtension("LocationReferencing")

Environments

This tool does not use any geoprocessing environments.

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)