Count Request Purge

This time-triggered transaction purges all the count requests for a period greater than the retention days specified in the Count Purge criteria and those, which are either in the status of cancelled or completed.

You can use the pseudo-logic of purge codes to benefit in analyzing purges. A count request is picked up for purge if it meets the following conditions:

Attributes

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

Table 1. Count Request Purge Attributes
Attribute Value
Base Transaction ID COUNTPRG
Base Document Type Count
Base Process Type Count Execution
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Count Request 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. Node for which the Count Request Purge needs to be run. If not passed, then all nodes are monitored.
ColonyID Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony.
Override Lead Days Optional. Used to override the lead days which are configured at the Enterprise/Document Type level.
Request Type Optional. Used to enter count request type for a particular count request.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Count Request Purge Statistics
Statistic Name Description
NumCountRequestsPurged Number of count requests purged.
NumCountResultsPurged Number of count results purged.

Pending Job Count

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

Events Raised

None.

Tables Purged

YFS_COUNT_RESULT_TAG

YFS_COUNT_RESULT

YFS_COUNT_REQUEST