To boost system performance, this transaction serves as a temporary purge until the Delivery Plan Purge deletes delivery plan-related data (see Delivery plan purge).
This transaction picks all delivery plans that do not have any of their loads or shipments still open and marks the deliveryplan_closed_flag='Y'. This flag indicates no further operations are possible on the plan.
This transaction corresponds to the base transaction close delivery plan (CLOSE_DELIVERY_PLAN) in the load pipeline.
Any enterprise using the Console must schedule purge jobs.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CLOSE_DELIVERY_PLAN |
Base Document Type | Load |
Base Process Type | Load Execution |
Abstract Transaction | No |
APIs Called | None |
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. |
ColonyID | Required in a multischema 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 |
---|---|
NumDeliveryPlansClosed | Number of delivery plans closed. |
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.
The following events are raised by this time-triggered transaction:
Transaction/Event | Key Data | Data Published | Template Support? |
---|---|---|---|
ON_SUCCESS | delivery_plan_ |
YDM_CLOSE_DELIVERY |
Yes |
However, note that the template name would read <TransactionId>.ON_SUCCESS.xml.