bridge user guide - calculated fields · web viewsome word processing programs replace straight...
Post on 20-May-2020
11 Views
Preview:
TRANSCRIPT
0Table of Contents
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
Bridge
User Guide - Calculated Fields
Version 2.4.82
iTable of Contents
Table of Contents
TABLE OF CONTENTS.........................................................................................I
INTRODUCTION...................................................................................................2
Guide...........................................................................................................................2
BUILDING FORMULAS........................................................................................3Operators........................................................................................................................... 3Simple Arithmetic Formulas...............................................................................................3Placeholders Within Formulas............................................................................................4Defining String Data...........................................................................................................4Concatenation (combining data)........................................................................................5
PLACEHOLDERS.................................................................................................7
Current Transaction Information..............................................................................7Premium Details................................................................................................................. 7Commission Details...........................................................................................................7Tax Details......................................................................................................................... 8
Current Term Information..........................................................................................9Premium Details................................................................................................................. 9Commission Details...........................................................................................................9Tax Details....................................................................................................................... 10Term Period Dates...........................................................................................................10
Previous Term Information.....................................................................................11Premium Details...............................................................................................................11Commission Details.........................................................................................................11Tax Details....................................................................................................................... 12Policy Number.................................................................................................................. 12
Limits.........................................................................................................................13
Deductibles...............................................................................................................14
Retrieving Premium IDs...........................................................................................15
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
iiTable of Contents
FUNCTIONS........................................................................................................16
Working with Boolean Values.................................................................................17
Defining Multiple Fields in a Function...................................................................18
Conditional Results – the If() Function..................................................................19Using Data and Comparison Operators as the Condition................................................19Using a Trigger as the Condition......................................................................................21Defining the Results.........................................................................................................22
Detailed Function Descriptions..............................................................................24Verifying User Security Roles...........................................................................................24Compare Data Against Sanction or Watch Lists..............................................................24Identifying When Fields Have Changed After an Integration............................................25Interpolation/Extrapolation...............................................................................................28Custom Date Format Function.........................................................................................30Functions to Enter Data Into Grids (Grid Mapping)..........................................................33
Full Function Reference List...................................................................................37
REFERENCE......................................................................................................56
Appendix A – Compliance() Function Parameters...............................................56
Appendix B - Full Placeholders List for Policy Information................................59Client Company Information.............................................................................................59Individual Client Information.............................................................................................63Distributor Information......................................................................................................65Insurer Information...........................................................................................................70Policy Information.............................................................................................................74Transaction Information...................................................................................................77Compliance Information...................................................................................................82Quote Information............................................................................................................86Current Transaction Premium, Commission, Tax Information..........................................89Current Transaction Limit Information..............................................................................92Current Transaction Deductible Information.....................................................................93Current Term Information.................................................................................................96Previous Term Information...............................................................................................98Billing Workflow Details..................................................................................................100System Date...................................................................................................................103Other.............................................................................................................................. 106
Appendix C - Full Placeholders List for Billing Information..............................109
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
iiiTable of Contents
Invoice Information.........................................................................................................109Statement Information....................................................................................................111Client Information...........................................................................................................117Distributor Information....................................................................................................119Insurer Information.........................................................................................................120Bill To Party Information.................................................................................................122Policy Information...........................................................................................................124Charge Information........................................................................................................126Installment Information...................................................................................................129Billing Integration Fields.................................................................................................130
Appendix D - Full Placeholders List for Claims Information.............................131Claim Information...........................................................................................................131Claim Party Information..................................................................................................134Claim Payment Information, Single Instance..................................................................143Claim Payment Information, Multiple Filtered Payments................................................161
INDEX................................................................................................................165
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
1Reference
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
2Reference
Introduction
Welcome to the Bridge insurance access portal. The system provides a full workflow, from the administration of products and coverage, to the submission and management of individual policies.
Access to all features, options, and data are controlled by the settings in your user account. This guide is for users with product design rights, and details the creation of formulas for use in calculated fields. Calculated fields can be used for simple purposes such as displaying a basic system variable, or can perform a complex calculation pulling in a variety of fields and system information and generating a result to be displayed on-screen, used in documentation, or even used in other calculated fields.
Calculated fields are not limited to numerical values. They can also work with dates and text, providing a wide range of possibilities.
This guide assumes the user is familiar with the general functions of the system. For instructions on logging in and using common features throughout the system, see the User Guide - Introduction document.
Guide
The instructions are divided into the following major categories. Click a link to jump to the appropriate section.
Building Formulas Details the structure for building formulas and pulling in submission information.
Policy Placeholders Provides the syntax for calling policy details into a formula.
Functions Describes the built-in tools used to work with data.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
3Reference
Building Formulas
Formulas are assembled using common logic and notation, and should be familiar for users experienced with formulas in spreadsheet and database applications.
Operators
Bridge uses the following symbols to represent common arithmetic operators.
+ Add
- Subtract
* Multiply
/ Divide
( Open bracket
) Close bracket
Simple Arithmetic Formulas
The above operators are used to build the basic structure of the formula.
Example:3 x 6 ÷ (5 + 15 – 0.3) x 0.6
Would be input into a calculated field as:
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
4Reference
3 * 6 / (5 + 15 - .3) * .6
Note: Spaces are optional, but can be included for clarity. They will be ignored by the system.
Placeholders Within Formulas
The real power of calculated fields in the Bridge system is the ability to pull in information from the system and from the submission or claims form itself. This is achieved using placeholders. When the system encounters a placeholder while resolving a formula, it replaces the placeholder with the current value from the system or workflow.
The placeholders are predefined, and are detailed in the Placeholders section. Placeholders for fields within the submission or claims form are made up of the Code for the field (defined in Field Management), enclosed in double square brackets [[ ]].
Example:100 x The Number of Trucks - 50
Would be input into a calculated field as:
100 * [[NumberOfTrucks]] - 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
Calculated fields are not restricted to using numerical values. Dates and text can also be manipulated using a selection of functions and features.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
5Reference
In some situations, however, the formatting of data could be mistaken for calculations. For example, the date format 5 / 15 / 2012 could be interpreted as 5 divided by 15 divided by 2012, or a policy number with dashes, such as 2012-12345 could be interpreted as 2012 minus 12345.
There are two methods for defining string data.
The String: formatting notation can be used at the beginning of a calculated field formula, and causes the system to treat all values as text. No calculations are performed, and any operators, arithmetic expressions, and spaces are treated as text. Functions and placeholders still function normally, but the resulting data is treated as text.
Example:String:[[field1]]/[[field2]]+[[field3]]
If the values of the three placeholders are 8, 4, and 2 respectively, the value of this calculated field would be 8/4+2, and would be displayed as such in the field and any documents or e-mails that pull in this calculated field.
Any text, numbers, or symbols enclosed in quotes " will be treated as simple text. No calculations will be performed on content within quotes, spaces in quotes will not be removed, and even functions and placeholders will be treated as text instead of being replaced with system information.
Example:"The value of " [[field1]] " / " [[field2]] " + " [[field3]] " equals " [[field1]] / [[field2]] + [[field3]]
If the values of the three placeholders are 8, 4, and 2 respectively, the result of this calculated field would be:
The value of 8 / 4 + 2 equals 4The first set of operators are treated as text and displayed in the output, while the second set are calculated and the result is displayed in the output. Note that the spaces within the quotes are kept, while the spaces outside of the quotes are ignored.
Note: All quotes must be straight quotes " or they will not be recognized. Some word processing programs replace straight quotes with angled quotes or "Smart Quotes". These quotes must be replaced with straight quotes, either in the word processor, or within Bridge.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
6Reference
Concatenation (combining data)
If no Operators are used between placeholders and/or data entered directly in the formula, the system simply pulls in the placeholder data without any modifications.
This is useful for merging fields that are collected separately, but need to be used together.
Examples: If a user's first name and last name are collected in separate fields, the following formulas could be used:
String:[[FirstName]] [[LastName]] -or- [[FirstName]] " " [[LastName]]The value of this field would be FirstName LastName. Note that a space must be included between the placeholders, or the two fields are combined without a space, such as FirstNameLastName.
Another example would be to assemble an address:
String:[[StreetAddress]], [[City]], [[Country]]. -or- [[StreetAddress]] ", " [[City]] ", " [[Country]] "."The commas, spaces, and period are included in the calculated value. For the example using quotes, note that the spaces within the quotes will be kept, while the spaces outside the quotes will be ignored.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
7Reference
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.4.82 Bridge User Guide User Guide - Calculated Fields
8Reference
The following placeholders return the commission amount for a specific premium type, as well as the gross premium and the net premium after commission. The premium types are identified by Id number.
[[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/GrossPremium]]
[[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/CommissionAmount]]
[[PremiumCommissionList/PremiumCommissionInfo[PremiumTypeId='#']/NetPremium]]
Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.
Tax Details
The following placeholders return the tax information for a specific premium type, identified by Id number.
[[TaxDefinition[PremiumTypeId='#']/TaxName]]
[[TaxDefinition[PremiumTypeId='#']/CalculatedAmount]]
Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
9Reference
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.4.82 Bridge User Guide User Guide - Calculated Fields
10Reference
[[CurrentTerm/Premium/TotalCommissionAmount]]
Tax Details
The following placeholders return the term tax amount for a specific premium type, identified by name or Id number.
[[CurrentTerm/Premium/PremiumInfo[PremiumType='Name']/TotalTaxAmount]]
[[CurrentTerm/Premium/PremiumInfo[PremiumTypeId='#']/TotalTaxAmount]]
Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.
The following placeholder returns the total tax amount for the term, for all premium types.
[[CurrentTerm/Premium/TotalTaxAmount]]
Notes: Only values from Bound transactions within the current term are returned. Using these references in a submission may have one value before binding (when the transaction being viewed is not included in the calculation) and a different value after binding (when the transaction being viewed is included in the calculation).
Once a transaction in a particular term is bound, the calculated fields are locked for that transaction. They are not updated if other transactions are subsequently bound within the same term.
Term Period Dates
The following placeholders return the start and end dates of the current term.
[[CurrentTerm/EffectiveDate]]
[[CurrentTerm/ExpiryDate]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
11Reference
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.4.82 Bridge User Guide User Guide - Calculated Fields
12Reference
[[PreviousTerm/Premium/TotalCommissionAmount]]
Tax Details
The following placeholders return the previous term tax amount for a specific premium type, identified by name or Id number.
[[PreviousTerm/Premium/PremiumInfo[PremiumType='Name']/TotalTaxAmount]]
[[PreviousTerm/Premium/PremiumInfo[PremiumTypeId='#']/TotalTaxAmount]]
Where Name is the full name or # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.
The following placeholder returns the total tax amount for the previous term, for all premium types.
[[PreviousTerm/Premium/TotalTaxAmount]]
Note: When a renewal is created, the values for the previous term are copied into the renewal transaction for use with these placeholders. If the previous term is changed in any way (such as by endorsement), the details saved in the renewal transaction may no longer be valid. If the renewal has not yet been bound, it may be possible to delete it and create a new renewal transaction with the updated values.
Policy Number
The following placeholder returns the Policy Number of the previous term.
[[PreviousTerm/PolicyNumber]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
13Reference
Limits
The following placeholders return specific limits information defined for the current transaction. The information is available for each premium type, identified by Id number.
[[LimitList/Limit[PremiumType='#']/Description]]
[[LimitList/Limit[PremiumType='#']/LimitType]]
[[LimitList/Limit[PremiumType='#']/Amount]]
[[LimitList/Limit[PremiumType='#']/Currency]]
Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
14Reference
Deductibles
The following placeholders return specific deductibles information defined for the current transaction. The information is available for each premium type, identified by Id number.
[[DeductibleList/Deductible[PremiumType='#']/Description]]
[[DeductibleList/Deductible[PremiumType='#']/Amount]]
[[DeductibleList/Deductible[PremiumType='#']/Currency]]
Where # is the Id number of the required premium type. See Retrieving Premium IDs below for instructions on identifying the Id number of the required premium type.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
15Reference
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.4.82 Bridge User Guide User Guide - Calculated Fields
16Reference
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 may begin with the $ symbol, followed by round brackets ( ). The $ symbol is optional for some functions, and may be included to help identify functions in complex formulas. 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 optional, but can be included for clarity. They will be ignored by the system.
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.4.82 Bridge User Guide User Guide - Calculated Fields
17Reference
Working with Boolean Values
Triggers and certain functions validate one or more conditions and return either "True" or "False", known as Boolean values. These can be used in a variety of ways.
When evaluating conditions in a trigger or IF() statement, the system retrieves the data to be checked and compares it to the condition value to determine if the statement is true or false.
If the data to be checked is either a boolean function or a field with a saved boolean value, the condition value can be left out. The system will accept the data as the result.
For example, the two following IF() statements will work exactly the same:
If BooleanFunction() = "True" then TrueValue else FalseValue endif
If BooleanFunction() then TrueValue else FalseValue endif
By default, boolean functions return "True" or "False", which will be shown if the results are displayed in the workflow. However, "1" and "Yes" are also recognized as "True" while "0" and "No" are also recognized as "False". These alternate values are mainly supported for compatibility with older calculations, but may be used if necessary. Boolean values are not case-sensitive.
The Checkbox field type stores a boolean value, and can be used without condition values as described above.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
18Reference
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, a comma or Pipe character ( | ) can be used to separate the fields in the list. Using commas is considered the best practice for legibility.
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]]) -or- Avg([[field1]]|[[field2]]|[[field3]])To determine the sum of all records in a column, plus one field outside the grid:
Sum([[column]], [[field]]) -or- Sum([[column]]|[[field]])
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
19Reference
Conditional Results – the If() Function
The If() function is used to define the value of a calculated field based on other data, such as system information or the content of other fields in the workflow.
The condition of the function can either be a pair of values and a comparison operator, or a trigger defined in the system. The function returns one value if the condition evaluates as true, or a different value if the condition evaluates as false.
The condition function can be constructed as follows:
If Value1 operator Value2 then TrueValue else FalseValue endif
-or-
If(TriggerCode, TrueValue, FalseValue)
Using Data and Comparison Operators as the Condition
The Value1 and Value2 data can include placeholders, formulas, or even other functions (including other If() functions).
The operator determines what comparison will be made between the values.
= Checks of the two values are exactly equal.
< Checks if the first value is less than the second value.
> Checks if the first value is greater than the second value.
<= Checks if the first value is less than or equal to the second value.
>= Checks if the first value is greater than or equal to the second value.
<> Checks of the two values are not exactly equal. This can also be achieved using the Not option detailed below.
Examples:
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
20Reference
If Sum([[GridColumn]]) > [[Tolerance]] then TrueValue else FalseValue endif
Uses the Sum() function to determine the total of all values in a grid column, and checks if it is greater than a maximum value found in the [[Tolerance]] field.
If [[RenewalDate]] <= TodayXml() then TrueValue else FalseValue endifRetrieves the value of the [[RenewalDate]] field and checks if it is less than or equal to today's date, retrieved by the TodayXml() function.
Negative Conditions:
Starting the function with If not will check that the conditions are not met. If the conditions evaluate as false, then the TrueValue is returned, else the FalseValue is returned. While using different operators can often achieve the same results, using Not may simplify complex conditions.
Examples:If 5 < 3 then TrueValue else FalseValue endif returns the FalseValue because we are checking that the first value is less than the second.
If not 5 < 3 then TrueValue else FalseValue endif returns the TrueValue because we are checking that the first value is not less than the second.
Combined conditions:
Multiple conditions can be checked within a single If function. Placing multiple Value1 operator Value2 sets, separated by and or or, will evaluate each set individually, then evaluate the and conditions followed by the or conditions.
Example:If 5 < 3 and 8 > 4 or 9 = 9 and 4 > 2 then TrueValue else FalseValue endif
The individual conditions are evaluated first, producing the following results.
If false and true or true and true then TrueValue else FalseValue endif
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
21Reference
The and conditions are evaluated next. An and evaluates to true if both conditions are true, producing the following results.
If false or true then TrueValue else FalseValue endifThe or conditions are evaluated next. An or evaluates to true if either condition is true, producing the following results.
If true then TrueValue else FalseValue endifThe final result is true, so the function returns the TrueValue.
In situations where an or condition must be evaluated before an and condition, brackets () can be used to divide entire sections. The contents of the innermost brackets will be completely evaluated first, then the next brackets out, and so on.
Example:If (5 < 3 and (8 > 4 or 9 = 8)) and 4 > 2 then TrueValue else FalseValue endif
The individual conditions are evaluated first, producing the following results.
If (false and (true or false)) and true then TrueValue else FalseValue endifThe (true or false) is evaluated first. Being an or, it evaluates as true.
If (false and true) and true then TrueValue else FalseValue endifThe (false and true) is evaluated next. Being an and, it evaluates as false.
If false and true then TrueValue else FalseValue endifThe remaining and condition is evaluated, producing in a false result, and the function returns the FalseValue.
Using a Trigger as the Condition
The TriggerCode identifies a trigger, which is created in the system and contains all necessary conditions to evaluate as true or false. For details about configuring triggers, see the Managing Triggers section of the User Guide - Product Design document.
Note: The Code for the trigger must be used. The code is based on the name of the trigger, but may not match exactly.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
22Reference
Defining the Results
The TrueValue and FalseValue data can include placeholders, formulas, or even other functions (including other If() functions). When using the If then else structure, the else can be omitted which produces no result (null) if the function evaluates as false.
Examples:The function could return a monthly value as an annual value, or leave it as one month, depending on the conditions.
If(TriggerCode,[[FieldA]]*12,[[FieldA]])
-or-
If Value1 operator Value2 then [[FieldA]]*12 else [[FieldA]] endif
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).
String:If(TriggerCode,[[UserFirstName]] [[UserLastName]],[[SpouseFirstName]] [[SpouseLastName]])(The String: option is included to ensure that the spaces are treated as text)
-or-
If Value1 operator Value2 then [[UserFirstName]] " " [[UserLastName]] else [[SpouseFirstName]] " " [[SpouseLastName]] endif
(The spaces between the names are enclosed in quotes, or they would be ignored)
Using functions in the True/False values allows these If() functions to return the sum of a table column, or the average of the values in that column.
If(TriggerCode,Sum([[Column1]]),Avg([[Column1]]))
-or-
If Value1 operator Value2 then Sum([[Column1]]) else Avg([[Column1]]) endif
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
23Reference
Multiple If() functions can be included in a single calculated field. The results can be used with arithmetic formulas or simple concatenation to form the final value of the calculated field.
(If(TriggerCode,TrueValue,FalseValue)+[[Value]])*If(TriggerCode,TrueValue,FalseValue)/2
-or-
(If Value1 operator Value2 then TrueValue else FalseValue endif + [[Value]]) * If Value3 operator Value4 then TrueValue else FalseValue endif / 2
These functions 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.
Tip: When using functions within functions or using brackets to control the order of operations, be sure to close all brackets at the appropriate places. The total number of closing brackets in the entire formula must match the number of opening brackets, and misplaced brackets will cause errors.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
24Reference
Detailed Function Descriptions
The following sections provide detailed descriptions of certain functions.
Verifying User Security Roles
Some situations may change depending on the type of user working in the system. The following functions are used to determine if the current user has a specific security role.
For use in the Policy module:
$UserContainsRole(UserRole)
Where UserRole is the Name of the security role as it appears in the system.
For use in the Claims module:
UserContainsSecurityRole(UserRole)
Where UserRole is the Code of the security role.
The function returns “True” if the user has the role, or “False” if they do not. The result can be used in a conditional formula, or as a condition within a trigger.
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:
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
25Reference
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.
Identifying When Fields Have Changed After an Integration
Transaction workflows may contain integration configurations that share data with external systems. In some cases, such as when the integration scans data for security concerns, it is important to know if the user has made changes to certain fields since the last time the integration was run.
This section describes how to assemble the necessary fields and configurations to identify such changes.
Overview:
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
26Reference
Once configured, each time the calculated fields in a transaction are recalculated, the HashAndModifiedOn() function evaluates the tracked fields and generates a composite value derived from those fields. The first time the function runs within a transaction, it stores the composite value (the Hash value) and the current date and time.
Each time it runs after the first time, the function recalculates the composite value and compares it to the stored value. If the value has changed, the old composite value is replaced with the new value and the date and time are updated to the current date and time. Note that this stores the date and time the changes were detected by the function, and not when the changes actually occurred.
In the background, whenever an integration is completed successfully, the system stores the date and time the integration was performed. Each different integration configuration is tracked separately, so the most recent date and time information is available for each. These dates and times can be retrieved using a calculated field, providing a reference date to determine if the data was changed since the last time the integration was performed.
With the date of the integration, and the date that changes were detected in the tracked fields, the IsDateGreaterThan() function is used to compare the dates. If the tracked fields were changed after the last integration, the function returns "True". This result can be used in a trigger to re-run the integration, activate a validation, or affect any other feature that uses the trigger.
Configuration:1. Identify and create the necessary fields.
Tracked Fields These are the fields that will contain the data that will be monitored for changes. These fields may already be part of the workflow, or may be new fields created specifically for tracking. All field types can be tracked.
Note: Use caution when tracking fields that may be changed by the integration. That change will be detected and trigger the integration again, creating a loop.
Hash Reference Field This field will contain the generated composite value from the HashAndModifiedOn() function. This should be a Text Area field with no default value.
Detected Changes Timestamp Field
This field will contain the date and time that the HashAndModifiedOn() function detected changes to the tracked fields.
Hash Function Field This field will contain the HashAndModifiedOn() function. This should be a standalone Text Area field containing just this function.
HashAndModifiedOn(p0, p0, p0, ..., p1, p2)
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
27Reference
P0: Placeholders for all Tracked Fields to be included in the hash calculation should be provided, separated by commas.
P1: The Code of the Hash Reference Field must be the second-to-last parameter after all of the tracked fields. This condition is literal and must contain the Code of the field without any square brackets, no placeholders or functions can be used here.
P2: The Code of the Detected Changes Timestamp Field must be the last parameter. This condition is literal and must contain the Code of the field without any square brackets, no placeholders or functions can be used here.
Example: HashAndModifiedOn([[tracked field 1]], [[tracked field 2]], [[tracked field 3]], HashReferenceFieldCode, DetectedChangesTimestampFieldCode)
Date Comparison Field This field retrieves the date of the integration and compares it to the last detected changes date from the HashAndModifiedOn() function. This field will resolve to "True" if changes are detected after the integration, or "False" if no changes are detected.
IsDateGreaterThan(p0, p1, p2)P0: Placeholder for the Detected Changes Timestamp Field.
P1: Placeholder containing the date and time the relevant integration was last completed successfully. The following placeholder can be placed directly in the function, or can be included in a calculated field that is then referenced in the function.If using a field, a Date Picker field should not be used or the time component will be lost. A Textbox field should be used.
[[Integrations/Integration[Code='code']/StartTime]]The code should be the code of the integration configuration defined for the workflow.
P2: Tolerance in milliseconds. The system date/time format is accurate to a ten-millionth of a second. Even dates that seem to be calculated at the same time will have a small difference. If the P0 date is only greater than the P1 date by less than the provided tolerance, it will not be considered a difference and the function will return false.
Example: IsDateGreaterThan([[Detected Changes Timestamp Field]], [[Integrations/Integration[Code='IntegrationConfigurationCode']/StartTime]], 1000)
With this configuration having a tolerance of 1000 milliseconds, if the Detected Changes Timestamp Field date is earlier than the integration timestamp or less than one second after, it will not be considered a change.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
28Reference
Integration Flag Field If the relevant integration has not yet been performed, the IsDateGreaterThan() function will try to compare the Detected Changes Timestamp Field with a non-existent date, and return an incorrect "true" value.
This field can be any type of field, but must be updated by the relevant integration when it runs. Any triggers created to detect the changes should also check this field to confirm the integration has been performed at least once in the current transaction.
Tip: Any of the fields used in this configuration can be hidden. Since many of the fields will only contain raw data used in the functions, it is probably best to hide them.
2. Once the fields have been configured, the results can be used in triggers. The trigger conditions should check the Date Comparison Field for a true result (Field - Equals - 1) AND the Integration Flag Field should equal the value inserted by the integration.
3. The triggers can then be used to reactivate the integration or for any other controls.
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
29Reference
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:
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.
Sample Data
X Y1 2
2 2.3
3 3.4
4 5
5 5
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
30Reference
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.
Custom Date Format Function
While there are several functions to format dates, sometimes a date needs to be presented in a very specific manner. The Custom Date Format function uses formatting codes that can be mixed and matched to provide an exceptional level of control.
The function is constructed as follows:
CustomDateFormat(Date,"{0:Code}")
Date is the date to be formatted. This can be a constant value or a placeholder. The date must be provided in the full system date format, such as "2016-06-15T14:55:22.1234-04:00". Date picker fields automatically save the date in this format.
Code is the formatting code. See the table of codes below. Some codes must be used alone, while others can be combined.
The formatting code can be pulled from a placeholder. There are two ways to achieve this.
With the function CustomDateFormat(Date,[[CodeField]]), the Code Field must include the full {0:Code} notation. The quotes are not required within the Code Field. If the [[CodeField]] is empty, the function will not return any results.
With the function CustomDateFormat(Date,"{0:"[[CodeField]]"}"), the Code Field only needs to contain the Code. If the [[CodeField]] is empty, the code will default to G.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
31Reference
Codes:
The following are pre-formatted codes that cannot be combined with other codes.
All examples are from the source date "2016-06-15T14:55:22.12-04:00".
Format Code Example Notes
Date (short) d 6/15/2016
Date (long) D Wednesday, June 15, 2016
Time t 2:55 PM
Time, with seconds T 2:55:22 PM
Date (short) and Time g 6/15/2016 2:55 PM
Date (short) and Time, with seconds
G 6/15/2016 2:55:22 PM
Date (long) and Time f Wednesday, June 15, 2016 2:55 PM
Date (long) and Time, with seconds
F Wednesday, June 15, 2016 2:55:22 PM
Month Name and Day M June 15
Month Name and Year Y June, 2016
Date and Time, sortable s 2016-06-15T14:55:22 Date and time can be accurately sorted as text.
Coordinated Universal Time (UTC)
u 2016-06-15 14:55:22Z
RFC 1123 Format r Wed, 15 Jun 2016 14:55:22 GMT
The following are component codes that can be combined to form a custom date format. Components can be divided by spaces, slashes, colons, commas, or periods.
All examples are from the source date "2016-06-15T14:55:22.12-04:00".
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
32Reference
Format Code Example Notes
Year (short) yy 16 A single "y" can be used to show the year as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
Year (long) yyyy 2016
Month (number) MM 06 A single "M" can be used to show the month as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
Month (short name) MMM Jun
Month (long name) MMMM June
Day (number) dd 15 A single "d" can be used to show the day as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
Day (short name) ddd Wed
Day (long name) dddd Wednesday
Hour hh 02 A single "h" can be used to show the hour as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
Hour (24 hour) HH 14 A single "H" can be used to show the hour as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
AM/PM tt PM
Minutes mm 55 A single "m" can be used to show the minutes as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
Seconds ss 22 A single "s" can be used to show the seconds as either 2-digits or 1-digit without any preceding zero, but will only work when other component codes are included.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
33Reference
Milliseconds (with trailing zeros)
fff 120 Up to seven fs can be used to show the necessary precision, with trailing zeros if the source date does not have that many digits.A single "f" can be used to show just the first digit, but will only work when other component codes are included.
Milliseconds (without trailing zeros)
FFF 12 Up to seven Fs can be used to show the necessary precision, without trailing zeros if the source date does not have that many digits.A single "F" can be used to show just the first digit, but will only work when other component codes are included.
Examples: [[SourceDate]] is "2016-06-15T14:55:22.12-04:00".
CustomDateFormat([[SourceDate]],"{0:F}")displays
Wednesday, June 15, 2016 2:55:22 PM
CustomDateFormat([[SourceDate]],"{0:h:mm tt, dddd, MMMM dd}")displays
2:55 PM, Wednesday, June 15
Functions to Enter Data Into Grids (Grid Mapping)
While there are multiple ways to enter data into a grid, they generally require user input. Calculated fields can be used to enter data into grids, either as static values or copied from other fields or grids within the workflow. The functions can add rows, edit or replace existing rows, or clear the grid and start fresh.
The two functions are SaveToGrid() and NewGrid(), and use the same parameters. The difference is that SaveToGrid() adds new rows after any existing rows, while NewGrid() deletes any existing rows and adds new rows to the empty grid.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
34Reference
SaveToGrid(p0, p1_SequenceNo, p2, p3, p4, p3, p4, …)
-or-
NewGrid(p0, p1_SequenceNo, p2, p3, p4, p3, p4, …)
Parameter 0 Code of the target grid. This must be a static code, not enclosed in brackets or quotes.
Parameter 1 This parameter is optional, and is used in conjunction with P2 to update a single row in the target grid. The format is the Code of the target grid followed by "_SequenceNo", such as GridCode_SequenceNo. This must be a static code, not enclosed in brackets or quotes.
Parameter 2 This parameter is optional, and is used in conjunction with P1 to update a single row in the target grid. This is the row number to be updated. This must be an integer, and can be a static value, the result of an embedded formula, or a placeholder to retrieve the value from another field.
Parameter 3 Code of the recipient field in the target grid. This must be a static code, not enclosed in brackets or quotes. There can be multiple recipient fields, but each p3 must be followed by an associated p4 parameter.
Parameter 4 Value to be inserted into the recipient field. This can be a static value or a placeholder to retrieve the value from another field. Each p4 must follow an associated p3 parameter.
If all p4 source fields are within form panels in the primary workflow, known as top-level fields, the functions create one row in the target grid.
If one or more grid fields are used as p4 source fields, the behavior depends on the configuration.
If all grid fields are from the same grid, one new row is created in the target grid for each row in the source grid.
If the source fields are from two or more separate grids, one new row is created in the target grid for each possible combination of the source rows. The number of new rows will equal the number of rows in the first grid, multiplied by the number of rows in the second grid, multiplied by the number of rows in the third grid, and so on. Only rows are multiplied, so taking multiple fields from a single grid will not increase the number of new rows.
For example: With three grids, each with two rows, the following new rows are created.
Grid 1 Row 1 Grid 2 Row 1 Grid 3 Row 1
Grid 1 Row 1 Grid 2 Row 1 Grid 3 Row 2
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
35Reference
Grid 1 Row 1 Grid 2 Row 2 Grid 3 Row 1
Grid 1 Row 1 Grid 2 Row 2 Grid 3 Row 2
Grid 1 Row 2 Grid 2 Row 1 Grid 3 Row 1
Grid 1 Row 2 Grid 2 Row 1 Grid 3 Row 2
Grid 1 Row 2 Grid 2 Row 2 Grid 3 Row 1
Grid 1 Row 2 Grid 2 Row 2 Grid 3 Row 2
If the source fields are from a parent grid with one or more child grids, one new row is created for each parent/child/grandchild combination. Only rows are multiplied, so taking multiple fields from a single grid will not increase the number of new rows.
For example: For a parent grid with one child grid, where the first row in the parent has three child rows, the second parent row has two child rows, and the third parent row has one child row, the following new rows are created.
Grid 1 Row 1 Grid 2 Row 1
Grid 1 Row 1 Grid 2 Row 2
Grid 1 Row 1 Grid 2 Row 3
Grid 1 Row 2 Grid 2 Row 1
Grid 1 Row 2 Grid 2 Row 2
Grid 1 Row 3 Grid 2 Row 1
If any top-level source fields are mixed in with grid sources, the value of the top-level field is repeated in each row resulting from the grid combinations. If the top-level field contains multiple values, such as a checkbox group, all selected values are combined into one value and repeated in each new row.
When using p1 and p2 to update a specific row, only one value can be inserted into each field. For this reason, updates are best performed using top-level fields. To use a grid value, the formula must use a conditional structure that returns a single value from the grid.
After being evaluated, both functions return the row numbers that were added or edited.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
36Reference
Notes: Without controls, the grid mapping will occur every time the calculated field is evaluated. This can result in unnecessary processing, duplicate data, or data loss if the grid is cleared after being edited.There are options to manage this:
The functions can be included within conditional structures. Set the calculated field to only evaluate under certain conditions. Disable Always Calculate for the field, then use
Field Evaluation Rules to evaluate the field when needed.
Due to the method used to process multiple rows, the entire calculated field is re-evaluated for each row combination in the source grids, even if a conditional structure prevents the grid mapping functions from creating new rows. This can result in repetitive processing of other functions or calculations in the field. This can be avoided by isolating the grid mapping functions within a calculated field, and calling that field from a conditional structure within a separate calculated field.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
37Reference
Full Function Reference 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.4.82 Bridge User Guide User Guide - Calculated Fields
38Reference
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.
IsDateGreaterThan(p0, p1, p2)Checks the first provided date to determine if it is greater than the second provided date. A tolerance can be set to account for minor differences.
P0 (date): First date field.P1 (date): Second date field.P2 (integer): Tolerance in milliseconds. The system date/time format is accurate to a ten-millionth of a second. Even dates that seem to be calculated at the same time will have a small difference. If the P0 date is only greater than the P1 date by less than the provided tolerance, it will not be considered a difference and the function will return false.Returns (text): Returns "True" if the P0 date is greater than the P1 date by more than the P2 tolerance, if any. Returns "False" if the P0 date is less than or equal to the P1 date, or if it is greater but within the P2 tolerance.
eg. If P0 is 2014-10-28T18:16:12.001-04:00, P1 is 2014-10-28T18:16:12.002-04:00, and no tolerance is specified, returns "False" since P0 is less than P1.If P0 is 2014-10-28T18:16:12.005-04:00, P1 is 2014-10-28T18:16:12.002-04:00, and no tolerance is specified, returns "True" since P0 is greater than P1.If P0 is 2014-10-28T18:16:12.005-04:00, P1 is 2014-10-28T18:16:12.002-04:00, and the P2 tolerance is set to 10, returns "False" since P0 is greater than P1, but only by 3 milliseconds when the tolerance is 10 milliseconds.
See Identifying When Fields Have Changed After an Integration for a detailed description of change detection structures.
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
39Reference
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.
CurrentDateTime()Obtains the current date and time from the server.
No parameters.Returns (date): The current Date and time in the full system format (2015-10-28T18:16:12.3313239-04:00).
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. 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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
40Reference
AddHours(p0, p1)Takes a provided date and adds or subtracts a specified number of hours.
P0 (date): Date field. The date must be in the system format, such as from a date picker field, the TodayXml() function, or any system dates.P1 (integer): Number of hours to add (positive values) or subtract (negative values). Decimal values are not supported.Returns (date): New date with adjusted time. The date itself will change if the hours cross into the next or previous days.
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)
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
41Reference
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.
P0 (date): Date fieldReturns (text): Date p0 in long date format.
eg. If p0 = 15/06/2011, returns Monday, June 15, 2011
DateTimeLong(p0)Converts a provided date and time into the long date and time format.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
42Reference
P0 (date): Date field. The date must be in the system format, such as from a date picker field, the TodayXml() function, or any system dates.Returns (text): Date p0 in long date and time format.
eg. If p0 = 2014-12-19T14:45:00.0000000-04:00, returns Friday, December 19, 2014 2:45:00 PM. The output may display differently due to regional settings.
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
DateTimeShort(p0)Converts a provided date and time into the short date and time format.
P0 (date): Date field. The date must be in the system format, such as from a date picker field, the TodayXml() function, or any system dates.Returns (text): Date p0 in short date and time format.
eg. If p0 = 2014-12-19T14:45:00.0000000-04:00, returns 12/19/2014 2:45 PM. The output may display differently due to regional settings.
CustomDateFormat(p0,"{0:p1}")Converts a provided date into a custom date format defined by codes.
P0 (date): Date field. The date must be in the system format, such as from a date picker field, the TodayXml() function, or any system dates.P1 (text): String containing formatting codes.Returns (text): Returns date p0 in format provided in p1. See Custom Date Format Function for a detailed description, a list of codes, and examples.
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): Returns "True" if the field contains a valid ABN, or returns "False" if the value is not valid for any reason (too
short, contains letters/special characters, failed encoding check, etc.)
$GetUser()Obtains the full name of the current user.
No parameters.Returns (string): The full first and last name of the user logged in at the time the calculated field is evaluated.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
43Reference
$UserContainsRole(p0)Checks the current user’s account to determine if it has a specific security role.
P0 (text): Name of security roleReturns (numeric): Returns "True" if current user account has role p0, returns "False" if it does not.Note: This function should only be used within policy workflows. For claims workflows, please use the UserContainsSecurityRole() function below instead. See Verifying User Security Roles for a detailed description of the function.
UserContainsSecurityRole(p0)Checks the current user’s account to determine if it has a specific security role.
P0 (text): Code of security roleReturns (numeric): Returns "True" if current user account has role p0, returns "False" if it does not.Note: This function should only be used within claims workflows. For policy workflows, please use the $UserContainsRole() function above instead. See Verifying User Security Roles for a detailed description of the function.
$IsNewBusiness(p0)Checks if a provided submission, identified by transaction id, is new business.
P0 (numeric): Transaction ID number of the submissionReturns (numeric): Returns "True" if given transaction ID is new business, returns "False" 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.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.
HashAndModifiedOn(p0, p0, p0, ..., p1, p2)The first time this function runs, it combines the content of all P0 fields, calculates a hash value (a unique value derived from the content), stores the hash value in the P1 field, and stores the date and time of the calculation in the P2 field.Each time the function runs after the first time, it calculates the hash value for all fields then compares it to the previous hash value stored in P1. If the hash value has changed, meaning that at least one of the fields was changed since the last time the function ran, the function stores the new hash value in the P1 field and updates the date and time stored in the P2 field.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
44Reference
The date stored in the P2 field can be compared to another date to determine if any of the fields changed within a certain time period. The IsDateGreaterThan() function is useful for making the comparison.Note: The date stored in the P2 field indicates the last time the function identified the changes. It does not reflect when the changes were made.
P0 (text): All fields to be included in the hash calculation should be provided, separated by commas.P1 (Text Area): The Code of the field to contain the hash value. This will be an alphanumeric value with no meaning outside of this function, so the field should most likely be hidden. This condition is literal and must contain the Code of the field without any square brackets, no placeholders or functions can be used here.P2 (text): The Code of the field to contain the last date and time that changes were detected. This condition is literal and must contain the Code of the field without any square brackets, no placeholders or functions can be used here. This should be a text field to ensure the full date and time are stored.Returns (text): Returns the same hash value stored in P1. See Identifying When Fields Have Changed After an Integration for a detailed description of change detection structures.
$CrossPolicyExactMatch(p0, p1, p3, p3, p3, ...)$CrossPolicyFuzzyMatch(p0, p1, p2, p3, p3, p3, ...)
Used with a Cross-Policy Data Configuration, these functions take a value from the current transaction and compare it to stored values from other transactions. The functions evaluate to true if they find an exact match ($CrossPolicyExactMatch()) within the stored data or data that is similar within a certain tolerance ($CrossPolicyFuzzyMatch()).
P0 (text): This identifies the field containing the source value that the function will search for. The field Code should be provided, enclosed in square brackets.P1 (text): This identifies the resource containing the stored data. The Code of the Cross-Policy Data Configuration should be provided, without any brackets.P2 (numeric): This is the tolerance, ranging from 0 to 100, and is only used for the $CrossPolicyFuzzyMatch() function. As the function compares the source value to the stored data, it calculates a percentage match score from 0 (no similarity at all) to 100 (exact match). The percentage must be equal to or greater than the tolerance value for the function to consider it a positive match.P3 (text): These are optional filters to control what data will be searched within the Cross-Policy Data Configuration. The source value will only be compared against data that fits within all of the selected filters.Each filter should be formatted as Filter=Value, and only one filter of each type can be used in each instance of the function, except where noted.
Filter ValuesProduct All, Current, Other Searches through data related to All products, the Current
product, or all products Other than the current product.
Policy All, Current, Other Searches through data related to All policies, the Current policy, or all policies Other than the current policy. If this filter is not specified, it will be applied with the default value of Other.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
45Reference
Assured All, Current, Other Searches through data related to All clients, the Current client, or all clients Other than the current client.
Distributor All, Current, Other Searches through data related to All distributors, the Current distributor, or all distributors Other than the current distributor.
PolicyTransaction All, Current, Other Searches through data related to All transactions, the Current transaction, or all transactions Other than the current transaction. If this filter is not specified, it will be applied with the default value of Other.
PolicyTransactionStatus
Quoted, Referred, Bound, UnderwritingRequired, Incomplete
Searches through data related to transactions in the selected status. This filter can be applied multiple times with different statuses.
Returns (text): $CrossPolicyExactMatch() returns "True" if an exact match is found within the stored data. Returns "False" if no match is found.$CrossPolicyFuzzyMatch() returns "True" if data is found that has a percentage match score that equals or exceeds the tolerance. Returns "False" if no data matches closely enough.Examples:$CrossPolicyExactMatch([[FieldCode]], ConfigurationCode, Product=Other, Distributor=Current,
PolicyTransactionStatus=Quoted, PolicyTransactionStatus=Bound)This function will search through the Cross-Policy Data Configuration "ConfigurationCode" for the text found in the [[FieldCode]] field. It will only search data associated to the current distributor, only within other products, and only within transactions in quoted or bound status.
$CrossPolicyFuzzyMatch([[FieldCode]], ConfigurationCode, 90, Policy=Current, Transaction=Other)This function will search through the Cross-Policy Data Configuration "ConfigurationCode" for the text found in the [[FieldCode]] field. It will only search data associated to other transactions within the current policy. Any similar values must have a percentage match score of 90 or better to produce a positive result.
ValueExists(p0, p1)Used with Field Indexing, this function takes a value from the current claim and compares it to stored values from other claims.
P0 (text): This identifies the field containing the source value that the function will search for. The field Code should be provided, enclosed in square brackets.P1 (text): This identifies the index containing the stored data. This can be the Code for a single indexed field, or an Alias for multiple indexed fields. This value must be provided without any brackets.Returns (text): Returns "true" if a match is found within the stored data. Returns "false" if no match is found.
Examples:ValueExists([[FieldCode]], Code)
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
46Reference
This function will search through the indexed field "Code" for the text found in the [[FieldCode]] field.ValueExists([[FieldCode]], AliasName)
This function will search through all indexed fields with the "AliasName" alias for the text found in the [[FieldCode]] field.
NextPolicySequenceNumber()Retrieves the next sequence number, as it appears in the Next Sequence Number field in the Master Cover - Policy Numbering page.
No parameters.Returns (numeric): Returns the next sequence number.
$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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
47Reference
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.
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.
$GetTransactionTaxAmount(p0)Calculates the total amount of a certain tax or fee across all premium types within the current transaction.
P0 (text): The Code of the tax or fee.Returns (numeric): Returns the total amount of the specified tax or fee for all premium types within the current transaction. This value is only available once quotes have been calculated and a quote option has been selected.
$GetTermTaxAmount(p0)Calculates the total amount of a certain tax or fee across all premium types, for all other transactions within the current term. This does not include the current transaction.
P0 (text): The Code of the tax or fee.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
48Reference
Returns (numeric): Returns the total amount of the specified tax or fee across all premium types, for all other transactions within the current term. This does not include the current transaction. Tax and fee details are only available for transactions where quotes have been calculated and a quote option has been selected.
$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.
$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. See Defining Multiple Fields in a Function for details.Returns (numeric): Number of records in collection p0.
Sum(p0)
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
49Reference
Calculates the sum of a range of fields.P0 (numeric collection): Any mix of numeric fields, grid columns, and policy details. See Defining Multiple Fields in a Function for 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. See Defining Multiple Fields in a Function for details.Returns (numeric): The average value in collection p0.
Multiply(p0)Multiplies all values in a specified range of fields.
P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.Returns (numeric): The multiplied total of all values 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 p2eg. Round(10.7, 1, 0) will round to the nearest 1, resulting in 11.
Round(10.7, 1, 2) will round down to the nearest 1, resulting in 10.Round(1100, 500, 1) will round up to the nearest 500, resulting in 1500.
$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.
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
50Reference
$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.
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.
See Interpolation/Extrapolation for a detailed description of the function.
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. See Defining Multiple Fields in a Function for details.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. See Defining Multiple Fields in a Function for details.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
51Reference
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. See Defining Multiple Fields in a Function for details.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. See Defining Multiple Fields in a Function for details.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.Note: This function is no longer required, but is still supported for backwards compatibility. Using a normal placeholder to reference a field from a parent grid will now return just the data associated to the current child record.
$Child(p0)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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
52Reference
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.Note: This function is no longer required, but is still supported for backwards compatibility. Using a normal placeholder to reference a field from a child grid will now return just the data associated to the current parent record.
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.If the option list is of Type: Static and Resource Type: Custom, alternate language versions may be defined for the labels. The appropriate version will be returned according to the browser language settings.
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.4.82 Bridge User Guide User Guide - Calculated Fields
53Reference
SaveToField(p0, p1)Saves a specific value to a specific field in the workflow.
P0 (text): The code of the target field to receive the data, not enclosed in brackets. The code can be entered directly, retrieved from a field by a placeholder, or calculated with conditional logic. Any method must return the code of the target field as straight text.
P1 (any): The value to be saved in the target field. This can be a literal value, a placeholder, or a calculated value.Returns (any): The calculated field itself will display the last value that was saved to the target field.
eg. SaveToField(TargetField, [[SourceField]]/2) will take the value in field [[SourceField]], divide it by 2, and save the result in field TargetField.SaveToField(TargetField, "Does not apply") will save the text Does not apply in field TargetField. This function will always save the same data in the field, so it would most likely be used within a conditional structure to only save the data under certain circumstances.
SaveToGrid(p0, p1_SequenceNo, p2, p3, p4, p3, p4, …)NewGrid(p0, p1_SequenceNo, p2, p3, p4, p3, p4, …)
Adds one or more rows to a grid, or edits a single row within a grid. The SaveToGrid() function adds new rows to a grid that may have existing data, while the NewGrid() function deletes all rows from the grid before adding new rows.
P0 (text): Code of the target grid. This must be a static code, not enclosed in brackets or quotes.P1 (text): This parameter is optional, and is used in conjunction with P2 to update a single row in the target grid. The format is the
Code of the target grid followed by "_SequenceNo", such as GridCode_SequenceNo. This must be a static code, not enclosed in brackets or quotes.
P2 (integer): This parameter is optional, and is used in conjunction with P1 to update a single row in the target grid. This is the row number to be updated. This must be an integer, and can be a static value, the result of an embedded formula, or a placeholder to retrieve the value from another field.
P3 (text): Code of the recipient field in the target grid. This must be a static code, not enclosed in brackets or quotes. There can be multiple recipient fields, but each P3 must be followed by an associated P4 parameter.
P4 (text): Value to be inserted into the recipient field. This can be a static value or a placeholder to retrieve the value from another field. Each P4 must follow an associated P3 parameter.
Returns (text): The row number for each row added or edited. See Functions to Enter Data Into Grids (Grid Mapping) for a detailed description of the function.
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, …)
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
54Reference
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. See Compare Data Against Sanction or Watch Lists for a detailed description of the function.
CheckComplianceHit(p0, p1, p2, p3, p4, p5, p6)Takes a provided field and compares the text to one or more lists of names and places under sanctions, and stores the results in provided fields.
P0 (text): The field or static value identifying the type of scan to perform. The value must be one of the following options: Company = Scans against company names. Country = Scans against country names. Person = Scans against names of individuals. Unknown = If the type of data being scanned is unknown, this option will scan against all list types. This option will take
longer to process.P1 (text area): The field to receive the reasons for any failed scans. This should be a Text Area field, as the results could be
extensive. This will include the matching percentage score, entity type, and entity name, plus additional information provided by the scan.
P2 (any): The field to receive just the matching percentage scores for any failed scans. The resulting values will be from 0 to 100.P3 (text): The field to receive the list names where the scans failed.P4 (text): The field to receive the combined results of the scan. This will be a pipe-separated list showing each list name followed by
the associated score in brackets. Example: List 1 (90%)|List 2 (80%)P5 (text): The field containing the data to be scanned.P6 (text): The field identifying lists to scan against and the score thresholds for each. The contents of the field should be formatted
as: List Code:Score|List Code:Score|…Multiple lists can be specified, separated by a pipe | character. Each list and score pairing must be separated by a colon :.List Code: The code of a sanction list to scan against. See Compliance() Function Parameters for all available lists and their codes.Score: The numeric score threshold for the associated list, from 0 to 100. If the scan results in a score equal to or greater than the threshold, it will be reported as a fail.
Note: When scanning against multiple lists, the P1, P2, and P3 fields may contain multiple result values. In a single text field, the results will be separated by pipe characters |. The field can be used in grids, where the data will be separated by rows containing associated values.
Returns (boolean): Returns "True" if any scan fails, or returns "False" if all scans passed.
$Lookup(p0, p1, ..., p10)
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
55Reference
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. For details on working with the If() functions, see Conditional Results.
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.
If Value1 operator Value2 then TrueValue else FalseValue endifThis is an alternate version of the If() function, where the conditions are built into the function instead of using a trigger. For details on working with the If() functions, see Conditional Results.
Value1: First value to compareoperator: Operator to determine how the values should be comparedValue2: Second value to compareTrueValue: The value to return if the trigger evaluates as trueFalseValue: The value to return if the trigger evaluates as falseReturns: TrueValue or FalseValue, depending on the result of the conditions.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
56Reference
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.4.82 Bridge User Guide User Guide - Calculated Fields
57Reference
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.4.82 Bridge User Guide User Guide - Calculated Fields
58Reference
Unauthorized Banks Unauthorized Banks
World Bank Ineligible Firms World Bank Ineligible Firms
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
59Reference
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 Company Information
Document E-mail Field
Client Company Address Word Ribbon Company Client / Client Address
E-mail [[InsuredAddress]]
Calculated Field [[InsuredAddress]]
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
60Reference
Client Company City Word Ribbon Company Client / Client City
E-mail [[InsuredCity]]
Calculated Field [[InsuredCity]]
Document E-mail Field
Client Company Contact First Name Word Ribbon Company Client / Client Contact First Name
E-mail [[InsuredContactFirstName]]
Calculated Field [[InsuredContactFirstName]]
Document E-mail Field
Client Company Contact Last Name Word Ribbon Company Client / Client Contact Last Name
E-mail [[InsuredContactLastName]]
Calculated Field [[InsuredContactLastName]]
Document E-mail Field
Client Company Contact Employee Number Word Ribbon Company Client / Client Contact Employee Number
E-mail [[InsuredContactEmployeeNumber]]
Calculated Field [[InsuredContactEmployeeNumber]]
Document E-mail Field
Client Company Contact Phone Word Ribbon Company Client / Client Contact Phone
E-mail [[InsuredContactPhone]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
61Reference
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 Company Contact Email Word Ribbon Company Client / Client Contact Email
E-mail [[InsuredEmail]]
Calculated Field [[InsuredEmail]]
Document E-mail Field
Client Company Country Word Ribbon Company Client / Client Country
E-mail [[InsuredCountry]]
Calculated Field [[InsuredCountry]]
Document E-mail Field
Client Company 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 Company Name Word Ribbon Company Client / Client Name
E-mail [[InsuredCompanyName]]
Calculated Field [[InsuredCompanyName]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
62Reference
Document E-mail Field
Client Company 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 Company State Word Ribbon Company Client / Client State
E-mail [[InsuredState]]
Calculated Field [[InsuredState]]
Document E-mail Field
Client Company Website Word Ribbon Company Client / Client Website
E-mail [[InsuredWebsite]]
Calculated Field [[InsuredWebsite]]
Document E-mail Field
Client Company Zip/Postal Code Word Ribbon Company Client / Client Zip/Postal Code
E-mail [[InsuredZip]]
Calculated Field [[InsuredZip]]
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
63Reference
Client Company Code Word Ribbon Company Client / Client Code
E-mail [[InsuredCode]]
Calculated Field [[InsuredCode]]
Individual Client Information
Document E-mail Field
Individual Client First NameError! Bookmark not defined. Word Ribbon Individual Client / Client First Name
E-mail [[InsuredContactFirstName]]
Calculated Field [[InsuredContactFirstName]]
Document E-mail Field
Individual Client Last NameError! Bookmark not defined. Word Ribbon Individual Client / Client Last Name
E-mail [[InsuredContactLastName]]
Calculated Field [[InsuredContactLastName]]
Document E-mail Field
Individual Client AddressError! Bookmark not defined. Word Ribbon Individual Client / Client Address
E-mail [[InsuredAddress]]
Calculated Field [[InsuredAddress]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
64Reference
Document E-mail Field
Individual Client CityError! Bookmark not defined. Word Ribbon Individual Client / Client City
E-mail [[InsuredCity]]
Calculated Field [[InsuredCity]]
Document E-mail Field
Individual Client Country Word Ribbon Individual Client / Client Country
E-mail [[InsuredCountry]]
Calculated Field [[InsuredCountry]]
Document E-mail Field
Individual Client State/ProvinceError! Bookmark not defined. Word Ribbon Individual Client / Client State
E-mail [[InsuredState]]
Calculated Field [[InsuredState]]
Document E-mail Field
Individual Client Zip Word Ribbon Individual Client / Client Zip/Postal Code
E-mail [[InsuredZip]]
Calculated Field [[InsuredZip]]
Document E-mail Field
Individual Client Email Word Ribbon Individual Client / Client Email
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
65Reference
E-mail [[InsuredEmail]]
Calculated Field [[InsuredEmail]]
Document E-mail Field
Individual Client PhoneError! Bookmark not defined. Word Ribbon Individual 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
Individual Client Code Word Ribbon Individual Client / Client Code
E-mail [[InsuredCode]]
Calculated Field [[InsuredCode]]
Distributor Information
Document E-mail Field
Distributor Address Word Ribbon Distributor / Distributor Address
E-mail [[DistributorAddress]]
Calculated Field [[DistributorAddress]]
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
66Reference
Distributor City Word Ribbon Distributor / Distributor City
E-mail [[DistributorCity]]
Calculated Field [[DistributorCity]]
Document E-mail Field
Distributor Client CodeError! Bookmark not defined. Word Ribbon Distributor / Distributor Client Code
E-mail [[DistributorClientCode]]
Calculated Field [[DistributorClientCode]]
Notes: This is the value of the Code field in the Distributor Information page.
Document E-mail Field
Distributor CodeError! Bookmark not defined. Word Ribbon Distributor / Distributor Code
E-mail [[DistributorCode]]
Calculated Field [[DistributorCode]]
Notes: This is the value of the Distributor Code field in the Distributor Information page.
Document E-mail Field
Distributor Reference CodeError! Bookmark not defined. Word Ribbon Distributor / Distributor Reference Code
E-mail [[DistributorReferenceCode]]
Calculated Field [[DistributorReferenceCode]]
Notes: This is the value of the Distributor Reference Code field in the Master Cover Association window of the Distributor Information page.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
67Reference
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 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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
68Reference
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 State/Province Word Ribbon Distributor / Distributor State/Province
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]]
Document E-mail Field
Distributor Primary Contact First NameError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact First Name
E-mail [[DistributorContactFirstName]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
69Reference
Calculated Field [[DistributorContactFirstName]]
Document E-mail Field
Distributor Primary Contact Last Name Word Ribbon Distributor / Distributor Contact Last Name
E-mail [[DistributorContactLastName]]
Calculated Field [[DistributorContactLastName]]
Document E-mail Field
Distributor Primary Contact Employee NumberError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact Employee Number
E-mail [[DistributorContactEmployeeNumber]]
Calculated Field [[DistributorContactEmployeeNumber]]
Document E-mail Field
Distributor Primary Contact EmailError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact Email
E-mail [[DistributorContactEmail]]
Calculated Field [[DistributorContactEmail]]
Document E-mail Field
Distributor Primary Contact PhoneError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact Phone
E-mail [[DistributorContactPhone]]
Calculated Field [[DistributorContactPhone]]
Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
70Reference
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
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]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
71Reference
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.
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
72Reference
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
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
73Reference
E-mail [[InsurerZipPostalCode]]
Calculated Field [[InsurerZipPostalCode]]
Document E-mail Field
Insurer Primary Contact First NameError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact First Name
E-mail [[InsurerContactFirstName]]
Calculated Field [[InsurerContactFirstName]]
Document E-mail Field
Insurer Primary Contact Last Name Word Ribbon Insurer / Insurer Contact Last Name
E-mail [[InsurerContactLastName]]
Calculated Field [[InsurerContactLastName]]
Document E-mail Field
Insurer Primary Contact Employee NumberError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact Employee Number
E-mail [[InsurerContactEmployeeNumber]]
Calculated Field [[InsurerContactEmployeeNumber]]
Document E-mail Field
Insurer Primary Contact EmailError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact Email
E-mail [[InsurerContactEmail]]
Calculated Field [[InsurerContactEmail]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
74Reference
Document E-mail Field
Insurer Primary Contact PhoneError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact Phone
E-mail [[InsurerContactPhone]]
Calculated Field [[InsurerContactPhone]]
Notes: For calculated fields, the placeholder must be prefixed by String: for the data to display properly.
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.
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
75Reference
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.
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
76Reference
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]]
Document E-mail Field
Submission Version Name Word Ribbon Policy Information / Submission Version Name
E-mail [[SubmissionVersionName]]
Calculated Field [[SubmissionVersionName]]
Document E-mail Field
Submission Version Number Word Ribbon Policy Information / Submission Version Number
E-mail [[SubmissionVersionNumber]]
Calculated Field [[SubmissionVersionNumber]]
Transaction Information
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
77Reference
Transaction ID Word Ribbon Policy Information / System ID
E-mail [[SubPolSystemID]]
Calculated Field [[SubPolSystemID]]
Notes: Retrieves the Transaction ID for the current transaction.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
Internal Transaction ID E-mail [[TransactionResourceId]]
Calculated Field [[TransactionResourceId]]
Notes: Retrieves the internal ID of the transaction, used for external services integrating with Bridge.
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
78Reference
Last 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
Last Modified By Last Name Word Ribbon Policy Information / Modified By Last Name
E-mail [[ModifiedByLastName]]
Calculated Field See the $ModifiedByLastName() function.
Document E-mail Field
Last Modified Date Word Ribbon N/A
E-mail [[ModifiedDate]]
Calculated Field [[ModifiedDate]]
Notes: Contains the date and time of the last change to the transaction. The following actions will not update this value: Clicking the Previous button. Clicking the Save & Refresh or Next buttons without making any changes to the transaction. Generating documents, attaching files (either through the Attachments feature or a File Upload field), or sending e-
mails.The date and time are saved in the full system format, such as "2015-10-28T18:16:12.3313239-04:00". Formatting placeholders and functions can be used to modify the value for presentation.
Document E-mail Field
Last Status Changed By First Name Word Ribbon Policy Information / Last Status Changed By First Name
E-mail [[LastStatusChangedByFirstName]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
79Reference
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
Last Integration Run Date and Time Calculated Field [[Integrations/Integration[Code='code']/StartTime]]
Notes: Retrieves the last date and time a specific integration ran successfully. This data is stored for each different integration configuration the first time it is run within a transaction. The integration configuration is identified by the code.If the resulting date and time are to be used for date comparisons, the field containing this placeholder should be a text field. If a date picker field is used, it will lose the time component.
Document E-mail Field
Status Calculated Field [[SubPolStatus]]
Document E-mail Field
Correction Type E-mail [[CorrectionType]
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
80Reference
Document E-mail Field
Valid Until Date Word Ribbon Policy Information / Valid Until Date
E-mail [[PolicyValidUntilDate]]
Calculated Field [[PolicyValidUntilDate]]
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
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
81Reference
Referral Reason E-mail [[Referral]]
Document E-mail Field
Lost Reason Word Ribbon Policy Information / Lost Reason
E-mail [[LostReasonLabel]]
Calculated Field [[LostReasonLabel]]
Document E-mail Field
Void Reason Name E-mail [[VoidReasonName]]
Document E-mail Field
Void Reason Code E-mail [[VoidReasonCode]]
Document E-mail Field
Void Reason Details E-mail [[VoidReasonDetails]]
Compliance Information
Document E-mail Field
Compliance Successful Word Ribbon Compliance Information / Compliance Successful
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
82Reference
E-mail [[ComplianceSuccessful]]
Calculated Field [[ComplianceSuccessful]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is created or updated when the compliance scan is completed.
Document E-mail Field
Compliance Message Word Ribbon Compliance Information / Compliance Message
E-mail [[ComplianceMessage]]
Calculated Field [[ComplianceMessage]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is created or updated when the compliance scan is completed.
Document E-mail Field
Compliance Detailed Message Word Ribbon Compliance Information / Compliance Detailed Message
E-mail [[ComplianceDetailedMessage]]
Calculated Field [[ComplianceDetailedMessage]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is created or updated when the compliance scan is completed.
Document E-mail Field
Compliance Executed On Word Ribbon Compliance Information / Compliance Executed On
E-mail [[ComplianceExecutedOn]]
Calculated Field [[ComplianceExecutedOn]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
83Reference
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is created or updated when the compliance scan is completed.
Document E-mail Field
Compliance Referral Requested By First Name Word Ribbon Compliance Information / Compliance Request User First Name
E-mail [[ComplianceRequestUserFirstName]]
Calculated Field [[ComplianceRequestUserFirstName]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user sends a transaction into compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Referral Requested By Last Name Word Ribbon Compliance Information / Compliance Request User Last Name
E-mail [[ComplianceRequestUserLastName]]
Calculated Field [[ComplianceRequestUserLastName]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user sends a transaction into compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Referral Requested On Date Word Ribbon Compliance Information / Compliance Request Date
E-mail [[ComplianceRequestDate]]
Calculated Field [[ComplianceRequestDate]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user sends a transaction into compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
84Reference
Compliance Acceptance Reason Word Ribbon Compliance Information / Compliance Acceptance Reason
E-mail [[ComplianceAcceptanceReason]]
Calculated Field [[ComplianceAcceptanceReason]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user accepts compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Accepted By First Name Word Ribbon Compliance Information / Compliance Acceptance User First Name
E-mail [[ComplianceAcceptanceUserFirstName]]
Calculated Field [[ComplianceAcceptanceUserFirstName]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user accepts compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Accepted By Last Name Word Ribbon Compliance Information / Compliance Acceptance User Last Name
E-mail [[ComplianceAcceptanceUserLastName]]
Calculated Field [[ComplianceAcceptanceUserLastName]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user accepts compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Accepted On Date Word Ribbon Compliance Information / Compliance Acceptance Date
E-mail [[ComplianceAcceptanceDate]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
85Reference
Calculated Field [[ComplianceAcceptanceDate]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user accepts compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Accepted Calculated Field [[ComplianceAccepted]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is set when a user accepts compliance for a compliance referral. The setting is cleared when a new scan is performed.
Document E-mail Field
Compliance Rejection Reason Word Ribbon Compliance Information / Compliance Rejection Reason
E-mail [[ComplianceRejectionReason]]
Calculated Field [[ComplianceRejectionReason]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user rejects compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Rejected By First Name Word Ribbon Compliance Information / Compliance Rejection User First Name
E-mail [[ComplianceRejectionUserFirstName]]
Calculated Field [[ComplianceRejectionUserFirstName]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user rejects compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Rejected By Last Name
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
86Reference
Word Ribbon Compliance Information / Compliance Rejection User Last Name
E-mail [[ComplianceRejectionUserLastName]]
Calculated Field [[ComplianceRejectionUserLastName]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user rejects compliance for a compliance referral. The information is cleared when a new scan is performed.
Document E-mail Field
Compliance Rejected On Date Word Ribbon Compliance Information / Compliance Rejection Date
E-mail [[ComplianceRejectionDate]]
Calculated Field [[ComplianceRejectionDate]]
Notes: This information is only available after performing a Compliance Scan integration within a transaction, and is populated when a user rejects compliance for a compliance referral. The information is cleared when a new scan is performed.
Quote Information
Document E-mail Field
Selected Quote Option Code Calculated Field [[SelectedQuoteOptionCode]]
Notes: This value will only be available once a quote has been selected.
Document E-mail Field
Selected Quote Expiry Date Word Ribbon Policy Information / Quote Expiry Date
E-mail [[QuoteExpiryDate]]
Notes: This value will only be available once a quote has been selected.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
87Reference
Document E-mail Field
Insurer Name by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/InsurerName]]
Notes: QuoteCode should be the code of the quote option.
Document E-mail Field
Premium Amount by Quote Option and Premium Type Calculated Field [[QuotePremiumInfoArray/QuotePremiumInfo[QuoteCode='code' and
PremiumTypeCode='code']/Amount]]
Notes: QuoteCode should be the code of the quote option and PremiumTypeCode should be the code of the premium type.
Document E-mail Field
Total Premium by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/TotalPremium]]
Notes: QuoteCode should be the code of the quote option.
Document E-mail Field
Tax Amount by Quote Option, Premium Type, and Tax Type Calculated Field [[QuoteTaxInfoArray/QuoteTaxInfo[QuoteCode='code' and PremiumTypeCode='code' and
TaxCode='code']/Amount]]
Notes: QuoteCode should be the code of the quote option, PremiumTypeCode should be the code of the premium type, and TaxCode should be the code of the tax type.
Document E-mail Field
Total Tax by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/TotalTax]]
Notes: QuoteCode should be the code of the quote option.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
88Reference
Document E-mail Field
Commission Amount by Quote Option and Premium Type Calculated Field [[QuoteCommissionInfoArray/QuoteCommissionInfo[QuoteCode='code' and
PremiumTypeCode='code']/Amount]]
Notes: QuoteCode should be the code of the quote option and PremiumTypeCode should be the code of the premium type.
Document E-mail Field
Total Commission by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/TotalCommission]]
Notes: QuoteCode should be the code of the quote option.
Document E-mail Field
Limit Amount by Quote Option, Premium Type, and Limit Type Calculated Field [[QuoteLimitInfoArray/QuoteLimitInfo[QuoteCode='code' and PremiumTypeCode='code' and
LimitTypeCode='code']/Amount]]
Notes: QuoteCode should be the code of the quote option, PremiumTypeCode should be the code of the premium type, and LimitTypeCode should be the limit type.
Document E-mail Field
Deductible Amount by Quote Option, Premium Type, and Deductible Type Calculated Field [[QuoteDeductibleInfoArray/QuoteDeductibleInfo[QuoteCode='code' and PremiumTypeCode='code' and
DeductibleTypeCode='code']/Amount]]
Notes: QuoteCode should be the code of the quote option, PremiumTypeCode should be the code of the premium type, and DeductibleTypeCode should be the deductible type.
Document E-mail Field
Insuring Conditions by Quote Option Calculated Field [[QuoteInsuringConditionInfoArray/QuoteInsuringConditionInfo[QuoteCode='code']/Text]]
Notes: QuoteCode should be the code of the quote option.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
89Reference
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 Word Ribbon Premium Summary / Total Gross Premium Amount
E-mail [[TotalGrossPremiumAmount]]
Calculated Field See the $TotalGrossPremiumAmount() function.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
90Reference
Document E-mail Field
Premium Currency Name Word Ribbon Premium Summary / Currency Name
E-mail [[PremiumCurrencyName]]
Calculated Field [[PremiumCurrencyName]]
Document E-mail Field
Premium Currency Code Word Ribbon Premium Summary / Currency Code
E-mail [[PremiumCurrencyCode]]
Calculated Field [[PremiumCurrencyCode]]
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
91Reference
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
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
92Reference
Current Transaction Limit Information
Document E-mail Field
Limit Premium Type Name Word Ribbon Limit Information / Limit Premium Type
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
93Reference
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.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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
94Reference
Document E-mail Field
Deductible Description Word Ribbon Deductible Information / Deductible Description
E-mail [[Deductible_Description]]
Calculated Field [[DeductibleList/Deductible[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
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.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
95Reference
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]]
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
96Reference
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 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]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
97Reference
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
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
98Reference
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]][[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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
99Reference
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]]
[[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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
100Reference
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 Calculated Field [[PreviousTerm/Premium/TotalTaxAmount]]
Billing Workflow Details
Document E-mail Field
Payment Plan Name Word Ribbon Billing Information / Payment Plan
E-mail [[Billing_PaymentPlan]]
Calculated Field [[BillingInfo/PaymentPlan]]
Document E-mail Field
Payment Plan Installment Number Word Ribbon Installment Information / Number
E-mail [[Installment_Number]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/Number]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
101Reference
Document E-mail Field
Payment Plan Installment Date Word Ribbon Installment Information / Date
E-mail Installment Date
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/Date]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).In a text field, the date and time is shown in the internal system format. In Date Picker type fields, the year, month, and day are displayed, formatted according to browser settings. If using a Date Picker field, the formula should be preceded by the String: prefix to maintain data compatibility.
Document E-mail Field
Payment Plan Installment Tax Amount Word Ribbon Installment Information / Tax Amount
E-mail [[Installment_TaxAmount]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/TaxAmount]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Document E-mail Field
Payment Plan Installment Amount Due Word Ribbon Installment Information / Amount Due
E-mail [[Installment_AmountDue]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/AmountDue]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
102Reference
Payment Plan Installment Gross Amount Word Ribbon Installment Information / Gross Amount
E-mail [[Installment_GrossAmount]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/GrossAmount]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Document E-mail Field
Payment Plan Installment Commission Amount Word Ribbon Installment Information / Commission Amount
E-mail [[Installment_CommissionAmount]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/CommissionAmount]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Document E-mail Field
Payment Plan Installment Total Amount Due Word Ribbon Installment Information / Total Amount Due
E-mail [[Installment_TotalAmountDue]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/TotalAmountDue]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Document E-mail Field
Payment Plan Installment Total Installment Amount Word Ribbon Installment Information / Total Installment Amount
E-mail [[Installment_TotalInstallmentAmount]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
103Reference
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/TotalInstallmentAmount]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
Document E-mail Field
Payment Plan Installment Currency Word Ribbon Installment Information / Currency
E-mail [[Installment_Currency]]
Calculated Field [[BillingInfo/Installments/Installment[Number='#']/Currency]]
Notes: Use repeaters for documents and e-mails.For calculated fields, values must be called individually by installment number (Installment[Number='#']).
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
104Reference
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 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]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
105Reference
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]]
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
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
106Reference
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
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.
Document E-mail Field
User's Browser Culture Calculated Field [[UserCultureCode]]
Notes: The value returned by the placeholder will be the short code version, such as en-us for English (United States), and will be in all lower-case characters.To identify the code for a language, see the language selection option in your browser. The code is displayed in brackets with the full name of the language.
Document E-mail Field
e-Signature Tag
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
107Reference
Word Ribbon Signature / Signature Placeholder
Notes: This placeholder allows the document to be digitally signed through an external certification service.To use the e-Signature feature, the document must be configured in the master cover and then attached to an integration configuration. The signature process will be initiated through a custom action in the submission workflow.A document containing this placeholder can still be generated through the Print Document feature in the submission workflow, but there will be no digital signature.For details on configuring the integration process, see the Integration Configurations section of the User Guide - Product Design document.
Document E-mail Field
e-Signature Document Created By Name Calculated Field [[DocumentArray/Document[MasterCoverDocumentCode='Code' and Status='Status']/CreatedBy]]
Notes: Provide the Code for the document configuration in the master cover, and the Status from the list below. Only the most recent information for each combination of code and status is tracked.
Status SentForSigning The document has been generated and sent to the certification service.
Signed The document has been signed and verified.
SigningDeclined User declined to sign the document.
SigningPending The document signing process is in progress.
SigningSessionExpired The signing process timed out due to inactivity (20 minutes).
OptedOutOfSigning User opted out of signing the document.
Document E-mail Field
e-Signature Document Status Modified On Date Calculated Field [[DocumentArray/Document[MasterCoverDocumentCode='Code' and
Status='Status']/StatusModifiedOn]]
Notes: Provide the Code for the document configuration in the master cover, and the Status from the list below. Only the most recent information for each combination of code and status is tracked.
Status
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
108Reference
SentForSigning The document has been generated and sent to the certification service.
Signed The document has been signed and verified.
SigningDeclined User declined to sign the document.
SigningPending The document signing process is in progress.
SigningSessionExpired The signing process timed out due to inactivity (20 minutes).
OptedOutOfSigning User opted out of signing the document.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
109Reference
Appendix C - Full Placeholders List for Billing 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 Billing 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.
Invoice Information
Document E-mail Field
Invoice Number Word Ribbon Invoice Information / Invoice Number
E-mail [[Billing_Invoice_Number]]
Document E-mail Field
Invoice Issue Date
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
110Reference
Word Ribbon Invoice Information / Invoice Issue Date
E-mail [[Billing_Invoice_IssueDate]]
Document E-mail Field
Invoice Total Amount Word Ribbon Invoice Information / Invoice Total Amount
E-mail [[Billing_Invoice_TotalAmount]]
Document E-mail Field
Invoice Net Amount Word Ribbon Invoice Information / Invoice Net Amount
E-mail [[Billing_Invoice_NetAmount]]
Document E-mail Field
Invoice Total Commission Amount Word Ribbon Invoice Information / Invoice Total Commission Amount
E-mail [[Billing_Invoice_TotalCommissionAmount]]
Document E-mail Field
Invoice Total Tax Amount Word Ribbon Invoice Information / Invoice Total Tax Amount
E-mail [[Billing_Invoice_TotalTaxAmount]]
Document E-mail Field
Invoice Total Amount Due Word Ribbon Invoice Information / Invoice Total Amount Due
E-mail [[Billing_Invoice_TotalAmountDue]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
111Reference
Document E-mail Field
Invoice Outstanding Amount Word Ribbon Invoice Information / Invoice Outstanding Amount
E-mail [[Billing_Invoice_OutstandingAmount]]
Document E-mail Field
Invoice Due Date Word Ribbon Invoice Information / Invoice Due Date
E-mail [[Billing_Invoice_DueDate]]
Document E-mail Field
Invoice Currency Word Ribbon Invoice Information / Invoice Currency
E-mail [[Billing_Invoice_Currency]]
Document E-mail Field
Invoice Created On Date Word Ribbon Invoice Information / Invoice Created On Date
E-mail [[Billing_Invoice_CreatedOn]]
Statement Information
These placeholders are for use in preparing statement templates for generated documents and e-mails. To access these placeholders in the Oceanwide Word Ribbon, select the Billing Statement option in the Workflow list.
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
112Reference
Outstanding Invoice Amount Word Ribbon Outstanding Invoice / Outstanding Invoice Amount
E-mail [[Billing_OutstandingInvoice_Amount]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Amount Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Amount Currency
E-mail [[Billing_OutstandingInvoice_AmountCurrency]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Date Word Ribbon Outstanding Invoice / Outstanding Invoice Date
E-mail [[Billing_OutstandingInvoice_Date]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Due Date Word Ribbon Outstanding Invoice / Outstanding Invoice Due Date
E-mail [[Billing_OutstandingInvoice_DueDate]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Number Word Ribbon Outstanding Invoice / Outstanding Invoice Number
E-mail [[Billing_OutstandingInvoice_Number]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
113Reference
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Remaining Balance Word Ribbon Outstanding Invoice / Outstanding Invoice Remaining Balance
E-mail [[Billing_OutstandingInvoice_RemainingBalance]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Remaining Balance Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Remaining Balance Currency
E-mail [[Billing_OutstandingInvoice_RemainingBalanceCurrency]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Outstanding Invoice Total Amount Word Ribbon Outstanding Invoice / Outstanding Invoice Total Amount
E-mail [[Billing_OutstandingInvoice_TotalAmount]]
Document E-mail Field
Outstanding Invoice Total Amount Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Total Amount Currency
E-mail [[Billing_OutstandingInvoice_TotalAmountCurrency]]
Document E-mail Field
Outstanding Invoice Total Remaining Balance Word Ribbon Outstanding Invoice / Outstanding Invoice Total Remaining Balance
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
114Reference
E-mail [[Billing_OutstandingInvoice_TotalRemainingBalance]]
Document E-mail Field
Outstanding Invoice Total Remaining Balance Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Total Remaining Balance Currency
E-mail [[Billing_OutstandingInvoice_TotalRemainingBalanceCurrency]]
Document E-mail Field
Statement Closing Balance Word Ribbon Statement / Statement Closing Balance
E-mail [[Billing_Statement_ClosingBalance]]
Document E-mail Field
Statement Total Amount Due Word Ribbon Statement / Statement Total Amount Due
E-mail [[Billing_Statement_TotalAmountDue]]
Document E-mail Field
Statement Transaction Amount Word Ribbon Statement Transaction / Statement Transaction Amount
E-mail [[Billing_StatementTransaction_Amount]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Amount Currency Word Ribbon Statement Transaction / Statement Transaction Amount Currency
E-mail [[Billing_StatementTransaction_AmountCurrency]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
115Reference
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Date Word Ribbon Statement Transaction / Statement Transaction Date
E-mail [[Billing_StatementTransaction_Date]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Due Date Word Ribbon Statement Transaction / Statement Transaction Due Date
E-mail [[Billing_StatementTransaction_DueDate]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Number Word Ribbon Statement Transaction / Statement Transaction Number
E-mail [[Billing_StatementTransaction_Number]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Reference Word Ribbon Statement Transaction / Statement Transaction Reference
E-mail [[Billing_StatementTransaction_Reference]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
116Reference
Statement Transaction Remaining Balance Word Ribbon Statement Transaction / Statement Transaction Remaining Balance
E-mail [[Billing_StatementTransaction_RemainingBalance]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Remaining Balance Currency Word Ribbon Statement Transaction / Statement Transaction Remaining Balance Currency
E-mail [[Billing_StatementTransaction_RemainingBalanceCurrency]]
Notes: Use repeaters for documents and e-mails.
Document E-mail Field
Statement Transaction Total Amount Word Ribbon Statement Transaction / Statement Transaction Total Amount
E-mail [[Billing_StatmentTransaction_TotalAmount]]
Document E-mail Field
Statement Transaction Total Amount Currency Word Ribbon Statement Transaction / Statement Transaction Total Amount Currency
E-mail [[Billing_StatementTransaction_TotalAmountCurrency]]
Document E-mail Field
Statement Transaction Total Remaining Balance Word Ribbon Statement Transaction / Statement Transaction Total Remaining Balance
E-mail [[Billing_StatementTransaction_TotalRemainingBalance]]
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
117Reference
Statement Transaction Total Remaining Balance Currency Word Ribbon Statement Transaction / Statement Transaction Total Remaining Balance Currency
E-mail [[Billing_StatementTransaction_TotalRemainingBalanceCurrency]]
Document E-mail Field
Statement Transaction Type Word Ribbon Statement Transaction / Statement Transaction Type
E-mail [[Billing_StatementTransaction_Type]]
Notes: Use repeaters for documents and e-mails.
Client Information
Document E-mail Field
Client Name Word Ribbon Client Information / Client Name
E-mail [[Billing_Client_Name]]
Document E-mail Field
Client Address Word Ribbon Client Information / Client Address
E-mail [[Billing_Client_Address]]
Document E-mail Field
Client City Word Ribbon Client Information / Client City
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
118Reference
E-mail [[Billing_Client_City]]
Document E-mail Field
Client Zip Word Ribbon Client Information / Client Zip
E-mail [[Billing_Client_Zip]]
Document E-mail Field
Client Country Word Ribbon Client Information / Client Country
E-mail [[Billing_Client_Country]]
Document E-mail Field
Client State Word Ribbon Client Information / Client State
E-mail [[Billing_Client_State]]
Document E-mail Field
Client Phone Word Ribbon Client Information / Client Phone
E-mail [[Billing_Client_Phone]]
Document E-mail Field
Client Email Word Ribbon Client Information / Client Email
E-mail [[Billing_Client_Email]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
119Reference
Distributor Information
Document E-mail Field
Distributor Name Word Ribbon Distributor Information / Distributor Name
E-mail [[Billing_Distributor_Name]]
Document E-mail Field
Distributor Address Word Ribbon Distributor Information / Distributor Address
E-mail [[Billing_Distributor_Address]]
Document E-mail Field
Distributor City Word Ribbon Distributor Information / Distributor City
E-mail [[Billing_Distributor_City]]
Document E-mail Field
Distributor Zip Word Ribbon Distributor Information / Distributor Zip
E-mail [[Billing_Distributor_Zip]]
Document E-mail Field
Distributor Country Word Ribbon Distributor Information / Distributor Country
E-mail [[Billing_Distributor_Country]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
120Reference
Document E-mail Field
Distributor State Word Ribbon Distributor Information / Distributor State
E-mail [[Billing_Distributor_State]]
Document E-mail Field
Distributor Phone Word Ribbon Distributor Information / Distributor Phone
E-mail [[Billing_Distributor_Phone]]
Document E-mail Field
Distributor Email Word Ribbon Distributor Information / Distributor Email
E-mail [[Billing_Distributor_Email]]
Insurer Information
Document E-mail Field
Insurer Name Word Ribbon Insurer Information / Insurer Name
E-mail [[Billing_Insurer_Name]]
Document E-mail Field
Insurer Address Word Ribbon Insurer Information / Insurer Address
E-mail [[Billing_Insurer_Address]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
121Reference
Document E-mail Field
Insurer City Word Ribbon Insurer Information / Insurer City
E-mail [[Billing_Insurer_City]]
Document E-mail Field
Insurer Zip Word Ribbon Insurer Information / Insurer Zip
E-mail [[Billing_Insurer_Zip]]
Document E-mail Field
Insurer Country Word Ribbon Insurer Information / Insurer Country
E-mail [[Billing_Insurer_Country]]
Document E-mail Field
Insurer State Word Ribbon Insurer Information / Insurer State
E-mail [[Billing_Insurer_State]]
Document E-mail Field
Insurer Phone Word Ribbon Insurer Information / Insurer Phone
E-mail [[Billing_Insurer_Phone]]
Document E-mail Field
Insurer Email
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
122Reference
Word Ribbon Insurer Information / Insurer Email
E-mail [[Billing_Insurer_Email]]
Bill To Party Information
Document E-mail Field
Bill to Party Name Word Ribbon Bill To Party Information / Bill to Party Name
E-mail [[Billing_BillToParty_Name]]
Document E-mail Field
Bill to Party Address Word Ribbon Bill To Party Information / Bill to Party Address
E-mail [[Billing_BillToParty_Address]]
Document E-mail Field
Bill to Party City Word Ribbon Bill To Party Information / Bill to Party City
E-mail [[Billing_BillToParty_City]]
Document E-mail Field
Bill to Party Zip Word Ribbon Bill To Party Information / Bill to Party Zip
E-mail [[Billing_BillToParty_Zip]]
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
123Reference
Bill to Party Country Word Ribbon Bill To Party Information / Bill to Party Country
E-mail [[Billing_BillToParty_Country]]
Document E-mail Field
Bill to Party State Word Ribbon Bill To Party Information / Bill to Party State
E-mail [[Billing_BillToParty_State]]
Document E-mail Field
Bill to Party Phone Word Ribbon Bill To Party Information / Bill to Party Phone
E-mail [[Billing_BillToParty_Phone]]
Document E-mail Field
Bill to Party Email Word Ribbon Bill To Party Information / Bill to Party Email
E-mail [[Billing_BillToParty_Email]]
Document E-mail Field
Bill to Party Account Number Word Ribbon Bill To Party Information / Bill to Party Account Number
E-mail [[Billing_BillToParty_AccountNumber]]
Document E-mail Field
Bill to Party On Account Balance Word Ribbon Bill To Party Information / Bill to Party On Account Balance
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
124Reference
E-mail [[Billing_BillToParty_OnAccountBalance]]
Document E-mail Field
Bill to Party On Account Balance Currency Word Ribbon Bill To Party Information / Bill to Party On Account Balance Currency
E-mail [[Billing_BillToParty_OnAccountBalanceCurrency]]
Policy Information
Document E-mail Field
Policy Term Billing Option Word Ribbon Policy Information / Policy Term Billing Option
E-mail [[Billing_PolicyTerm_BillingOption]]
Document E-mail Field
Policy Term Effective Date Word Ribbon Policy Information / Policy Term Effective Date
E-mail [[Billing_PolicyTerm_EffectiveDate]]
Document E-mail Field
Policy Term ID Word Ribbon Policy Information / Policy Term ID
E-mail [[Billing_PolicyTerm_PolicyTermID]]
Document E-mail Field
Policy Term Payment Plan
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
125Reference
Word Ribbon Policy Information / Policy Term Payment Plan
E-mail [[Billing_PolicyTerm_PaymentPlan]]
Document E-mail Field
Policy Term Policy Number Word Ribbon Policy Information / Policy Term Policy Number
E-mail [[Billing_PolicyTerm_PolicyNumber]]
Document E-mail Field
Policy Term Valid Until Date Word Ribbon Policy Information / Policy Term Valid Until Date
E-mail [[Billing_PolicyTerm_ValidUntilDate]]
Document E-mail Field
Policy Transaction Effective Date Word Ribbon Policy Information / Policy Transaction Effective Date
E-mail [[Billing_PolicyTransaction_EffectiveDate]]
Document E-mail Field
Policy Transaction ID Word Ribbon Policy Information / Policy Transaction ID
E-mail [[Billing_PolicyTransaction_PolicyTransactionID]]
Document E-mail Field
Policy Transaction Type Word Ribbon Policy Information / Policy Transaction Type
E-mail [[Billing_PolicyTransaction_TransactionType]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
126Reference
Document E-mail Field
Policy Transaction Valid Until Date Word Ribbon Policy Information / Policy Transaction Valid Until Date
E-mail [[Billing_PolicyTransaction_ValidUntilDate]]
Document E-mail Field
Total Online Payment Amount Calculated Field [[BillingInfo/TotalPaymentAmount]]
Notes: This placeholder displays the total of all online payments made through the current transaction. If the Separate Invoicing by Transaction option is not enabled, the payments may include amounts for other transactions. This amount does not include any payments made through features outside the transaction.
Charge Information
Document E-mail Field
Charge Adjustment Type Word Ribbon Charge / Charge Adjustment Type
Notes: Use repeaters for documents.
Document E-mail Field
Charge Amount Due Word Ribbon Charge / Charge Amount Due
Notes: Use repeaters for documents.If the amount is for an Agency Bill, the commission amount will not be included.
Document E-mail Field
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
127Reference
Charge Currency Word Ribbon Charge / Charge Currency
Notes: Use repeaters for documents.
Document E-mail Field
Charge Date Word Ribbon Charge / Charge Date
Notes: Use repeaters for documents.
Document E-mail Field
Charge Description Word Ribbon Charge / Charge Description
Notes: Use repeaters for documents.This will display the Premium Type if the charge originates from a policy, or the Adjustment Description if the charge originates from an adjustment.
Document E-mail Field
Charge Policy Transaction ID Word Ribbon Charge / Charge Policy Transaction ID
Notes: Use repeaters for documents.
Document E-mail Field
Charge Policy Number Word Ribbon Charge / Charge Policy Number
Notes: Use repeaters for documents.
Document E-mail Field
Charge System Claim Number
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
128Reference
Word Ribbon Charge / Charge System Claim Number
Notes: Use repeaters for documents.
Document E-mail Field
Charge Gross Amount Word Ribbon Charge / Charge Gross Amount
Notes: Use repeaters for documents.
Document E-mail Field
Charge Premium Type Word Ribbon Charge / Charge Premium Type
Notes: Use repeaters for documents.
Document E-mail Field
Charge Total Amount Word Ribbon Charge / Charge Total Amount
Notes: Use repeaters for documents.This is the total charge amount, including taxes.
Document E-mail Field
Charge Total Amount Due Word Ribbon Charge / Charge Total Amount Due
Notes: Use repeaters for documents.This is the total charge amount due, including taxes.
Document E-mail Field
Charge Total Commission Amount Word Ribbon Charge / Charge Total Commission Amount
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
129Reference
Notes: Use repeaters for documents.
Document E-mail Field
Charge Total Tax Amount Word Ribbon Charge / Charge Total Tax Amount
Notes: Use repeaters for documents.
Installment Information
Document E-mail Field
Installment Date Word Ribbon Installment Information / Installment Date
E-mail [[Billing_Installment_Date]]
Notes: This will be blank if multiple installments are included in the invoice.
Document E-mail Field
Installment Number Word Ribbon Installment Information / Installment Number
E-mail [[Billing_Installment_Number]]
Notes: This will be blank if multiple installments are included in the invoice.
Document E-mail Field
Installment Next Date Word Ribbon Installment Information / Installment Next Date
E-mail [[Billing_Installment_NextDate]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
130Reference
Notes: This will be blank if there are no more installments.
Billing Integration Fields
Integration Fields are not like standard placeholders, in that they cannot be used directly in documents, e-mails, or calculated fields. They are used to map a dynamic field to internal system data, so that the dynamic field displays the current value of the integration field. The dynamic field, however, can then be used as a standard placeholder.
This is a read-only connection, so any changes to the dynamic field will not be saved.
To create such a mapping, enter the Code for the appropriate integration field in the External Code field in the Field Management page for the dynamic field. Only one code can be entered for a single field.
Code DescriptionBilling.TermEarliestOverdueInvoiceDueDate
Provides the Due Date for the oldest overdue invoice in the term.
Billing.TermTotalOverdueAmount Provides the total overdue amount for all invoices in the term.
Billing.TermTotalCollectedAmount Provides the total collected amounts for the term.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
131Reference
Appendix D - Full Placeholders List for Claims 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 Claims 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 Core
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.
Core Field Code When a core system field can be updated through a custom field, it will have a Core Field Code. This code should be entered in the Bind To option for the custom field.
Notes: Any notes about using the placeholders.
Claim Information
Document E-mail Field Core
Claims Status E-mail [[Claim/Status]]
Calculated Field [[Claim/Status]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
132Reference
Document E-mail Field Core
Claims Sub-Status E-mail [[Claim/SubStatus]]
Calculated Field [[Claim/SubStatus]]
Document E-mail Field Core
System Number E-mail [[Claim/SystemNumber]]
Calculated Field [[Claim/SystemNumber]]
Document E-mail Field Core
Parent Claim Number E-mail [[Claim/ParentClaimNumber]]
Calculated Field [[Claim/ParentClaimNumber]]
Core Field Code [[Claim/ParentClaimNumber]]
Document E-mail Field Core
Date of Loss E-mail [[Claim/DateOfLoss]]
Calculated Field [[Claim/DateOfLoss]]
Core Field Code [[Claim/DateOfLoss]]
Document E-mail Field Core
Date Reported E-mail [[Claim/DateReported]]
Calculated Field [[Claim/DateReported]]
Core Field Code [[Claim/DateReported]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
133Reference
Document E-mail Field Core
Date Opened E-mail [[Claim/DateOpen]]
Calculated Field [[Claim/DateOpen]]
Document E-mail Field Core
Date Created E-mail [[Claim/DateCreated]]
Calculated Field [[Claim/DateCreated]]
Document E-mail Field Core
Loss Amount E-mail [[Claim/LossAmount/Amount]]
Calculated Field [[Claim/LossAmount/Amount]]
Core Field Code [[Claim/LossAmount/Amount]]
Document E-mail Field Core
Loss Amount Currency E-mail [[Claim/LossAmount/Currency]]
Calculated Field [[Claim/LossAmount/Currency]]
Core Field Code [[Claim/LossAmount/Currency]]
Document E-mail Field Core
Description of Loss E-mail [[Claim/DescriptionOfLoss]]
Calculated Field [[Claim/DescriptionOfLoss]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
134Reference
Core Field Code [[Claim/DescriptionOfLoss]]
Document E-mail Field Core
Policy Number E-mail [[Claim/ReportedPolicyNumber]]
Calculated Field [[Claim/ReportedPolicyNumber]]
Core Field Code [[Claim/ReportedPolicyNumber]]
Document E-mail Field Core
Cause of Loss E-mail [[Claim/CauseOfLoss]]
Calculated Field [[Claim/CauseOfLoss]]
Core Field Code [[Claim/CauseOfLoss]]
Document E-mail Field Core
Bordereau Number E-mail [[Claim/BordereauNumber]]
Calculated Field [[Claim/BordereauNumber]]
Notes: This is a read-only value that is populated when a claim is imported by bordereau. Claims that have been created manually will not have this value.
Claim Party Information
For each Party Information placeholder, the PartyRole must be specified. Enter an option from the following list:
PartyRole Description
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
135Reference
Claimant The party submitting the claim.
Adjuster The adjuster company attached to the claim.
Insurer The insurer company underwriting the policy.
Assured The client company attached to the policy.
Distributor The distributor company attached to the policy.
Document E-mail Field Core
Party Role E-mail [[Party/PartyRole/PartyRole]]
Calculated Field [[Party/PartyRole/PartyRole]]
Document E-mail Field Core
Party Claim Number E-mail [[Party/PartyRole/PartyClaimNumber]]
Calculated Field [[Party/PartyRole/PartyClaimNumber]]
Document E-mail Field Core
Name E-mail [[Party/PartyRole/Name]]
Calculated Field [[Party/PartyRole/Name]]
Document E-mail Field Core
Phone Number E-mail [[Party/PartyRole/Phone]]
Calculated Field [[Party/PartyRole/Phone]]
Document E-mail Field Core
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
136Reference
Email Address E-mail [[Party/PartyRole/Email]]
Calculated Field [[Party/PartyRole/Email]]
Document E-mail Field Core
Fax Number E-mail [[Party/PartyRole/Fax]]
Calculated Field [[Party/PartyRole/Fax]]
Document E-mail Field Core
Contact Name E-mail [[Party/PartyRole/ContactName]]
Calculated Field [[Party/PartyRole/ContactName]]
Document E-mail Field Core
Payment Method E-mail [[Party/PartyRole/PaymentMethod]]
Calculated Field [[Party/PartyRole/PaymentMethod]]
Document E-mail Field Core
Company Type E-mail [[Party/PartyRole/CompanyType]]
Calculated Field [[Party/PartyRole/CompanyType]]
Document E-mail Field Core
Party General Purpose Field One E-mail [[Party/PartyRole/GeneralField1]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
137Reference
Calculated Field [[Party/PartyRole/GeneralField1]]
Document E-mail Field Core
Party General Purpose Field Two E-mail [[Party/PartyRole/GeneralField2]]
Calculated Field [[Party/PartyRole/GeneralField2]]
Document E-mail Field Core
Party General Purpose Field Three E-mail [[Party/PartyRole/GeneralField3]]
Calculated Field [[Party/PartyRole/GeneralField3]]
Document E-mail Field Core
Address Line One E-mail [[Party/PartyRole/Address/AddressLine1]]
Calculated Field [[Party/PartyRole/Address/AddressLine1]]
Document E-mail Field Core
Address Line Two E-mail [[Party/PartyRole/Address/AddressLine2]]
Calculated Field [[Party/PartyRole/Address/AddressLine2]]
Document E-mail Field Core
City E-mail [[Party/PartyRole/Address/City]]
Calculated Field [[Party/PartyRole/Address/City]]
Document E-mail Field Core
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
138Reference
State or Province E-mail [[Party/PartyRole/Address/StateProvince]]
Calculated Field [[Party/PartyRole/Address/StateProvince]]
Document E-mail Field Core
Country E-mail [[Party/PartyRole/Address/Country]]
Calculated Field [[Party/PartyRole/Address/Country]]
Document E-mail Field Core
Postal Code E-mail [[Party/PartyRole/Address/PostalCode]]
Calculated Field [[Party/PartyRole/Address/PostalCode]]
Document E-mail Field Core
Payee Reference Number E-mail [[Party/PartyRole/PayeeInfo/ReferenceNumber]]
Calculated Field [[Party/PartyRole/PayeeInfo/ReferenceNumber]]
Document E-mail Field Core
Payee Name E-mail [[Party/PartyRole/PayeeInfo/Name]]
Calculated Field [[Party/PartyRole/PayeeInfo/Name]]
Document E-mail Field Core
Payee Address E-mail [[Party/PartyRole/PayeeInfo/Address]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
139Reference
Calculated Field [[Party/PartyRole/PayeeInfo/Address]]
Document E-mail Field Core
Payee City E-mail [[Party/PartyRole/PayeeInfo/City]]
Calculated Field [[Party/PartyRole/PayeeInfo/City]]
Document E-mail Field Core
Payee State or Province E-mail [[Party/PartyRole/PayeeInfo/StateProvince]]
Calculated Field [[Party/PartyRole/PayeeInfo/StateProvince]]
Document E-mail Field Core
Payee Country E-mail [[Party/PartyRole/PayeeInfo/Country]]
Calculated Field [[Party/PartyRole/PayeeInfo/Country]]
Document E-mail Field Core
Payee Postal Code E-mail [[Party/PartyRole/PayeeInfo/PostalCode]]
Calculated Field [[Party/PartyRole/PayeeInfo/PostalCode]]
Document E-mail Field Core
Payee Phone Number E-mail [[Party/PartyRole/PayeeInfo/Phone]]
Calculated Field [[Party/PartyRole/PayeeInfo/Phone]]
Document E-mail Field Core
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
140Reference
Payee Email Address E-mail [[Party/PartyRole/PayeeInfo/Email]]
Calculated Field [[Party/PartyRole/PayeeInfo/Email]]
Document E-mail Field Core
Payee Fax Number E-mail [[Party/PartyRole/PayeeInfo/Fax]]
Calculated Field [[Party/PartyRole/PayeeInfo/Fax]]
Document E-mail Field Core
Payment Method E-mail [[Party/PartyRole/PayeeInfo/PaymentMethod]]
Calculated Field [[Party/PartyRole/PayeeInfo/PaymentMethod]]
Document E-mail Field Core
Payment Currency E-mail [[Party/PartyRole/PayeeInfo/Currency]]
Calculated Field [[Party/PartyRole/PayeeInfo/Currency]]
Document E-mail Field Core
Payee General Purpose Field One E-mail [[Party/PartyRole/PayeeInfo/GeneralField1]]
Calculated Field [[Party/PartyRole/PayeeInfo/GeneralField1]]
Document E-mail Field Core
Payee General Purpose Field Two E-mail [[Party/PartyRole/PayeeInfo/GeneralField2]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
141Reference
Calculated Field [[Party/PartyRole/PayeeInfo/GeneralField2]]
Document E-mail Field Core
Payee General Purpose Field Three E-mail [[Party/PartyRole/PayeeInfo/GeneralField3]]
Calculated Field [[Party/PartyRole/PayeeInfo/GeneralField3]]
Document E-mail Field Core
Bank Details, Account Number E-mail [[Party/PartyRole/BankInfo/AccountNumber]]
Calculated Field [[Party/PartyRole/BankInfo/AccountNumber]]
Document E-mail Field Core
Bank Details, Routing Number E-mail [[Party/PartyRole/BankInfo/RoutingNumber]]
Calculated Field [[Party/PartyRole/BankInfo/RoutingNumber]]
Document E-mail Field Core
Bank Details, Name E-mail [[Party/PartyRole/BankInfo/Name]]
Calculated Field [[Party/PartyRole/BankInfo/Name]]
Document E-mail Field Core
Bank Details, Address E-mail [[Party/PartyRole/BankInfo/Address]]
Calculated Field [[Party/PartyRole/BankInfo/Address]]
Document E-mail Field Core
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
142Reference
Bank Details, City E-mail [[Party/PartyRole/BankInfo/City]]
Calculated Field [[Party/PartyRole/BankInfo/City]]
Document E-mail Field Core
Bank Details, State or Province E-mail [[Party/PartyRole/BankInfo/StateProvince]]
Calculated Field [[Party/PartyRole/BankInfo/StateProvince]]
Document E-mail Field Core
Bank Details, Country E-mail [[Party/PartyRole/BankInfo/Country]]
Calculated Field [[Party/PartyRole/BankInfo/Country]]
Document E-mail Field Core
Bank Details, Postal Code E-mail [[Party/PartyRole/BankInfo/PostalCode]]
Calculated Field [[Party/PartyRole/BankInfo/PostalCode]]
Document E-mail Field Core
Bank Details General Purpose Field One E-mail [[Party/PartyRole/BankInfo/GeneralField1]]
Calculated Field [[Party/PartyRole/BankInfo/GeneralField1]]
Document E-mail Field Core
Bank Details General Purpose Field Two E-mail [[Party/PartyRole/BankInfo/GeneralField2]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
143Reference
Calculated Field [[Party/PartyRole/BankInfo/GeneralField2]]
Document E-mail Field Core
Bank Details General Purpose Field Three E-mail [[Party/PartyRole/BankInfo/GeneralField3]]
Calculated Field [[Party/PartyRole/BankInfo/GeneralField3]]
Claim Payment Information, Single Instance
These Claim Payment placeholders are updated when attempting to save a payment. They can be saved in calculated fields for use in validations on the payment itself, or used in documents and e-mails automatically generated on saving a payment.
This is achieved by creating a Workflow Event with either the Save Payment or Import Payment action. Documents and e-mails can be configured to automatically generate on this Workflow Event, or custom validations can be created to provide warnings or errors (with errors preventing the payment from saving).
Note: To use the placeholders for validations, they will need to be included in calculated fields within the workflow (most likely hidden fields). These fields will be updated when attempting to save a payment, but will only have the data from the most recent save attempt.
For details on configuring workflow events, see the Workflow Events section of the User Guide - Claims document.
For details on configuring custom validations, see the Custom Validation Rules section of the User Guide - Claims document.
For details on configuring documents, see the Configuring Claims Documents section of the User Guide - Claims document.
For details on configuring e-mails, see the Configuring Claims E-mails section of the User Guide - Claims document.
When saving or importing a payment, any documents or e-mails configured for these events (and which meet any other criteria set in the configurations) will be generated and the placeholders below will be replaced with details from the current payment.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
144Reference
Document E-mail Field Core
Payment Type E-mail [[CurrentPayment/Type]]
Calculated Field [[CurrentPayment/Type]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Date E-mail [[CurrentPayment/PaymentDate]]
Calculated Field [[CurrentPayment/PaymentDate]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Amount E-mail [[CurrentPayment/PaymentAmount/Amount]]
Calculated Field [[CurrentPayment/PaymentAmount/Amount]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Currency
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
145Reference
E-mail [[CurrentPayment/PaymentAmount/Currency]]
Calculated Field [[CurrentPayment/PaymentAmount/Currency]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Status E-mail [[CurrentPayment/Status]]
Calculated Field [[CurrentPayment/Status]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Check Number E-mail [[CurrentPayment/CheckNumber]]
Calculated Field [[CurrentPayment/CheckNumber]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Reference Number E-mail [[CurrentPayment/ReferenceNumber]]
Calculated Field [[CurrentPayment/ReferenceNumber]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
146Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Category E-mail [[CurrentPayment/Category]]
Calculated Field [[CurrentPayment/Category]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Description E-mail [[CurrentPayment/Description]]
Calculated Field [[CurrentPayment/Description]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Coverage E-mail [[CurrentPayment/Coverage]]
Calculated Field [[CurrentPayment/Coverage]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
147Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Name E-mail [[CurrentPayment/Party/Name]]
Calculated Field [[CurrentPayment/Party/Name]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Code E-mail [[CurrentPayment/Party/Code]]
Calculated Field [[CurrentPayment/Party/Code]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Phone Number E-mail [[CurrentPayment/Party/Phone]]
Calculated Field [[CurrentPayment/Party/Phone]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
148Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Email Address E-mail [[CurrentPayment/Party/Email]]
Calculated Field [[CurrentPayment/Party/Email]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Fax Number E-mail [[CurrentPayment/Party/Fax]]
Calculated Field [[CurrentPayment/Party/Fax]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Contact Name E-mail [[CurrentPayment/Party/ContactName]]
Calculated Field [[CurrentPayment/Party/ContactName]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
149Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Payment Method E-mail [[CurrentPayment/Party/PaymentMethod]]
Calculated Field [[CurrentPayment/Party/PaymentMethod]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Company Type E-mail [[CurrentPayment/Party/CompanyType]]
Calculated Field [[CurrentPayment/Party/CompanyType]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party General Purpose Field One E-mail [[CurrentPayment/Party/GeneralField1]]
Calculated Field [[CurrentPayment/Party/GeneralField1]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
150Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party General Purpose Field Two E-mail [[CurrentPayment/Party/GeneralField2]]
Calculated Field [[CurrentPayment/Party/GeneralField2]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party General Purpose Field Three E-mail [[CurrentPayment/Party/GeneralField3]]
Calculated Field [[CurrentPayment/Party/GeneralField3]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Address Line 1 E-mail [[CurrentPayment/Party/Address/AddressLine1]]
Calculated Field [[CurrentPayment/Party/Address/AddressLine1]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
151Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Address Line 2 E-mail [[CurrentPayment/Party/Address/AddressLine2]]
Calculated Field [[CurrentPayment/Party/Address/AddressLine2]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party City E-mail [[CurrentPayment/Party/Address/City]]
Calculated Field [[CurrentPayment/Party/Address/City]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party State/Province E-mail [[CurrentPayment/Party/Address/StateProvince]]
Calculated Field [[CurrentPayment/Party/Address/StateProvince]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
152Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Country E-mail [[CurrentPayment/Party/Address/Country]]
Calculated Field [[CurrentPayment/Party/Address/Country]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party Postal Code E-mail [[CurrentPayment/Party/Address/PostalCode]]
Calculated Field [[CurrentPayment/Party/Address/PostalCode]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Reference Number E-mail [[CurrentPayment/Party/PayeeInfo/ReferenceNumber]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/ReferenceNumber]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
153Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Name E-mail [[CurrentPayment/Party/PayeeInfo/Name]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Name]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Address E-mail [[CurrentPayment/Party/PayeeInfo/Address]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Address]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee City E-mail [[CurrentPayment/Party/PayeeInfo/City]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/City]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
154Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee State/Province E-mail [[CurrentPayment/Party/PayeeInfo/StateProvince]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/StateProvince]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Country E-mail [[CurrentPayment/Party/PayeeInfo/Country]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Country]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Postal Code E-mail [[CurrentPayment/Party/PayeeInfo/PostalCode]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/PostalCode]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
155Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Phone Number E-mail [[CurrentPayment/Party/PayeeInfo/Phone]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Phone]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Email Address E-mail [[CurrentPayment/Party/PayeeInfo/Email]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Email]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Fax Number E-mail [[CurrentPayment/Party/PayeeInfo/Fax]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Fax]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
156Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Payment Method E-mail [[CurrentPayment/Party/PayeeInfo/PaymentMethod]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/PaymentMethod]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee Currency E-mail [[CurrentPayment/Party/PayeeInfo/Currency]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/Currency]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee General Purpose Field One E-mail [[CurrentPayment/Party/PayeeInfo/GeneralField1]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/GeneralField1]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
157Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee General Purpose Field Two E-mail [[CurrentPayment/Party/PayeeInfo/GeneralField2]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/GeneralField2]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Payee General Purpose Field Three E-mail [[CurrentPayment/Party/PayeeInfo/GeneralField3]]
Calculated Field [[CurrentPayment/Party/PayeeInfo/GeneralField3]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank Account Number E-mail [[CurrentPayment/Party/BankInfo/AccountNumber]]
Calculated Field [[CurrentPayment/Party/BankInfo/AccountNumber]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
158Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank Routing Number E-mail [[CurrentPayment/Party/BankInfo/RoutingNumber]]
Calculated Field [[CurrentPayment/Party/BankInfo/RoutingNumber]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank Name E-mail [[CurrentPayment/Party/BankInfo/Name]]
Calculated Field [[CurrentPayment/Party/BankInfo/Name]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank Address E-mail [[CurrentPayment/Party/BankInfo/Address]]
Calculated Field [[CurrentPayment/Party/BankInfo/Address]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
159Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank City E-mail [[CurrentPayment/Party/BankInfo/City]]
Calculated Field [[CurrentPayment/Party/BankInfo/City]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank State/Province E-mail [[CurrentPayment/Party/BankInfo/StateProvince]]
Calculated Field [[CurrentPayment/Party/BankInfo/StateProvince]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank Country E-mail [[CurrentPayment/Party/BankInfo/Country]]
Calculated Field [[CurrentPayment/Party/BankInfo/Country]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
160Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank Postal Code E-mail [[CurrentPayment/Party/BankInfo/PostalCode]]
Calculated Field [[CurrentPayment/Party/BankInfo/PostalCode]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank General Purpose Field One E-mail [[CurrentPayment/Party/BankInfo/GeneralField1]]
Calculated Field [[CurrentPayment/Party/BankInfo/GeneralField1]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank General Purpose Field Two E-mail [[CurrentPayment/Party/BankInfo/GeneralField2]]
Calculated Field [[CurrentPayment/Party/BankInfo/GeneralField2]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
161Reference
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Document E-mail Field Core
Payment Party, Bank General Purpose Field Three E-mail [[CurrentPayment/Party/BankInfo/GeneralField3]]
Calculated Field [[CurrentPayment/Party/BankInfo/GeneralField3]]
Notes: For documents and e-mails, this placeholder is only available when they are automatically generated on saving a claim payment.For calculated fields, this placeholder can be used in the workflow but will only be available while working within a payment. This allows it to be used for custom validations.
Claim Payment Information, Multiple Filtered Payments
These Claim Payment placeholders are used to retrieve details for each payment associated to a single claim. These fields are part of a system table, ClaimPayments. When using this table within a grid for a claim summary e-mail, the system will automatically filter the data to only include payments to the party receiving the e-mail.
Document E-mail Field Core
Certificate Number E-mail [[CertificateNumber]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
System Claim Number E-mail [[SystemClaimNumber]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
162Reference
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Policy Number E-mail [[PolicyNumber]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Type E-mail [[Type]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Category E-mail [[Category]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Date E-mail [[Date]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Amount E-mail [[Amount]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
163Reference
Currency E-mail [[Currency]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Payee E-mail [[Payee]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Status E-mail [[Status]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Coverage E-mail [[Coverage]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
CheckNumber E-mail [[CheckNumber]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Reference E-mail [[Reference]]
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
164Reference
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Document E-mail Field Core
Description E-mail [[Description]]
Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
165Reference
Index
AAdd Days function 40Add Hours function 39Add Months function 40Add operator 3Add Years function 40AddDays() function 40AddHours() function 39AddMonths() function 40Address Line One placeholder 137Address Line Two placeholder 137AddYears() function 40Adjusted Months function 50AdjustedMonths() function 50Adjuster party role 135Adjustment Number placeholder 81Alias field 45Always Calculate checkbox 35And condition 20Appendix A – Compliance() Function Parameters 56Appendix B - Full Placeholders List for Policy Information 59Appendix C - Full Placeholders List for Billing Information 109Appendix D - Full Placeholders List for Claims Information 131Arithmetic Expressions 5Assured filter 44Attachments 78Avg function 48Avg() function 48BBank Details General Purpose Field One placeholder 142Bank Details General Purpose Field Three placeholder 143, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160,
161Bank Details General Purpose Field Two placeholder 143Bank Details, Account Number placeholder 141
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
166Reference
Bank Details, Address placeholder 141Bank Details, City placeholder 142Bank Details, Country placeholder 142Bank Details, Name placeholder 141Bank Details, Postal Code placeholder 142Bank Details, Routing Number placeholder 141Bank Details, State or Province placeholder 142Bill to Party Account Number placeholder 123Bill to Party Address placeholder 122Bill to Party City placeholder 122Bill to Party Country placeholder 123Bill to Party Email placeholder 123Bill To Party Information 122Bill to Party Name placeholder 122Bill to Party On Account Balance Currency placeholder 124Bill to Party On Account Balance placeholder 123Bill to Party Phone placeholder 123Bill to Party State placeholder 123Bill to Party Zip placeholder 122Billing Integration Fields 130Billing Workflow Details 100Bound Date placeholder 80Building Formulas 3CCalculated Field placeholders 59, 109, 131Cancellation Date placeholder 75Cancellation Reason - Other placeholder 76Cancellation Reason placeholder 75Cause of Loss placeholder 134Certificate Number placeholder 161, 162, 163, 164Charge Adjustment Type placeholder 126Charge Amount Due placeholder 126Charge Currency placeholder 126Charge Date placeholder 127Charge Description placeholder 127Charge Gross Amount placeholder 128Charge Information 126Charge Policy Number placeholder 127
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
167Reference
Charge Policy Transaction ID placeholder 127Charge Premium Type placeholder 128Charge System Claim Number placeholder 127Charge Total Amount Due placeholder 128Charge Total Amount placeholder 128Charge Total Commission Amount placeholder 128Charge Total Tax Amount placeholder 129Check Compliance Hit function 54CheckComplianceHit() function 54Child function 51Child() function 51City placeholder 137Claim Information 131Claim Party Information 134Claim Payment Information, Multiple Filtered Payments 161Claim Payment Information, Single Instance 143Claimant party role 134Client Address placeholder 117Client City placeholder 117Client Company Address placeholder 59Client Company City placeholder 59Client Company Code placeholder 63Client Company Contact Email placeholder 61Client Company Contact Employee Number placeholder 60Client Company Contact First Name placeholder 60Client Company Contact Last Name placeholder 60Client Company Contact Phone placeholder 60Client Company Country placeholder 61Client Company Fax placeholder 61Client Company Information 59Client Company Name placeholder 61Client Company Phone placeholder 62Client Company State placeholder 62Client Company Website placeholder 62Client Company Zip/Postal Code placeholder 62Client Country placeholder 118Client Email placeholder 118Client Information 117
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
168Reference
Client Name placeholder 117Client Phone placeholder 118Client State placeholder 118Client Zip placeholder 118Close Bracket operator 3Code field 4, 7, 26, 27, 28, 44, 45Commas 18Commission Amount by Quote Option and Premium Type placeholder 88Commission Details 7, 9, 11Commission placeholder 90Compare Data Against Sanction or Watch Lists 24Compare function 43Compare() function 43Compliance Acceptance Reason placeholder 84Compliance Accepted By First Name placeholder 84Compliance Accepted By Last Name placeholder 84Compliance Accepted On Date placeholder 85Compliance Accepted placeholder 85Compliance Detailed Message placeholder 82Compliance Executed On placeholder 82Compliance function 53, 56Compliance Information 82Compliance Message placeholder 82Compliance Referral Requested By First Name placeholder 83Compliance Referral Requested By Last Name placeholder 83Compliance Referral Requested On Date placeholder 83Compliance Rejected By First Name placeholder 85Compliance Rejected By Last Name placeholder 86Compliance Rejected On Date placeholder 86Compliance Rejection Reason placeholder 85Compliance Successful placeholder 82Compliance() function 53, 56Concatenation (combining data) 5Conditional Results – the If() Function 19Contact Name placeholder 136, 137Core Field Code placeholders 131Correction Type placeholder 79Count function 48
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
169Reference
Count() function 48Country placeholder 138Created By First Name function 47Created By First Name placeholder 77Created By Last Name function 48Created By Last Name placeholder 77CreatedByFirstName() function 47CreatedByLastName() function 48Cross Policy Exact Match function 44Cross Policy Fuzzy Match function 44Cross-Policy Data Configuration 44CrossPolicyExactMatch() function 44CrossPolicyFuzzyMatch() function 44Current Date Time function 39Current Term Commission Amount placeholder 98Current Term Effective Date placeholder 96Current Term Expiry Date placeholder 97Current Term ID placeholder 96Current Term Information 9, 96Current Term Number placeholder 97Current Term Policy Number placeholder 96Current Term Premium Amount placeholder 97Current Term Tax Amount by Premium placeholder 98Current Term Total Commission Amount placeholder 98Current Term Total Premium Amount placeholder 97Current Term Total Tax Amount placeholder 98Current Transaction Deductible Information 93Current Transaction Information 7Current Transaction Limit Information 92Current Transaction Premium, Commission, Tax Information 89CurrentDateTime() function 39Custom Date Format function 42Custom Date Format Function 30CustomDateFormat() function 42DDate Comparison Field 27, 28Date Long function 41Date of Loss placeholder 132
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
170Reference
Date Overlap function 39Date Picker field 27Date Reported placeholder 132Date Short function 42Date Time Long function 41Date Time Short function 42DateLong() function 41DateOverlap() function 39DateShort() function 42DateTimeLong() function 41DateTimeShort() function 42Day - Double Digit placeholder 103Day - Single Digit placeholder 103Days Between function 37Days In Period function 38DaysBetween() function 37DaysInPeriod() function 38Deductible Amount by Quote Option, Premium Type, and Deductible Type placeholder 88Deductible Amount or Percentage placeholder 94Deductible Amount placeholder 95Deductible Currency placeholder 95Deductible Description placeholder 94Deductible Premium Type Name placeholder 94Deductible Type placeholder 94Deductibles 14Defining Multiple Fields in a Function 18Defining String Data 4Defining the Results 22Description of Loss placeholder 133Detailed Function Descriptions 24Detected Changes Timestamp Field 26, 27Distributor Address placeholder 65, 119Distributor City placeholder 66, 119Distributor Commission placeholder 67Distributor Country placeholder 67, 119Distributor Email placeholder 120Distributor Fax placeholder 67Distributor filter 44
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
171Reference
Distributor Information 65, 119Distributor Name placeholder 67, 119Distributor party role 135Distributor Phone placeholder 68, 120Distributor Primary Contact Email placeholder 69Distributor Primary Contact Employee Number placeholder 69Distributor Primary Contact First Name placeholder 68Distributor Primary Contact Last Name placeholder 69Distributor Primary Contact Phone placeholder 69Distributor State placeholder 120Distributor State/Province placeholder 68Distributor Website placeholder 68Distributor Zip placeholder 119Distributor Zip/Postal Code placeholder 68Divide operator 3EEffective Date 55Effective Date placeholder 79Email Address placeholder 135E-mail placeholders 59, 109, 131Endorsement Number placeholder 80e-Signature Document Created By Name placeholder 107e-Signature Document Status Modified On Date placeholder 108e-Signature Tag placeholder 107Exp function 49Exp() function 49External Code field 130FFax Number placeholder 136Field Evaluation Rules 35Field Indexing 45Field Management page 4, 130File Upload field 78Filter type 44Filter Values 44Formatted Date 1 placeholder 104Formatted Date 2 placeholder 104Formatted Date 3 placeholder 104
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
172Reference
Formatted Date 4 placeholder 104Full Date placeholder 104Full Function Reference List 37Full Month Name placeholder 105Functions 16Functions to Enter Data Into Grids (Grid Mapping) 33GGet Day Of Month function 41Get Day Of Year function 40Get Days From Current function 41Get Month function 40Get Months From Current function 41Get OFAC Scan function 53Get Term Number function 46Get Term Status function 46Get Term Tax Amount function 47Get Transaction Status function 46Get Transaction Type function 46Get TransactionTax Amount function 47Get User function 42Get Year function 40Get Years From Current function 41GetDayOfMonth() function 41GetDayOfYear() function 40GetDaysFromCurrent() function 41GetMonth() function 40GetMonthsFromCurrent() function 41GetOFACScan() function 53GetTermNumber() function 46GetTermStatus() function 46GetTermTaxAmount() function 47GetTransactionStatus() function 46GetTransactionTaxAmount() function 47GetTransactionType() function 46GetYear() function 40GetYearsFromCurrent() function 41Gross Premium Amount placeholder 89Guide 2
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
173Reference
HHash And Modified On function 43Hash Function Field 26Hash Reference Field 26HashAndModifiedOn() function 25, 43IIdentifying When Fields Have Changed After an Integration 25If function 55If not 20If() function 19, 55Individual Client Address placeholder 63Individual Client City placeholder 64Individual Client Code placeholder 65Individual Client Country placeholder 64Individual Client Email placeholder 64Individual Client First Name placeholder 63Individual Client Information 63Individual Client Last Name placeholder 63Individual Client Phone placeholder 65, 66Individual Client State/Province placeholder 64Individual Client Zip placeholder 64Installment Date placeholder 129Installment Information 129Installment Next Date placeholder 129Installment Number placeholder 129Insured party role 135Insurer Address placeholder 70, 120Insurer City placeholder 70, 121Insurer Client Code placeholder 70Insurer Code placeholder 70Insurer Country placeholder 71, 121Insurer Email placeholder 121Insurer Fax placeholder 71Insurer Information 70, 120Insurer Name by Quote Option placeholder 86, 87Insurer Name placeholder 71, 120Insurer party role 135Insurer Phone placeholder 71, 121
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
174Reference
Insurer Primary Contact Email placeholder 73Insurer Primary Contact Employee Number placeholder 73Insurer Primary Contact First Name placeholder 73Insurer Primary Contact Last Name placeholder 73Insurer Primary Contact Phone placeholder 74Insurer Reference Code placeholder 72Insurer Risk Percentage placeholder 72Insurer State placeholder 121Insurer State/Province placeholder 72Insurer Website placeholder 72Insurer Zip placeholder 121Insurer Zip/Postal Code placeholder 73Insuring Conditions by Quote Option placeholder 89Integration Flag Field 27, 28Internal Transaction ID placeholder 77Interpolated Lookup function 49InterpolatedLookup() function 28, 49Interpolation/Extrapolation 28Introduction 2Invoice Created On Date placeholder 111Invoice Currency placeholder 111Invoice Due Date placeholder 111Invoice Information 109Invoice Issue Date placeholder 109Invoice Net Amount placeholder 110Invoice Number placeholder 109Invoice Outstanding Amount placeholder 111Invoice Total Amount Due placeholder 110Invoice Total Amount placeholder 110Invoice Total Commission Amount placeholder 110Invoice Total Tax Amount placeholder 110Is Abn Valid function 42Is Date Greater Than function 38Is New Business function 43IsAbnValid() function 42IsDateGreaterThan() function 26, 38IsNewBusiness() function 43
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
175Reference
LLast Integration Run Date and Time placeholder 79Last Modified By First Name placeholder 78Last Modified By Last Name placeholder 78Last Modified Date placeholder 78Last Status Changed By First Name placeholder 79Last Status Changed By Last Name placeholder 79Limit Amount by Quote Option, Premium Type, and Limit Type placeholder 88Limit Amount placeholder 93Limit Currency placeholder 93Limit Description placeholder 92Limit Premium Type Name placeholder 92Limit Type placeholder 92Limits 13Long Date placeholder 105Lookup function 54Lookup Tables 54Lookup() function 54Loss Amount Currency placeholder 133Loss Amount placeholder 133Lost Reason placeholder 81MMax function 50Max() function 50Min function 50Min() function 50Modified By First Name function 48Modified By Last Name function 48ModifiedByFirstName() function 48ModifiedByLastName() function 48Month - Double Digit placeholder 105Month - Single Digit placeholder 105Month Day placeholder 105Months Between function 37MonthsBetween() function 37Multiply function 49Multiply operator 3Multiply() function 49
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
176Reference
NName column 15Name placeholder 135Net Premium placeholder 91New Grid function 33, 53NewGrid() function 33, 53Next Adjustment Number function 46Next button 78Next Endorsement Number function 46Next Policy Sequence Number function 45Next Sequence Number field 46NextAdjustmentNumber() function 46NextEndorsementNumber() function 46NextPolicySequenceNumber() function 45OOpen Bracket operator 3Operator 19Operators 3, 5Or condition 20Other 106Outstanding Invoice Amount Currency placeholder 112Outstanding Invoice Amount placeholder 111Outstanding Invoice Date placeholder 112Outstanding Invoice Due Date placeholder 112Outstanding Invoice Number placeholder 112Outstanding Invoice Remaining Balance Currency placeholder 113Outstanding Invoice Remaining Balance placeholder 113Outstanding Invoice Total Amount Currency placeholder 113Outstanding Invoice Total Amount placeholder 113Outstanding Invoice Total Remaining Balance Currency placeholder 114Outstanding Invoice Total Remaining Balance placeholder 113PParent function 51Parent() function 51Party Claim Number placeholder 135Party Role placeholder 135Payee Address placeholder 138Payee City placeholder 139
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
177Reference
Payee Country placeholder 139Payee Email Address placeholder 140Payee Fax Number placeholder 140Payee General Purpose Field One placeholder 140Payee General Purpose Field Three placeholder 141Payee General Purpose Field Two placeholder 140Payee Name placeholder 138Payee Phone Number placeholder 139Payee Postal Code placeholder 139Payee Reference Number placeholder 138Payee State or Province placeholder 139Payment Amount placeholder 144Payment Category placeholder 146Payment Check Number placeholder 145Payment Coverage placeholder 146Payment Currency placeholder 140, 145Payment Date placeholder 144Payment Description placeholder 146Payment Method placeholder 140Payment Party Code placeholder 147Payment Party Name placeholder 147Payment Plan Installment Amount Due placeholder 101Payment Plan Installment Commission Amount placeholder 102Payment Plan Installment Currency placeholder 103Payment Plan Installment Date placeholder 101Payment Plan Installment Gross Amount placeholder 102Payment Plan Installment Number placeholder 100Payment Plan Installment Tax Amount placeholder 101Payment Plan Installment Total Amount Due placeholder 102Payment Plan Installment Total Installment Amount placeholder 103Payment Plan Name placeholder 100Payment Reference Number placeholder 145Payment Status placeholder 145Payment Type placeholder 144Phone Number placeholder 135Pipe Character 18Placeholders 7Placeholders Within Formulas 4
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
178Reference
Policy Created Date placeholder 74Policy filter 44Policy First Quoted Date placeholder 74Policy Information 74, 124Policy Last Quoted Date placeholder 75Policy Number 12Policy Number placeholder 134Policy Numbering page 46Policy Term Billing Option placeholder 124Policy Term Effective Date placeholder 124Policy Term ID placeholder 124Policy Term Payment Plan placeholder 124Policy Term Policy Number placeholder 125Policy Term Valid Until Date placeholder 125Policy Transaction Effective Date placeholder 125Policy Transaction ID placeholder 125Policy Transaction Type placeholder 125Policy Transaction Valid Until Date placeholder 126PolicyTransaction filter 45PolicyTransactionStatus filter 45Postal Code placeholder 138Premium Amount by Quote Option and Premium Type placeholder 87Premium Currency Code placeholder 90Premium Currency Name placeholder 90Premium Details 7, 9, 11Premium Type List page 15Premium Type Management page 15Premium Type Name placeholder 89Premium Types menu item 15Previous button 78Previous Term Commission Amount placeholder 99Previous Term Information 11, 98Previous Term Policy Number placeholder 98Previous Term Premium Amount placeholder 99Previous Term Premium Name by Premium Id placeholder 99Previous Term Tax Amount by Premium placeholder 100Previous Term Total Commission Amount placeholder 99Previous Term Total Premium Amount placeholder 99
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
179Reference
Previous Term Total Tax Amount placeholder 100Product Design menu 15Product filter 44Product placeholder 75QQuote Information 86RReference 56Reinstatement Reason placeholder 76Replace function 52Replace() function 52Retrieving Premium IDs 15Round function 49Round() function 49SSave & Refresh button 78Save Payment action 143Save To Field function 52Save To Grid function 33, 53SaveToField() function 52SaveToGrid() function 33, 53Separate Invoicing by Transaction checkbox 126Set Max function 51Set Min function 50SetMax() function 51SetMin() function 50Short Date placeholder 105Simple Arithmetic Formulas 3State or Province placeholder 138Statement Closing Balance placeholder 114Statement Information 111Statement Total Amount Due placeholder 114Statement Transaction Amount Currency placeholder 114Statement Transaction Amount placeholder 114Statement Transaction Date placeholder 115Statement Transaction Due Date placeholder 115Statement Transaction Number placeholder 115Statement Transaction Reference placeholder 115
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
180Reference
Statement Transaction Remaining Balance Currency placeholder 116Statement Transaction Remaining Balance placeholder 116Statement Transaction Total Amount Currency placeholder 116Statement Transaction Total Amount placeholder 116Statement Transaction Total Remaining Balance Currency placeholder 117Statement Transaction Total Remaining Balance placeholder 116Statement Transaction Type placeholder 117Status placeholder 79Straight Quotes 5, 7String modifier 5Subtract operator 3Sum function 48Sum() function 48System Date 103System Number placeholder 131, 132, 133TTax Amount by Quote Option, Premium Type, and Tax Type placeholder 87Tax Amount placeholder 91Tax Details 8, 10, 12Tax Name placeholder 91Term Period Dates 10Text Area control type 54Text Area field 26Textbox field 27Today Long function 39Today Short function 39Today Xml function 39TodayLong() function 39TodayShort() function 39TodayXml() function 39, 42Total Commission Amount function 47Total Commission Amount placeholder 90Total Commission by Quote Option placeholder 88Total Gross Premium Amount function 47Total Gross Premium Amount placeholder 90Total Net Premium Amount placeholder 91Total Online Payment Amount placeholder 126Total Premium by Quote Option placeholder 87
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
181Reference
Total Tax by Quote Option placeholder 88Total Taxes Amount function 47Total Taxes Amount placeholder 92TotalCommissionAmount() function 47TotalGrossPremiumAmount() function 47TotalTaxesAmount() function 47Tracked Fields 26Transaction ID field 77Transaction ID placeholder 77Transaction Information 77UURL to Current Transaction placeholder 106User Contains Role function 42User Contains Security Role function 43UserContainsRole() function 24, 42, 43User's Browser Culture placeholder 106Using a Trigger as the Condition 21Using Data and Comparison Operators as the Condition 19VValid Until Date placeholder 80Value Exists function 45ValueExists() function 45Verifying User Security Roles 24Void Reason Code placeholder 81Void Reason Details placeholder 81Void Reason Name placeholder 81WWord Ribbon placeholders 59, 109, 131Workflow Event 143Working with Boolean Values 17YYear Month placeholder 106Year placeholder 106Years Between function 37YearsBetween() function 37
Version 2.4.82 Bridge User Guide User Guide - Calculated Fields
Copyright Notice
Copyright © 1998 - 2016 Oceanwide Canada 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 Canada 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 Canada Inc. Printed and published in Montreal, Quebec CANADA.
Trademarks
All trademarks, registered trademarks and service marks in this document are exclusive to Oceanwide Canada Inc.
Disclaimer
The publisher Oceanwide Canada 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).
top related