Organization audit purge

This purge removes the YFS_AUDIT table data from the system, which reduces the load on frequently accessed tables. It purges records in the YFS_AUDIT and the YFS_AUDIT_HEADER tables that meet the following conditions:

  • The YFS_AUDIT records that have ‘modifyts' greater than the retention days specified and the records have the table name as 'YFS_ORGANIZATION'.
  • The last modified time is before the lead time (in days) setup.

When the enterprise modifies records in the YFS_ORGANIZATION table through the Applications Manager, the YFS_ORGANIZATION is audited and the audit records are inserted in the YFS_AUDIT table. In order to clean up the audit records, this purge transaction can be used.

Any enterprise using the Console must schedule purge transactions.

Attributes

The following are the attributes for this time-triggered transaction:

Table 1. Organization audit purge attributes
Attribute Value
Base Transaction ID YFS_ORGANIZATION_AUDIT_PURGE
Base Document Type General
Base Process Type General
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Organization audit purge criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, the value defaults to Get, the only valid value.
Number of Records To Buffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), this value defaults to 5000.
Live Optional. Mode in which to run. Valid values are:
  • Y - Default value. Production mode. Deletes records from the regular tables.
  • N - Test mode.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds to the PurgeCode used in Business Rules Purge Criteria.
ColonyID Required in a sharded deployment where the YFS_AUDIT and YFS_AUDIT_HEADER tables may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Organization audit purge statistics
Statistic Name Description
NumOrganizationAudit
RecordsPurged
 Number of organization audit records purged.

Pending job count

For this transaction, the pending job count is the number of records that can be purged from the YFS_AUDIT table that match the criteria values.

Events raised

None.

Tables purged

YFS_AUDIT

YFS_AUDIT_HEADER