Skip To Content

Append Events

Summary

Appends event records from a table, layer, or feature class into an existing ArcGIS Pipeline Referencing event feature class.

Note:

When the target layer is a feature service layer, the validation results for this tool are written to a file in the ArcGIS Server directory. By default, this file will be automatically cleaned up after 10 minutes, which may not be enough time to process all of the validations and then write them to your workstation that is running ArcGIS Pro. For larger data loads, it is recommended to adjust the maximum file age to at least one hour. To adjust this setting, see Edit a server directory in Manager.

Usage

  • The Input Event can be a table, layer, or feature class.

  • The Target Event should be a layer or feature class registered with Location Referencing.

  • This tool supports both point and polyline features. The feature type in the input and target event parameters should match.

  • For more information about the fields required in Pipeline Referencing event feature classes, see the events data model.

  • If the Generate EventID GUIDs for loaded events option is checked and you want GUIDs generated, you should either not map the EventID field in the field mapping section or have Null records in the EventID column in the source event data. If the EventID field in a source event record is populated and the Generate EventID GUIDs for loaded events option is checked, the value in the source event record EventID field will be loaded into the target event.

Syntax

AppendEvents_locref (in_dataset, in_target_event, field_mapping, {load_type}, {generate_event_ids})
ParameterExplanationData Type
in_dataset

The source event records to append.

Table View
in_target_event

The Pipeline Referencing event layer or feature class into which the source event records append.

Feature Layer
field_mapping

Controls how the attribute information in the fields of the in_dataset is transferred to the in_target_event.

Because the data of the in_dataset is appended into an existing event that has a predefined schema (field definitions), fields cannot be added or removed from the target dataset. While you can set merge rules for each output field, the tool ignores those rules.

The ArcPy FieldMappings class can be used to define this parameter.

Field Mappings
load_type
(Optional)

Determines how appended events with measure or temporality overlaps with identical Event IDs as Target Event records are loaded into the event feature class.

  • ADDAppends the Input Event records to the Target Event. No changes are made to Target Event records.
  • RETIRE_OVERLAPSAppends the Input Event records to the Target Event and retires any records in the Target Event with measure or temporality overlaps as the appended events. If the appended event eclipses the Target Event, the Target Event will be deleted. This option should only be used for linear events.
  • RETIRE_BY_EVENT_IDAppends the Input Event records to the Target Event and retires any records in the Target Event with the same Event ID and temporality overlaps as the appended events. If the appended event eclipses a Target Event with the same Event ID, the Target Event will be deleted.
  • REPLACE_BY_EVENT_IDAppends the Input Event records to the Target Event and deletes any records in the Target Event with the same Event ID as the appended events.
String
generate_event_ids
(Optional)

Indicates whether to generate Event IDs for in_dataset records being appended. Generation of Events IDs will only be applied to in_dataset records with a Null value for the Event ID field.

  • GENERATE_EVENT_IDSGenerates Event IDs of thein_dataset records being appended.
  • NO_GENERATE_EVENT_IDSDoes not generate Event IDs of the in_dataset records being appended. This is the default.
Boolean

Derived Output

NameExplanationData Type
out_target_event

The event layer or feature class into which the source event records have been appended.

Feature Layer
out_details_file

Text file that details changes made by the tool.

Text File

Code sample

AppendEvents example 1 (Python window)

Demonstrates how to use the AppendEvents tool in the Python window.

# Name: AppendEvents_InlinePython_Example.py
# Description: Append event records into an existing Pipeline Referencing event feature class.
# Requires: ArcGIS Pipeline Referencing


# set current workspace
arcpy.env.workspace= r"C:\Pipeline.gdb"

# Setting tool variables
# Source Event Table in fgdb
in_dataset = "PTMS_Add"

# Target Event Feature Class in fgdb
in_target_event = "LRSE_PTMS"

#Mapping fields b/w target and source
field_mapping = r'AADT "AADT" true true false 4 Long 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,AADT,-1,-1;YEAR_ "YEAR_" true true false 2 Short 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,YEAR_,-1,-1;Cosite "Cosite" true true false 6 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,Cosite,0,6;Classd "Classd" true true false 3 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,Classd,0,3;SECTION_ "SECTION_" true true false 8 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,SECTION_,0,8;COMM "COMM" true true false 254 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,COMM,0,254;Active "Active" true true false 1 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,Active,0,1;Sitetype "Sitetype" true true false 11 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,Sitetype,0,11;KFCTR "KFCTR" true true false 8 Double 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,KFCTR,-1,-1;DFCTR "DFCTR" true true false 8 Double 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,DFCTR,-1,-1;TFCTR "TFCTR" true true false 8 Double 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,TFCTR,-1,-1;LOCATION "LOCATION" true true false 8 Double 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,LOCATION,-1,-1;FromDate "FromDate" true true false 8 Date 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,FromDate,-1,-1;ToDate "ToDate" true true false 8 Date 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,ToDate,-1,-1;EventID "EventID" true true false 50 Text 0 0,First,#,C:\Pipeline.gdb\PTMS_Add,EventID,0,50'

load_type = "Add"

generate_event_ids = "NO_GENERATE_EVENT_IDS"

generate_shapes = "GENERATE_SHAPES"

# execute the tool
arcpy.locref.AppendEvents(in_dataset, in_target_event, field_mapping, load_type, generate_event_ids, generate_shapes)
AppendEvents example 2 (stand-alone script)

Demonstrates how to use the AppendEvents tool as a stand-alone Python script.

# Name: AppendEvents_StandAlonePython_Example.py
# Description: Append event records into an existing Pipeline Referencing event feature class.
# Requires: ArcGIS Pipeline Referencing

# Import arcpy module
import arcpy

# Check out any necessary licenses
arcpy.CheckOutExtension("LocationReferencing")

# Setting tool variables
# Source Event Table in fgdb
in_dataset = r"C:\Pipeline.gdb\PTMS_Add"

# Target Event Feature Class in fgdb
in_target_event = r"C:\Pipeline.gdb\LRSE_PTMS"

#Mapping fields b/w target and source
field_mapping = "AADT \"AADT\" true true false 4 Long 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,AADT,-1,-1;YEAR_ \"YEAR_\" true true false 2 Short 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,YEAR_,-1,-1;Cosite \"Cosite\" true true false 6 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,Cosite,0,6;Classd \"Classd\" true true false 3 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,Classd,0,3;SECTION_ \"SECTION_\" true true false 8 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,SECTION_,0,8;COMM \"COMM\" true true false 254 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,COMM,0,254;Active \"Active\" true true false 1 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,Active,0,1;Sitetype \"Sitetype\" true true false 11 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,Sitetype,0,11;KFCTR \"KFCTR\" true true false 8 Double 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,KFCTR,-1,-1;DFCTR \"DFCTR\" true true false 8 Double 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,DFCTR,-1,-1;TFCTR \"TFCTR\" true true false 8 Double 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,TFCTR,-1,-1;LOCATION \"LOCATION\" true true false 8 Double 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,LOCATION,-1,-1;FromDate \"FromDate\" true true false 8 Date 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,FromDate,-1,-1;ToDate \"ToDate\" true true false 8 Date 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,ToDate,-1,-1;EventID \"EventID\" true true false 50 Text 0 0,First,#,C:\\Pipeline.gdb\\PTMS_Add,EventID,0,50"

load_type = "REPLACE_BY_EVENT_ID"

generate_event_ids = "NO_GENERATE_EVENT_IDS"

generate_shapes = "GENERATE_SHAPES"

# execute the tool
arcpy.locref.AppendEvents(in_dataset, in_target_event, field_mapping, load_type, generate_event_ids, generate_shapes)

Environments

Licensing information

  • Basic: Requires ArcGIS Pipeline Referencing
  • Standard: Requires ArcGIS Pipeline Referencing
  • Advanced: Requires ArcGIS Pipeline Referencing

Related topics