Configuring Recognition Rules

Use the Order Recognition Rule editor to configure and edit recognition rules.

To configure a recognition rule:

  1. Select Studio, then Show Design Perspective.

  2. In the Studio Projects view, double-click any recognition rule.

    The Order Recognition Rule editor is displayed.

  3. In the Input Message field, specify the data structure of the incoming customer order.

    Do one of the following:

    • To select a structure or node, right-click in the Input Message field and select Select Input Message.

    • To drag a structure or node from the Dictionary view into the Input Message field, right-click in the Input Message field and select Open Data Element View.

    • To select a structure or data node, click Select.

  4. Associate the recognition rule with a single order type. Click:

    • Select to select from a list of all orders in the workspace.

    • New to create a new order to associate with the rule. See "Creating New Orders" for more information.

    • Open to review the order details in the Order editor.

    OSM creates an order of the type you select when the corresponding recognition rule evaluates to true.

  5. Assign a relevancy to the rule.

    Relevancy determines the order in which the OSM server evaluates the order recognition rules at run time. OSM evaluates a rule with a higher relevance before it evaluates a rule with a lower relevance. For example, OSM evaluates a rule with a relevancy value of 2 before it evaluates a rule with a relevancy value of 1. OSM uses at run time the first order recognition rule that evaluates to true. The relevancy value can be any whole integer greater than or equal to zero.

  6. (Optional) Click the relevancy Select button.

    The Edit Relevancy dialog box opens, which displays a list of all recognition rules and their relevancy values in the workspace. You can refer to the list to help determine the value for the new order recognition rule.

  7. Click Recognition Rule.

    The Recognition Rule area expands to reveal the subtabs area.

  8. Click the XQuery subtab.

  9. Configure the XQuery-based rule or element.

    See "Order Recognition Rule Editor" for more information.

  10. (Optional) Click Properties.

    The Recognition Rule Properties view opens, where you can define annotation and a description for the rule.

  11. Click the Instances tab.

  12. (Optional) Associate a Data Instance behavior with the recognition rule.

    You can define a Data Instance behavior to obtain data that is not included in the order data and make that data available to the recognition rule. Click:

    • Add to add a Data Instance behavior.

    • Properties to configure the Data Instance behavior.

    See "Defining Data Instance Behavior Properties" for more information.

  13. Click the Notes tab.

  14. Describe the intended use of the rule.

    For example, you might describe the functionality of a complex rule or provide instructions on its use.

  15. (Optional) Click Validation Rule.

    The Validation Rule area expands to reveal the subtabs.

  16. Repeat steps 7 through 14 for the Validation subtabs.

    See "Order Recognition Rule Editor Recognition Tab" for more information about validation rules.

  17. (Optional) Click the Transformation tab.

  18. (Optional) Configure order priorities, references, and data rules.

    Click Order Priority, Order Reference, and Order Data to expand each area.

    Repeat steps 8 through 13 to configure rules for each area. See "Order Recognition Rule Editor Transformation Tab" for more information about transformation rules.

Related Topics

Creating New Recognition Rules

Order Recognition Rule Editor

Working with Recognition Rules