This purge deletes delivery plans after they have completed their typical life cycle. All the loads and shipments that are associated with the delivery plans should have been purged before running this purge agent.
It purges all the delivery plans that have been marked as ‘Closed' for a period greater than the retention days specified in the criteria parameters and those that do not have any shipments or loads. The order should have been moved to history before the lead time (in days) setup.
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 delivery plan is picked up for purge:
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | DELIVERYPLANPRG |
Base Document Type | Load |
Base Process Type | Load Execution |
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. 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. Enterprise for which the Delivery Plan 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. |
BatchDelete | Required. The method by which all records are deleted from
the table. Valid values are:
|
ColonyID | Required in a multi schema deployment where the YFS_DELIVERY_PLAN table may exist in multiple schemas. Runs the agent for the colony. |
The following statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumDeliveryPlansPurged | Number of delivery plans purged. |
For this transaction the pending job count is the number of records that can be purged from the YFS_DELIVERY_PLAN table.
7 Events Raised
None.
YFS_DELIVERY_PLAN