This transaction is equivalent to the changeShipmentStatus() API. For detailed information about this transaction, see the Sterling Selling and Fulfillment Foundation: Javadocs.
To be configured as part of your shipment processing pipeline, this transaction can be used whenever an automatic change in the status of a shipment is required. For example, this automatic change could represent exporting shipment information to a warehouse management system or to transmit an Advance Shipping Notice to the buyer.
This transaction should be configured to work from the task queue.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CHANGE_SHIPMENT_STATUS |
Base Document Type | Order |
Base Process Type | Order Delivery |
Abstract Transaction | Yes |
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 |
---|---|
NumShipmentsChanged | Number of shipments whose status was changed. |
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.
This transaction raises events as specified under the changeShipmentStatus() API in the Sterling Selling and Fulfillment Foundation: Javadocs.