Change data export agent
The Change Data Export Agent is used to export the database changes into XML files, which are then zipped and placed in the ChangeProjectID_OrganizationCode/Version/ColonyID/TableGroup directory from which they can be sent to the target environment for processing by the Change Data Import agent. The Change Data Export agent runs for a specific enterprise, however, if an enterprise code is not provided, the agent runs on all the enterprises of the colony.
Attributes
| Attribute | Value |
|---|---|
| Base Transaction ID | CHANGE_DATA_EXPORT |
| Base Process Type | General |
Criteria Parameters
| Parameter Name | Description |
|---|---|
| Action | Required. This parameter triggers the transaction. The default value is "Get". |
| Number of Records To Buffer | The number of records to retrieve and process by the agent is set in this attribute. The default value is "5000". |
| Enterprise Code | The enterprise for which the agent is run. If it is not specified, the agent is run on all the enterprises of the colony. |
| Change Project ID | The change project for which the agent is run. If it is not specified, the agent is run for all the change projects of the colony that are in "Approved" status. |
| Service To Invoke | The Service that is invoked by the agent. The default value is
"ChangeDataPublisher", which writes changes to an XML file. Note: Use only the ChangeDataPublisher
service provided out-of-the-box by Sterling™ Order Management System. Do not modify this
service.
|
| Export Directory | The folder path where the XML files are written and zipped. |
| Collect Pending Jobs | If this parameter is set to N, the agent does not collect information on the pending jobs for this monitor. This pending job information is used for monitoring the monitor in the System Management Console. |
| Number of Messages | Required. Number of messages to use when exporting the XML files. Sterling Order Management System processes only one message per thread. For example, if Number of Messages is set to 10 and Threads is set to 3, Sterling Order Management System processes only 3 messages at a time. For more information about fine-tuning system performance, see the Considerations for Performance Management topic |
| Synchronization Type | The type of data export (FULL or DELTA) that you want to perform. "FULL" is a full export of the data. "DELTA" is a partial extract and exports any changes since the last Delta export. You can specify "None" or leave this field blank if you want to use the original Change Project Management style of synchronization. |
| Zip Retry Interval | The time interval for which the agent should wait before zipping the XML files of a default project if all the files could not be exported. Set the value to "0" if files need not be zipped or if asynchronous service is used. |
| Max number of files in zip | The maximum number of files allowed in the zip file is set in this attribute. The default value is "1000". |
| Locking Entities Per File | Number of unique combination of entity keys that are used for locking an entity. |
| Colony Id | The identification number of the colony. Required in a multi schema deployment where a table may exist in multiple schemas. Runs the agent for the colony. |
Events Raised
| Transaction/Event | Key Data | Data Published | Template Support |
|---|---|---|---|
| PUBLISHED | None | YSC_CHANGE_DATA_EXPORT.PUBLISHED.xml* | No |
Statistics Tracked
None
Pending Job Count
None