Help

Export Data Change Message

Summary

Creates an output delta file containing updates from an input replica.

Usage

  • The geodatabase may be a local geodatabase or a geodata service.

  • The output delta file can be a delta file geodatabase (.gdb), delta personal geodatabase (.mdb), or a delta XML file (.xml). When specifying the output delta file, you must include the appropriate suffix (.gdb, .mdb, or .xml).

  • This tool is used when synchronizing replica while disconnected. This is done by first running the Export Data Change Message tool which creates a delta file with changes to synchronize. The delta file is then copied to the relative replica and imported using the Import Message tool. If a delta file gets lost and you want to resend, you can use the Re-Export Unacknowledged Messages tool to regenerate the delta file. After the changes are imported, the relative replica can export an acknowledgment file using the Export Acknowledgement Message tool. The acknowledgment file is copied to the replica and imported using the Import Message tool. If an acknowledgment is not received, the next time changes are sent they will include the new changes plus the previously sent changes.

  • To synchronize replicas in a connected mode see the Synchronize Changes tool.

Syntax

ExportDataChangeMessage_management (in_geodatabase, out_data_changes_file, in_replica, switch_to_receiver, include_unacknowledged_changes, include_new_changes)
ParameterExplanationData Type
in_geodatabase

Specifies the replica geodatabase from which to export the data change message. The geodatabase may be local or remote.

Workspace ;GeoDataServer
out_data_changes_file

Specifies the delta file to export to.

File
in_replica

The replica containing updates to be exported.

String
switch_to_receiver

Indicates whether to change the role of the replica to that of a receiver. The receiver may not send replica updates until updates from the relative replica sender arrive.

  • DO_NOT_SWITCH —Do not switch replica role. This is the default.
  • SWITCH —Switch replica role from sender to receiver.
Boolean
include_unacknowledged_changes

Indicates whether to include data changes that have been previously exported for which no acknowledgment message has been received.

  • NO_UNACKNOWLEDGED —Do not include data changes that have been previously sent.
  • UNACKNOWLEDGED —Include all of the data changes that have been previously exported for which no acknowledgment message has been sent. This is the default.
Boolean
include_new_changes

Indicates whether to include all data changes created since the last exported data change message.

  • NO_NEW_CHANGES —Do not include data changes created since the last exported data change message.
  • NEW_CHANGES —Include data changes created since the last exported data change message. This is the default.
Boolean

Code sample

ExportDataChangeMessage example 1 (Python window)

The following Python window script demonstrates how to use the ExportDataChangeMessage function in the Python window. 

import arcpy
from arcpy import env
env.workspace = "C:/Data"
arcpy.ExportDataChangeMessage_management("MySDEdata.sde", "Changes.gdb", "MyReplica1", "SWITCH", "TRUE", "TRUE")
ExportDataChangeMessage example 2 (stand-alone Python script)

The following Python script demonstrates how to use the ExportDataChangeMessage function in a stand-alone script. 

# Name: ExportDataChangesMessage_Example2.py
# Description: Exports a data change message to a delta file geodatabase (.gdb)


# Import system modules
import arcpy
from arcpy import env

# Set workspace
env.workspace = "C:/Data"

# Set local variables
in_geodatabase = "MySDEdata.sde"
out_dataChanges = "Changes.gdb"
replica_name = "MyReplica1"
switch_directions = "SWITCH"
acknowledge = "TRUE"
new_changes = "TRUE"

# Execute ExportDataChangeMessage
arcpy.ExportDataChangeMessage_management(in_geodatabase, out_dataChanges, replica_name, switch_directions, acknowledge, new_changes)

Environments

Licensing information

  • ArcGIS for Desktop Basic: No
  • ArcGIS for Desktop Standard: Yes
  • ArcGIS for Desktop Advanced: Yes

Related topics