Global Serial Number Purge

This time-triggered transaction purges all the serial numbers that have not been at a node for a period greater than the retention days specified in the Global Serial Number Purge criteria.

You can use the pseudo-logic of purge codes to analyze purges better. A serial number is picked up for purge if it meets the following conditions:

Attributes

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

Table 1. Global Serial Number Purge Attributes
Attribute Value
Base Transaction ID GLOBALSERIALNUMPURGE
Base Document Type General
Base Process Type General
Abstract Transaction No
APIs Called None
User Exits Called None

Criteria Parameters

The following are the criteria parameters for this transaction:

Table 2. Global Serial Number Purge Criteria Parameters
Parameter Description
Action Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value.
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.
NumberofRecordsToBuffer Optional. Number of records to retrieve and process at one time. If left blank or specified as 0 (zero), it defaults to 5000.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds to the PurgeCode used in Business Rules Purge Criteria.
Node Optional. Node for which the Global Serial Number 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 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.

EnterpriseCode Optional. Enterprise for which the Global Serial Number Purge needs to be run. If not passed, then all enterprises are monitored.
Live Optional. Mode in which to run. Defaults to N.
  • Y - Production mode. Deletes records from regular tables.
  • N - Test mode.
ColonyId Required in a multischema deployment where the YFS_GLOBAL_SERIAL_NUM table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Global Serial Number Purge Statistics
Statistic Name Description
NumGlobalSerialsPurged Number of global serial numbers purged.

Pending Job Count

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

Events Raised

None.

Tables Purged

YFS_GLOBAL_SERIAL_NUM