Manifest Purge

This purge picks up all the manifests that have been marked as "Closed" and purges them.

Any enterprise using the Console must schedule purge transactions.

All manifests which do not associate to any shipments and with modify timestamp less than the current date minus the purge criteria’s retention days can be configured to be picked up by the Manifest Purge.

You can use the pseudo-logic of purge codes to analyze purges. If the following conditions are met, a manifest is picked up for purge:

Attributes

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

Table 1. Manifest Purge Attributes
Attribute Value
Base Transaction ID MANIFESTPRG
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. Manifest Purge 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.
AgentCriteriaGroup Optional. Used to classify nodes. This value can be accepted by Sterling Warehouse Management System time-triggered transactions that only perform their tasks on the nodes with a matching node transactional velocity value.

Valid values are: LOW, HIGH, and any additional values defined by the Hub from Sterling Application Platform > System Administration > Agent Criteria Groups.

ShipNode Optional. Ship node for which the Manifest Purge needs to be run. If not passed, then all ship nodes are monitored.
ColonyID Required in a multischema deployment where the YFS_MANIFEST table may exist in multiple schemas. Runs the agent for the colony.

Statistics Tracked

The following statistics are tracked for this transaction:

Table 3. Manifest Purge Statistics
Statistic Name Description
NumManifestsPurged Number of manifests purged.

Pending Job Count

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

Events Raised

None.

Tables Purged

YFS_MANIFEST

Note: To purge Manifests, the Shipments related to the manifests should be purged by Shipment Purge, and the Manifests should be in 'Closed' status.