Working with Rules
Rules outline what you would like to monitor in Business Views from your reports. Based on a Rule, the Rule Agent performs data analysis considering your defined monitoring criteria, and delivers targeted results. The software stores existing Rules in Reports Center > Intelligence Layer > Configure > Rules.
Creating Rules
Before you start, make sure that the following prerequisites are fulfilled:
- You have a Designer license.
- You have published the report data as Business Views (BVs). The Rule Agent runs only on BVs from named ranges in your reports.
Expand the dropdown to see how to define named ranges:
- Before you start, make sure that the report has a single header row with valid, unique column names and there are no blank headers, duplicates or merged cells. Then, follow the below steps:
- In the report in Excel, select the table area: header, data rows and one extra blank row (required for BVs).
- Go to Formulas > Name Manager.
- Click Define Name and fill in other properties.
- Make sure Refers to property covers the header, data, and extra blank row. Now, you can save your report and upload it to Reports Center.
After defining the named range and uploading the report to Reports Center, you can publish report data as BV. Expand the dropdown to see how to publish report data as BVs:
- To publish report data as a Business View, follow the below steps:
- Navigate to Reports Center > Reports and select your report.
- Run the report. Publishing option is unavailable until the report runs.
- After completion, select Publish to Business Views. Review the data preview in the popup.
- Click Confirm. The BV will appear under Business Views in Reports Center. If publishing fails, verify your headers and named ranges are correct, then re-run the report.
To create a Rule and configure how and when the software notifies you of an analysis result, follow the below steps:
-
Navigate to Reports Center > Intelligence Layer > Configure > Rules and click the Create Rule button. The software opens the Create New Rule modal.
-
From the dropdown, select a Business View for which you want to create the Rule and click Next. The software displays Rules suggested by the Rule Agent based on the selected report.
-
Define the Rule. You have two options to do this:
-
Select one of the suggested Rules.
-
Insert your own Rule in the Label field. When entering the Rule, the suggested Rules disappear and instead, the software displays suggestions on how you can finish your Rule. You can select one of the options or continue entering your own idea.
Figure 1: Create New Rule modal with a text field to define the Rule
-
Define Rule Name and click Next. The software displays subscription options.
-
In the Add Subscribers field, enter subscribers e-mail addresses or select from suggestions.
-
Click Create Rule. The software displays a success message.
Figure 2: Success Message
Note: Rules don't work for reports that haven't been run.
Your Rule is now active. When the report is run, the Rule Agent performs the analysis of the Business View taking into consideration the monitoring criteria. The agent generates the result and sends it to the dashboard. You can view the result in Reports Center > Intelligence Layer > Results. For more information, see Monitoring Analysis Results.
Note: The Rule creator automatically becomes the subscriber. The only way to change it is to transfer the Rule ownership to a different user. For details, click here.
How the Rule Agent Works
The Rule Agent runs automatically each time the report data is updated. This happens, for example, when you run the report manually using the Play button, or when the report runs on a configured schedule. To learn how to set up a schedule for your report, see Jet Documentation > Schedule Reports.
Managing Rules
The existing Rules are stored in Reports Center > Intelligence Layer > Configure > Rules. In this space, you can view and manage Rules, for example disable, edit, delete or duplicate them.
Viewing Rules Details
To view an existing Rule details, follow these steps:
- Navigate to Reports Center > Configure > Rules and on the list of Rules find the one you want to view.
- Click on the Rule. Alternatively, click the
icon and from the list of options and select View Details. The software displays the Rule Details modal containing information about the Rule and Rule history.
- (Optional) You can edit the Rule if needed by clicking the Edit button.
- After reviewing the Rule details, click Okay to close the modal.
After viewing a Rule, you may proceed to perform other Rule-related actions. You may, for example, disable a rule, edit it, or change the rule owner. For more information, see the following sections:
Disabling Rules
Newly created Rules are always active by default. However, you can conveniently disable them. To disable a Rule, follow these steps:
- Navigate to Reports Center > Intelligence Layer > Configure > Rules.
- On the list of Rules, navigate the one you want to disable.
-
Disable the toggle on the Rule tile.
Figure 3: Disabling a Rule.
The rule has been disabled. You will not receive results connected with this rule. You can enable the Rule again at any time.
Editing Rules
You can edit the existing Rules by adding or removing subscribers. To edit an existing Rule, follow these steps:
- Navigate to Reports Center > Intelligence Layer > Configure > Rules and on the list of Rules find the one you want to edit.
- Click on the Rule and select the Edit button in the Rule Details view. Alternatively, click the
icon and from the list of options, select Edit. The software displays the Edit Rule modal.
- Introduce the changes.
- Click Done.
The software applies changes to the existing Rule. Next time the software runs your report, the Rule agent will perform data analysis based on the modified Rule.
Changing a Rule Owner
Before you start, make sure that a new Rule owner has a Designer license.
If you want to change transfer the ownership of a Rule, do the following:
- Navigate to Reports Center > Configure > Rules and on the list of Rules find the one you want to change.
- Click on the Rule. The software displays the Rule Details view. At the top right corner of this view you'll find the Change Owner button.
- Click the Change Owner button. The software opens the Transfer Rule Ownership modal with the current owner's name.
- From a Transfer To dropdown select a user who will become the owner of the rule.
- Click Transfer Ownership button to confirm.
You've transferred the Rule ownership to a selected user. From now on, this user has full control of the Rule.