Wave Purge

This purge deletes data after a wave has completed its typical lifecycle. This reduces load from the frequently accessed tables. This transaction works on a task queue. It picks up the waves from YFS_TASK_Q table that are available for this transaction. Waves are then purged if they have not been modified within the time specified in the purge criteria configuration.

You can use the pseudo-logic of purge codes to benefit in analyzing purges. The system picks up waves from the YFS_TASK_Q table for the purge transaction. A wave is picked up for purge if it meets the following condition:

Attributes

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

Table 1. Wave Purge Attributes
Attribute Value
Base Transaction ID YFS_Wave
Base Document Type Outbound Picking
Base Process Type OUTBOUND_PICKING
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Wave Purge Criteria Parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
Live Optional. Mode in which to run. Defaults to N.
  • Y - Production mode. Deletes records from regular tables.
  • N - Test mode.
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.
Node Optional. Node for which the Wave Purge needs to be run. If not passed, then all nodes are monitored.
AgentCriteriaGroup Optional. Used to classify nodes. This value can be accepted by WMS time-triggered transactions that only perform their tasks on the nodes with a matching node transactional velocity value.

Valid values are: LOW, HIGH, and any additional values defined by the Hub from Sterling Application Platform > System Administration > Agent Criteria Groups.

ColonyID Required in a multischema deployment where the YFS_WAVE table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Wave Purge Statistics
Statistic Name Description
NumWavesPurged Number of waves purged.

Pending Job Count

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

Events Raised

None.

Tables Purged

YFS_WAVE