Productivity Purge

This time-triggered transaction purges productivity data for a period greater than the lead_days specified in the Productivity Purge criteria for a specific OrganizationCode.

Attributes

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

Table 1. Productivity Purge Attributes
Attribute Value
Base Transaction ID PRODUCTIVITYPRG
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. Productivity 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.
EnterpriseCode Optional. Enterprise for which the Productivity Purge needs to be run. If not passed, then all enterprises are monitored.
Organization Code Optional. Organization for which the Productivity Purge needs to be run. If not passed, then all organizations are monitored.
ColonyID Required in a multischema deployment where the YFS_PRODUCTIVITY table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Productivity Purge Statistics
Statistic Name Description
NumProductivityRecordsPurged Number of productivity records purged.

Pending Job Count

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

Events Raised

None.

Tables Purged

YFS_PRODUCTIVITY