Release

This transaction releases orders to specific ship nodes, making sure that the scheduled ship nodes have enough inventory to process the order.

This transaction should be invoked after the scheduling process.

For more details, see the information provided under the releaseOrder() API in the Javadoc.

If you run the combined ‘Schedule and Release' agent, do not also run the individual Schedule or the individual Release agents.

Attributes

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

Table 1. Release attributes
Attribute Value
Base Transaction ID RELEASE
Base Document Type Order
Base Process Type Order Fulfillment
APIs Called releaseOrder()

Criteria parameters

The following are the criteria parameters for this transaction:

Table 2. Release 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.
IgnoreReleaseDate Optional. Determines whether the schedule process should ignore line release date criteria. Valid values are:
  • Y - Releases line quantities regardless of release date criteria
  • N - Default value. Releases line quantities only after release date criteria have been met.
CheckInventory Optional. Determine whether inventory should be checked. Valid values are:
  • Y - Default value. Inventory needs to be checked.
  • N - Inventory does not need to be checked.
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. Release criteria statistics
Statistic Name Description
NumFutureDateFailures Number of orders did not attempt to release because of future date failures.
NumOrdersAttempted Number of orders attempted to release.
NumOrdersCannotBeProcessed
Failures
 Number of orders did not attempt to release because of cannot be processed failures.
NumOrdersProcessed Number of orders processed.
NumOrdersReleased Number of orders released.
NumOrdersBackordered Number of orders backordered.
NumOrderLinesReleased Number of order lines released.
NumOrderLinesBackordered Number of order lines backordered.
NumReleasesCreated Number of order releases created.
NumOrdersCannotBeProcessed
Failures
 Number of orders that were not released due to process failure.

If the release process results in splitting of an order line, NumOrderLinesReleased, NumOrderLinesBackordered, and NumOfReleasesCreated may result in more than one count.

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, if tasks on hold are not ready to be processed.

Events raised

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