Purpose
BizRule Analyzer Web is designed for Encompass administrators and developers who need to identify fields and text in custom calculations, business rules, and custom input forms. It helps resolve inconsistencies and conflicts in calculations and rules by providing a comprehensive search tool.
This tool streamlines collaboration between multiple developers and admins working within the same area by automatically scanning and saving settings data. All administrators can access the same settings data set.
Key Features
User Interface: The web-styled interface is easy to navigate, improving upon the previous version. The Tool can be run from outside Encompass from the Lender Toolkit Toolshed Portal, allowing the admin to use the Tool while also in Encompass.
API Based: BizRule Analyzer Web utilized the Encompass API to read and parse the details of Encompass customizations. Settings files are auto-generated in the background on the first login by a system administrator each day.
Efficient Search: Indexes settings to display both overall context and specific details, minimizing the time spent identifying configurations and settings.
Activation: Available as an additional PowerTool in the Expert Tier. Can be run simultaneously with the original SDK version for real-time comparison. Requires a Super Administrator to turn it on in PowerTools. The downloaded package will generate a license key and install the form. Encompass should be restarted after installation.
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.
1 - Search Box | Enter a field ID within brackets [...] or a text string to search for instances 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 | Displays standard and custom fields, showing the number of appearances in various categories like Calculated Fields, Business Rules, Custom Forms, etc. |
4 - Settings File List | Access current and previous settings files, generate new ones, and refresh the list to ensure all available files are listed. See additional information about Settings Files below. |
5 - Data Stats | Provides counts of various system settings, including Alerts, Archived Milestones, Audit Fields, Custom Fields, and more. |
6 - Display Options | Modify how search results are displayed, including sorting tabs, suppressing empty tabs, and filtering by rule status. |
7 - Search Results Category Tabs - Displays system settings in tabs 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 -Automated creation of settings capture files daily 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 is auto-selected.
Format - Stored in .json format, allowing for comparison between files.
Storage - API generated settings files will be stored online in the AWS S3 service. The SDK version stored settings files on the local computer of the user who created the file. Online settings files are available to all system administrators. Previous files can be selected if the admin needs to review settings from an earlier date.
File Comparison - Administrators can compare any two settings files, highlighting adds, changes, and deletions between the two. This feature simplifies tracking change control and troubleshooting system issues due to settings changes.
Examples of Search Results Display
Calculated Fields
Field Data Entry
Field Triggers
Milestone Completion
Persona Access to Fields
Persona Access to Loans
Print Form Rules
Form Input Fields
Form Event Code
Click on a Code Line to expand the view to the complete code block
Installed Components
Custom Input Form - "LTK-BizRuleAnalyzer"
Custom Data Object - BizRuleAnalyzerHostedKey.txt