Bridge User Guide - Calculated Fields

Bridge
User Guide - Calculated Fields
Version 2.4.78

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Table of Contents

Introduction

Guide

Building Formulas

Operators

Simple Arithmetic Formulas

Placeholders Within Formulas

Defining String Data

Concatenation (combining data)

Placeholders

Current Transaction Information

Premium Details

Commission Details

Tax Details

Current Term Information

Premium Details

Commission Details

Tax Details

Term Period Dates

Previous Term Information

Premium Details

Commission Details

Tax Details

Policy Number

Limits

Deductibles

Retrieving Premium IDs

Functions

Working with Boolean Values

Defining Multiple Fields in a Function

Verifying User Security Roles

Compare Data Against Sanction or Watch Lists

Identifying When Fields Have Changed After an Integration

Conditional Results – the If() Function

Using Data and Comparison Operators as the Condition

Using a Trigger as the Condition

Defining the Results

Interpolation/Extrapolation

Full Function List

Reference

Appendix A – Compliance() Function Parameters

Appendix B - Full Placeholders List for Policy Information

Client Company Information

Individual Client Information

Distributor Information

Insurer Information

Policy Information

Transaction Information

Compliance Information

Quote Information

Current Transaction Premium, Commission, Tax Information

Current Transaction Limit Information

Current Transaction Deductible Information

Current Term Information

Previous Term Information

Billing Workflow Details

System Date

Other

Appendix C - Full Placeholders List for Billing Information

Invoice Information

Statement Information

Client Information

Distributor Information

Insurer Information

Bill To Party Information

Policy Information

Charge Information

Installment Information

Appendix D - Full Placeholders List for Claims Information

Claim Information

Claim Party Information

Claim Payment Information

Index

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Introduction

Welcome to the Bridge insurance access portal. The system provides a full workflow, from the administration of products and coverage, to the submission and management of individual policies.

Access to all features, options, and data are controlled by the settings in your user account. This guide is for users with product design rights, and details the creation of formulas for use in calculated fields. Calculated fields can be used for simple purposes such as displaying a basic system variable, or can perform a complex calculation pulling in a variety of fields and system information and generating a result to be displayed on-screen, used in documentation, or even used in other calculated fields.

Calculated fields are not limited to numerical values. They can also work with dates and text, providing a wide range of possibilities.

This guide assumes the user is familiar with the general functions of the system. For instructions on logging in and using common features throughout the system, see the User Guide - Introduction document.

Guide

The instructions are divided into the following major categories. Click a link to jump to the appropriate section.

Building Formulas / Details the structure for building formulas and pulling in submission information.
Policy Placeholders / Provides the syntax for calling policy details into a formula.
Functions / Describes the built-in tools used to work with data.

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Building Formulas

Formulas are assembled using common logic and notation, and should be familiar for users experienced with formulas in spreadsheet and database applications.

Operators

Bridge uses the following symbols to represent common arithmetic operators.

+ / Add
- / Subtract
* / Multiply
/ / Divide
( / Open bracket
) / Close bracket

Simple Arithmetic Formulas

The above operators are used to build the basic structure of the formula.

/ Example:
3 x 6 ÷ (5 + 15 – 0.3) x 0.6
Would be input into a calculated field as:
3 * 6 / (5 + 15 - .3) * .6
/ Note: Spaces are optional, but can be included for clarity. They will be ignored by the system.

Placeholders Within Formulas

The real power of calculated fields in the Bridge system is the ability to pull in information from the system and from the submission or claims form itself. This is achieved using placeholders. When the system encounters a placeholder while resolving a formula, it replaces the placeholder with the current value from the system or workflow.

The placeholders are predefined, and are detailed in the Placeholders section. Placeholders for fields within the submission or claims form are made up of the Code for the field (defined in Field Management), enclosed in double square brackets [[ ]].

/ Example:
100 x The Number of Trucks - 50
Would be input into a calculated field as:
100 * [[NumberOfTrucks]] - 50
Where, NumberOfTrucks is the Code for the field “The Number of Trucks”.
/ Note: In order for any field to be used within a calculated field, it must be included in the workflow with the calculated field.

Defining String Data

Calculated fields are not restricted to using numerical values. Dates and text can also be manipulated using a selection of functions and features.

In some situations, however, the formatting of data could be mistaken for calculations. For example, the date format 5/15/2012 could be interpreted as 5 divided by 15 divided by 2012, or a policy number with dashes, such as 2012-12345 could be interpreted as 2012 minus 12345.

There are two methods for defining string data.

The String: formatting notation can be used at the beginning of a calculated field formula, and causes the system to treat all values as text. No calculations are performed, and any operators, arithmetic expressions, and spaces are treated as text. Functions and placeholders still function normally, but the resulting data is treated as text.

/ Example:
String:[[field1]]/[[field2]]+[[field3]]
If the values of the three placeholders are 8, 4, and 2 respectively, the value of this calculated field would be 8/4+2, and would be displayed as such in the field and any documents or e-mails that pull in this calculated field.

Any text, numbers, or symbols enclosed in quotes " will be treated as simple text. No calculations will be performed on content within quotes, spaces in quotes will not be removed, and even functions and placeholders will be treated as text instead of being replaced with system information.

/ Example:
"The value of " [[field1]] " / " [[field2]] " + " [[field3]] " equals " [[field1]] / [[field2]] + [[field3]]
If the values of the three placeholders are 8, 4, and 2 respectively, the result of this calculated field would be:
The value of 8 / 4 + 2 equals 4
The first set of operators are treated as text and displayed in the output, while the second set are calculated and the result is displayed in the output. Note that the spaces within the quotes are kept, while the spaces outside of the quotes are ignored.
/ Note: All quotes must be straight quotes " or they will not be recognized. Some word processing programs replace straight quotes with angled quotes or "Smart Quotes". These quotes must be replaced with straight quotes, either in the word processor, or within Bridge.

Concatenation (combining data)

If no Operators are used between placeholders and/or data entered directly in the formula, the system simply pulls in the placeholder data without any modifications.

This is useful for merging fields that are collected separately, but need to be used together.

/ Examples: If a user's first name and last name are collected in separate fields, the following formulas could be used:
String:[[FirstName]] [[LastName]] -or- [[FirstName]] " " [[LastName]]
The value of this field would be FirstName LastName. Note that a space must be included between the placeholders, or the two fields are combined without a space, such as FirstNameLastName.
Another example would be to assemble an address:
String:[[StreetAddress]], [[City]], [[Country]]. -or- [[StreetAddress]] ", " [[City]] ", " [[Country]] "."
The commas, spaces, and period are included in the calculated value. For the example using quotes, note that the spaces within the quotes will be kept, while the spaces outside the quotes will be ignored.

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Placeholders

While the field Code is used in a standard placeholder to pull in information from the submission form, specific placeholders are required to pull in background information about the current submission or policy. This information is available in any status where the quote details have been calculated, and some transaction types may have additional options.

Information is available for the Current Transaction and the Current Term, with Previous Term information available when working with renewals.

/ Note: Some placeholders use single quotes ' to identify a specific version of the variable. These must be straight quotes ' or the formula does not recognize them. Some word processing programs replace straight quotes with angled quotes or "Smart Quotes". These quotes must be replaced with straight quotes, either in the word processor, or within Bridge.

Current Transaction Information

In any status where quote details have been calculated, that quote information is available for use in calculated fields.

Premium Details

The following placeholders return the premium amount for a specific premium type, identified by name or Id number.

[[PremiumInfo[PremiumType='Name']/Amount]]

[[PremiumInfo[PremiumTypeId='#']/Amount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

Commission Details

The following placeholders return the commission amount for a specific premium type, as well as the gross premium and the net premium after commission. The premium types are identified by Id number.

[[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/GrossPremium]]

[[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/CommissionAmount]]

[[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/NetPremium]]

Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

Tax Details

The following placeholders return the tax information for a specific premium type, identified by Id number.

[[TaxDefinition[PremiumTypeId='#']/TaxName]]

[[TaxDefinition[PremiumTypeId='#']/CalculatedAmount]]

Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Current Term Information

The Current Term placeholders access the total values for all bound transactions in the current term. The references can access premium values, commissions, and taxes, for individual premium types or a total for all premium types.

Premium Details

The following placeholders return the term premium amount for a specific premium type, identified by name or Id number.

[[CurrentTerm/Premium/PremiumInfo[PremiumType='Name']/Amount]]

[[CurrentTerm/Premium/PremiumInfo[PremiumTypeId='#']/Amount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

The following placeholder returns the total bound premium for the term, for all premium types.

[[CurrentTerm/Premium/TotalPremiumAmount]]

Commission Details

The following placeholders return the term commission amount for a specific premium type, identified by name or Id number.

[[CurrentTerm/Premium/PremiumInfo[PremiumType='Name']/CommissionAmount]]

[[CurrentTerm/Premium/PremiumInfo[PremiumTypeId='#']/CommissionAmount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

The following placeholder returns the total bound commission amount for the term, for all premium types.

[[CurrentTerm/Premium/TotalCommissionAmount]]

Tax Details

The following placeholders return the term tax amount for a specific premium type, identified by name or Id number.

[[CurrentTerm/Premium/PremiumInfo[PremiumType='Name']/TotalTaxAmount]]

[[CurrentTerm/Premium/PremiumInfo[PremiumTypeId='#']/TotalTaxAmount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

The following placeholder returns the total tax amount for the term, for all premium types.

[[CurrentTerm/Premium/TotalTaxAmount]]

/ Notes: Only values from Bound transactions within the current term are returned. Using these references in a submission may have one value before binding (when the transaction being viewed is not included in the calculation) and a different value after binding (when the transaction being viewed is included in the calculation).
Once a transaction in a particular term is bound, the calculated fields are locked for that transaction. They are not updated if other transactions are subsequently bound within the same term.

Term Period Dates

The following placeholders return the start and end dates of the current term.

[[CurrentTerm/EffectiveDate]]

[[CurrentTerm/ExpiryDate]]

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Previous Term Information

The Previous Term placeholders access the total values for all bound transactions in the previous term. The references can access premium values, commissions, and taxes, for individual premium types or a total for all premium types.

Premium Details

The following placeholders return the previous term premium amount for a specific premium type, identified by name or Id number.

[[PreviousTerm/Premium/PremiumInfo[PremiumType='Name']/Amount]]

[[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/Amount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

The following placeholder returns the total bound premium for the previous term, for all premium types.

[[PreviousTerm/Premium/TotalPremiumAmount]]

Commission Details

The following placeholders return the previous term commission amount for a specific premium type, identified by name or Id number.

[[PreviousTerm/Premium/PremiumInfo[PremiumType='Name']/CommissionAmount]]

[[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/CommissionAmount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

The following placeholder returns the total bound commission amount for the previous term, for all premium types.

[[PreviousTerm/Premium/TotalCommissionAmount]]

Tax Details

The following placeholders return the previous term tax amount for a specific premium type, identified by name or Id number.

[[PreviousTerm/Premium/PremiumInfo[PremiumType='Name']/TotalTaxAmount]]

[[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/TotalTaxAmount]]

Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

The following placeholder returns the total tax amount for the previous term, for all premium types.

[[PreviousTerm/Premium/TotalTaxAmount]]

/ Note: When a renewal is created, the values for the previous term are copied into the renewal transaction for use with these placeholders. If the previous term is changed in any way (such as by endorsement), the details saved in the renewal transaction may no longer be valid. If the renewal has not yet been bound, it may be possible to delete it and create a new renewal transaction with the updated values.

Policy Number

The following placeholder returns the Policy Number of the previous term.

[[PreviousTerm/PolicyNumber]]

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Limits

The following placeholders return specific limits information defined for the current transaction. The information is available for each premium type, identified by Id number.

[[LimitList/Limit[PremiumType='#']/Description]]

[[LimitList/Limit[PremiumType='#']/LimitType]]

[[LimitList/Limit[PremiumType='#']/Amount]]

[[LimitList/Limit[PremiumType='#']/Currency]]

Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Deductibles

The following placeholders return specific deductibles information defined for the current transaction. The information is available for each premium type, identified by Id number.

[[DeductibleList/Deductible[PremiumType='#']/Description]]

[[DeductibleList/Deductible[PremiumType='#']/Amount]]

[[DeductibleList/Deductible[PremiumType='#']/Currency]]

Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.

Version 2.4.78Bridge User GuideUser Guide - Calculated Fields

Retrieving Premium IDs

When calling placeholders related to individual premium types, the premium type must be identified. For some placeholders, marked with the 'Name' notation, the name of the premium type is used. The remaining placeholders are marked with the '#' notation, and require the premium type Id number.

To retrieve the Id numbers of the premium types you want to work with, open the Product Design menu and select Premium Types. The Premium Type List opens with all available premium types.

Point the mouse cursor at the hyperlink in the Name column to display the URL in the status bar at the bottom of the browser window. The URL resembles the one below:

Take note of the numerical value after “id=”, underlined in red in the above example.

If the URL does not display, or the status bar is not visible, clicking the link for the premium type opens the Premium Type Management page. The URL is displayed in the address bar, ending with the ID number.

If the status bar and address bar are hidden, please check the instructions for your browser to display one or the other.