This purge removes alert data from the system. This reduces the load on frequently accessed tables. The alert should be marked as CLOSED.
Any enterprise that uses the Application Console must schedule purge transactions.
You can use purge codes pseudo-logic to analyze purges. If the following conditions are met, an alert is picked up for purge:
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | INBOXPRG |
Base Document Type | General |
Base Process Type | General |
Abstract Transaction | No |
APIs Called | None |
User Exits Called | YFSBeforePurgeUE |
The following are the criteria parameters for this transaction:
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 |
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:
|
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 multi schema deployment where a table may exist in multiple schemas. Runs the agent for the colony. |
The following statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumInboxPurged | Number of inbox records purged. |
For this transaction the pending job count is the number of records that can be purged from the YFS_INBOX table.
None.
YFS_INBOX
YFS_INBOX_NOTES
YFS_INBOX_AUDIT
YFS_INBOX_REFERENCES