Relavent to ShareDo v7.7 and later

Introduction

To create a business rule, navigate to Modeller > Rules > Business Rules. There you will see all existing rules once they have been migrated from Matching Rules that existed before ShareDo version 7.7.

Click the Matching rules (deprecated) button at the top right of the Business Rules page to view the old, matching rules. These rules are read-only and provided so that you can compare the old rule with the migrated rule in case you need to fix the new rule. See the article Matching Rules and Striping for information on the deprecated system.

See the article Migrating Matching Rules to Business Rules for more information on migrating rules.

Business Rule editor

Click the button on the top-right of the page to open the Rule Set Editor.

Configure the Rule Set as necessary and take note of the following:

• You must enter a name and ensure the system name is unique.
• You must select a context type.
• Except for the Global context, you can optionally select an entity type for the selected context type. The entity type list is filtered based on the context selected.
  We recommend you select an entity type. The entity type's primary use is to drive the data composer.

The Rule Set canvas allows you to add rules and operators. 

Add Rule

The list of rules available depends on the context you chose. For example, if you chose a context of ODS Entity, the Work Item Type and Phase Match rule is not available because that rule is only relevant in the context of a Work Item.

When you've selected the rule to add, enter or select the relevant information into the rule block's fields. Click the tick mark at the top right to save the block, or click the X to remove it. 

The value option in some rule block fields allows you to type in a value, like a GUID or specific hard-coded value. It is best not to do this except for testing purposes; if the value is not exactly correct, or something in the system changes, this whole rule block will cause a problem in the system.

 

Continue adding rule blocks and operators until you have built up the rule, then use the Test button in the ribbon to check the rule. See the Test the Rule section below for more information.

Transient Evaluations

The Advanced section of the Rule Set tab has a toggle allowing you to enable transient evaluations. Transient evaluations are defined as follows:

A transient evaluation is primarily a UI-centred feature that can run rules against newly created entities (for example, a new work item) or changes that have not been saved yet (for example, when a user changes the work item's sub-type).

Enabling transient evaluations adds an option to the rule set. The options in the Add transient rule drop-down also depend on the rule set's context.

Operators

Use the AND, NOT, and OR operators to build up more complex evaluations. Operator blocks can be nested.

Once you are finished building your rule, click Save. The ribbon changes to include more options:

• You can use the Text Display button to see the rule in plain text. This is especially useful when there are many operator/rule blocks.
  
• Clicking Delete performs a Find Usage which shows you where the rule is being used and also allows you to delete the rule if it is not being used.
• Usages opens a blade showing where the rule set has been used.
• Clone creates a copy of the rule set for you to edit. It is important to consider changing the cloned rule set's name (and consequently its system name).
• Clicking Test opens the Rule Set Evaluation blade. 

Test the Rule

After creating your new rule set, you should test it to ensure it works as expected and no parts of the rule fail. Click Test in the ribbon.

The Rule Set Evaluation page shows the rule in plain text. 

Options Tab

	Evaluate
	Run All Rules	Setting this on causes all rules to run even if an early one fails (which would normally cause the evaluation to terminate early). For example, if you have an AND with Rule 1 and Rule 2, if Rule 1 fails, Rule 2 is usually not evaluated, but if you're debugging and you want to see how everything would turn out, you can turn this on.
	Throw On Error	Errors get ‘caught’ by the framework rather than surfaced in the Uncaught Exceptions window. This is usually only used by developers.
	Full Trace	Toggles on a more detailed trace than you would normally see in SEQ, and opens in a separate Trace tab. This is usually only used by developers.
	Advanced
	Enter all date manually	Toggling this on shows the ‘code view’ of the rule, allowing you to enter all data manually.

Parameters

To test the rule, enter data you want to test the rule against in the Parameters tab. The Parameters tab shows context parameters and so will depend on the context of the rule. This image shows an example:

You can enter data manually by selecting Manual Entry from the drop-down menu or select Search to open the Advanced Search blade.

Review

This article showed you how to create a Business Rule and test that it works correctly. It also showed you where to find more information on Business Rules.