Purpose

Encompass Administrators and developers often need to find calculations, rules and forms that use or change specific fields or rules that may run into inconsistent or conflicting calculations. There’s also a constant “back-and-forth” between multiple developers and admins about what each of them did in Encompass when they work within the same area.

BizRule Analyzer allows Administrators to search business rules, calculated fields and custom input forms very effectively by indexing the settings in such way that it presents results displaying both overall context and specific details of what is being searched. This allows admins & developers to spend minimal time identifying configurations and settings that they need to review or modify.

Activation

The Web version is an additional PowerTool in the Expert Tier. A user can have both the original version and the web version of the Tool enabled and run simultaneously so they can be compared in real time.

When a Super Administrator turns the tool ON, a license key will be generated and the input form will be installed. Encompass should be restarted after installing the tool.

Web User Interface

The newly designed, web-styled, version of BizRule Analyzer improves upon the previous version with an easy to navigate user interface. Below is a screenshot of the new search results display.

Image Placeholder

1 - Search Box	User enters a field ID, within brackets [...] or a text string to search for instances of that item in Custom Fields and Business Rules
2 - Search History	Previous search items for the session are listed and can be selected to rerun the search for that item.
3 - Field List	Opens a full list of standard and custom fields. The number of appearances in Calculated Fields, Business Rules, Custom Forms, Form Code, and Persona Access Rules is displayed for each field.
4 - Settings File List	Current and previous settings files are available for the user to select for searches. The user can also generate a new settings file from this tab. The list can be refreshed to ensure the user that all available settings files are listed. See additional information about Settings Files below.
5 - Data Stats	Lists the count of the following system settings: Alerts, Archived Milestones, Audit Fields, Custom Fields, Custom Forms, DDM Fee Rules, DDM Field Rules, Documents, Field Access Rules, Data Entry Rules, Trigger Rules, Milestone Rules, Milestones, Personas, Print Form Rules, RDB Fields, Tasks
6 - Display Options	Allows the user to modify how the search results are displayed. Sort Tabs Descending - the tabs will be sorted descending based on the number of appearances of the search item in each category. Suppress Empty Tabs - if the search item does not have any instances for a settings category, the category tab is not displayed. Show All Rule Details - selecting this option will only show the parts of a rule where the search item appears. Clearing this option will show all aspects of the rule, including sections where the search item is not included. Filter By - show All rules regardless of status, only show Active rules, only show Inactive rules.

7 - Search Results Category Tabs - system settings will be visible in the tabs listed below when the search term is included in any area of the setting (Filter, Notes, Field Listing, Advanced Code, etc.)

Calculated Fields	Custom fields where the search item is included in the calculation are listed.
Field Data Entry	Rule details listed
Field Triggers	Rule details listed
Milestone Completion	Rule details listed
Persona Access to Fields	Rule details listed
Persona Access to Loans	Rule details listed
Print Form Rules	Rule details listed
Form Input Fields	Forms are listed when the search field is mapped to any of the form's controls. The Control ID is listed so the user can easily find it in the Form.
Form Event Code	The full text of the Form code is listed when the search field is included in any of the control events in the form or the load/unload events.

Settings Files

A major improvement in the Web version is the creation, format and storage of the settings files.

Creation - A key feature of the web version is the automated creation of the settings capture files. Each day a new settings file will be auto-generated on the first login by any Super Admin. The settings capture occurs in the background with no action required by the admin user. When the Tool is opened, the newest settings file will be auto-selected for searching.

Format - Settings files are stored in .json format. This provides the ability to use tools that can compare any two files and determine the changes between them. A file comparison utility will be added in a future enhancement release.

Storage - Settings files will be stored online in the AWS S3 service. This differs from the original version which stored settings files on the local computer of the user who created the file. The online settings files will be available to all administrators using the tool, without having to generate a new file before beginning a search. Previous files can be selected if the admin needs to review settings from an earlier date.