This is a task queue based transaction in the order pipeline that corresponds to base transaction CONSOLIDATE_TO_SHIPMENT. This transaction finds a shipment into which a given order release can be included. If it finds an existing shipment, it calls changeShipment() API. Otherwise, it calls the createShipment() API.
To find the existing shipments it matches ShipNode, ShipTo Address, SellerOrganizationCode, Carrier, DocumentType and so forth, of the Order Release with that of existing shipments.
This transaction is applicable only to the shipments in one of the following Statuses:
For more information, see the details provided under the createShipment(), changeShipment(), releaseOrder(), and consolidateToShipment() APIs in the Sterling Selling and Fulfillment Foundation: Javadocs.
The following are the attributes for this time-triggered transaction:
Attribute | Value |
---|---|
Base Transaction ID | CONSOLIDATE_TO_SHIPMENT |
Base Document Type | Order |
Base Process Type | Order Fulfillment |
Abstract Transaction | No |
APIs Called | createShipment() and changeShipment() |
User Exits |
|
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 |
---|---|
NumOrderReleasesConsolidated | Number of order releases consolidated. |
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_CONSOLIDATE_TO |
Yes |
This transaction also raises events as specified under the createShipment() and changeShipment() APIs in the Sterling Selling and Fulfillment Foundation: Javadocs.
However, note that the template name would read <TransactionId>.ON_SUCCESS.xml.