Export table purge

This purge removes export table data from the system. This reduces the load on frequently accessed tables.

You can use purge codes pseudo-logic to analyze purges. If the following conditions are met, the YFS_EXPORT table is picked up for purge:

  • YFS_EXPORT records should be marked as processed (Status = 10).
  • The last modified time should fall before the lead time (in days) setup.

    This purge reads only the rules defined by the hub. Enterprise overridden rules are not considered. This purge should be single threaded when you run it in batch delete mode(BatchDelete=Y).

Any enterprise using the Application Console must schedule purge transactions.

Attributes

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

Table 1. Export table purge attributes
Attribute Value
Base Transaction ID EXPORTTBLPRG
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. Export table purge criteria parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it 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), it defaults to 5000.
Live Optional. Mode in which to run. Valid values are:
  • Y - Default value. Moves qualifying records from the regular tables listed under Tables Purged to the corresponding history tables.
  • N - Test mode. Determines the rows that are moved to history tables without actually moving them.
BatchDelete Required. The method by which all records are deleted from the table. Valid values are:
  • Y - Records are deleted in batches.
  • N - Default value. Records are deleted one by one.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
CollectPendingJobs 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.
ColonyID Required in a sharded deployment where the YFS_EXPORT table may exist in multiple schemas. Runs the agent for the colony.
IgnoreStatus If this parameter is set to "Y", all records before the set lead time are purged and the status value is ignored. The default value is "N".
   

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Export table purge statistics
Statistic Name Description
NumExportsPurged Number of exports purged.

Pending job count

For this transaction the pending job count is the number of records that can be purged from the YFS_Export table.

Events raised

None.

Tables purged

YFS_EXPORT