Create chained order

This transaction creates one or more chained orders from an order whose OrderHeaderKey is stored in the task queue object. Chainable lines of the order can also be added to existing chained orders, instead of creating new chained orders with these lines. The existing chained orders must be identified by the determineChainedOrderForConsolidation user exit. If the user exit is not implemented, or if the user exit returns a blank document, one or more new chained orders are created.

For more information about the creation of chained orders, see the information provided under the createChainedOrder() API and the YFSDetermineChainedOrderForConsolidation user exit in the Javadoc.

This transaction should be invoked after order scheduling.

Attributes

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

Table 1. Create chained order attributes
Attribute	Value
Base Transaction ID	CHAINED_ORDER_CREATE
Base Document Type	Order
Base Process Type	Order Fulfillment
Abstract Transaction	Yes
APIs Called	`createChainedOrder()`

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Create chained order criteria 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.
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.
Task Queue Filter Criteria	Optional. Determines the jobs to be fetched by the agent. The value assigned to this parameter is matched against the value stored in the `FILTER_CRITERIA` column of `YFS_TASK_Q` table, while fetching the jobs. The possible values for the parameter depend on the following two segregation policies that are implemented for the order entity out of the box. Order Line Size: Valid values for the order line size based segregation policy are `VeryLarge`, `Large`, and `VOID`. Order Attribute: Valid values for the order attribute based segregation policy are the distinct values that can be assigned to the order attribute that is configured for segregation and `VOID`. Note: `VOID` is a valid task queue filter criteria value irrespective of the segregation policy. It is used to match records with NULL value in the `FILTER_CRITERIA` column of `YFS_TASK_Q` table. The parameter accepts multiple values so that the jobs matching the values can be fetched or processed together. When assigning multiple values to the parameter use comma-separated enumerations. For more information, see Workload segregation for task queue agents.
ColonyID	Required in a sharded 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. Create chained order statistics
Statistic Name	Description
NumOrdersProcessed	Number of orders processed for creating chained order.
NumOrdersCreated	Number of chained orders created.

If there are 2 orders being processed and the first order creates a chained order, the DetermineChainedOrderForConsolidation user exit causes the lines of the 2nd order to be added to the first order. The number of chained orders created is counted as 2.

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

Events raised

This transaction raises events as specified under the createChainedOrder() API in the Javadoc.