Rule Manager User Guide - Ekhosoft · 2016-07-11 · Rule Manager Rule Manager UI Overview Summary Page The Rule Manager opens to the Summary page, see Figure 2. This page displays

Document ID: E2-011-UGRevision: 1Release Date: 2016-02-29

Copyright Ekhosoft 2016 Canada. All rights reserved 7005 Taschereau, suite 260 | Brossard (QC) J4Z 1A7 tel +1.450.462.8105 fax +1.450.462.8205 WWW.EKHOSOFT.COM

Rule Manager User Guide

The Rule Manager is a tool located within the Form Builder. This tool is used to add rules to forms in order to modify the form’s behavior in defined circumstances.

Topics:

Accessing the Rule ManagerTo access the Rule Manager:

1. Open the Form Builder.

2. Click on the General configuration tab at the top of the Form Builder Window.

3. Click on the Rule Manager icon. This Rule Manager page will open. •

Introduction ............................................ 1 Building a Rule .......................................4Accessing the Rule Manager ................. 1 Rule Manager Tutorial ............................8Rule Manager UI Overview.................... 2

Figure 1. Accessing the Rule Manager

1

Rule Manager

Rule Manager UI OverviewSummary Page

The Rule Manager opens to the Summary page, see Figure 2. This page displays the rules that have already been created for the form and displays their status.

Note: Quick edits can be made to the rules directly from this page if the user is familiar with the Rule Manager.

Rule Manager Main Page

The Rule Manager main page is where the user goes to create and edit rules. See Table 1 for a general description of the tools on the main page and Figure 3 for a depiction of the window.

Figure 2. Summary Page

Table 1. Rule Manager Tools

Item Description

Action The area where the user configures the action triggered by the rule.

Apply Enters the rule into the code but does not save it.

Close Closes the Rule Manager

Condition tab The area where the user builds the rule equation.

Condition Type Determines the interaction rule.

Enabled Determine whether the rule will be executed or not.

Fields that can be edited from the summary page

Export as.XLSX file

Add/Edit/Delete buttons

Continued on next page

Rule Manager

Continued> Rule Manager UI Overview

Event Lists the actions that trigger the rule.

Save Saves the rule into the code.

Figure 3. Main Page Overview

Table 1. Rule Manager Tools (Continued)

Item Description

Apply Save Close

Event Enabled

Condition TypeCondition Tab Action Tab

Rule Grid Position Arrows

Add/Remove Arrows

Conditional Operators

Condition Objects

3

Rule Manager

Building a RuleThe following steps describe how to build a rule in the Rule Manager.

1. Select the event that will trigger the rule:• After all events are loaded: The rule will be put into effect once all the events have been

loaded into the form.• After save is completed: The rule will be put into effect once the save process has been

completed. • Before save is completed: The rule will be put into effect once the save process has been

triggered but before the data is actually saved. Example: A prompt that appears once the user clicks Save and that requires that the user performs an action before the saving process is completed.

• On addition of a child event: The rule will be put into effect once a child event is added to the form.

• Upon deletion of a child event: The rule will be put into effect once a child event is deleted from a form.

• When event content is changed: The rule will be put into effect once any action is made that affects the event.

• When a field is edited: The rule will be put into effect once changes have been made to a field.

2. Decide whether the rule will be immediately executed or not.• Yes: The rule will be applied to the form.• No: The rule will not be applied to the form.

3. Select condition type:• If: This rule is linked to a specified result. • Else If: This type of rule allows the user to add a second rule to continue an existing If rule. • Else: This type of condition allows the user to apply a rule to all results that are not the result

specified in the If of Else If rule.

4. Click on the Condition tab. This is where you will build the condition portion of the rule.

Continued on next page

Figure 4. Rule Triggers

4

Rule Manager

Continued> Building a Rule5. Build the condition portion of the rule. Table 2 explains the options available in the rule grid and

Figure 5 depicts an example. 5.1. Select the condition object who will be part of the condition equation. Objects can be

dragged and dropped onto the equation grid or can be added and removed using the Add and Remove arrows to the left of the equation grid.

5.2. Select the property that must be applied to the condition object. 5.3. Select the comparison operator.

5.4. Select the value.

Figure 5. Rule Grid Example

Table 2. Condition and Action Options

Grid Items Descriptions

Condition Operators These items are only available in the Conditions tab and allow the user to create multiple scenarios for the rule.

And Allows the rule to include multiple condition objects.

Example: The rule is triggered when the Volume tag value is false and when the Temperature value is greater or equal to 100.

Figure 6. And Condition

Volume

Temperature 100

False

Continued on next page

Rule Manager

Continued> Building a Rule

Continued on next page

Condition Operators Or Allows the rule to be triggered by multiple condition objects.

Example: The rule is triggered when the Volume tag value is false or when the Maintenance maker is set to yes.

Figure 7. Or Condition

Parentheses Allows the user to add condition equations within the rule.

Example: The rule is triggered when the Volume tag value is false and when the Temperature value is greater or equal to 100, or when the maintenance maker value is Yes.

Figure 8. Parenthesis Condition

Condition Objects These are the items in the form that can be used in the condition equation.

Form Control: Available control items.

Security Object: The list of the security groups that have access to the form.

Template property: The tags and markers used on the form.

Template name Identifies the template the rule is being applied to.

Object Identifies the object that will be affected by the rule.

Property The action that must be applied to the object.

Operator The factor that determines the relation between the object and the value

Value The result that must be achieved at the end of the equation.

Position Arrows These arrows are used to reposition the rules in the grid.

Table 2. Condition and Action Options (Continued)

Grid Items Descriptions

Maintenance Needed Value Equal YES

Volume

Volume

Maintenance Needed YES

Empty

Temperature 100

False

6

Rule Manager

Continued> Building a Rule

6. If needed, use the position arrows on the left side of the Rule Manager window to reposition the rows in the rule equation.

7. Click on the Action tab once the condition section is complete.

8. Build the action portion of the rule. Table 2 explains the options available.8.1. Select the Object the action will be applied to. Objects can be dragged and dropped onto

the equation grid or can be added and removed using the Add and Remove arrows to the left of the equation grip.

8.2. Select the property that the Object will be attributed. 8.3. Select the operator.8.4. Select the value.

9. Click on the Save button to save the rule. The rule will now be applied to the form when it is viewed in the Event Editor. See the next section for a tutorial of the Rule Manager.

7

Rule Manager

Rule Manager TutorialThe company Global Winery wants to add a rule to its grape quality form so that when a quality agent finds seeds in a batch of grapes they can immediately fill out a Seed Report simultaneously with the quality report. They will be working with their Grape QA Form with the Seed Report added as a child template. The form will feature a button called Add to Seed Report whose action is to add an event to the child template.

They will start by creating a first rule stating that when the marker Seeds appears in the parent form, the Add Child Event button will become enabled:

First rule:

• Event: When event content is changed• Enabled: Yes• Condition type: “If”

• Condition:

• Condition description: If the value in the Seed Status Field is equal to “Seeds”...

• Action:

• Action description: The “Add to Seed Report” button will be enabled when the value of the condition is true (i.e.Seeds).

Continued on next page

Figure 9. Form Setup

Figure 10. Condition Example

Figure 11. Action Example

Main Template Child Template

Add Event to Child Template Button

8

Rule Manager

Continued> Rule Manager ExampleThey will then create a second rule stating that if the marker value is set to anything else other than “Seed” the button will be disabled.

Second rule:

• Event: When event content is changed• Enabled: Yes• Condition Type: Else

• Action:

• Action description: The “Add to Seed Report” button will be enabled when the value is false.Once the rule is saved, the Add to Seed Report button will only be enabled when the seed status on the form is set to Seeds.

Figure 12. Action Example for the Second Equation

Figure 13. The Rule in Action.

User can add child events The user cannot add events to the child template

The value is “Seeds”

The “Add to Seed Report” button is enabled

Button is enabled

The value is something other than “Seeds”

The button is dissabled

9

E2-011-UG Copyright Ekhosoft 2016 Canada. All rights reserved .WWW.EKHOSOFT.COM