Entity change purge agent

The EntityChangePurge agent removes the records from the YFS_ENTITY_CHANGE table that correspond to published changes. The agent removes the records that are older than the number of days that are defined in the purge criteria.

Attributes

Table 1. Entity change purge agent attributes

Attribute	Value
Base Transaction ID	PURGE
Base Process Type	Data Synchronization

Criteria parameters

Table 2. Entity change purge agent 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 zero (0).
PurgeCode	Required. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria. You can set this parameter to the following value: ENTITY_CHANGE_PRG
CollectPendingJobs	Optional. If set to Y, collects information for presentation in the system management console.
ColonyID	Required in a multi-schema deployment where a table might exist in multiple schemas. Runs the agent for the colony.
Lead Days	Number of days before the present date the agent will purge the records. The default value is 30.

Events raised

None

Statistics tracked

None

Pending job count

None

Tables purged

YFS_ENTITY_CHANGE