Creating rules

Rules evaluate incoming events generated by monitor adapters and trigger processes according to the results.

Every rule on a grid evaluates all XML input from the events from the monitor adapters on the grid. Each rule can trigger only one process, but a single event might cause multiple rules to evaluate to true, causing multiple processes to run.

When a process is triggered by a rule, the entire contents of the adapter event is passed to the process to an input parameter. The input parameter must be created in the Start Activity of the process and named inputevent. You can use a transform editor to parse the input event and store extracted content in context items. For more information about monitor adapter events, see the topics about Adapters, modules, and run books.

To create a rule

1. In the BMC Atrium Orchestrator Development Studio Project Navigator, expand the module that will use the rule.
2. Double-click rules.
   Unknown macro: {multi-excerpt}

   1. Unknown macro: {multi-excerpt}
      In the Rules Designer tab, click Add in the toolbar.

3. Unknown macro: {multi-excerpt} In the empty rule, enter the name for the rule in the Rule field.

4. Unknown macro: {multi-excerpt} Click the Search button on the far right and browse to select the process that you want to run if the rule evaluates to true.
   A process is listed in the process browser only if the Expose Process in Rules property was selected for that process in the Process Properties dialog box or in the New Process dialog box.

5. Unknown macro: {multi-excerpt}

   In the Match selection list, choose how you want the rule to be applied:

   1. • All indicates that if every condition evaluates to true, the process is executed.
      • Any indicates that if any condition evaluates to true, the process is executed.
        The source for the condition comparison is the adapter event generated by the monitor adapter. The adapter event is an XML document that you can transform to extract a portion from for comparison.

6. Unknown macro: {multi-excerpt}

   To launch the transform editor, click the Transform button.
   The Transform Editor wizard is displayed. For information about using the transform editor, see Using the Transform Editor.

   Note

   The Token pane is not present in the transform editor launched from the rules designer because tokens cannot be used in XPath expressions executed against adapter events.

7. Unknown macro: {multi-excerpt} Create the XPath expression to extract the content that you want to use for the rule condition.

8. Unknown macro: {multi-excerpt} Click Save and Exit to save the expression and return to the rules designer.

9. Unknown macro: {multi-excerpt} Select the comparator that you want to use from the drop-down menu.
   The comparator is a relational operator that compares the value derived from the Source field to the contents of the Value field and evaluates the expression to true or false.

10. Unknown macro: {multi-excerpt}

    Select the value type from the selection list to the right of the Value field, as described in the following table:
    

    Unknown macro: {multi-excerpt}

    Value type	Description
    String	A character string If you select String, enclose the value in single quotation marks.
    Numeric	A number
    Date	A date Use the Calendar button below the Value field to populate the field. All dates are stored in epoch time format. When comparing a date from an event generated by an IMAP or POP monitor adapter, use the value contained in the <sent-epoch-milliseconds> element.
    Input Event	A value from the incoming monitor adapter event Use this value type to compare one part of the adapter event to another. If you select this type, the Transform button is displayed below the Value field to allow access to the transform editor.

    Unknown macro: {multi-excerpt}

    1. Unknown macro: {multi-excerpt}
       In the Value field, enter the value that you want to compare to the source value.
       For values with a Value Type of Input Event, the Value field is not available. The value is the entire adapter event, or the segment of the adapter event as defined with an XPath expression in the transform editor. Repeat steps 6 through 8 to extract the portion that you want to compare to the source value.

11. Unknown macro: {multi-excerpt} (optional) Click the Add button to add additional conditions.

12. Unknown macro: {multi-excerpt}

    Click Apply to save the rule; click OK to clear the confirmation message.
    The new rule is displayed in the Rules List.

    Note

    To use the rule to trigger a process to run, export the module containing the rule to the repository and activate it on the grid.

    Unknown macro: {multi-excerpt}