Inbox purge

The Inbox purge deletes the alert data and reduces the load on the frequently accessed tables.

If you are using the Application Console, ensure that you schedule purge transactions. To analyze purges, use the purge codes pseudo-logic.

If the following conditions are met, an alert is picked up for purge.

  • The alert must be in the Closed status.
  • An inactive alert must contain the resolution date earlier than or equal to the current date minus the purge criterion’s retention days.
  • If the alert is in the Open status and the expiration days is greater than 0, then the modified timestamp must be less than the current date minus the number of expiration days.
  • If the alert is in the Open status, the expiration days is set to 0, and the yfs.purge.inboxPurge.zeroExpiryAlert.defaultExpiryWindow database property is set to a number such that the modified timestamp is less than the current date minus the expiry window property, such alerts are moved to the Closed status.

Attributes

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

Table 1. Alert console purge attributes
Attribute Value
Base Transaction ID INBOXPRG
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. Alert console purge criteria parameters
Criteria Parameters 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.
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. The organization for which the Alert Purge needs to be run. If not passed, then all enterprises are monitored.
ExceptionsWithBlank
EnterpriseOnly
 Optional. If the parameter is set to Y, the agent purges only those exceptions that has blank enterprise code. In this case, the value set for the EnterpriseCode criteria parameter is ignored.
Live Optional. Mode in which to run. Valid values are:
  • Y - Default value. Moves qualifying records from the regular tables listed under Tables Purged to the corresponding history tables.
  • N - Test mode. Determines the rows that are moved to history tables without actually moving them.
PurgeCode Required. Cannot be modified. Used for internal calculations, such as determining retention days. Corresponds with the PurgeCode used in Business Rules Purge Criteria.
ColonyID Required in a sharded deployment where a table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Alert console purge statistics
Statistic Name Description
NumInboxPurged Number of inbox records purged.

Pending job count

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

Events raised

None.

Tables purged

YFS_INBOX

YFS_INBOX_NOTES

YFS_INBOX_AUDIT

YFS_INBOX_REFERENCES