Template order

The Template Order condition builder attributes are identical to the Order Fulfillment attributes.

Table 1. Template order condition builder attributes
Attribute Description
Condition Variable 1 A variable that can be used for condition building. This is an existing field in the YFS_ORDER_LINE database table, and can be used to create conditions without extending the database.
Condition Variable 2 A variable that can be used for condition building. This is an existing field in the YFS_ORDER_LINE database table, and can be used to create conditions without extending the database.
Delivery Method The delivery method of the order (shipment, pickup, delivery, or cash and carry).
Disposition Code The disposition code of the item. This field is only applicable for Reverse Logistics and Supply Collaboration.
Is Large Order The flag indicates whether the order is a large order.
Is Very Large Order The flag indicates whether the order is a very large order.
Line Type The type of the order line. Sterling™ Order Management System has no application logic associated with the order line type. This field can be set up as per your business practices.
Order Segregation Filter The value of Order Segregation Filter is derived based on the following two segregation policies that are implemented by default for the order entity.
  • order line size
  • order attribute

The segregation policy is decided by the yfs.taskqueue.segregation.order property. The valid values are order line size and order attribute. Default value is order line size.

For the order line size based segregation policy, Order Segregation Filter is derived based on the count of the order lines and rules that define large and very large order sizes.

Note: Default value of VERY_LARGE_ORDER_SIZE is 500 and LARGE_ORDER_SIZE is 20. The size that is defined in the VERY_LARGE_ORDER_SIZE rule must always be greater than the size that is defined in the LARGE_ORDER_SIZE rule.

For orders with the order line count greater than or equal to LARGE_ORDER_SIZE and less than VERY_LARGE_ORDER_SIZE, the value returned by Order Segregation Filter is Large.

For orders with order line count greater than or equal to VERY_LARGE_ORDER_SIZE, the value returned by Order Segregation Filter is VeryLarge.

In other cases, Order Segregation Filter returns an empty string.

For order attribute based segregation policy, you must define the attribute name in the yfs.taskqueue.segregation.order.orderattribute property. The XML name of the attribute can be set to this property. The attribute can be the default attribute or an extended attribute, but it must be an attribute of the YFS_ORDER_HEADER entity. To know more about the default attributes for this setting, see Workload segregation for task queue agents.

The value of Order Segregation Filter is derived from the value of the defined attribute.

Order Type The type of the order. Sterling Order Management System has no application logic associated with the order type. This field can be set up as per your business practices.
Payment Status The payment status of the order.
Sale Voided The flag indicating whether the order is voided.
Transaction ID The ID of the last transaction that was run on the order.
Is Order From Contract The flag indicating whether the order is created from a contract order.
Order Release Attributes
Is Large Release The flag indicates whether the release is a large release.
Is Very Large Release The flag indicates whether the release is a very large release.
Release Segregation Filter The value of Release Segregation Filter is derived based on the following two segregation policies that are implemented by default for the release entity.
  • release line size
  • release attribute

The segregation policy for release is decided by the yfs.taskqueue.segregation.release property. The valid values are release line size and release attribute. The release line size is the default segregation policy.

For release line size based segregation policy, the Release Segregation Filter is derived based on the count of the order lines included in the release and rules that define large and very large order sizes.

Note: Default value for VERY_LARGE_ORDER_SIZE is 500 and for LARGE_ORDER_SIZE is 20. It is expected that the size defined in the VERY_LARGE_ORDER_SIZE rule must be always greater than the size that is defined in the LARGE_ORDER_SIZE rule.

For releases with order line count greater than or equal to LARGE_ORDER_SIZE rule and less than VERY_LARGE_ORDER_SIZE rule, the value returned by Release Segregation Filter is Large.

For releases with order line count greater than or equal to VERY_LARGE_ORDER_SIZE, the value returned by Release Segregation Filter is VeryLarge.

In other cases, Release Segregation Filter returns an empty string.

For release attribute based segregation policy, you must define the attribute name in the yfs.taskqueue.segregation.release.releaseattribute property. The XML name of the attribute can be set to this property. The attribute must be an attribute of YFS_ORDER_RELEASE entity. To know more about the valid attributes for this setting, see Workload segregation for task queue agents.

The value of Release Segregation Filter is derived from the value of the defined attribute.

Participant Attributes
Bill To ID The ID of the bill to address for the order.
Buyer Organization Code The code of the organization that is buying the goods or services.
Enterprise Code The code of the enterprise on the order.
Receiving Node The node that receives the shipment for the order.
Seller Organization Code The code of the organization that is selling the goods or services.
Ship Node The node that ships the shipment for the order.
Ship Node Interface Type The interface type of the ship node on the order (External Application, Console, Sterling Store Inventory Management, or WMS 6.2).
Ship To ID The ID of the ship to address for the order.
Supplier Code The code of the supplier for the order.
Item Attributes
Item ID The ID of the item on the order line.
Item Group Code The group code of the service item. For example, if the service is a provided service item, then the item group code is PS.
Product Line The product line of the item on the order line.
Sourcing Attributes
Fulfillment Type The fulfillment type of the order.
Intentional Backorder The flag indicating whether the order was intentionally dropped into backordered status at order creation.
Is Firm Predefined Node The flag indicating whether the node on the order is a firm predefined node.
Order Sourcing Classification The order sourcing classification of the order.
Reservation Mandatory The flag indicating whether the reservation is mandatory.
Related Order Attributes
Chain Type The chain type of the order.
Is Chained Line The flag indicating whether the order line is chained with another order line.
Is Derived Line The flag indicating whether the order line is derived from another order line.
Order Purpose The purpose of the order. If this is an exchange order, this field is set to EXCHANGE.
Is Line From Contract The flag indicating whether the order line is created from a contract order line.
{Enter Your Own Attribute} A customizable condition builder attribute. For more information about customizing this field, see the IBM Sterling Order Management: Extending the Condition Builder.

This field is limited only to unexposed key attributes that are predefined by Sterling Order Management System as opposed to any XML attribute that you can enter.