Reverse logistics

Table 1. Return fulfillment condition builder attributes
Attribute Description
Order Attributes
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 return (shipment, pickup or delivery).
Disposition Code The disposition code of the item.
Line Type The type of the return line. Sterling Order Management System Software has no application logic associated with the return line type. This field can be set up as per your business practices.
Order Type The type of the return. Sterling Order Management System Software has no application logic associated with the return type. This field can be set up as per your business practices.
Payment Status The payment status of the return.
Sale Voided The flag indicating whether the return is voided.
Transaction ID The ID of the last transaction that was run on the return.
Participant Attributes
Bill To ID The ID of the bill to address for the return.
Buyer Organization Code The code of the organization that is buying the goods or services.
Enterprise Code The code of the enterprise on the return.
Is Large Order The flag indicating whether the order is a large order.
Is Very Large Order The flag indicating whether the order is a very large order.
Order Segregation Filter The value of Order Segregation Filter is derived based on the following two segregation policies that are implemented for order entity out of the box.
  • order line size
  • order attribute

The segregation policy is decided by the yfs.taskqueue.segregation.order property. The allowed values are order line size and order attribute. The order line size is the default segregation policy.

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 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 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 an out of the box attribute or an extended attribute, but it must be an attribute of YFS_ORDER_HEADER entity. For more information about the allowed 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.

Receiving Node The node that receives the shipment for the return.
Seller Organization Code The code of the organization that is selling the goods or services.
Ship Node The node that be ships the shipment for the return.
Ship Node Interface Type The interface type of the ship node on the return (External Application, Console, Sterling Store Inventory Management, or WMS 6.2).
Ship To ID The ID of the ship to address for the return.
Supplier Code The code of the supplier for the return.
Order Release Attributes
Is Large Release The flag indicating whether the release is a large release.
Is Very Large Release The flag indicating 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 for release entity out of the box.
  • release line size
  • release attribute

The segregation policy for release is decided by the yfs.taskqueue.segregation.release property. The allowed 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. For more information about the allowed 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.

Item Attributes
Item ID The ID of the item on the return 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 return line.
Sourcing Attributes
Fulfillment Type The fulfillment type of the return.
Intentional Backorder The flag indicating whether the return was intentionally dropped into backordered status at return creation.
Is Firm Predefined Node The flag indicating whether the node on the return is a firm predefined node.
Order Sourcing Classification The order sourcing classification of the return.
Reservation Mandatory The flag indicating whether the reservation is mandatory.
Related Order Attributes
Chain Type The chain type of the return.
Is Chained Line The flag indicating whether the return line is chained with another return line.
Is Derived Line The flag indicating whether the return line is derived from another return line.
Order Purpose This field is only applicable to sales orders.
{Enter Your Own Attribute} A customizable condition builder attribute. For more information about customizing this field, see Extending the condition builder.

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