Close delivery plan

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.

Attributes

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

Table 1. Close delivery plan attributes
Attribute	Value
Base Transaction ID	CLOSE_DELIVERY_PLAN
Base Document Type	Load
Base Process Type	Load Execution
Abstract Transaction	No
APIs Called	None

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Close delivery plan criteria 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.
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. Close delivery plan statistics
Statistic Name	Description
NumDeliveryPlansClosed	Number of delivery plans closed.

Pending job count

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.

Events raised

The following events are raised by this time-triggered transaction:

Table 4. Events raised by close delivery plan transaction
Transaction/Event	Key Data	Data Published	Template Support?
ON_SUCCESS	delivery_plan_ dbd.txt	YDM_CLOSE_DELIVERY _PLAN.ON_ SUCCESS.xml	Yes

However, note that the template name would read <TransactionId>.ON_SUCCESS.xml.