guide · web viewsome word processing programs will replace straight quotes with angled quotes or...

Calculated Fields Reference Guide

Version 1.7

1BRIDGE: Calculated Fields Reference Guide

INTRODUCTION.............................................................................................................................................................. 2

Guide 2

EXPRESSIONS................................................................................................................................................................... 3

Operators 3

Arithmetic Expressions 3

Expressions with Placeholders 3

Defining String Data 4

Concatenation (combining data) 4

POLICY REFERENCES..................................................................................................................................................... 6

Premiums 6

Limits 6

Deductibles 7

Taxes 7

Term Premiums 7

Retrieving Premium IDs 7

FUNCTIONS....................................................................................................................................................................... 9

Calculate the Time Between Two Date Fields 9

Discovering User Specific Roles 9

Defining Multiple Fields in a Function 9

Specify a Time Before or After a Date Field 10

Compare Data Against Sanction or Watch Lists 10

Conditional Results 11

Full Function List 12

APPENDIX A................................................................................................................................................................... 19

v1.7.0 BRIDGE: Calculated Fields Reference Guide


Introduction

Welcome to the Bridge Calculated Fields Reference Guide. This document is intended to provide a functional overview of Calculated Fields within Bridge and provide explanations of using basic expressions as well as advanced functions.

GuideClick a link to jump to the desired section.

Expressions Details how operators are used, how to build arithmetic expressions, and how to build expressions with system reference placeholders.

Policy References Details how to use a calculated Field to reference and leverage policy related information.

Functions Details of specific functions included within Bridge to perform calculations against data in submission Fields.



Expressions

The following section describes how operators are used, how to build arithmetic expressions, and how to build expressions with system reference placeholders within calculated fields.

OperatorsBridge recognizes common arithmetic operators as follows:

+ Plus

- Minus

* Multiply

/ Divide

( Open bracket

) Close bracket

$ Denotes a Function name

Arithmetic ExpressionsWithin calculated fields you can build most standard arithmetic expressions for numerical output using the operators described above.

For example:3 x 6 ÷ (5 + 15 – 0.3) x 0.6

Would be input into a calculated field as:

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

Expressions with PlaceholdersCalculated fields allow you to build arithmetic expressions using numerical data, either manually input or generated by Bridge, by inserting placeholders that refer to Fields within a submission. Placeholders are built using double square brackets around the System Reference for any given Field.

For example:100 x The Number of Trucks – 50

Would be input into a calculated field as:

100*[[NumberOfTrucks]]-50

Where, NumberOfTrucks denotes the specific “System Reference” name for the Field “The Number of Trucks”.



Notes: A calculated field cannot be used as a placeholder within another calculated field.

In order for any field to be used within a calculated field, it must be included in the workflow with the calculated field.

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

Defining String DataIn some situations, 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.

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

For 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 or Arithmetic Expressions are used between placeholders and/or data entered directly in the formula, the system will simply pull in the placeholder data without any modifications.

This is useful for merging data that is collected separately, but needs to be used together. For example, if a user's first name and last name are collected in separate fields, the following formula could be used:

String:[[FirstName]] [[LastName]]

Note: The String: notation must be used to display text in fields, emails, and generated documents.



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 will be combined without a space.

Another example would be to assemble an address:

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

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



Policy References

This section describes how to use a Calculated Field to reference and leverage policy related information within Bridge.

PremiumsIf you desire to work with Premium related data then you will need to use a Calculated Field to retrieve the relevant values.

For example:

The following placeholders will return the amount of premium for a premium type:

[[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.

It is also possible to return the commission amounts associated to the various premium types:

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

Where # is the Id number of the premium.

Should it be desired to work with the Net or Gross premium amounts, then one of the following placeholders can be used:

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

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

In all cases, changing the premium type name or numerical Id within the function will retrieve the associated premium information as in the examples above.

LimitsIf you desire to work with Limit related data then you will need to use a Calculated Field to retrieve the relevant values.

For Example:

[[LimitList/Limit[n]/Description]] will return description of limit for nth premium type.



[[LimitList/Limit[n]/LimitType]] will return the type of Limit (e.g. Per Occurrence) for the nth premium type.

[[LimitList/Limit[n]/Amount]] will return the limit amount for the nth premium type.

[[LimitList/Limit[n]/Currency]] will return the limit currency for nth premium type.

DeductiblesIf you desire to work with Deductible related data then you will need to use a Calculated Field to retrieve the relevant values.

For Example:

[[DeductibleList/Deductible[n]/Description]] will return the description of deductible for nth premium type.

[[DeductibleList/Deductible[n]/Amount]] will return the deductible amount for nth premium type.

[[DeductibleList/Deductible[n]/Currency]] will return the deductible currency for the nth premium type.

TaxesIf you desire to work with Taxes related data then you will need to use a Calculated Field to retrieve the relevant values.

For example:

[[TaxDefinition[n]/TaxName]] returns the tax name of the nth premium type.

[[TaxDefinition[n]/CalculatedAmount]] returns the calculated tax amount for the nth premium type.

Term PremiumsIf you desire to work with Term Premiums related data then you will need to use a Calculated Field to retrieve the relevant values.

For example:

[[PremiumInfo[PremiumType='Name']/TermAmount]] returns the term premium amount for the Name premium type.

Retrieving Premium IDs



When calling placeholders related to premiums, the premium will need to be identified. For the PremiumType placeholder, the name of the premium or the premium ID can be used. For other premium related placeholders, such as PremiumCommissionInfo, the premium ID should be used.

The order number can also be used in either case, however the order may change in various ways. It is recommended to use the name or ID to ensure the correct premium type is used.

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 will resemble 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 will open the Premium Type Management page. The URL will be 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.



Functions

The following section describes the use of specific functions within Bridge to perform calculations against data in submission Fields. In all cases a Function is denoted by a $ at the beginning of the string.

Note: Certain functions require a specific number of reference parameters in order to evaluate correctly. Different functions may have a different number of required parameters, or none at all.

Calculate the Time Between Two Date FieldsFor any instance where a submission contains more than one Date Field, it is possible to calculate the number of (i) days, (ii) months, or (iii) years between any two (2) of the date fields.

For example:

The number of days between: $DaysBetween([[Date1Field]],[[Date2Field]])The number of months between: $MonthsBetween([[Date1Field]],[[Date2Field]])The number of years between: $YearsBetween([[Date1Field]],[[Date2Field]])

In the above three (3) examples, a function is called (denoted with the $ symbol). The name is not case-sensitive, so $daysbetween would also be acceptable. These particular functions require two (2) reference parameters in order to evaluate correctly, which *must* be date fields, and separated by a comma.

Discovering User Specific RolesIn the event that a value or Trigger depends on a specific User Role, the following function can be used:

$UserContainsRole(UserRole)

Where UserRole denotes the specific system name for the User Role you desire to identify, such as Underwriter Supervisor.

The slightly unusual thing about this function is it returns a “1” for true, and “0” for false. So please take care when setting up your Triggers.

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 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 will automatically retrieve 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]])

Specify a Time Before or After a Date FieldA calculated Field can also be used to generate the number of days, months, or years before or after a specified Date Field within a Submission.

Examples:

Here is how to output a date 30 days after an existing date field:

$DateShort($AddDays([[MyDateField]],30))

Outputs a date 30 days after MyDateField’s date in Short Date format. (eg. 6/1/2009)

Similarly, here is how to output a date 30 days before an existing date Field:

$DateLong($AddDays([[MyDateField]],-30))

Outputs a date 30 days before MyDateField’s date in Long Date format (eg. Wednesday June 1, 2009)

By substituting the functions $AddMonths or $AddYears for $AddDays in the above examples would also work in a similar fashion.

Compare Data Against Sanction or Watch ListsOne or more fields can be compared to one or more sanction or watch lists from around the world.

Examples:



Comparing 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.Outputs a numerical value from 0 (no match) to 100 (perfect match).

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.

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 will be returned.

See Appendix A for a table of all lists and their associated codes.

Conditional ResultsThe $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 will return 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(TriggerReference, TrueValue, FalseValue)

If TriggerReference is true, the TrueValue will be returned, otherwise the FalseValue will be returned.

Note: The System Reference 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) or their spouse's name (also concatenated).

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.Tip: Be sure to close the parentheses for both functions at the end. The total number of closing parentheses in the entire formula must match the number of opening parentheses.

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

Multiple $If functions can be included in a single calculated field. The results can be used with arithmetic expressions or simple concatenation to form the final value of the calculated field.

Example:

($If(Trigger,TrueValue,FalseValue)+[[Value]])*$If(Trigger,TrueValue,FalseValue)/2

This formula will take the conditional result of the first $IF statement and add it to the amount in the Value field, then multiply that by the conditional result of the second $IF statement, and divide the entire value by 2.

Full Function ListThe 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), identifying the required format, plus any notes

about the parameters. The value that will be returned by the function, and in what format it will be.

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

P0 (date) First date fieldP1 (date) Second date field



Returns (numeric): Number of days between p0 and p1.eg. Comparing date Feb20/2010 and Feb22/2010 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.

eg. Comparing date Feb28/2010 and Mar1/2010 returns 1.

$YearsBetween(p0,p1)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.eg. Comparing date Dec15/2010 and Jan1/2011 returns 1.

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

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

$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.

eg. 15/6/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.

$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.

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

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.



$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.Note: This function will be changed in the future to return a Boolean type.

$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.Note: This function will be changed in the future to return a Boolean type.

$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.

$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 and grid columns.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.

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



P0 (numeric collection) Any mix of numeric fields and grid columns.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.

$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.

$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.



$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.

$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 will be 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 for all available lists and their codes.

Returns (numeric): Match value based on the input parameter p0. The returned value will be from 0 to 100, 100 being a perfect match, 0 being no match. If more than one list is provided, the highest value will be returned.

$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 (numeric) Precision or nearest valueP2 (numeric) Rounding mode:

- 0 = Round from midpoint- 1 = Round upward- 2 = Round downward

Returns (numeric): Round off p0 parameter to the nearest value p1 according to the round mode p2

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

P0 (trigger) System Reference 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.



Appendix A

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

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

Japan METI-WMD Proliferators



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

Unauthorized Banks Unauthorized Banks

World Bank Ineligible Firms World Bank Ineligible Firms


guide · web viewsome word processing programs will replace straight quotes with angled quotes or...

Documents