Start order negotiation

The start order negotiation transaction creates the negotiations for orders that are configured to go through the negotiation process.

Use this transaction in environments where an Order needs to go through a Negotiation phase before it is released.

Attributes

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

Table 1. Start order negotiation attributes
Attribute	Value
Base Transaction ID	START_ORD_NEGOTIATION
Base Document Type	Order
Base Process Type	Order Fulfillment
Abstract Transaction	No
APIs Called	`createNegotiation()`
User Exits Called	YCPBeforeCreateNegotiationUE, YCPGetNegotiationNoUE

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Start order negotiation 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 retrieved by the agent. The value that is assigned to this parameter is matched against the value that is stored in the `FILTER_CRITERIA` column of the `YFS_TASK_Q` table while retrieving the jobs. The possible values for the parameter depend on the following two default segregation policies that are implemented for the order entity. 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 that match the values can be retrieved or processed together. Use comma-separated enumerations when you assign multiple values to the parameter. For more information, see Workload segregation for task queue agents.
Node	Required. The ship node for which records are being processed.
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. Start order negotiation statistics
Statistic Name	Description
NumOrdersProcessed	Number of orders processed.
NumNegotiationsCreated	Number of negotiations created.

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 createNegotiation() API in the IBM Sterling Order Management: Javadoc.