99
0 Table of Contents Version 2.3.1 Bridge User GuideUser Guide - Calculated Fields Oceanwide Bridge User Guide - Calculated Fields Version 2.3.1

helpdocs.oceanwide.comhelpdocs.oceanwide.com/ow_files/bridge_docs/archives... · Web viewWhile the field . Code. is used in a standard placeholder to pull in information from the

  • Upload
    hakhue

  • View
    214

  • Download
    0

Embed Size (px)

Citation preview

0Table of Contents

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

Oceanwide Bridge

User Guide - Calculated Fields

Version 2.3.1

iTable of Contents

Table of Contents

TABLE OF CONTENTS.........................................................................................I

INTRODUCTION...................................................................................................1

Guide...........................................................................................................................1

BUILDING FORMULAS........................................................................................2Operators........................................................................................................................... 2Simple Arithmetic Formulas...............................................................................................2Placeholders Within Formulas............................................................................................3Defining String Data...........................................................................................................3Concatenation (combining data)........................................................................................4

POLICY PLACEHOLDERS..................................................................................5

Current Transaction Information..............................................................................5Premium Details................................................................................................................. 5Commission Details...........................................................................................................5Tax Details......................................................................................................................... 6

Current Term Information..........................................................................................7Premium Details................................................................................................................. 7Commission Details...........................................................................................................7Tax Details......................................................................................................................... 8Term Period Dates.............................................................................................................8

Previous Term Information.......................................................................................9Premium Details................................................................................................................. 9Commission Details...........................................................................................................9Tax Details....................................................................................................................... 10Policy Number.................................................................................................................. 10

Limits.........................................................................................................................11

Deductibles...............................................................................................................12

Retrieving Premium IDs...........................................................................................13

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

iiTable of Contents

FUNCTIONS........................................................................................................14

Defining Multiple Fields in a Function...................................................................15

Verifying User Security Roles.................................................................................16

Compare Data Against Sanction or Watch Lists..................................................17

Conditional Results.................................................................................................18

Interpolation/Extrapolation.....................................................................................20

Full Function List.....................................................................................................22

REFERENCE......................................................................................................35

Appendix A - $Compliance Function Parameters.................................................35

Appendix B - Full Placeholders List for Policy Information................................38Client Information.............................................................................................................38Distributor Information......................................................................................................41Insurer Information...........................................................................................................44Policy Information.............................................................................................................47Transaction Information...................................................................................................49Current Transaction Premium, Commission, Tax Information..........................................53Current Transaction Limit Information..............................................................................55Current Transaction Deductible Information.....................................................................57Current Term Information.................................................................................................59Previous Term Information...............................................................................................62System Date.....................................................................................................................64Other................................................................................................................................ 67

INDEX..................................................................................................................68

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

1Reference

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.3.1 Bridge User Guide User Guide - Calculated Fields

2Reference

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.6Would be input into a calculated field as:

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

3Reference

3*6/(5+15-.3)*.6

Note: Spaces are not permitted within formulas, except where specifically instructed.

Placeholders Within Formulas

The real power of calculated fields in the Bridge system is the ability to pull in information from the policy and from the submission 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 policy or submission form.

The placeholders for policy information are predefined, and are detailed in the next section, Policy Placeholders. Placeholders for fields within the submission 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 – 50Would be input into a calculated field as:

100*[[NumberOfTrucks]]-50Where, 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

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

4Reference

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. Also, spaces are not permitted in calculations, resulting in errors.

The String: formatting notation is 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 2, 4, and 6 respectively, the value of this calculated field would be 2+4/6, and would be displayed as such in the field and any documents or e-mails that pull in this calculated field.

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 data that is collected separately, but needs to be used together.

Examples: If a user's first name and last name are collected in separate fields, the following formula could be used:

String:[[FirstName]] [[LastName]]The value of this field would be the first name, then a space, then the last name. Note that the space must be entered between the placeholders, or the two fields are combined without a space.

Another example would be to assemble an address:

String:[[StreetAddress]], [[City]], [[Country]].

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

5Reference

The commas, spaces, and period are included in the calculated value.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

6Reference

Policy 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

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

7Reference

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.3.1 Bridge User Guide User Guide - Calculated Fields

8Reference

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.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

9Reference

[[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.3.1 Bridge User Guide User Guide - Calculated Fields

10Reference

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.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

11Reference

[[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.3.1 Bridge User Guide User Guide - Calculated Fields

12Reference

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.3.1 Bridge User Guide User Guide - Calculated Fields

13Reference

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.3.1 Bridge User Guide User Guide - Calculated Fields

14Reference

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.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

15Reference

Functions

The Bridge system provides an advanced set of tools for retrieving and manipulating data within the system. Functions provide ways to retrieve and work with dates, analyze data within a table, set conditional results within a formula, and much more.

A function is made up of the function name, which always begins with the $ symbol, followed by round brackets ( ). The parameters of the function are added within the brackets separated by commas.

$Function(p0,p1,...)

Some functions require a specific number of parameters, others allow as many as required, and some do not require any parameters at all.

Note: Spaces are not permitted within formulas or functions, including between parameters, except where specifically instructed.

All functions are listed in the Full Function List section, which includes descriptions of the functions, parameters, and results of each.

This section provides a more detailed introduction to some of these functions.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

16Reference

Defining Multiple Fields in a Function

Some functions evaluate multiple fields to provide a result. These functions may calculate the average of all values in a single column of a grid, the sum of a series of individual fields throughout the submission form, or a mix of fields and columns.

For functions that support multiple fields, the Pipe character ( | ) is used to separate the fields in the list. For columns in a grid, only the field names must be provided. The system automatically retrieves all records in the grid.

Examples:

To determine the average value of three fields:

$Avg([[field1]]|[[field2]]|[[field3]])To determine the sum of all records in a column, plus one field outside the grid:

$Sum([[column]]|[[field]])

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

17Reference

Verifying User Security Roles

Some situations may change depending on the type of user working in the system. The following function is used to determine if the current user has a specific security role.

$UserContainsRole(UserRole)

Where UserRole is the Name of the security role as it appears in the system.

The function returns the value “1” if the user has the role, or “0” if they do not. The result can be used in a conditional formula, or as a condition within a trigger.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

18Reference

Compare Data Against Sanction or Watch Lists

With the potential consequences of violating international restrictions, it can be very important to validate data and ensure that it is in compliance with regulations. The $Compliance function allows one or more fields to be compared to one or more sanction or watch lists from around the world.

To compare a field against a single list:

$Compliance([[ScanField]],List)

Where ScanField is the field to be scanned and List is the code of the list.

Comparing a field against multiple lists:

$Compliance([[ScanField]],List1,List2,List3)

Where ScanField is the field to be scanned and each List# is the code of a list. Any number of lists can be included.

Comparing multiple fields against multiple lists:

$Compliance([[ScanField1]] [[ScanField2]] [[ScanField3]],List1,List2,List3)

Where ScanField# are the fields to be scanned and each List# is the code of a list. The scan fields are combined and scanned as one large block of text, which is why a space should be added between each field to prevent the text from flowing together.

This function outputs a numerical value from 0 (no match) to 100 (perfect match). If a different score is achieved on different lists, the highest score is returned.

See Appendix A - $Compliance Function Parameters for a table of all lists and their associated codes.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

19Reference

Conditional Results

The $If function is used to define the value of a calculated field based on the content of other fields in the workflow. A trigger is defined as the condition, and the function returns one value if the trigger evaluates as true, or a different value if the trigger evaluates as false.

The condition line is constructed as follows:

$If(TriggerCode,TrueValue,FalseValue)

If TriggerCode is true, the TrueValue is returned, otherwise the FalseValue is returned.

Note: The Code for the trigger must be used. The code is based on the name of the trigger, but may not match exactly.

The True/False values can include placeholders, formulas, or even other functions (including other $If functions).

Examples:The function could return a monthly value as an annual value, or leave it as one month, depending on the trigger.

$If(Trigger,[[FieldA]]*12,[[FieldA]])

The function could return the user's name (concatenated from two fields with a space to divide them) or their spouse's name (also concatenated). The String: option is included to ensure that the content is treated as text.

String:$If(Trigger,[[UserFirstName]] [[UserLastName]],[[SpouseFirstName]] [[SpouseLastName]])

Using functions in the True/False values allows this $If function to return the sum of a table column, or the average of the values in that column.

$If(Trigger,$Sum([[Column1]]),$Avg([[Column1]]))

Multiple $If functions can be included in a single calculated field. The results can be used with arithmetic formulas or simple

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

20Reference

concatenation to form the final value of the calculated field.

($If(Trigger,TrueValue,FalseValue)+[[Value]])*$If(Trigger,TrueValue,FalseValue)/2This formula takes the conditional result of the first $If statement and adds it to the amount in the Value field, then multiplies that by the conditional result of the second $If statement, and divides the entire value by 2.

Tip: When using functions within functions, be sure to close the parentheses for all functions at the appropriate places. The total number of closing parentheses in the entire formula must match the number of opening parentheses, and misplaced parentheses cause errors.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

21Reference

Interpolation/Extrapolation

The process of interpolation or extrapolation involves taking a known set of paired values, like the x and y-values of points in a grid, and determining unknown y-values from known x-values. Determining values within the known range is called interpolation, while determining values beyond the known range is called extrapolation.

The $InterpolatedLookup function takes a lookup table already defined in Bridge as the known set, and will interpolate or extrapolate a value of y for a specific value of x.

The function is constructed as follows:

$InterpolatedLookup(p0,p1,p2)P0 (text): The Code of the table containing the data. The first column of the table must be a numeric column to be used as the y-values.P1 (text): The name of the column containing the x-values. This must be a numeric column with unique values.P2 (numeric): The x-value for which to calculate the y-value.

The function sorts the points by the x-values in the P1 column, and then finds the two points nearest to the x-value provided as P2, shown as the dotted vertical line in the examples below. For x-values within the known range, the function finds the closest points above and below the x-value. For x-values lower than the known range, the function finds the two points with the lowest x-values, and for values higher than the range, it finds the two points with the highest x-values.

Those two points are used to determine a linear rate of increase or decrease, shown as the dashed line in the examples below.

Examples:Sample Data

X Y1 2

2 2.3

3 3.4

4 5

5 5

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

22Reference

This graph shows the source data. The x-axis comes from the column identified in P1, and the y-axis comes from the first column of the table provided in P0.

With an x-value of -1, the function selects the points at (1, 2) and (2, 2.3) as the nearest points.

With an x-value of 2.5, the function selects the points at (2, 2.3) and (3, 3.4) as the nearest points.

With an x-value of 7, the function selects the points at (5, 5) and (6, 4) as the nearest points.

6 4

The point where the dashed line crosses the dotted line is the interpolated or extrapolated point. The value of y at that point is determined using the following calculation.

Where (x1, y1) and (x2, y2) are the two nearest points.

y= y1+(x−x1 ) y2− y1

x2−x1

The calculated value of y is then returned by the function.

Some exceptions exist:

If the P2 value exactly matches an x-value in the P1 column, the function returns the associated y value. If the table only contains one row of data, interpolation/extrapolation is not possible. The function will return the single y-

value. If the P0 lookup table is empty, the function will return 0.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

23Reference

Full Function List

The following is a complete list of all functions currently available in the system.

For each function, the following information is provided: The full name of the function, plus placeholders (in green) for the required parameters. A brief description of the function. A list of the required parameters (if any), the required format, and any notes about the parameters. The value that is returned by the function, and the format of the response.

Tips: When using a function that refers to a date field in the submission form, if the field is blank it is considered to be 0001/01/01. If this could create unwanted results from the calculation, either set the field to Required or use the $If function to return a safe value if the field is blank.

The system stores all dates in the full system format "2014-10-28T18:16:12.3313239-04:00". When pulling dates from date picker fields or functions that return full dates, this will be handled automatically. However, when providing literal date values within a calculated field, the dates must be provided in this format.

$DaysBetween(p0,p1)Counts the number of days that have elapsed between two dates.

P0 (date): First date fieldP1 (date): Second date fieldReturns (numeric): Number of days between p0 and p1. If the first date is earlier than the second date, the value will be positive. If the first date is later than the second date, the value will be negative.

eg.Comparing date 4/22/2014 and 4/24/2014 returns 2.Comparing date 4/26/2014 and 4/24/2014 returns -2.

$MonthsBetween(p0,p1)Counts the number of months that have elapsed between two dates.

P0 (date): First date fieldP1 (date): Second date fieldReturns (numeric): Number of calendar months between p0 and p1. If the first date is earlier than the second date, the value will be positive. If the first date is later than the second date, the value will be negative.

eg.Comparing date 2/24/2014 and 4/24/2014 returns 2.Comparing date 6/24/2014 and 4/24/2014 returns -2.

$YearsBetween(p0,p1)

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

24Reference

Counts the number of years that have elapsed between two dates.P0 (date): First date fieldP1 (date): Second date fieldReturns (numeric): Number of years between p0 and p1. Difference is calendar years. If the first date is earlier than the second date, the value will be positive. If the first date is later than the second date, the value will be negative.

eg.Comparing date 4/24/2012 and 4/24/2014 returns 2.Comparing date 4/24/2016 and 4/24/2014 returns -2.

$DaysInPeriod(p0,p1,p2,p3)Similar to the $DateOverlap function, this function compares two date ranges to determine if they overlap, counting the number of days that are common between the two ranges.

P0 (date): Start date of the first date rangeP1 (date): End date of the first date rangeP2 (date): Start date of the second date rangeP3 (date): End date of the second date rangeReturns (numeric): Number of days that are included in both ranges. Note that the start and end dates are included in each range. Time of day is not taken into account. If there is no overlap, the function returns 0.

eg. If the first date range is from January 1st to June 30th and the second range is from June 15th to August 31st, the function returns 17, counting the overlapping days at the end of June.If the first date range is from January 1st to January 31st and the second range is from January 10th to January 20th, the function returns 11, since the full second range is included within the first range.

$DateOverlap(p0,p1,p2,p3,p4,p5)Similar to the $DaysInPeriod function, this function compares two date ranges to determine if they overlap, returning one value if they do, and returning a different value if they do not. If any of the four date fields are missing or invalid, the P5 value (no overlap) is returned.

P0 (date): Start date of the first date rangeP1 (date): End date of the first date rangeP2 (date): Start date of the second date rangeP3 (date): End date of the second date rangeP4 (matches type of field): The value to return if there is an overlap between the date rangesP5 (matches type of field): The value to return if there is no overlap between the date rangesReturns (any): Either the value entered as P4 or P5.

$TodayXml()Obtains the current date from the server.

No parameters.Returns (date): The current Date, formatted for use in other functions.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

25Reference

$TodayLong()Obtains the current date from the server.

No parameters.Returns (text): The current Date, in Long Date format.

eg. Monday, June 15, 2011

$TodayShort()Obtains the current date from the server.

No parameters.Returns (text): The current Date, in Short Date format. The date will be formatted according to the browser language settings at the time the field was last calculated.

eg. 15/6/2011 or 6/15/2011

$AddDays(p0,p1)Takes a provided date and adds a specified number of days.

P0 (date): Date fieldP1 (numeric): Number of days to addReturns (date): Date which is the addition of p1 days to date p0.

$AddMonths(p0,p1)Takes a provided date and adds a specified number of months.

P0 (date): Date fieldP1 (numeric): Number of months to addReturns (date): Date which is the addition of p1 months to date p0.

$AddYears(p0,p1)Takes a provided date and adds a specified number of years.

P0 (date): Date fieldP1 (numeric): Number of years to addReturns (date): Date which is the addition of p1 years to date p0.

$GetYear(p0)Takes a provided date and returns just the year.

P0 (date): Date fieldReturns (numeric): Returns the year of p0.

eg. If p0 = 15/10/2011, returns 2011.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

26Reference

$GetMonth(p0)Takes a provided date and returns just the month.

P0 (date): Date fieldReturns (numeric): Returns the month of p0, from 1 to 12

eg. If p0 = 15/10/2011, returns 10.

$GetDayOfYear(p0)Takes a provided date and returns the number of the day, counted from January 1st.

P0 (date): Date fieldReturns (numeric): Returns the numeric day of the year from p0.

eg. If p0 = 15/02/2010, returns 46.

$GetDayOfMonth(p0)Takes a provided date and returns the number of the day, counted from the first day of the month.

P0 (date): Date fieldReturns (numeric): Returns the numeric day of the month from p0.

eg. If p0 = 15/02/2010, returns 15.

$GetMonthsFromCurrent(p0)Takes a provided date and compares it to the current date, returning the number of months difference.

P0 (date): Date fieldReturns (numeric): Number of calendar months from p0 to the current date. Dates earlier than the current date will return a positive value, dates later than the current date will return a negative value.

$GetDaysFromCurrent(p0)Takes a provided date and compares it to the current date, returning the number of days difference.

P0 (date): Date fieldReturns (numeric): Number of calendar days from p0 to the current date. Dates earlier than the current date will return a positive value, dates later than the current date will return a negative value.

$GetYearsFromCurrent(p0)Takes a provided date and compares it to the current date, returning the number of years difference.

P0 (date): Date fieldReturns (numeric): Number of calendar years from p0 to the current date. Dates earlier than the current date will return a positive value, dates later than the current date will return a negative value.

$DateLong(p0)Converts a provided date into the long date format.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

27Reference

P0 (date): Date fieldReturns (text): Date p0 in long date format.

eg. If p0 = 15/06/2011, returns Monday, June 15, 2011

$DateShort(p0)Converts a provided date into the short date format.

P0 (date): Date fieldReturns (text): Date p0 in short date format.

eg. If p0 = Monday, June 15, 2011, returns 15/6/2011

$CustomDateFormat(p0,p1)Advanced function. Converts a provided date into a custom date format.

P0 (date): Date fieldP1 (text): String containing .NET formatting instructionsReturns (text): Returns date p0 in format provided in P1.

$IsAbnValid(p0)Validates a text field to determine if the content is a valid Australian Business Number (ABN).

P0 (text): Field to be examinedReturns (numeric): 1 if the field contains a valid ABN, or returns 0 if the value is not valid for any reason (too short, contains

letters/special characters, failed encoding check, etc.)

$UserContainsRole(p0)Checks the current user’s account to determine if it has a specific security role.

P0 (text): Name of security roleReturns (numeric): 1 if current user account has role p0, 0 if it does not.

$IsNewBusiness(p0)Checks if a provided submission, identified by transaction id, is new business.

P0 (numeric): Transaction ID number of the submissionReturns (numeric): 1 if given transactionID is new business, 0 if it is not.

$Compare(p0,p1,p2,p3)Compares two source values and returns one value if they match, or a different value if they do not match. The values are compared as raw text, and only an exact match will return the true value.

P0 (text): The first source value for comparison.P1 (text): The second source value for comparison.P2 (text): The value to return if the comparison values are an exact match.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

28Reference

P3 (text): The value to return if the comparison values do not match exactly.Returns (text): The value for either P2 or P3, depending on whether the source values match or not.

$GetTermStatus(p0)Retrieves the current status of the provided submission or policy, identified by transaction id.

P0 (numeric): Transaction ID number of the submission or policyReturns (text): Returns the current status of the submission or policy.

$GetTransactionType(p0)Retrieves the current type of the provided transaction, identified by transaction id.

P0 (numeric): Transaction ID number of the submission or policyReturns (text): Returns the current type of the transaction.

$GetTransactionStatus(p0)Retrieves the current status of the provided transaction, identified by transaction id.

P0 (numeric): Transaction ID number of the submission or policyReturns (text): Returns the current status of the transaction.

$GetTermNumber(p0)Returns the sequential term number of the provided transaction.

P0 (numeric): Transaction ID number of the submission. The [[SubPolSystemID]] placeholder can be used to automatically insert the Transaction ID of the current transaction.Returns (numeric): Returns the number of the current term.

eg. The original policy returns 1, the first renewal returns 2, the second renewal returns 3, etc.

$NextAdjustmentNumber([[SubPolSystemID]])Returns the next adjustment number in line for the term.

[[SubPolSystemID]]: This is a placeholder that automatically inserts the transaction ID for the current transaction. This parameter should not be changed.Returns (numeric): Returns the number that will be assigned to the next bound adjustment in the current term.

eg. In a newly created term with no adjustments, this function returns 1. If 3 adjustments have been bound in the current term, this function returns 4.

$NextEndorsementNumber([[SubPolSystemID]])Returns the next endorsement number in line for the term.

[[SubPolSystemID]]: This is a placeholder that automatically inserts the transaction ID for the current transaction. This parameter should not be changed.Returns (numeric): Returns the number that will be assigned to the next bound endorsement in the current term.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

29Reference

eg. In a newly created term with no endorsements, this function returns 1. If 3 endorsements have been bound in the current term, this function returns 4.

$TotalGrossPremiumAmount()Returns the total gross premium for the current quote.

No parameters.Returns (numeric): Returns the combined total of all premium types included in the current quote.

$TotalCommissionAmount()Returns the total calculated commission for the current quote.

No parameters.Returns (numeric): Returns the combined total commission from all premium types included in the current quote.

$TotalTaxesAmount()Returns the total calculated taxes for the current quote.

No parameters.Returns (numeric): Returns the combined total taxes of all premium types included in the current quote.

$CreatedByFirstName([[SubPolSystemID]])Returns the first name of the user who created the transaction.

[[SubPolSystemID]]: This is a placeholder that automatically inserts the transaction ID for the current transaction. This parameter should not be changed.Returns (text): Returns the first name of the user who created the transaction. See the Concatenation section for instructions on combining multiple text results.

$CreatedByLastName([[SubPolSystemID]])Returns the last name of the user who created the transaction.

[[SubPolSystemID]]: This is a placeholder that automatically inserts the transaction ID for the current transaction. This parameter should not be changed.Returns (text): Returns the last name of the user who created the transaction. See the Concatenation section for instructions on combining multiple text results.

$ModifiedByFirstName([[SubPolSystemID]])Returns the first name of the last user to make changes to the transaction.

[[SubPolSystemID]]: This is a placeholder that automatically inserts the transaction ID for the current transaction. This parameter should not be changed.Returns (text): Returns the first name of the last user to make changes to the transaction. See the Concatenation section for instructions on combining multiple text results.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

30Reference

$ModifiedByLastName([[SubPolSystemID]])Returns the last name of the last user to make changes to the transaction.

[[SubPolSystemID]]: This is a placeholder that automatically inserts the transaction ID for the current transaction. This parameter should not be changed.Returns (text): Returns the last name of the last user to make changes to the transaction. See the Concatenation section for instructions on combining multiple text results.

$Count(p0)Counts the number of records in a range of fields.

P0 (any type): Any mix of fields and grid columns.Returns (numeric): Number of records in collection p0.

$Sum(p0)Calculates the sum of a range of fields.

P0 (numeric collection): Any mix of numeric fields, grid columns, and policy details.Returns (numeric): The sum of elements in collection p0.

$Avg(p0)Calculates the average of all values in a specified range of fields.

P0 (numeric collection): Any mix of numeric fields and grid columns.Returns (numeric): The average value in collection p0.

$Round(p0,p1,p2)Takes a provided numeric value or field, and rounds it to the nearest value, according to the selected mode.

P0 (numeric): Value to be rounded P1 (Positive Integer): Precision or nearest value. Rounds to the appropriate multiple of the provided value.P2 (Integer): Rounding mode:

0 = Rounds to the nearest multiple of P1, with the exact midpoint rounding up. 1 = Rounds up to the next multiple of P1. 2 = Rounds down to the next multiple of P1.

Returns (numeric): Round off p0 parameter to the appropriate multiple of p1 according to the round mode p2

$Exp(p0,p1)Calculates exponential values.

P0 (numeric): Base value P1 (numeric): Exponential value.Returns (numeric): Returns the value of p0 to the power of p1.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

31Reference

Exceptions: 0 or any positive base number to the power of 0 will return 1.0 base to the power of any negative number will return 0.Any negative base number to the power of any decimal value will return 0.

eg. $Exp(2,3) will return 8. $Exp(2,0) will return 1. $Exp(0,-3) will return 0. $Exp(-2,3.5) will return 0.

$InterpolatedLookup(p0,p1,p2)Calculates interpolated or extrapolated information. When provided with a range of known values in an (x, y) grid, this function will take a specific x-value and determine its y-value using the existing data.For a detailed description of this function, see the Interpolation/Extrapolation section.

P0 (text): The Code of the table containing the data. The first column of the table must be a numeric column to be used as the y-values.P1 (text): The name of the column containing the x-values. This must be a numeric column with unique values.P2 (numeric): The x-value for which to calculate the y-value.Returns (numeric): The interpolated or extrapolated value of y.

Exceptions: If the P2 value exactly matches an x-value in the P1 column, the function returns the associated y-value.If the table only contains one row of data, interpolation/extrapolation is not possible. The function will return the single y-value.If the P0 lookup table is empty, the function will return 0.

$AdjustedMonths(p0,p1,p2)Divides one number by another, and adds 1 to the total if the remainder exceeds a specific amount. This function is commonly used to determine how many months are in a specific number of days, possibly including a partial month.

P0 (numeric): The dividend, the number to be dividedP1 (numeric): The divisor, the number to divide byP2 (numeric): If the remainder equals or exceeds this value, the result is increased by 1Returns (integer): The whole number resulting from the division and remainder.

eg. This function can be used to convert a number of days into months, with any remainder meeting or exceeding 16 days counting as an additional full month. Enter the number of days, which can come from a field or other function, divide by the average length of a month, 30 (for example), and set the remainder threshold to 16.

$AdjustedMonths([[DaysField]],30,16)If [[DaysField]] equals 130, the number of months is 4 with a remainder of 10. Since 10 is less than the remainder threshold, the final value is 4.If [[DaysField]] equals 78, the number of months is 2 with a remainder of 18. Since 18 is more than the remainder threshold, the final value is 3.

$Min(p0)Identifies the lowest value in a specified range of fields.

P0 (numeric collection): Any mix of numeric fields and grid columns.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

32Reference

Returns (numeric): The minimum value in collection p0.

$Max(p0)Identifies the highest value in a specified range of fields.

P0 (numeric collection): Any mix of numeric fields and grid columns.Returns (numeric): The maximum value in collection p0

$SetMin(p0,p1,p2)Identifies the lowest value in a specified range of fields, and compares it to a provided minimum or maximum value.

P0 (numeric collection): Any mix of numeric fields and grid columns.P1 (numeric): The minimum or maximum value returned, depending on the Mode.P2 (numeric): Mode

0 = P1 is a minimum value 1 = P1 is a maximum value

Returns (numeric): Mode 0 = Lowest value of p0, unless it is lower than p1, in which case p1 is returned. Mode 1 = Lowest value of p0, unless it is not as low as p1, in which case p1 is returned.

$SetMax(p0,p1,p2)Identifies the highest value in a specified range of fields, and compares it to a provided minimum or maximum value.

P0 (numeric collection): Any mix of numeric fields and grid columns.P1 (numeric): The maximum or minimum value returned, depending on the Mode.P2 (numeric): Mode:

0 = P1 is a maximum value 1 = P1 is a minimum value

Returns (numeric): Mode 0 = Highest value of p0, unless it is higher than p1, in which case p1 is returned. Mode 1 = Highest value of p0, unless it is not as high as p1, in which case p1 is returned.

$Parent(p0)For use with multi-level parent and child grids. This function is used within a child grid to search all parent grids for the specified column, then returns the value from that column correlated to each entry in the child grid.

P0 (text): The field (column) Code to be found among the parent grids. This condition is literal and must contain the Code of the field, no placeholders or functions can be used here.Returns (any): The correlated value from the selected field in the parent grid.

$Child(p0)

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

33Reference

For use with multi-level parent and child grids. This function is used within a parent grid to search all child grids for the specified column, then returns all values from that column correlated to each entry in the parent grid.

P0 (text): The field (column) Code to be found among the child grids. This condition is literal and must contain the Code of the field without any square brackets, no placeholders or functions can be used here.

For example: $Child(FieldCode)Returns (any): The correlated values from the selected field in the child grid. Multiple values are returned separated by pipe characters ( | ). The results can be displayed directly using a text field, but this function is primarily intended for use within other grid related functions such as $Sum, $Count, and $Avg. Since this function can return multiple values, it cannot be used in calculations or as a condition in functions that expect a single input value.

$Replace(p0:Label,p1,p2)When pulling data from a grid, field, or function that returns multiple values, the results are received in a delimited format where the values are separated by the pipe ( | ) character. This function removes the pipe characters and replaces them with characters defined in the parameters. This allows the results to be displayed on-screen, or in generated e-mails and documents, in a clean and legible format. Missing values are skipped without adding an extra separator.

P0 (source): Field or function that returns multiple values.:Label (optional): When pulling data from a field that uses an option list (checkbox groups, drop downs, include / exclude, multi

selects, and radio buttons), the default [[Placeholder]] format will return the codes for the selected options. Using [[Placeholder:Label]] will return the labels for the selected options instead of the codes.

P1 (text, optional): The text to be replaced. Note that P1 and P2 must both be used, or neither should be used. If both P1 and P2 are left out, the function defaults to just replacing the pipe character.

P2 (text, optional): The text that will replace the P1 text. Note that P1 and P2 must both be used, or neither should be used. If both P1 and P2 are left out, the function defaults to a comma followed by a space. The comma, round brackets ( ), and double-square brackets [[ ]] should not be used.

Returns (text): Text string with all pipe characters or P1 text replaced by a comma and a space or the P2 text.eg. $Replace([[StatesField]])

If the [[StatesField]] column has three states, the results would be "New York, Florida, California" (without the quotes).$Replace([[OptionsList:Label]],R-,Region )

If the [[OptionsList]] field is a multi-select with "Canada R-1", "US R-1", "Europe R-2", and "China R-6" selected, the results would be "Canada Region 1|US Region 1|Europe Region 2|China Region 6". Note the space after "Region " in the parameters.

$Replace($Replace([[OptionsList:Label]],R-,Region ))With the previous function included in a standard replace without P1 and P2, the results can then have the pipes replaced. The results of this function would be "Canada Region 1, US Region 1, Europe Region 2, China Region 6".

Notes: This function changes the data to a single string of text. Even if the source was a grid column, the results of this function cannot be used in a repeater to build a table in a document or e-mail.If the P2 parameter includes any mathematical symbols, such as +, -, and /, the String: prefix should be used to return the results as text and prevent the system from trying to resolve the results as a mathematical equation.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

34Reference

$GetOFACScan(p0)Takes a provided field and compares the text to standard OFAC lists of names and places under government sanctions.

P0 (text): Text field to be scannedReturns (numeric): Match value from a standard OFAC scan based on the input parameter p0. The returned value is from 0 to 100,

100 being a perfect match, 0 being no match.

$Compliance(p0,p1,...)Takes a provided field and compares the text to one or more lists of names and places under sanctions.

P0 (text): Text field to be scannedP1 (text): Code of the first list the data should be checked against. At least one list must be included, but additional lists can be

provided, separated by commas. See Appendix A - $Compliance Function Parameters for all available lists and their codes.Returns (numeric): Match value based on the input parameter p0. The returned value is from 0 to 100, 100 being a perfect match, 0

being no match. If more than one list is provided, the highest value is returned.

$Lookup(p0,p1,...,p10)Takes one or more condition fields and checks a lookup table for the value that matches the conditions, returning that value. Lookup tables are configured in the Lookup Tables option in the Product Design menu. For details about configuring lookup tables, see the Lookup Tables section of the User Guide - Product Design document.

P0 (any): Code of the lookup table to be checkedP1 (any): The first condition to be used in identifying the appropriate value. Additional conditions can be added, separated by

commas. The number of conditions in the function should match the number of conditions in the target lookup table. If the function includes more conditions than exist in the table, the function does not return any value. If the table includes more conditions than are used in the function, the function returns the first value that matches the conditions. There is a maximum of ten conditions.

Returns (any): The function checks the Effective Date of the current transaction, and looks for any versions of the lookup table that are valid for that date. If more than one version is valid for the date, the most recent table is used. The functions returns the first value in the table that matches all of the conditions. If the lookup table does not have a version valid for the date, the function does not return any value.If the function is used to lookup numerical values, the function can be used as-is. If the values include text or any non-numerical characters, the String: prefix must be used (detailed here).

$If(p0,p1,p2)Evaluates a trigger and returns one value or another.

P0 (trigger) Code of trigger to be evaluatedP1 (matches type of field): The value to return if the trigger evaluates as trueP2 (matches type of field): The value to return if the trigger evaluates as falseReturns (matches type of field): Parameter 1 or 2, depending on the result of the trigger.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

35Reference

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

36Reference

Reference

Appendix A - $Compliance Function Parameters

When using the $Compliance function, the codes below are used as parameters.

List Name Code

Australian Department of Foreign Affairs and Trade Australia Dept of Foreign Affairs and Trade

Bureau of Industry and Security Bureau of Industry and Security

Chiefs of State and Foreign Cabinet Members Chiefs of State and Foreign Cabinet Members

Commodity Futures Trading Commission Sanctions Commodity Futures Trading Commission Sanctions

Defense Trade Controls Debarred Parties DTC Debarred Parties

European Union Consolidated List EU Consolidated List

Excluded Parties List System EPLS

FBI Hijack Suspects FBI Hijack Suspects

FBI Most Wanted FBI Most Wanted

FBI Most Wanted Terrorists FBI Most Wanted Terrorists

FBI Seeking Information FBI Seeking Information

FBI Top Ten Most Wanted FBI Top Ten Most Wanted

Financial Action Task Force FATF Financial Action Task Force

Foreign Agents Registrations Foreign Agents Registrations

Her Majesty’s Treasury’s Investment Ban List HM Treasury Investment Ban List

HM Treasury Sanctions Watchlist HM Treasury Sanctions

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

37Reference

Hong Kong Monetary Authority Hong Kong Monetary Authority

Housing and Urban Developement Limited Denials of Participation HUD LDP

Interpol Most Wanted Interpol Most Wanted

Ireland Financial Regulator Unauthorized Firms Ireland Financial Regulator Unauthorized Firms

Japan Financial Services Agency Japan FSA

Japan Ministry of Economy Trade and Industry—Weapons of Mass Destruction Proliferators

Japan METI-WMD Proliferators

Japan Ministry of Finance Sanctions Japan MOF Sanctions

Monetary Authority of Singapore Monetary Authority of Singapore

Nonproliferation Sanctions Nonproliferation Sanctions

Office of Foreign Assets Control Non-SDN Entities OFAC Non-SDN Entities

Office of Foreign Assets Control Sanctions OFAC Sanctions

Office of Foreign Assets Control Specially Designated Nationals OFAC SDN

Office of the Inspector General Exclusions OIG Exclusions

OSFI Consolidated List—Canada OSFI Consolidated List

OSFI Country OSFI Country

Offshore Financial Centers Offshore Financial Centers

Peoples Bank of China (PBC) Peoples Bank of China (PBC)

Primary Money Laundering Concern Primary Money Laundering Concern

Primary Money Laundering Concern—Jurisdictions Primary Money Laundering Concern - Jurisdictions

Reserve Bank of Australia Reserve Bank of Australia

Terrorist Exclusion List Terrorist Exclusion List

UK HM Treasury List Bank of England Consolidated List

United Kingdom Financial Services Authority UK FSA

United Nations Consolidated List UN Consolidated List

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

38Reference

Unauthorized Banks Unauthorized Banks

World Bank Ineligible Firms World Bank Ineligible Firms

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

39Reference

Appendix B - Full Placeholders List for Policy Information

Placeholders are the identifying codes that allow live data to be pulled from the system for use in generated documents, e-mails, and calculated fields. But not all placeholders work in all three formats, some require different codes for different formats, others require specific conditions for the calculated field.

This section identifies all placeholders for the Policy module, and provides the necessary information to use the placeholders effectively.

Format: Each placeholder is displayed in a grid like the one below.Document E-mail Field

Name: The information being accessed by the placeholder. Availability

Word Ribbon The path to find the placeholder in the Workflow Explorer window when creating a document template. Presented as Group Name / Item Name. When searching in the Field Lookup list, the fields are shown as Item Name (Group Name).

E-mail The placeholder to use in email templates.

Calculated Field The placeholder or XML path for use in calculated fields.

Notes: Any notes about using the placeholders.

Client Information

Document E-mail Field

Client Address Word Ribbon Company Client / Client Address

E-mail [[InsuredAddress]]

Calculated Field [[InsuredAddress]]

Document E-mail Field

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

40Reference

Client City Word Ribbon Company Client / Client City

E-mail [[InsuredCity]]

Calculated Field [[InsuredCity]]

Document E-mail Field

Client Contact First Name Word Ribbon Company Client / Client Contact First Name

E-mail [[InsuredContactFirstName]]

Calculated Field [[InsuredContactFirstName]]

Document E-mail Field

Client Contact Last Name Word Ribbon Company Client / Client Contact Last Name

E-mail [[InsuredContactLastName]]

Calculated Field [[InsuredContactLastName]]Document E-mail Field

Client Contact Phone Word Ribbon Company Client / Client Contact Phone

E-mail [[InsuredContactPhone]]

Calculated Field [[InsuredContactPhone]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.Document E-mail Field

Client Country Word Ribbon Company Client / Client Country

E-mail [[InsuredCountry]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

41Reference

Calculated Field [[InsuredCountry]]

Document E-mail Field

Client Fax Word Ribbon Company Client / Client Fax

E-mail [[InsuredFax]]

Calculated Field [[InsuredFax]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.

Document E-mail Field

Client Name Word Ribbon Company Client / Client Name

E-mail [[InsuredCompanyName]]

Calculated Field [[InsuredCompanyName]]

Document E-mail Field

Client Phone Word Ribbon Company Client / Client Phone

E-mail [[InsuredPhone]]

Calculated Field [[InsuredPhone]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.

Document E-mail Field

Client State Word Ribbon Company Client / Client State

E-mail [[InsuredState]]

Calculated Field [[InsuredState]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

42Reference

Document E-mail Field

Client Website Word Ribbon Company Client / Client Website

E-mail [[InsuredWebsite]]

Calculated Field [[InsuredWebsite]]

Document E-mail Field

Client Zip/Postal Code Word Ribbon Company Client / Client Zip/Postal Code

E-mail [[InsuredZip]]

Calculated Field [[InsuredZip]]

Distributor Information

Document E-mail Field

Distributor Address Word Ribbon Distributor / Distributor Address

E-mail [[DistributorAddress]]

Calculated Field [[DistributorAddress]]

Document E-mail Field

Distributor City Word Ribbon Distributor / Distributor City

E-mail [[DistributorCity]]

Calculated Field [[DistributorCity]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

43Reference

Document E-mail Field

Distributor Client Code Word Ribbon Distributor / Distributor Client Code

E-mail [[DistributorClientCode]]

Calculated Field [[DistributorClientCode]]

Document E-mail Field

Distributor Code Word Ribbon Distributor / Distributor Code

E-mail [[DistributorCode]]

Calculated Field [[DistributorCode]]

Document E-mail Field

Distributor Commission Word Ribbon Distributor / Distributor Commission

E-mail [[DistributorCommission]]

Calculated Field [[DistributorCommission]]

Document E-mail Field

Distributor Country Word Ribbon Distributor / Distributor Country

E-mail [[DistributorCountry]]

Calculated Field [[DistributorCountry]]

Document E-mail Field

Distributor Fax

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

44Reference

Word Ribbon Distributor / Distributor Fax

E-mail [[DistributorFax]]

Calculated Field [[DistributorFax]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.

Document E-mail Field

Distributor Name Word Ribbon Distributor / Distributor Name

E-mail [[DistributorName]]

Calculated Field [[DistributorName]]

Document E-mail Field

Distributor Phone Word Ribbon Distributor / Distributor Phone

E-mail [[DistributorPhone]]

Calculated Field [[DistributorPhone]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.

Document E-mail Field

Distributor Reference Code Word Ribbon Distributor / Distributor Reference Code

E-mail [[DistributorReferenceCode]]

Calculated Field [[DistributorReferenceCode]]

Document E-mail Field

Distributor State/Province Word Ribbon Distributor / Distributor State/Province

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

45Reference

E-mail [[DistributorStateProvince]]

Calculated Field [[DistributorStateProvince]]

Document E-mail Field

Distributor Website Word Ribbon Distributor / Distributor Website

E-mail [[DistributorWebsite]]

Calculated Field [[DistributorWebsite]]

Document E-mail Field

Distributor Zip/Postal Code Word Ribbon Distributor / Distributor Zip/Postal Code

E-mail [[DistributorZipPostalCode]]

Calculated Field [[DistributorZipPostalCode]]

Insurer Information

Document E-mail Field

Insurer Address Word Ribbon Insurer / Insurer Address

E-mail [[InsurerAddress]]

Calculated Field [[InsurerAddress]]

Document E-mail Field

Insurer City Word Ribbon Insurer / Insurer City

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

46Reference

E-mail [[InsurerCity]]

Calculated Field [[InsurerCity]]

Document E-mail Field

Insurer Client Code Word Ribbon Insurer / Insurer Client Code

E-mail [[InsurerClientCode]]

Calculated Field [[InsurerClientCode]]

Document E-mail Field

Insurer Code Word Ribbon Insurer / Insurer Code

E-mail [[InsurerCode]]

Calculated Field [[InsurerCode]]

Document E-mail Field

Insurer Country Word Ribbon Insurer / Insurer Country

E-mail [[InsurerCountry]]

Calculated Field [[InsurerCountry]]

Document E-mail Field

Insurer Fax Word Ribbon Insurer / Insurer Fax

E-mail [[InsurerFax]]

Calculated Field [[InsurerFax]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

47Reference

Document E-mail Field

Insurer Name Word Ribbon Insurer / Insurer Name

E-mail [[InsurerName]]

Calculated Field [[InsurerName]]

Document E-mail Field

Insurer Phone Word Ribbon Insurer / Insurer Phone

E-mail [[InsurerPhone]]

Calculated Field [[InsurerPhone]]

Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.

Document E-mail Field

Insurer Reference Code Word Ribbon Insurer / Insurer Reference Code

E-mail [[InsurerReferenceCode]]

Calculated Field [[InsurerReferenceCode]]

Document E-mail Field

Insurer Risk Percentage Word Ribbon Insurer / Insurer Risk Percentage

E-mail [[InsurerRiskPercentage]]

Calculated Field [[InsurerRiskPercentage]]

Document E-mail Field

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

48Reference

Insurer State/Province Word Ribbon Insurer / Insurer State/Province

E-mail [[InsurerStateProvince]]

Calculated Field [[InsurerStateProvince]]

Document E-mail Field

Insurer Website Word Ribbon Insurer / Insurer Website

E-mail [[InsurerWebsite]]

Calculated Field [[InsurerWebsite]]

Document E-mail Field

Insurer Zip/Postal Code Word Ribbon Insurer / Insurer Zip/Postal Code

E-mail [[InsurerZipPostalCode]]

Calculated Field [[InsurerZipPostalCode]]

Policy Information

Document E-mail Field

Policy Created Date Word Ribbon Policy Information / Created Date

E-mail [[CreatedDate]]

Calculated Field [[CreatedDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

49Reference

Document E-mail Field

Policy First Quoted Date Word Ribbon Policy Information / First Quoted Date

E-mail [[FirstQuotedDate]]

Calculated Field [[FirstQuotedDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Document E-mail Field

Policy Last Quoted Date Word Ribbon Policy Information / Last Quoted Date

E-mail [[LastQuotedDate]]

Calculated Field [[LastQuotedDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Document E-mail Field

Product Word Ribbon Policy Information / Product

E-mail [[SubPolProduct]]

Calculated Field [[SubPolProduct]]

Document E-mail Field

Cancellation Date Calculated Field [[CancellationInfoUserControl/CancellationDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

50Reference

Document E-mail Field

Cancellation Reason Word Ribbon Policy Information / Cancellation Reason Name

E-mail [[CancellationReason]]

Calculated Field [[CancellationInfoUserControl/CancellationReason]]

Document E-mail Field

Cancellation Reason - Other Word Ribbon Policy Information / Cancellation Reason - Other Description

E-mail [[IfOtherSpecify]]

Calculated Field [[CancellationInfoUserControl/IfOtherSpecify]]

Document E-mail Field

Reinstatement Reason Word Ribbon Policy Information / Reinstatement Reason Name

E-mail [[ReinstatementReason]]

Calculated Field [[ReinstatementReasonInfoUserControl/ReinstatementReason]]

Transaction Information

Document E-mail Field

Transaction ID Word Ribbon Policy Information / System ID

E-mail [[SubPolSystemID]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

51Reference

Calculated Field [[SubPolSystemID]]

Notes: The leading zeroes are removed by default. To keep the zeroes, the placeholder must be prefixed by String: and the field must be a text field.

Document E-mail Field

Created By First Name Word Ribbon Policy Information / Created By First Name

E-mail [[CreatedByFirstName]]

Calculated Field See the $CreatedByFirstName() function.

Document E-mail Field

Created By Last Name Word Ribbon Policy Information / Created By Last Name

E-mail [[CreatedByLastName]]

Calculated Field See the $CreatedByLastName() function.

Document E-mail Field

Modified By First Name Word Ribbon Policy Information / Modified By First Name

E-mail [[ModifiedByFirstName]]

Calculated Field See the $ModifiedByFirstName() function.

Document E-mail Field

Modified By Last Name Word Ribbon Policy Information / Modified By Last Name

E-mail [[ModifiedByLastName]]

Calculated Field See the $ModifiedByLastName() function.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

52Reference

Document E-mail Field

Last Status Changed By First Name Word Ribbon Policy Information / Last Status Changed By First Name

E-mail [[LastStatusChangedByFirstName]]

Document E-mail Field

Last Status Changed By Last Name Word Ribbon Policy Information / Last Status Changed By Last Name

E-mail [[LastStatusChangedByLastName]]Document E-mail Field

Status Calculated Field [[SubPolStatus]]

Document E-mail Field

Effective Date Word Ribbon Policy Information / Effective Date

E-mail [[PolicyEffectiveDate]]

Calculated Field [[PolicyEffectiveDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Document E-mail Field

Valid Until Date Word Ribbon Policy Information / Valid Until Date

E-mail [[PolicyValidUntilDate]]

Calculated Field [[PolicyValidUntilDate]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

53Reference

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Document E-mail Field

Bound Date Word Ribbon Policy Information / Bound Date

E-mail [[BoundDate]]

Calculated Field [[BoundDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.

Document E-mail Field

Quote Expiry Date Word Ribbon Policy Information / Quote Expiry Date

E-mail [[QuoteExpiryDate]]

Document E-mail Field

Endorsement Number Word Ribbon Policy Information / Endorsement Number

E-mail [[EndorsementNumber]]

Document E-mail Field

Adjustment Number Word Ribbon Policy Information / Adjustment Number

E-mail [[AdjustmentNumber]]

Document E-mail Field

Lost Reason

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

54Reference

Word Ribbon Policy Information / Lost Reason

E-mail [[LostReasonLabel]]

Calculated Field [[LostReasonLabel]]

Current Transaction Premium, Commission, Tax Information

Document E-mail Field

Premium Type Name Word Ribbon Premium Information / Premium Type

E-mail [[Premium_PremiumType]]

Calculated Field [[PremiumInfo[PremiumTypeId='#']/PremiumType]]

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Gross Premium Amount Word Ribbon Premium Information / Gross Premium Amount

E-mail [[Premium_Amount]]

Calculated Field [[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/GrossPremium]][[PremiumInfo[PremiumType='name']/Amount]][[PremiumInfo[PremiumTypeId='#']/Amount]]

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type Name or ID.

Document E-mail Field

Total Gross Premium Amount

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

55Reference

Word Ribbon Premium Summary / Total Gross Premium Amount

E-mail [[TotalGrossPremiumAmount]]

Calculated Field See the $TotalGrossPremiumAmount() function.

Document E-mail Field

Commission Word Ribbon Premium Information / Commission

E-mail [[Premium_CommissionAmount]]

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

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Total Commission Amount Word Ribbon Premium Summary / Total Commission Amount

E-mail [[TotalCommissionAmount]]

Calculated Field See the $TotalCommissionAmount() function

Document E-mail Field

Net Premium Word Ribbon Premium Information / Net Premium

E-mail [[Premium_NetPremium]]

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

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

56Reference

Total Net Premium Amount Word Ribbon Premium Summary / Total Net Premium Amount

E-mail [[TotalNetPremiumAmount]]

Document E-mail Field

Tax Name Calculated Field [[TaxDefinition[PremiumTypeId='#']/TaxName]]

Notes: Values must be called individually by premium type ID.

Document E-mail Field

Tax Amount Calculated Field [[TaxDefinition[PremiumTypeId='#']/CalculatedAmount]]

Notes: Values must be called individually by premium type ID.

Document E-mail Field

Total Taxes Amount Word Ribbon Premium Summary / Total Taxes Amount

E-mail [[TotalTaxesAmount]]

Calculated Field See the $TotalTaxesAmount() function

Current Transaction Limit Information

Document E-mail Field

Limit Premium Type Name Word Ribbon Limit Information / Limit Premium Type

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

57Reference

E-mail [[Limit_PremiumType]]

Notes: Use repeaters.

Document E-mail Field

Limit Description Word Ribbon Limit Information / Limit Description

E-mail [[Limit_Description]]

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

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Limit Type Word Ribbon Limit Information / Limit Type

E-mail [[Limit_LimitType]]

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

Notes: Use repeaters for documents and e-mails. This returns the full limit type name.For calculated fields, values must be called individually by premium type ID. This returns an abbreviated version of the limit type name.

Document E-mail Field

Limit Amount Word Ribbon Limit Information / Limit Amount

E-mail [[Limit_Amount]]

Calculated Field [[LimitList/Limit[PremiumType='#']/Amount]][[LimitList/Limit[PremiumType='#' and Description='description']/Amount]]

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

58Reference

If more than one limit exists for any premium type, a second qualifier must be used to locate individual values. Unique Descriptions should be assigned to each limit, which can then be isolated using the Description='description' condition.

Document E-mail Field

Limit Currency Word Ribbon N/A

E-mail [[Limit_Currency]]

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

Notes: Use repeaters for documents and e-mails.For use in generated documents, insert a different placeholder, press Alt+F9 to view the code, update the code to read { MERGEFIELD Limit_Currency }, right-click in the placeholder and select Update Field, the press Alt+F9 to return to normal.For calculated fields, values must be called individually by premium type ID.

Current Transaction Deductible Information

Document E-mail Field

Deductible Premium Type Name Word Ribbon Deductible Information / Deductible Premium Type

E-mail [[Deductible_PremiumType]]

Notes: Use repeaters.

Document E-mail Field

Deductible Description Word Ribbon Deductible Information / Deductible Description

E-mail [[Deductible_Description]]

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

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

59Reference

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Deductible Type Word Ribbon Deductible Information / Deductible Type

E-mail [[Deductible_DeductibleType]]

Calculated Field [[DeductibleList/Deductible[PremiumType='#']/DeductibleType]]

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Deductible Amount or Percentage Word Ribbon N/A

E-mail [[Deductible_AmountOrPercentage]]

Calculated Field [[DeductibleList/Deductible[PremiumType='#']/AmountOrPercentage]]

Notes: Identifies if the Deductible is a flat Amount or a Percentage of another value.Use repeaters for documents and e-mails.For use in generated documents, insert a different placeholder, press Alt+F9 to view the code, update the code to read { MERGEFIELD Deductible_AmountOrPercentage }, right-click in the placeholder and select Update Field, the press Alt+F9 to return to normal.For calculated fields, values must be called individually by premium type ID.

Document E-mail Field

Deductible Amount Word Ribbon Deductible Information / Deductible Amount

E-mail [[Deductible_Amount]]

Calculated Field [[DeductibleList/Deductible[PremiumType='#']/Amount]][[DeductibleList/Deductible[PremiumType='#' and Description='description']/Amount]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

60Reference

Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by premium type ID.If more than one Deductible exists for any premium type, a second qualifier must be used to locate individual values. Unique Descriptions should be assigned to each Deductible, which can then be isolated using the Description='description' condition.

Document E-mail Field

Deductible Currency Word Ribbon N/A

E-mail [[Deductible_Currency]]

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

Notes: Use repeaters for documents and e-mails.For use in generated documents, insert a different placeholder, press Alt+F9 to view the code, update the code to read { MERGEFIELD Deductible_Currency }, right-click in the placeholder and select Update Field, the press Alt+F9 to return to normal.For calculated fields, values must be called individually by premium type ID.

Current Term Information

Document E-mail Field

Current Term Policy Number Word Ribbon Policy Information / Policy Number

E-mail [[SubPolPolicyNo]]

Calculated Field [[SubPolPolicyNo]]

Notes: If the policy number is numeric with certain dividing characters (eg: 2013-0012-17), the String: prefix may be necessary for the value to display properly.

Document E-mail Field

Current Term ID

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

61Reference

Word Ribbon Policy Information / Policy Term ID

E-mail [[SubPolPolicyTermID]]

Calculated Field [[SubPolPolicyTermID]]

Notes: The leading zeroes are removed by default. To keep the zeroes, the placeholder must be prefixed by String: and the field must be a text field.

Document E-mail Field

Current Term Effective Date Word Ribbon Term Information / Term Effective Date

E-mail [[TermEffectiveDate]]

Calculated Field [[CurrentTerm/EffectiveDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.This data is only updated on calculating quote. If the effective date is changed, it will not be reflected in this placeholder until a new quote is calculated.

Document E-mail Field

Current Term Expiry Date Word Ribbon Term Information / Term Expiry Date

E-mail [[TermExpiryDate]]

Calculated Field [[CurrentTerm/ExpiryDate]]

Notes: In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. In a text field, the date and time is shown in the internal system format.This data is only updated on calculating quote. If the expiry date is changed, it will not be reflected in this placeholder until a new quote is calculated.

Document E-mail Field

Current Term Number Word Ribbon Term Information / Term Number

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

62Reference

E-mail [[TermNumber]]

Document E-mail Field

Current Term Premium Amount Calculated Field [[CurrentTerm/Premium/PremiumInfo[PremiumType='name']/Amount]]

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

Notes: Values must be called individually by premium type Name or ID.

Document E-mail Field

Current Term Total Premium Amount Word Ribbon Term Information / Term Total Premium

E-mail [[TermTotalPremium]]

Calculated Field [[CurrentTerm/Premium/TotalPremiumAmount]]

Document E-mail Field

Current Term Commission Amount Calculated Field [[CurrentTerm/Premium/PremiumInfo[PremiumType='name']/CommissionAmount]]

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

Notes: Values must be called individually by premium type Name or ID.

Document E-mail Field

Current Term Total Commission Amount Calculated Field [[CurrentTerm/Premium/TotalCommissionAmount]]

Document E-mail Field

Current Term Tax Amount by Premium Calculated Field [[CurrentTerm/Premium/PremiumInfo[PremiumType='name']/TotalTaxAmount]]

[[CurrentTerm/Premium/PremiumInfo[PremiumTypeId='#']/TotalTaxAmount]][[CurrentTerm/Premium/PremiumInfo[PremiumType='name']/Taxes/Tax[TaxDescription='name']/TaxAmount]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

63Reference

[[CurrentTerm/Premium/PremiumInfo[PremiumTypeId='#']/Taxes/Tax[TaxDescription='name']/TaxAmount]]

Notes: Values must be called individually by premium type Name or ID.If more than one Tax exists for any premium type, a second qualifier must be used to locate individual values. Use the name of the tax in the [TaxDescription='name'] qualifier as shown.

Document E-mail Field

Current Term Total Tax Amount Calculated Field [[CurrentTerm/Premium/TotalTaxAmount]]

Previous Term Information

Document E-mail Field

Previous Term Policy Number Word Ribbon Term Information / Previous Term Policy Number

E-mail [[PreviousTermPolicyNumber]]

Calculated Field [[PreviousTerm/PolicyNumber]]

Notes: If the policy number is numeric with certain dividing characters (eg: 2013-0012-17), the String: prefix may be necessary for the value to display properly.

Document E-mail Field

Previous Term Premium Name by Premium Id Calculated Field [[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/PremiumType]]

Notes: Values must be called individually by premium type ID.

Document E-mail Field

Previous Term Premium Amount Calculated Field [[PreviousTerm/Premium/PremiumInfo[PremiumType='name']/Amount]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

64Reference

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

Notes: Values must be called individually by premium type Name or ID.

Document E-mail Field

Previous Term Total Premium Amount Calculated Field [[PreviousTerm/Premium/TotalPremiumAmount]]

Document E-mail Field

Previous Term Commission Amount Calculated Field [[PreviousTerm/Premium/PremiumInfo[PremiumType='name']/CommissionAmount]]

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

Notes: Values must be called individually by premium type Name or ID.

Document E-mail Field

Previous Term Total Commission Amount Calculated Field [[PreviousTerm/Premium/TotalCommissionAmount]]

Document E-mail Field

Previous Term Tax Amount by Premium Calculated Field [[PreviousTerm/Premium/PremiumInfo[PremiumType='name']/TotalTaxAmount]]

[[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/TotalTaxAmount]][[PreviousTerm/Premium/PremiumInfo[PremiumType='name']/Taxes/Tax[TaxDescription='name']/TaxAmount]][[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/Taxes/Tax[TaxDescription='name']/TaxAmount]]

Notes: Values must be called individually by premium type Name or ID.If more than one Tax exists for any premium type, a second qualifier must be used to locate individual values. Use the name of the tax in the [TaxDescription='name'] qualifier as shown.

Document E-mail Field

Previous Term Total Tax Amount

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

65Reference

Calculated Field [[PreviousTerm/Premium/TotalTaxAmount]]

System Date

Document E-mail Field

Day - Double Digit Word Ribbon System Date / Day - Double Digit

E-mail [[dd]]

Document E-mail Field

Day - Single Digit Word Ribbon System Date / Day - Single Digit

E-mail [[%d]]

Document E-mail Field

Formatted Date 1 Word Ribbon System Date / Formatted Date 1

E-mail [[MM/dd/yyyy]]

Document E-mail Field

Formatted Date 2 Word Ribbon System Date / Formatted Date 2

E-mail [[M/d/yyyy]]

Document E-mail Field

Formatted Date 3

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

66Reference

Word Ribbon System Date / Formatted Date 3

E-mail [[dd/MM/yyyy]]

Document E-mail Field

Formatted Date 4 Word Ribbon System Date / Formatted Date 4

E-mail [[d/M/yyyy]]

Document E-mail Field

Full Date -> Monday, June 15, 2009 1:45 PM Word Ribbon System Date / Full Date -> Monday, June 15, 2009 1:45 PM

E-mail [[f]]

Document E-mail Field

Full Month Name Word Ribbon System Date / Full Month Name

E-mail [[MMMM]]

Document E-mail Field

Long Date -> Monday, June 15, 2009 Word Ribbon System Date / Long Date -> Monday, June 15, 2009

E-mail [[D]]

Document E-mail Field

Month - Double Digit Word Ribbon System Date / Month - Double Digit

E-mail [[MM]]

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

67Reference

Document E-mail Field

Month - Single Digit Word Ribbon System Date / Month - Single Digit

E-mail [[%M]]

Document E-mail Field

Month Day - June 15 Word Ribbon System Date / Month Day - June 15

E-mail [[M]]

Document E-mail Field

Short Date -> 6/15/2009 Word Ribbon System Date / Short Date -> 6/15/2009

E-mail [[d]]

Document E-mail Field

Year Word Ribbon System Date / Year

E-mail [[yyyy]]

Document E-mail Field

Year Month -> June, 2009 Word Ribbon System Date / Year Month -> June, 2009

E-mail [[Y]]

Other

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

68Reference

Document E-mail Field

URL to Current Transaction E-mail [[URL]]

Notes: When an e-mail is generated in relation to a submission, this placeholder is replaced by a full URL leading to the first screen of the submission. If the person using the link is already logged in with an active session, they are brought straight to the submission. If they are not logged in, they are brought to the login page. Once they successfully log in, they are brought to the submission.

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

69Reference

Index

$$AddDays function 24$AddMonths function 24$AddYears function 24$AdjustedMonths function 30$Avg function 29$Child function 31$Compare function 26$Compliance function 33, 35$Count function 29$CreatedByFirstName function 28$CreatedByLastName function 28$CustomDateFormat function 26$DateLong function 25$DateOverlap function 23$DateShort function 26$DaysBetween function 22$DaysInPeriod function 23$Exp function 29$GetDayOfMonth function 25$GetDayOfYear function 25$GetDaysFromCurrent function 25$GetMonth function 24$GetMonthsFromCurrent function 25$GetOFACScan function 33$GetTermNumber function 27$GetTermStatus function 27$GetTransactionStatus function 27$GetTransactionType function 27$GetYear function 24$GetYearsFromCurrent function 25$If function 18, 33$InterpolatedLookup function 20, 30$IsAbnValid function 26

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

70Reference

$IsNewBusiness function 26$Lookup function 33$Max function 31$Min function 30$ModifiedByFirstName function 28$ModifiedByLastName function 29$MonthsBetween function 22$NextAdjustmentNumber function 27$NextEndorsementNumber function 27$Parent function 31$Replace function 32$Round function 29$SetMax function 31$SetMin function 31$Sum function 29$TodayLong function 24$TodayShort function 24$TodayXml function 23$TotalCommissionAmount function 28$TotalGrossPremiumAmount function 28$TotalTaxesAmount function 28$UserContainsRole function 26$YearsBetween function 22AAdd operator 2Adjustment Number placeholder 52Appendix A - $Compliance Function Parameters 35Appendix B - Full Placeholders List for Policy Information 38Arithmetic Expressions 4BBound Date placeholder 52Building Formulas 2CCalculated Field placeholders 38Cancellation Date placeholder 49Cancellation Reason - Other placeholder 49Cancellation Reason placeholder 49Client Address placeholder 38

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

71Reference

Client City placeholder 38Client Contact First Name placeholder 39Client Contact Last Name placeholder 39Client Contact Phone placeholder 39Client Country placeholder 39Client Fax placeholder 40Client Information 38Client Name placeholder 40Client Phone placeholder 40Client State placeholder 40Client Website placeholder 41Client Zip/Postal Code placeholder 41Close Bracket operator 2Code field 3, 5, 20Commission Details 5, 7, 9Commission placeholder 54Compare Data Against Sanction or Watch Lists 17Concatenation (combining data) 4Conditional Results 18Created By First Name placeholder 50Created By Last Name placeholder 50Current Term Commission Amount placeholder 61Current Term Effective Date placeholder 60Current Term Expiry Date placeholder 60Current Term ID placeholder 60Current Term Information 7, 59Current Term Number placeholder 61Current Term Policy Number placeholder 59Current Term Premium Amount placeholder 61Current Term Tax Amount by Premium placeholder 62Current Term Total Commission Amount placeholder 61Current Term Total Premium Amount placeholder 61Current Term Total Tax Amount placeholder 62Current Transaction Deductible Information 57Current Transaction Information 5Current Transaction Limit Information 55Current Transaction Premium, Commission, Tax Information 53

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

72Reference

DDay - Double Digit placeholder 64Day - Single Digit placeholder 64Deductible Amount or Percentage placeholder 58Deductible Amount placeholder 58Deductible Currency placeholder 59Deductible Description placeholder 57Deductible Premium Type Name placeholder 57Deductible Type placeholder 58Deductibles 12Defining Multiple Fields in a Function 15Defining String Data 3Distributor Address placeholder 41Distributor City placeholder 41Distributor Client Code placeholder 42Distributor Code placeholder 42Distributor Commission placeholder 42Distributor Country placeholder 42Distributor Fax placeholder 43Distributor Information 41Distributor Name placeholder 43Distributor Phone placeholder 43Distributor Reference Code placeholder 43Distributor State/Province placeholder 44Distributor Website placeholder 44Distributor Zip/Postal Code placeholder 44Divide operator 2EEffective Date 33Effective Date placeholder 51E-mail placeholders 38Endorsement Number placeholder 52FField Management page 3Formatted Date 1 placeholder 64Formatted Date 2 placeholder 64Formatted Date 3 placeholder 65Formatted Date 4 placeholder 65

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

73Reference

Full Date placeholder 65Full Function List 22Full Month Name placeholder 65Functions 14GGross Premium Amount placeholder 53Guide 1IInsurer Address placeholder 44Insurer City placeholder 45Insurer Client Code placeholder 45Insurer Code placeholder 45Insurer Country placeholder 45Insurer Fax placeholder 45Insurer Information 44Insurer Name placeholder 46Insurer Phone placeholder 46Insurer Reference Code placeholder 46Insurer Risk Percentage placeholder 46Insurer State/Province placeholder 47Insurer Website placeholder 47Insurer Zip/Postal Code placeholder 47Interpolation/Extrapolation 20Introduction 1LLast Status Changed By First Name placeholder 51Last Status Changed By Last Name placeholder 51Limit Amount placeholder 56Limit Currency placeholder 57Limit Description placeholder 56Limit Premium Type Name placeholder 56Limit Type placeholder 56Limits 11Long Date placeholder 65Lookup Tables 33Lost Reason placeholder 53MModified By First Name placeholder 50

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

74Reference

Modified By Last Name placeholder 51Month - Double Digit placeholder 65Month - Single Digit placeholder 66Month Day placeholder 66Multiply operator 2NName column 13Net Premium placeholder 54OOpen Bracket operator 2Operators 2, 4Other 67PPipe Character 15Placeholders Within Formulas 3Policy Created Date placeholder 47Policy First Quoted Date placeholder 48Policy Information 47Policy Last Quoted Date placeholder 48Policy Number 10Policy Placeholders 5Premium Details 5, 7, 9Premium Type List page 13Premium Type Management page 13Premium Type Name placeholder 53Premium Types menu item 13Previous Term Commission Amount placeholder 63Previous Term Information 9, 62Previous Term Policy Number placeholder 62Previous Term Premium Amount placeholder 63Previous Term Premium Name by Premium Id placeholder 62Previous Term Tax Amount by Premium placeholder 63Previous Term Total Commission Amount placeholder 63Previous Term Total Premium Amount placeholder 63Previous Term Total Tax Amount placeholder 64Product Design menu 13Product placeholder 48

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

75Reference

QQuote Expiry Date placeholder 52RReference 35Reinstatement Reason placeholder 49Retrieving Premium IDs 13SShort Date placeholder 66Simple Arithmetic Formulas 2Status placeholder 51Straight Quotes 5String modifier 4Subtract operator 2System Date 64TTax Amount placeholder 55Tax Details 6, 8, 10Tax Name placeholder 55Term Period Dates 8Total Commission Amount placeholder 54Total Gross Premium Amount placeholder 54Total Net Premium Amount placeholder 55Total Taxes Amount placeholder 55Transaction ID placeholder 50Transaction Information 49UURL to Current Transaction placeholder 67VValid Until Date placeholder 52Verifying User Security Roles 16WWord Ribbon placeholders 38YYear Month placeholder 66Year placeholder 66

Version 2.3.1 Bridge User Guide User Guide - Calculated Fields

Copyright Notice

Copyright © 1998 - 2015 Oceanwide Inc. All Rights Reserved.

All material in this document and on this website are protected by copyright and intellectual property laws and are the property of Oceanwide Inc. ®™

No part of this document may be reproduced, stored in a retrieval system, or transmitted by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission from the owner Oceanwide Inc.®™ Printed and published in Montreal, Quebec CANADA.

Trademarks

All trademarks, registered trademarks and service marks in this document are exclusive to Oceanwide Inc. ®™.

Disclaimer

The publisher Oceanwide Inc. ®™ and authors specifically disclaim any responsibility for any liability, loss, or risk; whether corporate, personal or otherwise in whole or in part of which; is incurred as a consequence directly or indirectly of the application use; or reliance on or any of the contents of this document (documentation).