To boost system performance, this transaction serves as a temporary purge until the Shipment Purge deletes all shipment-related data (see Shipment purge).
This transaction picks all shipments eligible to be closed, based on the pipeline configuration for pickup for transaction CLOSE_SHIPMENT, and marks the shipment_closed_flag='Y'. This flag indicates no further operations are possible on the shipment. There is no status change involved. This transaction can be configured in the pipeline so that it picks up either Shipped or Delivered status.
This transaction corresponds to the base transaction close shipment (CLOSE_SHIPMENT) in the shipment pipeline.
This transaction should be made part of the pipeline. In addition, it should be configured to work from the task queue.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CLOSE_SHIPMENT |
Base Document Type | Order |
Base Process Type | Order Delivery |
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. |
Next Task Queue Interval | Optional. Specifies in hours how long a failed task should be suspended before it is considered for reprocessing. Defaults to 5 hours. |
ColonyID | Required in a multischema deployment where a table may exist in multiple schemas. Runs the agent for the colony. |
The following are statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumShipmentsClosed | Number of shipments 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 | shipment_dbd.txt | YDM_CLOSE_SHIPMENT. |
Yes |