Planned Task Purge

This time-triggered transaction purges all the planned tasks whose value of COMPLETED flag is set to Y, and those that are existing for a period greater than the retention days specified in the Planned Task Purge criteria.

A planned task is picked up for purge if it meets the following conditions:

Attributes

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

Table 1. Planned Task Purge Attributes
Attribute Value
Base Transaction ID PLANNEDTASKPRG
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. Planned Task 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.
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.

Node Optional. Ship Node to which the planned task belongs.
ColonyID Required in a multischema deployment where the YFS_PLANNED_TASK table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Planned Task Purge Statistics
Statistic Name Description
NumPlannedTasksPurged Number of planned tasks purged.

Pending Job Count

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

Events Raised

None.

Tables Purged

YFS_PLANNED_TASK