Appearance

Formula Configuration User Manual ​

Introduction ​

The Formula Configuration in Banclo Console provides a powerful way to create custom calculations and logic for your loan processing workflows. This comprehensive guide explains how to use the Formula Management interfaces to create, edit, and manage formulas across your organization.

Table of Contents ​

Formula Management Interface ​

The Formula Management interface provides a centralized location to view, create, edit, and delete formulas in your organization.

Access and Permissions ​

  • The Formula Management interface is available in the Settings section of the Banclo Console
  • Users need to have the role of a Bank Loan Manager to access the Formula Management interface.
  • System formulas are read-only and cannot be modified or deleted

Interface Overview ​

The Formula Management screen displays a table with the following columns:

  • Name - The formula name and description
  • Category - Whether the formula belongs to the "User" or "LoanRequest" category
  • Variables - The number of variables used in the formula
  • Visibility - Whether the formula is visible or hidden in the UI
  • Type - Whether it's a system formula or a custom formula
  • Bank - (Admin only) The bank the formula belongs to, or "System" for system formulas
  • Actions - Options to edit or delete formulas

Formula Categories ​

Formulas are organized into two main categories:

  1. User Formulas: Applied to individual participants in a loan application
  2. Loan Request Formulas: Applied to the entire loan application

Note: Loan Request formulas are evaluated only once per loan application, while User formulas are evaluated for each participant.

Creating and Editing Formulas ​

To create a new formula, click the "Add New Formula" button at the top right of the Formula Management screen. This opens the Formula Builder interface.

Understanding Variations, Variables, and Variants ​

These terms have specific meanings in the Formula Configuration:

Variables ​

Variables are placeholders for values that can change depending on the context. In the Formula Configuration, a variable:

  • Has a unique name (e.g., "income")
  • Is referenced in formulas as {{$vars.variableName}}
  • Contains one or more variants

Variants ​

Variants represent different possible values for a single variable:

  • Each variant has a display name and a value
  • Variants can have different formatting options
  • A variant's value can be a simple value or a formula expression

Variations ​

Variations are complete alternative versions of a formula with the same name but potentially different implementations:

  • Each variation is a separate formula object
  • Variations allow different implementations for the same concept (e.g., income calculation)
  • The system selects the appropriate variation based on context

Formula Builder Interface ​

The Formula Builder is organized into four tabs:

  1. Details - Basic formula information and display settings
  2. Formula Editor - The expression editor for creating the formula logic
  3. Variables - Manager for custom variables used in the formula
  4. Preview & Test - Test the formula with sample data

Details Tab ​

In the Details tab, you configure the basic formula information:

  • Formula Name - The technical identifier for the formula (e.g., monthlyIncome)
  • Display Title - The human-readable name shown in the UI (e.g., "Monthly Income")
  • Description - Explains what the formula calculates
  • Category - Select "User" or "Loan Request"
  • Display Format - How the result should be displayed:
    • None - Raw value with no formatting
    • Number - Numeric display with decimal places
    • Currency - Monetary value with currency symbol
    • Percentage - Value displayed as a percentage
  • Maximum Decimal Places - For numeric formats, controls precision
  • Hidden - Toggle to hide the formula from the UI (still calculated but not displayed)
  • Associated Task - The task this formula should be associated with

Formula Editor ​

The Formula Editor is a specialized interface for creating and editing formula expressions with syntax highlighting, autocomplete, and validation.

Key Features ​

  • Search - Find functions, variables, and settings quickly
  • Category Filters - Filter the available elements by type
  • Quick Access Panels - Tabbed interface for common elements:
    • Task Fields - Results from tasks in the workflow
    • Variables - Custom variables defined for this formula
    • Formulas - References to other formulas
    • Loan Fields - Properties of the loan application
    • Bank Settings - Configuration values from your bank
    • Functions - Mathematical and logical functions

Syntax ​

Formulas use a spreadsheet-like syntax with the following special elements:

  • Variables: {{$vars.variableName}}
  • Formula References: {{$formula:formulaName}}
  • Bank Settings: {{bank.settingPath}}
  • Task Results: {{taskResults.taskName.fieldPath}}
  • Loan Fields: {{loan.fieldPath}}

Functions ​

The Formula Editor supports a wide range of functions for calculations:

  • Math functions: SUM, AVERAGE, MIN, MAX, ROUND, etc.
  • Financial functions: PMT, RATE, IPMT, etc.
  • Logical functions: IF, AND, OR, NOT, etc.
  • Text functions: CONCATENATE, LEFT, RIGHT, etc.
  • Date functions: TODAY, DATE, DATEDIF, etc.

Variable Management ​

The Variable Manager allows you to create and manage variables that can be used in your formulas.

Adding Variables ​

  1. Enter a variable name (e.g., "income")
  2. Click "Add Variable"
  3. Configure the variable's properties and variants

Variable Properties ​

Each variable has the following properties:

  • Variable Name - The identifier used in formulas (e.g., "income")
  • Variants - Different possible values for the variable

Variants ​

Each variable can have multiple variants, which represent different possible values:

  • Display Name - A label for this variant (e.g., "Net Income")
  • Value - Can be a simple value or a formula expression
  • Display Format - How this variant should be displayed (Currency, Number, Percentage)
  • Maximum Decimal Places - For numeric formats

Formula Toggle ​

Each variant can use either:

  • Simple Value - A direct value input
  • Formula Editor - For computed values using the formula editor

Formula Preview & Testing ​

The Formula Preview component allows you to test your formulas with sample data and see the results in real-time.

Features ​

  • Formula Display - Shows the current formula with syntax highlighting
  • Validation Status - Indicates if the formula is valid or has errors
  • Test Variables - Input fields for all variables, settings, and references used in the formula
  • Result Display - Shows the calculated result with proper formatting

Testing Workflow ​

  1. Enter test values for all variables and references used in the formula
  2. The formula will be evaluated in real-time
  3. The result will be displayed with the selected formatting
  4. If there are errors, they will be displayed in the result area

Technical Reference ​

Formula Data Structure ​

When formulas are saved, they use a specific structure that organizes them by participant and formula type.

Performance Optimization ​

The formula evaluation system includes several optimizations:

  1. User formulas are evaluated for each participant
  2. Loan Request formulas are only evaluated once per loan application
  3. Formula results are cached to avoid redundant calculations

Formula Evaluation ​

The Formula Configuration uses a dependency-based evaluation approach:

  1. Formulas are analyzed to identify dependencies
  2. Dependent formulas are evaluated after their dependencies
  3. The system handles both user and loan request formulas in a single pass
  4. Results are cached for efficiency