Inventory audit purge

This purge removes inventory audit data from the system. This reduces the load on frequently accessed tables.

Any enterprise using the Console must schedule purge transactions.

All inventory audits of the provided organization with modify timestamp earlier than the current date minus the purge criteria's retention days can be configured to be picked up by the Inventory Audit Purge.

You can use purge codes pseudo-logic to analyze purges. If the following condition is met, an inventory audit record is picked up for purge:

  • The inventory audit record's last modification is earlier than the current timestamp minus the retention days.

    Number of threads for this purge's agent criteria details must be set to 1. For more information about agent criteria, see the Organization and Participant Modeling Concepts topic
Note: When the Promising server is being used, this transaction is not called on the Order server.

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

Table 1. Inventory audit purge attributes
Attribute Value
Base Transaction ID INVENTORYAUDITPRG
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. Inventory audit 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.
EnterpriseCode Optional. The inventory organization for which the Inventory Audit Purge needs to be run. If not passed, then all enterprises are monitored.
Live Optional. Mode in which to run. Valid values are:
  • Y - Default value. Moves qualifying records from the regular tables listed under Table 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 multi schema 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. Inventory audit statistics
Statistic Name Description
NumInventoryAuditsPurged Number of inventory audits purged.

Pending job count

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

Events raised

None.

Table purged

YFS_INVENTORY_AUDIT