Export AIXM 5.1 Message (Aviation)

Available with Aviation Charting license.

Summary

Exports aeronautical data to an AIXM 5.1 message.

An AIXM message is a standard data exchange format for aeronautical data. AIXM is a well-established information exchange format in the aviation domain. Using aeronautical data in this format is an important step in the creation of an ArcGIS Aviation Charting product. This tool allows you to export data from an Aeronautical Information System (AIS) schema geodatabase as an AIXM message.

Usage

  • The Input Aviation Workspace parameter value must be a valid AIS schema geodatabase.

  • This tool exports data to an AIXM 5.1 message that is saved as an .xml file.

  • If you validate the output AIXM 5.1 message, you can store all validation messages in the Output Validation Log parameter value. This may be a benefit if you have a large amount of messages to store.

  • If you do not select a value for the Input Filter Layers parameter, the tool will run on all of the layers in the geodatabase. Once you apply a filter on one layer, you must apply a filter on all of the layers you want to export.

  • The export will honor definition queries set on the Input Filter Layers parameter value.

  • The following AIS entities can be used for the input feature layers: ADHP, ADHPCollocation, Airspace, ADHPSurfaceArea, ADHPSurfaceElement, ADHPSurfacePoint, ADHPSurfaceLine, ADHPThreshold, AirspaceAuth, ATSRoute, DesignatedPoint, EnrouteInformation, Frequency, GeoBorder, Marking, NavaidComponent, NavaidSystem, ObstacleArea, ObstacleStructure, OrgAuth, Service, SurfaceLightSys, and Unit.

  • Related AIS features will be included in the export pursuant to mappings in the export configuration files. Export configuration files are 51ExportRelationships.json and 51ExportTemplate.xml and are under C:\Program Files\ArcGIS\Pro\Resources\Aviation.

Parameters

LabelExplanationData Type
Input Aviation Workspace

The AIS schema workspace.

Workspace
Output Message File

The exported AIXM 5.1 message as an .xml file.

File
Export Type

Specifies the AIXM temporality type the message represents.

  • Baseline The message contains all features in a given message.
  • SnapshotThe message contains all features at a specific point in time.
  • Permanent DeltaThe message contains updates in a given time slice in features as a result of a baseline update.
  • Temporary DeltaThe message contains changes for some features in a given time slice representing a temporary event.
String
Last Modified Time
(Optional)

The date that will be used to filter the output to only features modified after that date.

Date
Input Filter Layers
(Optional)

The layers that will filter output to a smaller spatial subset. The input layers should be AIXM 5.1 feature types. This value should be in the same AIS geodatabase as the Input Aviation Workspace parameter value.

Feature Layer; Table
From Time
(Optional)

The starting time that will be applied to the validTime\beginPosition and featureLifetime\beginPosition fields in the output message types for any missing ValidFrom_Date or FeatureFrom_Date field values in the features to export. The value will be converted to UTC. If a value is not specified, the current system date and time in UTC will be applied to the missing field values in the output message.

This parameter will be used differently depending on the Export Type parameter value.

  • Baseline—The parameter will be honored only when the actual database record does not have the FromFeature_Date or ValidFrom_Date attributes populated.
  • Snapshot—The parameter value provided will be exported regardless of the FromFeature_Date and ValidFrom_Date attributes in the database.
  • Permanent Delta—The parameter will be honored only when the actual database record does not have the FromFeature_Date or ValidFrom_Date attributes populated.
  • Temporary Delta—The parameter will be honored only when the actual database record does not have the FromFeature_Date or the ValidFrom_Date attributes populated.
Date
To Time
(Optional)

The ending time that will be applied to the validTime\endPosition and featureLifetime\endPosition fields in the output message types for any missing ValidTo_Date or FeatureTo_Date field values in the features to export. The value will be converted to UTC. If a value is not specified, the current system date and time in UTC will be applied to the missing field values in the output message.

This parameter is only valid when the Export Type parameter is set to Temporary Delta.

Date
Validate Output
(Optional)

Specifies whether the exported message will be validated for the XML format.

  • Checked—The exported message will be validated for the XML format.
  • Unchecked—The exported message will not be validated for the XML format. This is the default.
Boolean
Output Validation Log
(Optional)

The output XML validation log file.

File

arcpy.aviation.ExportAIXM51Message(in_aviation_workspace, out_message_file, export_type, {last_modified_time}, {in_filter_layers}, {from_time}, {to_time}, {validate_output}, {out_validation_log})
NameExplanationData Type
in_aviation_workspace

The AIS schema workspace.

Workspace
out_message_file

The exported AIXM 5.1 message as an .xml file.

File
export_type

Specifies the AIXM temporality type the message represents.

  • BASELINE The message contains all features in a given message.
  • SNAPSHOTThe message contains all features at a specific point in time.
  • PERM_DELTAThe message contains updates in a given time slice in features as a result of a baseline update.
  • TEMP_DELTAThe message contains changes for some features in a given time slice representing a temporary event.
String
last_modified_time
(Optional)

The date that will be used to filter the output to only features modified after that date.

Date
in_filter_layers
[in_filter_layers,...]
(Optional)

The layers that will filter output to a smaller spatial subset. The input layers should be AIXM 5.1 feature types. This value should be in the same AIS geodatabase as the in_filter_layers parameter value.

Feature Layer; Table
from_time
(Optional)

The starting time that will be applied to the validTime\beginPosition and featureLifetime\beginPosition fields in the output message types for any missing ValidFrom_Date or FeatureFrom_Date field values in the features to export. The value will be converted to UTC. If a value is not specified, the current system date and time in UTC will be applied to the missing field values in the output message.

This parameter will be used differently depending on the export_type parameter value.

  • BASELINE—The parameter will be honored only when the actual database record does not have the FromFeature_Date or ValidFrom_Date attributes populated.
  • SNAPSHOT—The parameter value provided will be exported regardless of the FromFeature_Date and ValidFrom_Date attributes in the database.
  • PERM_DELTA—The parameter will be honored only when the actual database record does not have the FromFeature_Date or ValidFrom_Date attributes populated.
  • TEMP_DELTA—The parameter will be honored only when the actual database record does not have the FromFeature_Date or the ValidFrom_Date attributes populated.
Date
to_time
(Optional)

The ending time that will be applied to the validTime\endPosition and featureLifetime\endPosition fields in the output Baseline or Permanent Delta message types for any missing ValidTo_Date or FeatureTo_Date field values in the features to export. The value will be converted to UTC. If a value is not specified, the current system date and time in UTC will be applied to the missing field values in the output message.

This parameter is only valid when the export_type parameter is set to TEMP_DELTA.

Date
validate_output
(Optional)

Specifies whether the exported message will be validated for the XML format.

  • VALIDATE The exported message will be validated for the XML format.
  • NO_VALIDATE The exported message will not be validated for the XML format. This is the default.
Boolean
out_validation_log
(Optional)

The output XML validation log file.

File

Code sample

ExportAIXM51Message example (stand-alone script)

The following code sample demonstrates how to use the ExportAIXM51Message function.

# Name: ExportAIXM51Message_example
# Description: Exports aeronautical data to an AIXM 5.1 message.

import arcpy

# Check out Aviation license

arcpy.CheckOutExtension("Aeronautical")

# Set variables

in_aviation_workspace = "D:\\data\\AIS.gdb"
out_message_file = "C:\\Users\\user1\\Documents\\My AIXM Message.xml"
export_type = "TEMP_DELTA"
last_modified_time = "1/1/2001 12:01:00 AM"
in_filter_layers = None
from_time = "1/1/2000 12:01:00 AM"
to_time = "1/1/2002 12:01:00 AM"
validate_output = "VALIDATE"
out_validation_log = "C:\\Users\\user1\\Documents\\Output Validation Log.txt"

# Execute ExportAIXM51Message

arcpy.aviation.ExportAIXM51Message(in_aviation_workspace, out_message_file, export_type, last_modified_time, in_filter_layers,
                                    from_time, to_time, validate_output, out_validation_log)

# Check in Aviation license

arcpy.CheckInExtension("Aeronautical")

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: No
  • Standard: Requires ArcGIS Aviation Charting
  • Advanced: Requires ArcGIS Aviation Charting

Related topics