Shipment history purge

This transaction deletes shipments previously archived by the Shipment Purge. See Shipment purge.

Any enterprise using the Console must schedule purge transactions.

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

  • The last modification performed on the shipment falls before the lead time (in days) setup.

Orders related to the shipments should have been purged by order purge. Shipments should have been closed by the Close Shipment transaction. See Close shipment.

Attributes

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

Table 1. Shipment history purge attributes
Attribute Value
Base Transaction ID SHIPMENTHISTPRG
Base Document Type Order
Base Process Type Order Delivery
Abstract Transaction No
APIs Called None
User Exits Called YFSBeforePurgeUE

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Shipment 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 Shipment 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 sharded 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. Shipment history purge statistics
Statistic Name Description
NumShipmentHistoriesPurged Number of shipment histories purged.
NumShipmentLineHistoriesPurged Number of shipment line histories purged.

Pending job count

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

Events raised

None.

Tables purged

YFS_ADDITIONAL_ATTRIBUTE_H

YFS_ADDITIONAL_DATE_H

YFS_AUDIT

YFS_CONTAINER_DETAILS_H

YFS_CONTAINER_STS_AUDIT_H

YFS_INSTRUCTION_DETAIL_H

YFS_SHIPMENT_CONTAINER_H

YFS_SHIPMENT_H

YFS_SHIPMENT_LINE_H

YFS_SHIPMENT_LINE_REQ_TAG_H

YFS_SHIPMENT_STATUS_AUDIT_H

YFS_SHIPMENT_TAG_SERIAL_H

YFS_CONTAINER_ACTIVITY_H