Reservation purge

This purge deletes expired inventory reservations from the system. This reduces the load on frequently accessed tables as well as free up demands that are consumed by expired reservations.

You can use purge codes pseudo-logic to analyze purges. If the following condition is met, all records in the YFS_INVENTORY_RESERVATION tables are picked up for purge:

  • EXPIRATION_DATE is earlier than the current date minus the purge criteria's retention days or quantity is less than or equal to 0.

Any enterprise using the Console must schedule purge transactions.

Attributes

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

Table 1. Reservation purge attributes
Attribute Value
Base Transaction ID RESERVATIONPRG
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. Reservation purge criteria parameters
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:
  • 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 the YFS_INVENTORY_RESERVATION table may exist in multiple schemas. Runs the agent for the colony.

Statistics tracked

The following statistics are tracked for this transaction:

Table 3. Reservation purge statistics
Statistic Name Description
NumReservationsPurged Number of reservations purged.

Pending job count

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

Events raised

None.

Tables purged

YFS_INVENTORY_RESERVATION