To boost system performance, this transaction serves as a temporary purge until the Load Purge deletes load-related data (see Load purge).
This transaction corresponds to the base transaction Close Load (CLOSE_LOAD) in the load pipeline.
If you use the Load processing pipeline, you must schedule this transaction. Only closed loads are picked up by the purge transaction. Therefore, it is required that this transaction be made part of the pipeline and scheduled to run at the end of the day.
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_LOAD |
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. |
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 statistics are tracked for this transaction:
Statistic Name | Description |
---|---|
NumLoadsClosed | Number of loads closed. |
For this transaction the pending job count is the number of open delivery plans, which are not associated to any open loads and open shipments.
The following events are raised by this time-triggered transaction:
Transaction/Event | Data Published | Template Support? |
---|---|---|
ON_SUCCESS | YDM_CLOSE_LOAD_PLAN.ON_ |
Yes |
However, note that the template name would read <TransactionId>.ON_SUCCESS.xml.