Learning
Community
Open Exchange
Global Masters
InterSystems IRIS Data Platform 2019.3 / System Interoperability / Developing Business Rules / Introduction to the Rule Editor
Previous section   Next section

Introduction to the Rule Editor

This chapter introduces the Rule Editor in the Management Portal. It is divided into the following sections:

Business Rule List

The Interoperability > List > Business Rules page displays a list of the business rule classes defined in the active interoperability-enabled namespace. Navigate to this page from the Business Rules item of the InterSystems IRIS™ List menu.
Select a rule class to be the target of one of the following commands in the ribbon bar:
  • Edit — Click to change or view the rule definition using the Business Rule Editor.
  • Delete — Click to permanently delete the rule definition class.
  • Export — Click to export the selected rule class as an XML file.
  • Import — Click to import an XML file into a rule class.
You can also export and import rule classes as you do any other class in InterSystems IRIS. You can use the System Explorer > Globals page of the Management Portal or use the Export and Import commands on the Tools menu in Studio.

Business Rule Editor

The Interoperability > Build > Business Rules page page is where you create and edit business rule class definitions for all types of business rule. The page opens with the last rule you had open in the namespace. The tab at the left of the title bar contains the name of the business rule definition class. If this is the first time on the page for this namespace, the working pane is empty and you must either create a new rule or open an existing one.
The “Creating and Editing Rule Sets” chapter describes the details of how to use the editor to define business and routing rules; the rest of this chapter describes how the user interface works with the rule structure.
The ribbon bar of the Rule Editor page contains the following elements:
  • New button — Click to launch the Business Rule Wizard to create a new business rule definition.
  • Open button — Click to launch the Finder Dialog to choose an existing business rule definition to edit.
  • Save button — Click to save and compile any changes you have made to the rule definition.
  • Save As button — Click if you have been editing a rule definition and wish to save your changes as a new business rule class.
  • Contract — Click to contracts the display of all of the rules in the rule set. You can then individually expand the rule you want to view or edit.
  • Expand — Click to expand the display of all of the rules in the rule set.
  • Open new windows check box — If checked, the New and Open commands open the rule editor in a new window or browser tab.
  • Zoom drop-down—Specifies the zoom percentage to view the rule.
General Tab
Once you have a rule definition in the working pane you see tabs of information. The general tab contains the summary information for the rule definition:
Description
Class description of the rule definition and its purpose.
Rule Type / Rule Assist Class
Each rule type has an associated rule assist class which controls the constraints of the rule and provides information in the right pane of the page to guide you when editing rules.
The table shows the four rule types and their associated Ens.Rule.Assist class:
Rule Type Rule Assist Class
General Business Rule Ens.Rule.GeneralBusinessRuleAssist
General Message Routing Rule EnsLib.MsgRouter.RuleAssist
Virtual Document Message Routing Rule EnsLib.MsgRouter.VDocRuleAssist
Context Class
The class that contains the information to tell the Rule Editor which object properties to provide as choices in the Value editor while you are editing a rule. For general rules, it is generated from the business process BPL class and ends in .Context. For routing rules without a BPL process, it is usually the routing engine business process class.
Rule Alias
Deprecated. Do not use.
Temporary Variables
You can specify temporary variables in this field. You can use these temporary variables in the business rule. Each variable specification is separated by commas. For example:
FreeShippingValue,ShipMethod,PremierMember
Temporary variables are used in a rule by preceding the variable name with an @ (at sign). For example, @FreeShippingValue. Temporary variables are available only within the rule. If you want to pass information to the transformation using the rule, use the RuleUserData property. See “Selecting the Transformation and Target of a Send Action” for details.
Production Name
(Only for routing rules) This optional, informational setting makes it easier for you to define rules because the rule editor uses this setting to select configuration items to display when you are defining rules. The production configuration actually specifies that a rule is used for a production.
Rule Set List
List of Rule Sets with the following information:
  • Rule Set Name —Name to identify the particular set.
  • Beginning Date and Time — The time from which the rule becomes active. The exact time is included in the active interval. The format is YYYY-MM-DDTHH:MM:SS. The time portion is optional and defaults to 00:00:00.
  • Ending Date and Time — The time when the rule stops being active. The exact time is excluded from the active interval. The format is YYYY-MM-DDTHH:MM:SS. The time portion is optional and defaults to 24:00:00
Rule Set Tabs
Each rule set has its own tab for editing its list of rules. For details, see the “Creating and Editing Rule Sets” chapter.
Editor Icons
Both tabs contain following set of icons. The following icons are available to edit the rule definition, rule sets, rules, and clauses within a rule set:
images/ebus_rule_up_enabled.png images/ebus_rule_down_enabled.png images/ebus_rule_add_enabled.png images/ebus_rule_delete_enabled.png images/ebus_rule_undo_enabled.png images/ebus_rule_redo_enabled.png images/ebus_rule_function_enabled.png
The specific action may differ depending on the entity you are editing; the following table describes the action of each icon in general.
Icon Action
images/ebus_rule_up_enabled.png
Click the Up icon to move the selected item up in the list.
images/ebus_rule_down_enabled.png
Click the Down icon to move the selected item down in the list.
images/ebus_rule_add_enabled.png
Click the Add icon to add the type of item you choose from the list or beneath the icon in the Rule Assistant.
images/ebus_rule_delete_enabled.png
Click the Delete icon to delete the item next to it.
images/ebus_rule_undo_enabled.png
Click the Undo icon to undo the last change.
images/ebus_rule_redo_enabled.png
Click the Redo icon to redo the last change that was undone.
images/ebus_rule_function_enabled.png
Click the Function icon to open the associated editor for the selected action.
If an action is not available, its icon appears dimmed.
Rule Assistant
You can hide or show the Rule Assistant using the double-arrow in the right pane of the Rule Editor. When you are editing a rule set, the expanded Rule Assistant pane provides you with help throughout the editing process. It describes the item you have selected and provides a list of options based on your assist class.

Business Rule Wizard

This wizard helps you create a new business rule definition based on the Ens.Rule.Definition class with an XData block named RuleDefinition. Enter values for the following fields:
Package
Enter a package name or use the arrow to select an existing package name.
Name
Enter the name of the business rule class.
Alias
(Optional) Enter the alias name for this rule. Do not use any of the following characters:
; , : | ! * - $ ‘ “ < > &
Deprecated. Do not use.
Description
(Optional) Enter a description for this rule definition. This becomes the class description.
Type
Enter one of four rule types:
  • General Business Rule
  • General Message Routing Rule
  • Virtual Document Message Routing Rule
Each rule type has an associated rule assist class which provides information in the right pane of the page to guide you in entering rules and controls which options the editor presents.
Context Class
(Optional)
This field tells the Rule Editor which object properties to provide as choices in the Value field when you are editing a rule. For general rules, this class is generated from the BPL business process class that invokes the <rule>. The naming convention of the class is the business process class name plus the .Context extension.
Previous section   Next section