This purge removes capacity data from the system. This reduces the load on frequently accessed tables.
Any enterprise using the Console must schedule purge transactions.
You can use purge codes pseudo-logic to analyze purges. If the following conditions are met, a capacity data gets picked up for purge:
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CAPACITYPRG |
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:
Parameter | Description |
---|---|
Action | Required. Triggers the transaction. If left blank, it defaults to Get, the only valid value. |
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. |
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 |
---|---|
NumStdCapacityPeriodsPurged | Number of standard capacity periods purged. |
NumCapacityOverridesPurged | Number of capacity overrides purged. |
NumCapacityConsumptionsPurged | Number of capacity consumptions purged. |
For this transaction the pending job count is the total number of records that can be purged from the YFS_RES_POOL_STD_CAPCTY_PERD, YFS_RES_POOL_CAPCTY_OVERRIDE, YFS_RES_POOL_CONSMPTN_DTLS and YFS_RES_POOL_CAPCTY_CONSMPTN tables.
None.
The YFS_RES_POOL_STD_CAPCTY_PERD table is purged when EFFECTIVE_TO_DATE <= (CurrentDate - LeadDays)
The YFS_RES_POOL_CAPCTY_OVERRIDE table is purged when CAPACITY_DATE <= (CurrentDate - LeadDays)
The YFS_RES_POOL_CAPCTY_CONSMPTN table is purged when CONSUMPTION_DATE <= (CurrentDate - LeadDays), or if a manual reservation is taken, when CONSUMPTION_DATE <= (CurrentDate - Manual Reservation Retention Days). When this table is purged, YFS_RES_POOL_CONSMPTN_DTLS is also purged.
The YFS_RES_POOL_CONSMPTN_DTLS table is purged when RESERVATION_EXPIRATION_DATE <= (CurrentDate - LeadDays)