Receipt history purge

This transaction deletes receipts previously archived by the Receipt Purge. See Receipt purge.

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 receipt that is previously purged by the receipt purge agent is picked up for history purge:

  • The last modified date of the receipt should exceed the retention day period.
  • The shipment associated with the receipt should be purged from the history table.

To purge a receipt history, ensure that the Receipts are closed and Shipments are purged.

Attributes

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

Table 1. Receipt history purge attributes
Attribute Value
Base Transaction ID RECEIPTHISTPRG
Base Document Type Order
Base Process Type Order Fulfillment
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Receipt history purge criteria parameters
Parameter Description
Action Required. Triggers the transaction.
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. Enterprise for which the Receipt History 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. Removes qualifying records from the history tables listed under Tables Purged.
  • N- Test mode. Determines the rows that are removed without actually removing 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. Receipt history purge statistics
Statistic Name Description
NumReceiptLineHistoriesPurged Number of receipt line histories purged.
NumReceiptHistoriesPurged Number of receipt histories purged.

Pending job count

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

Events raised

None.

Tables purged

YFS_RECEIPT_HEADER_H

YFS_RECEIPT_LINE_H

YFS_RECEIPT_STATUS_AUDIT_H

YFS_INSTRUCTION_DETAIL_H