This purge removes receipt data from the system. This reduces the load on frequently accessed tables. This transaction picks up all receipts that are not open and not pending inspection and archives them into their history tables. See Receipt history purge. It also archives and purges the receipt's child tables.
This is a pipeline transaction and works from a task queue.
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 is picked up for purge:
To purge a receipt, ensure that the receipts are closed and Shipments are purged.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | RECEIPTPRG |
Base Document Type | Order |
Base Process Type | Order Fulfillment |
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. |
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 Purge needs to be run. If not passed, then all enterprises are monitored. |
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 |
---|---|
NumReceiptLinesPurged | Number of Receipt Lines purged. |
NumReceiptsPurged | Number of receipts purged. |
For this transaction, the pending job count is the number of records available to be processed by the transaction with the AVAILABLE_DATE value less than or equal to (<=) the current date value in the YFS_Task_Q table.
None.
YFS_RECEIPT_HEADER
YFS_RECEIPT_LINE
YFS_RECEIPT_STATUS_AUDIT
YFS_INSTRUCTION_DETAIL