Change load status

This transaction is equivalent to the changeLoadStatus() API. For detailed information about this transaction, see the Sterling Selling and Fulfillment Foundation: Javadocs.

To be configured as part of your load processing pipeline, this transaction can be used whenever an automatic change in the status of a load is required. This automatic change could represent exporting load information to load planning software or transmission to the load's carrier.

This transaction should be configured to work from the task queue.

Attributes

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

Table 1. Change load status attributes
Attribute Value
Base Transaction ID CHANGE_LOAD_STATUS
Base Document Type Load
Base Process Type Load Execution
Abstract Transaction Yes
APIs Called changeLoadStatus()

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Change load status 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 multischema 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. Change load status statistics
Statistic Name Description
NumLoadsChanged Number of loads whose status was changed.

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 CurrentDate value in the YFS_Task_Q table.

Events raised

This transaction raises events as specified under the changeLoadStatus() API in the Sterling Selling and Fulfillment Foundation: Javadocs.