helpdocs.oceanwide.comhelpdocs.oceanwide.com/ow_files/bridge_docs/help...  · web viewtips:...

265
0 Table of Contents Version 2.4.86 Bridge User Guide User Guide - Calculated Fields Bridge User Guide - Calculated Fields Version 2.4.86

Upload: truongthu

Post on 27-Apr-2018

219 views

Category:

Documents


2 download

TRANSCRIPT

0Table of Contents

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

Bridge

User Guide - Calculated Fields

Version 2.4.86

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

iiTable of Contents

FUNCTIONS........................................................................................................16

Defining Multiple Fields in a Function...................................................................17

Conditional Results – the IF Function....................................................................18The If/Then Conditional Structure....................................................................................18The $If() Function.............................................................................................................18Defining the Results.........................................................................................................19

Sequential "Case" Conditions - the MapValue() function....................................22

Conditional Selection of Grid Rows - the Where() function.................................24

Building Conditional Expressions..........................................................................27Operators.........................................................................................................................27Negative Conditions.........................................................................................................28Combined conditions........................................................................................................28Working with Boolean Values...........................................................................................29

Detailed Function Descriptions..............................................................................31Verifying User Security Roles...........................................................................................31Compare Data Against Sanction or Watch Lists..............................................................31Identifying When Fields Have Changed After an Integration............................................32Interpolation/Extrapolation...............................................................................................35Custom Date Format Function.........................................................................................37Functions to Enter Data Into Grids (Grid Mapping)..........................................................40

Full Function Reference List...................................................................................50

REFERENCE......................................................................................................73

Appendix A – Compliance() Function Parameters...............................................73

Appendix B - Full Placeholders List for Policy Information................................76Client Company Information.............................................................................................76Individual Client Information.............................................................................................80Distributor Information......................................................................................................82Insurer Information...........................................................................................................87Policy Information.............................................................................................................91Transaction Information...................................................................................................94Compliance Information...................................................................................................99Quote Information..........................................................................................................103Current Transaction Premium, Commission, Tax Information........................................106Current Transaction Limit Information............................................................................109

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

iiiTable of Contents

Current Transaction Deductible Information...................................................................110Current Term Information...............................................................................................113Previous Term Information.............................................................................................115Billing Workflow Details..................................................................................................117System Date...................................................................................................................120Other.............................................................................................................................. 123

Appendix C - Full Placeholders List for Billing Information..............................126Invoice Information.........................................................................................................126Statement Information....................................................................................................128Client Information...........................................................................................................134Distributor Information....................................................................................................136Insurer Information.........................................................................................................137Bill To Party Information.................................................................................................139Policy Information...........................................................................................................141Charge Information........................................................................................................143Installment Information...................................................................................................146Billing Integration Fields.................................................................................................147

Appendix D - Full Placeholders List for Claims Information.............................148Claim Information...........................................................................................................148Claim Party Information..................................................................................................151Claim Payment Information, Single Instance..................................................................160Claim Payment Information, Multiple Filtered Payments................................................178

Appendix E - Full Placeholders List for General System Information..............182Grid Information.............................................................................................................182

INDEX................................................................................................................185

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

1Table of Contents

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

2Table of Contents

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

3Table of Contents

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

4Table of Contents

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

5Table of Contents

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

6Table of Contents

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

7Table of Contents

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

8Table of Contents

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

9Table of Contents

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

10Table of Contents

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

11Table of Contents

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

12Table of Contents

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

13Table of Contents

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

14Table of Contents

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

15Table of Contents

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

16Table of Contents

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

17Table of Contents

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

18Table of Contents

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.

There are two versions of the If statement. The If/Then version, which is formatted as follows.

If Condition then TrueValue else FalseValue endif

Then there is the $If() version, which is formatted as follows.

$If(TriggerCode, TrueValue, FalseValue)

The If/Then version is more powerful and flexible, so it is the recommended version. The $If() version will most commonly be encountered when reviewing older calculated fields.

The If/Then Conditional Structure

The Condition is any conditional expression that evaluates to boolean values (True or False). This can be a simple field containing boolean values, a function that returns a boolean value, a comparison between two values, or even multiple conditions that resolve to a single boolean result. The Trigger() function can also be used to evaluate a trigger with additional conditions.

See the section on Building Conditional Expressions for information on operators, negative conditions, and combined conditions.

The $If() Function

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.

Notes:

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

19Table of Contents

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

If you need a conditional structure that makes use of an existing trigger configuration, the trigger can be referenced in the If/Then version using the Trigger() function.

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 structure, the else can be omitted which produces no result (null) if the function evaluates as false.

When embedding additional If functions within the true or false calculations, each If function must have its own endif parameter. As an alternative, the elseif parameter can be used in place of the else parameter. This allows multiple conditions to be chained together with only one endif for each standalone If function.

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)

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

20Table of Contents

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

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.

Multiple If functions can be chained to check one condition, then another, then another, and so on. The elseif function is used to insert a new condition when the preceding condition evaluates as false.

The following structure refers to a radio button field with three options. It systematically checks for each value, and returns a specific result when it finds the selected value.

If [[Field]] = "Option 1" then "Option 1 selected"elseif [[Field]] = "Option 2" then "Option 2 selected"elseif [[Field]] = "Option 3" then "Option 3 selected"else "No option selected"

endifThe indented multiple-line structure is recommended to help organize complex conditional formulas. Also, it is best to include a final else statement in case none of the conditions evaluate to true.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

21Table of Contents

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

22Table of Contents

Sequential "Case" Conditions - the MapValue() function

The MapValue() function allows a calculated field to perform a series of value comparisons until it finds a matching value, then returns a specific value for that result. This is often known as a "Case" structure.

The function is provided a specific field to evaluate, and one or more sets of paired values for Case and Response. An optional Default value can be provided.

The format is as follows:

MapValue(p0, p1, p2, p1, p2, …, p3, p4)

P0 Placeholder for the target field to be evaluated.

P1 Each P1 parameter must have a matching P2 parameter. These are the paired case conditions and return results. The condition can be a static value, placeholder, or another function.

The condition value must match the value of the target field exactly, or the function will move on to the next condition.

P2 Each P2 parameter must have a matching P1 parameter. These are the paired case conditions and return results. The return result can be a static value, placeholder, or another function.

P3 The P3 parameter must have a matching P4 parameter. This parameter is optional, and should contain the text "Default". This condition will be used when all other listed conditions fail. If the P3 and P4 parameters are not included, the function will return null if all other listed conditions fail.

P4 The P4 parameter must have a matching P3 parameter. This parameter is optional, and returns the default value if all other conditions fail.

Tips:Because the condition and target values must match exactly, this function may not be useful for evaluating field types where the user can enter values directly. This is best used with selection fields such as radio buttons and checkbox groups, or calculated fields that produce predictable results.

When using target fields that can contain multiple values, such as checkbox groups, multiple values are saved differently than single values. A single selection may be saved as "Value1", while multiple values are saved as "Value1|Value2". Individual condition and return pairs must be created for each combination of values that should produce a result.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

23Table of Contents

The Include/Exclude field type allows the selection of multiple values, however the order of the selected values can change while navigating within the workflow. These changes can alter the results of the MapValue function.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

24Table of Contents

Conditional Selection of Grid Rows - the Where() function

When used on their own, most functions or placeholders that reference data in a grid will use all rows in the grid. This may be a calculation function that produces the sum of values in a column, a Grid Mapping function that copies some or all of a row, or just a simple placeholder that pulls all values for reference.

The Where() function applies conditions when referencing a grid, so that only rows that meet the conditions will be included.

The format is as follows:

Subject Where(Condition)

The Subject is what will be modified by the Where function. This can be a placeholder, another function, or a single parameter of another function. The Where function will apply to the subject that directly precedes it.

For example:

[[Placeholder]] Where(Condition)This will return all values from the specified column for each row that meets the conditions.

Function(Column1, Column2) Where(Condition)With the Where function outside of the function parameters, it applies to the entire function. The function will evaluate column1 and column2 for each row that meets the conditions.

Function(Column1, Column2 Where(Condition))With the Where function inside the function parameters, it only applies to the preceding parameter. The function will evaluate column1 for every row, but only evaluate column2 for each row that meets the conditions.Note: Care should be taken when applying conditions to parameters. Using Where to omit a required parameter will result in an error. However, two versions of a required parameter can be provided with conditions that use one version or the other (do not include additional commas).

The Condition is any conditional expression that evaluates to boolean values (True or False). This can be a simple field containing boolean values, a function that returns a boolean value, a comparison between two values, or even multiple conditions that resolve to a single boolean result.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

25Table of Contents

In general, at least one of these will be a field in the grid or a calculated value based on a field in the grid, producing separate results for each row. The other value can be a grid field, calculated value, static value, or a top-level field (field outside of a grid).

See the section on Building Conditional Expressions for information on operators, negative conditions, and combined conditions.

Examples: A column in a table has five values, 100, 200, 300, 400, and 500. The following basic formula is used.

Sum([[NumberColumn]])

This sums up all values in the column and displays 1500. If the following conditional formula is used instead:

Sum([[NumberColumn]]) Where([[NumberColumn]] > 300)

Only the fourth and fifth rows are greater than 300, so the calculated field sums those values and displays 900.

A column in a table has five values, 100, 200, 300, 400, and 500. A placeholder is used to retrieve the values. The results can be used for display, or as a parameter for another function.

[[NumberColumn]]

This returns all values in the column, "100|200|300|400|500". If the placeholder is used with a condition instead:

[[NumberColumn]] Where([[NumberColumn]] < 300)

Only the first and second rows are less than 300, so the calculated field returns those values, "100|200".

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

26Table of Contents

The Round() function uses a parameter to determine how a value is rounded. A condition can be applied to determine if the value should be rounded up or rounded down.

Round([[OriginalValue]], 1, 1 Where([[RoundUpOrDown]] = "Up") 2 Where([[RoundUpOrDown]] = "Down"))

As this is a required parameter, the conditions must use one value or the other, or the function will fail. In this example, the two values could be pulled from a Radio Button control, ensuring that one or the other is selected.

If the condition were instead comparing if a value was more or less than a threshold value, one condition could verify if the value is less (<) than the threshold, but the other condition would need to check if the value is greater than or equal (>=) to the threshold.

The Where function is useful when copying data between tables (grid mapping). See the Functions to Enter Data Into Grids section for configuration instructions and samples.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

27Table of Contents

Building Conditional Expressions

Some functions allow multiple results based on conditions, such as the If and Where() functions. The condition is any conditional expression that evaluates to boolean values (True or False). This can be a simple field containing boolean values, a function that returns a boolean value, a comparison between two values, or even multiple conditions that resolve to a single boolean result.

The most common format is Value1 operator Value2 which compares one value to another, although more complex comparisons are possible. The Value1 and Value2 data can include placeholders, formulas, or even other functions (including other conditional functions).

The operators and other options are detailed below.

Operators

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: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 endif

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

28Table of Contents

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

This can also be used with the Where() function, by adding it to the beginning of the conditions, such as Where(Not Value1 operator Value2).

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

29Table of Contents

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.

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, If statement, or Where() function, the system retrieves the data to be checked and compares it to the condition value to determine if the statement is true or false.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

30Table of Contents

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

As will the two following Where() calculations:

Sum(Value) Where(BooleanFunction = "True")

Sum(Value) Where(BooleanFunction)

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

31Table of Contents

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

32Table of Contents

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

33Table of Contents

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

34Table of Contents

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

35Table of Contents

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

36Table of Contents

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

37Table of Contents

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

38Table of Contents

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

39Table of Contents

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

40Table of Contents

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 first function is ClearGrid(), which deletes all rows from a grid, as well as any associated child grids.

ClearGrid(p0)

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

41Table of Contents

Parameter 0 Code of the target grid. This must be a static code, not enclosed in brackets or quotes.

The two functions for copying rows 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.

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.

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.

The best way to control the processing is to isolate each function within its own calculated field, which can be hidden in the workflow. The function fields must have the Always Calculate option unchecked, or they will be activated each time the system evaluates calculated fields. Another calculated field can then be set to call the function fields from within a conditional structure.

Due to the method used to process multiple rows, the entire calculated field is re-evaluated for each row combination in the

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

42Table of Contents

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 moving any extra calculations to other fields that will be called before or after processing the grid mapping functions.

Basic Processing of Standalone Grids:By default, the SaveToGrid() and NewGrid() functions process every row in the source grids, and consider any child grids as separate grids. This section describes this default functionality.

For details on other options, see the Conditional Processing of Standalone Grids and Processing Parent and Child Grids sections.

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

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

43Table of Contents

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.

Conditional Processing of Standalone Grids:By default, the SaveToGrid() and NewGrid() functions process every row in the source grids, and consider any child grids as separate grids. This section describes how the Where() function can be used to apply conditions that omit individual values or entire rows.

For details on other options, see the Basic Processing of Standalone Grids and Processing Parent and Child Grids sections.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

44Table of Contents

Both the SaveToGrid() and NewGrid() functions can be used to copy data from specific rows in the source grid. The Where() function applies a condition that is evaluated for each row in the source grid. If the condition evaluates to True, the row or value is processed, and if it evaluates to False, the row or value is skipped. The placement of the Where() function affects the results, as shown below.

Placing the Where() function outside of the grid function applies to the entire function, causing it to skip entire rows.

For example, a source grid has the following data.

Source Grid

Field 1 Field 2 Number

Row 1 Field 1 Row 1 Field 2 5

Row 2 Field 1 Row 2 Field 2 14

Row 3 Field 1 Row 3 Field 2 9

Row 4 Field 1 Row 4 Field 2 20

The following formula is used.

NewGrid(TargetGrid, TargetGridField1, [[SourceGridField1]], TargetGridField2, [[SourceGridField2]], TargetGridNumber, [[SourceGridNumber]])Where([[SourceGridNumber]] > 10)

The Where() function evaluates if the value in the Number field is greater than 10, which produces the following content in the target grid.

Target Grid

Field 1 Field 2 Number

Row 2 Field 1 Row 2 Field 2 14

Row 4 Field 1 Row 4 Field 2 20

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

45Table of Contents

Placing the Where() function inside the grid function applies to the preceding parameter. The grid function will process all rows, but the optional value will only be included if the condition evaluates to True.

For example, a source grid has the following data.

Source Grid

Field 1 Field 2 Number

Row 1 Field 1 Row 1 Field 2 5

Row 2 Field 1 Row 2 Field 2 14

Row 3 Field 1 Row 3 Field 2 9

Row 4 Field 1 Row 4 Field 2 20

The following formula is used.

NewGrid(TargetGrid, TargetGridField1, [[SourceGridField1]], TargetGridField2, [[SourceGridField2]], TargetGridNumber, [[SourceGridNumber]] Where([[SourceGridNumber]] > 10))

The Where() function evaluates if the value in the Number field is greater than 10, which produces the following content in the target grid.

Target Grid

Field 1 Field 2 Number

Row 1 Field 1 Row 1 Field 2

Row 2 Field 1 Row 2 Field 2 14

Row 3 Field 1 Row 3 Field 2

Row 4 Field 1 Row 4 Field 2 20

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

46Table of Contents

Note: Care should be taken when applying conditions to parameters. Using Where to omit a required parameter will result in an error. However, two versions of a required parameter can be provided with conditions that use one version or the other (do not include additional commas).

Processing Parent and Child Grids:By default, the SaveToGrid() and NewGrid() functions process every row in the source grids, and consider child grids as separate grids. This section describes how the Where() function can be used to copy grids with child grids, maintaining the associations.

For details on other options, see the Basic Processing of Standalone Grids and Conditional Processing of Standalone Grids sections.

Copying rows from a parent grid and child grid is a two-step operation. The first step copies all rows in the parent grid, assigning the row numbers in the process. The next step conditionally copies the rows in the child grid, matching the parent row number from the source grid to the parent row number in the target grid.

The functions for the parent copy and child copy should be kept in separate calculated fields, and called one after the other from a third field, such as "[[CopyParentGrid]] [[CopyChildGrid]]". If the two functions are not activated together like this, there is a chance that the parent data could be modified before the child data is copied, resulting in mismatched data.

1. The Parent Copy function: The parent copy can be performed using the same basic processing or conditional processing methods detailed above. However, the row numbers must be tracked to allow the child copy function to associate the correct child grid rows to each parent.

The [[GridCode_SequenceNo]] placeholder can be used to reference the internal row numbers in the grid. When copying all grid rows from a source grid to an empty target grid, the row numbers will match. However, if the copy is conditional or if the target grid is not empty, the row numbers will likely not match up and the child copy will associate the incorrect rows. The best practice in all cases is to add an extra field to the parent target grid, perhaps named "SourceRowNumber" or something similar, and copy the row numbers into this field along with the rest of the parent data. This extra field can be set to read-only, and hidden in the workflow.

2. The Child Copy function: The child copy function is similar to the conditional processing method detailed above, except that the condition specifically uses row numbers to associate the child rows to the correct parent rows.

Without the condition, the child copy would copy all rows in the source child grid for each row in the target parent grid. With the condition, the system still evaluates all rows in the source child grid for each row in the target parent grid, but leaves out any child rows that do not match the current parent.

The Where() function should be outside of the grid function, and should be formatted as shown below.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

47Table of Contents

NewGrid(TargetChildGrid, TargetChildGridField1, [[SourceChildGridField1]], etc…)Where([[TargetParentSourceRowNumber]] = [[SourceParent_SequenceNo]])

This compares the [[TargetParentSourceRowNumber]] copied by the parent copy function to the [[SourceParent_SequenceNo]] from the original parent grid, and only copies the child rows belonging to the current target parent row.

Example:This example uses the following source data for one parent grid and one child grid. Note that the row numbers and parent row numbers (PR#) displayed in the fields are part of the test data to track the original values as they get copied. The actual internal SequenceNo values are displayed to the left of the tables.

Source Parent Grid

Seq. No Field 1 Field 2 Number

1 Row 1 Field 1 Row 1 Field 2 5

2 Row 2 Field 1 Row 2 Field 2 14

3 Row 3 Field 1 Row 3 Field 2 9

4 Row 4 Field 1 Row 4 Field 2 20

Source Child Data for Source Parent Row 2

Seq. No Field 1 Field 2 Number

1 PR2 Row 1 Field 1 PR2 Row 1 Field 2 1

2 PR2 Row 2 Field 1 PR2 Row 2 Field 2 2

Source Child Data for Source Parent Row 4

Seq. No Field 1 Field 2 Number

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

48Table of Contents

1 PR4 Row 1 Field 1 PR4 Row 1 Field 2 1

2 PR4 Row 2 Field 1 PR4 Row 2 Field 2 2

The following formula is used to copy the rows from the source parent where the Number is greater than 10.

NewGrid(TargetParentGrid, TargetParentGridField1, [[SourceParentGridField1]], TargetParentGridField2, [[SourceParentGridField2]], TargetParentGridNumber, [[SourceParentGridNumber]], TargetParentGridSourceRowNumber, [[SourceParentGrid_SequenceNo]])Where([[SourceParentGridNumber]] > 10)

This produces the following rows in the target parent grid.

Target Parent Grid

Seq. No Field 1 Field 2 Number Source Row Number

1 Row 2 Field 1 Row 2 Field 2 14 2

2 Row 4 Field 1 Row 4 Field 2 20 4

Note that the internal SequenceNo values do not match those in the source grid, but the Source Row Number values retain the correct original row numbers. This allows the child data to be associated to the correct parent rows.

Immediately after the parent grid copy is performed, the child grid copy is called. This formula is used to copy the rows from the source child where the Target Parent Grid Source Row Number matches the Source Parent Grid SequenceNo.

Note: It may seem odd to use conditional values that are not in either of the source or target child grids. However, when the system is processing data in child grids, it is automatically tracking the associated parent grid rows. This makes the parent values available for use in the conditions.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

49Table of Contents

NewGrid(TargetChildGrid, TargetChildGridField1, [[SourceChildGridField1]], TargetChildGridField2, [[SourceChildGridField2]], TargetChildGridNumber, [[SourceChildGridNumber]],Where([[TargetParentGridSourceRowNumber]] = [[SourceParentGrid_SequenceNo]])

This produces the following rows in the target child grid.

Target Child Data for Target Parent Row 1

Seq. No Field 1 Field 2 Number

1 PR2 Row 1 Field 1 PR2 Row 1 Field 2 1

2 PR2 Row 2 Field 1 PR2 Row 2 Field 2 2

Target Child Data for Target Parent Row 2

Seq. No Field 1 Field 2 Number

1 PR4 Row 1 Field 1 PR4 Row 1 Field 2 1

2 PR4 Row 2 Field 1 PR4 Row 2 Field 2 2

The necessary parent rows have been copied, and the child rows have been copied and associated to the correct parents.

This example is a relatively straightforward copy process. Combined Conditions can be used in the Where() function of the child copy to only copy specific children, calculations and other functions can be inserted to modify data as it's copied, and a range of other combinations are possible.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

50Table of Contents

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

51Table of Contents

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

52Table of Contents

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

53Table of Contents

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

54Table of Contents

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

55Table of Contents

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

56Table of Contents

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

57Table of Contents

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

58Table of Contents

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

59Table of Contents

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.

IsNull(p0)Determines if a specific field is empty.

P0 (any): The field to be evaluated.Returns (boolean): Returns True if the field value is null or an empty string. Returns False if the field contains any data of any type.

IsNotNull(p0)Determines if a specific field contains any data.

P0 (any): The field to be evaluated.Returns (boolean): Returns True if the field contains any data of any type. Returns False if the field value is null or an empty string.

IsNumeric(p0)Determines if a specific value is a number.

P0 (any): The value to be evaluated. This can be a field placeholder, function, or formula.Returns (boolean): Returns True if the value is a number, including 0. Returns False if the value is null, and empty string, or if it contains any non-numeric characters.Periods and commas will be recognized as decimal separators, while commas will also be recognized as thousands separators.

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.

GetAndIncrementSequenceNumber(p0)Retrieves the next sequence number from a sequence number configuration and then increments the sequence number by 1.

P0 (text): The Code of the sequence number configuration.Returns (numeric): Returns the next sequence number.If the function is called from a transaction whose master cover is in test mode, the number from the configuration’s Test - Next Sequence Number field is returned.If the function is called from a transaction whose master cover is in live mode, the number from the configuration’s Live - Next Sequence Number field is returned.Note: The function will retrieve and increment the number every time it is evaluated. Conditional structures, such as an If statement or Field Evaluation Rule, can be used to control when the function is evaluated.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

60Table of Contents

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

61Table of Contents

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

62Table of Contents

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

63Table of Contents

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.

Trim(p0)Processes a string value and returns the string with any leading or trailing spaces removed.

P0 (string): String value to be trimmed.Returns (string): The string value without any leading or trailing spaces.Note: Data that has been entered manually in workflow fields are automatically trimmed by the UI. This function is for data that may have been imported from external systems.

Length(p0)Evaluates a string value and returns the total number of characters.

P0 (string): Source string value.Returns (integer): The number of characters in the source string.

eg. Length("Test String") will return 11.

Mid(p0, p1, p2)Evaluates a string value and returns a range of characters.

P0 (string): Source string value.P1 (integer): Starting character position. This is the numerical position of the first character to be returned, starting at 1. If the starting position is beyond the end of the string, nothing will be returned.P2 (integer): Number of characters to return, counting from the starting position and including the starting position. If the string ends before the number is reached, the existing characters will be returned.Returns (string): The portion of the string defined by the range values.

eg. Mid("Test String", 6, 4) will return "Stri".Mid("Test String", 6, 8) will return "String", as there are only six characters from the starting point.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

64Table of Contents

Mid("Test String", 1, 4) will return "Test".

UCase(p0)Converts the letters in a string of text to upper case.

P0 (text): This identifies the text to be converted. This can be a placeholder, function, formula or literal value. Numbers and symbols can be included in the text and will be unaffected by the conversion.Returns (text): Returns a string of text with all the letters in upper case.

eg.If the value of p0 is “Policy”, the function returns “POLICY”.If the value of p0 is “a1b2c”, the function returns “A1B2C”.

LCase(p0)Converts the letters in a string of text to lower case.

P0 (text): This identifies the text to be converted. This can be a placeholder, function, formula or literal value. Numbers and symbols can be included in the text and will be unaffected by the conversion.Returns (text): Returns a string of text with all the letters in lower case.

eg.If the value of p0 is “POLICY”, the function returns “policy”.If the value of p0 is “A1B2C”, the function returns “a1b2c”.

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

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

65Table of Contents

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

66Table of Contents

1 = P1 is a maximum valueReturns (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.

TakeFirst(p0)Returns the first value of a grid field.

P0 (any): The grid field containing the values.Returns (any): Returns the first value of the grid field, based on the row numbers. The result is not affected by sorting or filtering the grid.

TakeLast(p0)Returns the last value of a grid field.

P0 (any): The grid field containing the values.Returns (any): Returns the last value of the grid field, based on the row numbers. The result is not affected by sorting or filtering the grid.

MatchAny(p0, p1)Searches a set of values to determine if any value matches a provided search value.Warning: This function should not be used in any formula. This function can appear in analysis features when a trigger is converted into a formula, and is described here for troubleshooting purposes.

P0 (any): Any mix of fields and grid columns.P1 (any): The search value being matched against the fields.Returns (boolean): Returns True if any value in the set matches the search value. Returns False if none of the values match.

MatchAll(p0, p1)Searches a set of values to determine if all values match a provided search value.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

67Table of Contents

Warning: This function should not be used in any formula. This function can appear in analysis features when a trigger is converted into a formula, and is described here for troubleshooting purposes.

P0 (any): Any mix of fields and grid columns.P1 (any): The search value being matched against the fields.Returns (boolean): Returns True if all values in the set match the search value. Returns False if even a single value does not match.

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

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.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

68Table of Contents

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.

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.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

69Table of Contents

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.

ClearGrid(p0)Clears all data from a provided grid and any associated child grids

P0 (text): Code of the grid to be cleared. Child grids are cleared automatically, and do not need to be specified.Returns (): N/A

Where(Value1 operator Value2)This function applies a condition to the subject that directly precedes it. This can be a placeholder, another function, or a single parameter of another function.

Value1: This is the first value for comparison.operator: Operator to determine how the values should be comparedValue2: This is the second value for comparison.Returns (): N/A

See Conditional Selection of Grid Rows - the Where() function 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, …)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 scanned

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

70Table of Contents

P1 (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.86 Bridge User Guide User Guide - Calculated Fields

71Table of Contents

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 (text): 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 function 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.

Trigger(p0)Evaluates a trigger configuration and returns the boolean result (True or False).

P0 (text): The Code of the trigger to be evaluated.Returns (boolean): Returns True if the trigger evaluates as true. Returns False if the trigger evaluates as false.Note: This function can be used on its own, but is particularly useful for If/Then conditional structures.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

72Table of Contents

MapValue(p0, p1, p2, p1, p2, …, p3, p4)Performs a series of value comparisons until it finds a matching value, then returns a specific value for that result.

P0 (text): Placeholder for the target field to be evaluated.P1 (any): Each P1 parameter must have a matching P2 parameter. These are the paired case conditions and return results. The

condition can be a static value, placeholder, or another function.The condition value must match the value of the target field exactly, or the function will move on to the next condition.

P2 (any): Each P2 parameter must have a matching P1 parameter. These are the paired case conditions and return results. The return result can be a static value, placeholder, or another function.

P3 (text): The P3 parameter must have a matching P4 parameter. This parameter is optional, and should contain the text "Default". This condition will be used when all other listed conditions fail. If the P3 and P4 parameters are not included, the function will return null if all other listed conditions fail.

P4 (any): The P4 parameter must have a matching P3 parameter. This parameter is optional, and returns the default value if all other conditions fail.

Returns (any): The P2 value of the first condition that matches the target field value, or returns the P4 value or null if none of the conditions match the target field value.

See Sequential "Case" Conditions - the MapValue() function for a detailed description of the function.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

73Table of Contents

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

74Table of Contents

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

75Table of Contents

Unauthorized Banks Unauthorized Banks

World Bank Ineligible Firms World Bank Ineligible Firms

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

76Table of Contents

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

77Table of Contents

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]]

Calculated Field [[InsuredContactPhone]]

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

Document E-mail Field

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

78Table of Contents

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]]

Document E-mail Field

Client Company Phone Word Ribbon Company Client / Client Phone

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

79Table of Contents

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

Client Company Code Word Ribbon Company Client / Client Code

E-mail [[InsuredCode]]

Calculated Field [[InsuredCode]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

80Table of Contents

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]]

Document E-mail Field

Individual Client CityError! Bookmark not defined. Word Ribbon Individual Client / Client City

E-mail [[InsuredCity]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

81Table of Contents

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

E-mail [[InsuredEmail]]

Calculated Field [[InsuredEmail]]

Document E-mail Field

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

82Table of Contents

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

Distributor City Word Ribbon Distributor / Distributor City

E-mail [[DistributorCity]]

Calculated Field [[DistributorCity]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

83Table of Contents

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.

Document E-mail Field

Distributor Commission Word Ribbon Distributor / Distributor Commission

E-mail [[DistributorCommission]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

84Table of Contents

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

85Table of Contents

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]]

Calculated Field [[DistributorContactFirstName]]

Document E-mail Field

Distributor Primary Contact Last Name

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

86Table of Contents

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.

Insurer Information

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

87Table of Contents

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]]

Document E-mail Field

Insurer Country Word Ribbon Insurer / Insurer Country

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

88Table of Contents

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.

Document E-mail Field

Insurer Reference Code Word Ribbon Insurer / Insurer Reference Code

E-mail [[InsurerReferenceCode]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

89Table of Contents

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

E-mail [[InsurerZipPostalCode]]

Calculated Field [[InsurerZipPostalCode]]

Document E-mail Field

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

90Table of Contents

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]]

Document E-mail Field

Insurer Primary Contact PhoneError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact Phone

E-mail [[InsurerContactPhone]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

91Table of Contents

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

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

E-mail [[LastQuotedDate]]

Calculated Field [[LastQuotedDate]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

92Table of Contents

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 Word Ribbon Policy Information / Cancellation Reason - Other Description

E-mail [[IfOtherSpecify]]

Calculated Field [[CancellationInfoUserControl/IfOtherSpecify]]

Document E-mail Field

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

93Table of Contents

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

Transaction ID Word Ribbon Policy Information / System ID

E-mail [[SubPolSystemID]]

Calculated Field [[SubPolSystemID]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

94Table of Contents

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

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

E-mail [[ModifiedByFirstName]]

Calculated Field See the $ModifiedByFirstName() function.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

95Table of Contents

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]]

Document E-mail Field

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

E-mail [[LastStatusChangedByLastName]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

96Table of Contents

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.

Document E-mail Field

Valid Until Date Word Ribbon Policy Information / Valid Until Date

E-mail [[PolicyValidUntilDate]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

97Table of Contents

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

Referral Reason E-mail [[Referral]]

Document E-mail Field

Lost Reason

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

98Table of Contents

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

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.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

99Table of Contents

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]]

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

100Table of Contents

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

Compliance Acceptance Reason Word Ribbon Compliance Information / Compliance Acceptance Reason

E-mail [[ComplianceAcceptanceReason]]

Calculated Field [[ComplianceAcceptanceReason]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

101Table of Contents

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]]

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

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

102Table of Contents

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 Word Ribbon Compliance Information / Compliance Rejection User Last Name

E-mail [[ComplianceRejectionUserLastName]]

Calculated Field [[ComplianceRejectionUserLastName]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

103Table of Contents

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.

Document E-mail Field

Insurer Name by Quote Option

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

104Table of Contents

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.

Document E-mail Field

Commission Amount by Quote Option and Premium Type

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

105Table of Contents

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

106Table of Contents

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.

Document E-mail Field

Premium Currency Name

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

107Table of Contents

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

Net Premium Word Ribbon Premium Information / Net Premium

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

108Table of Contents

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

109Table of Contents

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

Limit Amount

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

110Table of Contents

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

111Table of Contents

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.

Document E-mail Field

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

112Table of Contents

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

E-mail [[SubPolPolicyNo]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

113Table of Contents

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

114Table of Contents

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

115Table of Contents

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

116Table of Contents

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

117Table of Contents

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

118Table of Contents

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

119Table of Contents

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

120Table of Contents

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

121Table of Contents

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

122Table of Contents

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

123Table of Contents

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

124Table of Contents

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

125Table of Contents

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

126Table of Contents

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

127Table of Contents

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

128Table of Contents

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

129Table of Contents

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

130Table of Contents

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

131Table of Contents

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

132Table of Contents

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

133Table of Contents

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

134Table of Contents

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

135Table of Contents

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

136Table of Contents

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

137Table of Contents

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

138Table of Contents

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

139Table of Contents

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

140Table of Contents

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

141Table of Contents

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

142Table of Contents

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

143Table of Contents

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

144Table of Contents

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

145Table of Contents

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

146Table of Contents

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

147Table of Contents

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

148Table of Contents

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

149Table of Contents

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

150Table of Contents

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

151Table of Contents

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

152Table of Contents

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

153Table of Contents

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

154Table of Contents

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

155Table of Contents

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

156Table of Contents

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

157Table of Contents

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

158Table of Contents

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

159Table of Contents

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

160Table of Contents

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

161Table of Contents

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

162Table of Contents

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

163Table of Contents

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

164Table of Contents

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

165Table of Contents

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

166Table of Contents

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

167Table of Contents

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

168Table of Contents

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

169Table of Contents

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

170Table of Contents

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

171Table of Contents

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

172Table of Contents

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

173Table of Contents

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

174Table of Contents

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

175Table of Contents

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

176Table of Contents

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

177Table of Contents

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

178Table of Contents

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

179Table of Contents

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

180Table of Contents

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

181Table of Contents

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

182Table of Contents

Appendix E - Full Placeholders List for General System Information

While many placeholders are specific to certain modules, others are related to the system itself, or certain features that are available across modules.

Grid Information

Dynamic grids within the policy and claims workflows have a set of hidden tracking numbers that can be pulled into calculated fields. For each of these placeholders, the grid code must be provided.

Document E-mail Field

Grid Row Number Calculated Field [[gridcode_SequenceNo]]

Notes:o Must be used within a grid.o When used in child grids, the numbers will represent the overall row numbers across all parent rows. For row numbers

specific to each parent row, use the Child Row Number.o Row numbers may not be sequential. Deleting rows does not renumber existing rows, and new rows will always have a row

number one higher than the highest existing row number.

Document E-mail Field

Child Row Number Calculated Field [[gridcode_ChildSequenceNo]]

Notes:o Must be used within a grid.o When used in child grids, the numbers will represent the row numbers specific to each parent row. For overall row numbers

across all parent rows, use the Grid Row Number.o Row numbers may not be sequential. Deleting rows does not renumber existing rows, and new rows will always have a row

number one higher than the highest existing row number.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

183Table of Contents

Document E-mail Field

Grid Hierarchy Calculated Field [[gridcode_HierarchyId]]

Notes:o Must be used within a grid.o Displays the current row's position in the parent/child grid hierarchy, presented as a period-separated set of row numbers.

For example, the second row of the top-level grid has four child entries, and the third row of those child entries has one child entry, the hierarchy will display "2.3.1".

Document E-mail Field

Unique Row Identifier Calculated Field [[gridcode_Key]]

Notes:o Must be used within a grid.o Displays a unique internal ID code for the row.

Document E-mail Field

Next Row Number Calculated Field [[gridcode_NextSequenceNo]]

Notes:o Displays the next row number to be used when adding a new row to the selected grid.o Row numbers may not be sequential. Deleting rows does not renumber existing rows, and new rows will always have a row

number one higher than the highest existing row number.

Document E-mail Field

Next Child Row Number Calculated Field [[gridcode_NextChildSequenceNo]]

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

184Table of Contents

Notes:o Must be used within a grid.o Displays the next child row number to be used when adding a new child row to the current parent row.o Row numbers may not be sequential. Deleting rows does not renumber existing rows, and new rows will always have a row

number one higher than the highest existing row number.

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

185Table of Contents

Index

$$Child() function 67$CreatedByFirstName() function 61$CreatedByLastName() function 61$CrossPolicyExactMatch() function 57$CrossPolicyFuzzyMatch() function 57$Exp() function 64$GetTermNumber() function 60$GetTermStatus() function 59$GetTermTaxAmount() function 61$GetTransactionStatus() function 60$GetTransactionTaxAmount() function 61$GetTransactionType() function 60$GetUser() function 55$If() function 71$InterpolatedLookup() function 64$IsNewBusiness() function 56$Lookup() function 70$ModifiedByFirstName() function 62$ModifiedByLastName() function 62$NextAdjustmentNumber() function 60$NextEndorsementNumber() function 60$Parent() function 67$TotalCommissionAmount() function 61$TotalGrossPremiumAmount() function 60$TotalTaxesAmount() function 61$UserContainsRole() function 55AAdd Days function 53Add Hours function 52Add Months function 53Add operator 3Add Years function 53AddDays() function 53

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

186Table of Contents

AddHours() function 52AddMonths() function 53Address Line One placeholder 154Address Line Two placeholder 154AddYears() function 53Adjusted Months function 65AdjustedMonths() function 65Adjuster party role 152Adjustment Number placeholder 98Alias field 58And condition 28Appendix A – Compliance() Function Parameters 73Appendix B - Full Placeholders List for Policy Information 76Appendix C - Full Placeholders List for Billing Information 126Appendix D - Full Placeholders List for Claims Information 148Appendix E - Full Placeholders List for General System Information 182Arithmetic Expressions 5Assured filter 57Attachments 95Avg function 62Avg() function 62BBank Details General Purpose Field One placeholder 159Bank Details General Purpose Field Three placeholder 160, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177,

178Bank Details General Purpose Field Two placeholder 160Bank Details, Account Number placeholder 158Bank Details, Address placeholder 158Bank Details, City placeholder 159Bank Details, Country placeholder 159Bank Details, Name placeholder 158Bank Details, Postal Code placeholder 159Bank Details, Routing Number placeholder 158Bank Details, State or Province placeholder 159Bill to Party Account Number placeholder 140Bill to Party Address placeholder 139Bill to Party City placeholder 139Bill to Party Country placeholder 140

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

187Table of Contents

Bill to Party Email placeholder 140Bill To Party Information 139Bill to Party Name placeholder 139Bill to Party On Account Balance Currency placeholder 141Bill to Party On Account Balance placeholder 140Bill to Party Phone placeholder 140Bill to Party State placeholder 140Bill to Party Zip placeholder 139Billing Integration Fields 147Billing Workflow Details 117Bound Date placeholder 97Building Conditional Expressions 27Building Formulas 3CCalculated Field placeholders 76, 126, 148Cancellation Date placeholder 92Cancellation Reason - Other placeholder 93Cancellation Reason placeholder 92Cause of Loss placeholder 151Certificate Number placeholder 178, 179, 180, 181Charge Adjustment Type placeholder 143Charge Amount Due placeholder 143Charge Currency placeholder 143Charge Date placeholder 144Charge Description placeholder 144Charge Gross Amount placeholder 145Charge Information 143Charge Policy Number placeholder 144Charge Policy Transaction ID placeholder 144Charge Premium Type placeholder 145Charge System Claim Number placeholder 144Charge Total Amount Due placeholder 145Charge Total Amount placeholder 145Charge Total Commission Amount placeholder 145Charge Total Tax Amount placeholder 146Check Compliance Hit function 70CheckComplianceHit() function 70Child function 67

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

188Table of Contents

Child() function 67City placeholder 154Claim Information 148Claim Party Information 151Claim Payment Information, Multiple Filtered Payments 178Claim Payment Information, Single Instance 160Claimant party role 151Clear Grid function 69ClearGrid() function 69Client Address placeholder 134Client City placeholder 134Client Company Address placeholder 76Client Company City placeholder 76Client Company Code placeholder 80Client Company Contact Email placeholder 78Client Company Contact Employee Number placeholder 77Client Company Contact First Name placeholder 77Client Company Contact Last Name placeholder 77Client Company Contact Phone placeholder 77Client Company Country placeholder 78Client Company Fax placeholder 78Client Company Information 76Client Company Name placeholder 78Client Company Phone placeholder 79Client Company State placeholder 79Client Company Website placeholder 79Client Company Zip/Postal Code placeholder 79Client Country placeholder 135Client Email placeholder 135Client Information 134Client Name placeholder 134Client Phone placeholder 135Client State placeholder 135Client Zip placeholder 135Close Bracket operator 3Code field 4, 7, 33, 34, 35, 57, 58, 59Combined conditions 28Commas 17

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

189Table of Contents

Commission Amount by Quote Option and Premium Type placeholder 105Commission Details 7, 9, 11Commission placeholder 107Compare Data Against Sanction or Watch Lists 31Compare function 56Compare() function 56Compliance Acceptance Reason placeholder 101Compliance Accepted By First Name placeholder 101Compliance Accepted By Last Name placeholder 101Compliance Accepted On Date placeholder 102Compliance Accepted placeholder 102Compliance Detailed Message placeholder 99Compliance Executed On placeholder 99Compliance function 69, 73Compliance Information 99Compliance Message placeholder 99Compliance Referral Requested By First Name placeholder 100Compliance Referral Requested By Last Name placeholder 100Compliance Referral Requested On Date placeholder 100Compliance Rejected By First Name placeholder 102Compliance Rejected By Last Name placeholder 103Compliance Rejected On Date placeholder 103Compliance Rejection Reason placeholder 102Compliance Successful placeholder 99Compliance() function 69, 73Concatenation (combining data) 5Conditional Results – the IF Function 18Conditional Selection of Grid Rows - the Where() function 24Contact Name placeholder 153, 154Core Field Code placeholders 148Correction Type placeholder 96Count function 62Count() function 62Country placeholder 155Created By First Name function 61Created By First Name placeholder 94Created By Last Name function 61Created By Last Name placeholder 94

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

190Table of Contents

CreatedByFirstName() function 61CreatedByLastName() function 61Cross Policy Exact Match function 57Cross Policy Fuzzy Match function 57Cross-Policy Data Configuration 57CrossPolicyExactMatch() function 57CrossPolicyFuzzyMatch() function 57Current Date Time function 52Current Term Commission Amount placeholder 115Current Term Effective Date placeholder 113Current Term Expiry Date placeholder 114Current Term ID placeholder 113Current Term Information 9, 113Current Term Number placeholder 114Current Term Policy Number placeholder 113Current Term Premium Amount placeholder 114Current Term Tax Amount by Premium placeholder 115Current Term Total Commission Amount placeholder 115Current Term Total Premium Amount placeholder 114Current Term Total Tax Amount placeholder 115Current Transaction Deductible Information 110Current Transaction Information 7Current Transaction Limit Information 109Current Transaction Premium, Commission, Tax Information 106CurrentDateTime() function 52Custom Date Format function 55Custom Date Format Function 37CustomDateFormat() function 55DDate Comparison Field 34, 35Date Long function 54Date of Loss placeholder 149Date Overlap function 52Date Picker field 34Date Reported placeholder 149Date Short function 55Date Time Long function 54Date Time Short function 55

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

191Table of Contents

DateLong() function 54DateOverlap() function 52DateShort() function 55DateTimeLong() function 54DateTimeShort() function 55Day - Double Digit placeholder 120Day - Single Digit placeholder 120Days Between function 50Days In Period function 51DaysBetween() function 50DaysInPeriod() function 51Deductible Amount by Quote Option, Premium Type, and Deductible Type placeholder 105Deductible Amount or Percentage placeholder 111Deductible Amount placeholder 112Deductible Currency placeholder 112Deductible Description placeholder 111Deductible Premium Type Name placeholder 111Deductible Type placeholder 111Deductibles 14Defining Multiple Fields in a Function 17Defining String Data 4Defining the Results 19Description of Loss placeholder 150Detailed Function Descriptions 31Detected Changes Timestamp Field 33, 34Distributor Address placeholder 82, 136Distributor City placeholder 83, 136Distributor Commission placeholder 84Distributor Country placeholder 84, 136Distributor Email placeholder 137Distributor Fax placeholder 84Distributor filter 57Distributor Information 82, 136Distributor Name placeholder 84, 136Distributor party role 152Distributor Phone placeholder 85, 137Distributor Primary Contact Email placeholder 86Distributor Primary Contact Employee Number placeholder 86

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

192Table of Contents

Distributor Primary Contact First Name placeholder 85Distributor Primary Contact Last Name placeholder 86Distributor Primary Contact Phone placeholder 86Distributor State placeholder 137Distributor State/Province placeholder 85Distributor Website placeholder 85Distributor Zip placeholder 136Distributor Zip/Postal Code placeholder 85Divide operator 3EEffective Date 71Effective Date placeholder 96Email Address placeholder 152E-mail placeholders 76, 126, 148Endorsement Number placeholder 97e-Signature Document Created By Name placeholder 124e-Signature Document Status Modified On Date placeholder 125e-Signature Tag placeholder 124Exp function 64Exp() function 64External Code field 147FFax Number placeholder 153Field Evaluation Rule 59Field Indexing 58Field Management page 4, 147File Upload field 95Filter type 57Filter Values 57Formatted Date 1 placeholder 121Formatted Date 2 placeholder 121Formatted Date 3 placeholder 121Formatted Date 4 placeholder 121Full Date placeholder 121Full Function Reference List 50Full Month Name placeholder 122Functions 16Functions to Enter Data Into Grids (Grid Mapping) 40

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

193Table of Contents

GGet Day Of Month function 54Get Day Of Year function 53Get Days From Current function 54Get Month function 53Get Months From Current function 54Get OFAC Scan function 69Get Term Number function 60Get Term Status function 59Get Term Tax Amount function 61Get Transaction Status function 60Get Transaction Type function 60Get TransactionTax Amount function 61Get User function 55Get Year function 53Get Years From Current function 54GetDayOfMonth() function 54GetDayOfYear() function 53GetDaysFromCurrent() function 54GetMonth() function 53GetMonthsFromCurrent() function 54GetOFACScan() function 69GetTermNumber() function 60GetTermStatus() function 59GetTermTaxAmount() function 61GetTransactionStatus() function 60GetTransactionTaxAmount() function 61GetTransactionType() function 60GetUser() function 55GetYear() function 53GetYearsFromCurrent() function 54Grid Information 182Gross Premium Amount placeholder 106Guide 2HHash And Modified On function 56Hash Function Field 33Hash Reference Field 33

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

194Table of Contents

HashAndModifiedOn() function 32, 56IIdentifying When Fields Have Changed After an Integration 32If function 59, 71If not 28If() function 18, 71Individual Client Address placeholder 80Individual Client City placeholder 81Individual Client Code placeholder 82Individual Client Country placeholder 81Individual Client Email placeholder 81Individual Client First Name placeholder 80Individual Client Information 80Individual Client Last Name placeholder 80Individual Client Phone placeholder 82, 83Individual Client State/Province placeholder 81Individual Client Zip placeholder 81Installment Date placeholder 146Installment Information 146Installment Next Date placeholder 146Installment Number placeholder 146Insured party role 152Insurer Address placeholder 87, 137Insurer City placeholder 87, 138Insurer Client Code placeholder 87Insurer Code placeholder 87Insurer Country placeholder 88, 138Insurer Email placeholder 138Insurer Fax placeholder 88Insurer Information 87, 137Insurer Name by Quote Option placeholder 103, 104Insurer Name placeholder 88, 137Insurer party role 152Insurer Phone placeholder 88, 138Insurer Primary Contact Email placeholder 90Insurer Primary Contact Employee Number placeholder 90Insurer Primary Contact First Name placeholder 90Insurer Primary Contact Last Name placeholder 90

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

195Table of Contents

Insurer Primary Contact Phone placeholder 91Insurer Reference Code placeholder 89Insurer Risk Percentage placeholder 89Insurer State placeholder 138Insurer State/Province placeholder 89Insurer Website placeholder 89Insurer Zip placeholder 138Insurer Zip/Postal Code placeholder 90Insuring Conditions by Quote Option placeholder 106Integration Flag Field 34, 35Internal Transaction ID placeholder 94Interpolated Lookup function 64InterpolatedLookup() function 35, 64Interpolation/Extrapolation 35Introduction 2Invoice Created On Date placeholder 128Invoice Currency placeholder 128Invoice Due Date placeholder 128Invoice Information 126Invoice Issue Date placeholder 126Invoice Net Amount placeholder 127Invoice Number placeholder 126Invoice Outstanding Amount placeholder 128Invoice Total Amount Due placeholder 127Invoice Total Amount placeholder 127Invoice Total Commission Amount placeholder 127Invoice Total Tax Amount placeholder 127Is Abn Valid function 55Is Date Greater Than function 51Is New Business function 56Is Not Null function 59Is Null function 58Is Numeric function 59IsAbnValid() function 55IsDateGreaterThan() function 33, 51IsNewBusiness() function 56IsNotNull() function 59IsNull() function 58

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

196Table of Contents

IsNumeric() function 59LL Case function 64Last Integration Run Date and Time placeholder 96Last Modified By First Name placeholder 95Last Modified By Last Name placeholder 95Last Modified Date placeholder 95Last Status Changed By First Name placeholder 96Last Status Changed By Last Name placeholder 96LCase() function 64Length function 63Length() function 63Limit Amount by Quote Option, Premium Type, and Limit Type placeholder 105Limit Amount placeholder 110Limit Currency placeholder 110Limit Description placeholder 109Limit Premium Type Name placeholder 109Limit Type placeholder 109Limits 13Live - Next Sequence Number field 59Long Date placeholder 122Lookup function 70Lookup Tables 70Lookup() function 70Loss Amount Currency placeholder 150Loss Amount placeholder 150Lost Reason placeholder 98MMatch All function 66Match Any function 66MatchAll() function 66MatchAny() function 66Max function 65Max() function 65Mid function 63Mid() function 63Min function 65Min() function 65

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

197Table of Contents

Modified By First Name function 62Modified By Last Name function 62ModifiedByFirstName() function 62ModifiedByLastName() function 62Month - Double Digit placeholder 122Month - Single Digit placeholder 122Month Day placeholder 122Months Between function 50MonthsBetween() function 50Multiply function 62Multiply operator 3Multiply() function 62NName column 15Name placeholder 152Negative Conditions 28Net Premium placeholder 108New Grid function 41, 68, 71NewGrid() function 41, 68, 71Next Adjustment Number function 60Next button 95Next Endorsement Number function 60Next Policy Sequence Number function 59Next Sequence Number field 59NextAdjustmentNumber() function 60NextEndorsementNumber() function 60NextPolicySequenceNumber() function 59OOpen Bracket operator 3Operator 27Operators 3, 5, 27Or condition 28Other 123Outstanding Invoice Amount Currency placeholder 129Outstanding Invoice Amount placeholder 128Outstanding Invoice Date placeholder 129Outstanding Invoice Due Date placeholder 129Outstanding Invoice Number placeholder 129

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

198Table of Contents

Outstanding Invoice Remaining Balance Currency placeholder 130Outstanding Invoice Remaining Balance placeholder 130Outstanding Invoice Total Amount Currency placeholder 130Outstanding Invoice Total Amount placeholder 130Outstanding Invoice Total Remaining Balance Currency placeholder 131Outstanding Invoice Total Remaining Balance placeholder 130PParent function 67Parent() function 67Party Claim Number placeholder 152Party Role placeholder 152Payee Address placeholder 155Payee City placeholder 156Payee Country placeholder 156Payee Email Address placeholder 157Payee Fax Number placeholder 157Payee General Purpose Field One placeholder 157Payee General Purpose Field Three placeholder 158Payee General Purpose Field Two placeholder 157Payee Name placeholder 155Payee Phone Number placeholder 156Payee Postal Code placeholder 156Payee Reference Number placeholder 155Payee State or Province placeholder 156Payment Amount placeholder 161Payment Category placeholder 163Payment Check Number placeholder 162Payment Coverage placeholder 163Payment Currency placeholder 157, 162Payment Date placeholder 161Payment Description placeholder 163Payment Method placeholder 157Payment Party Code placeholder 164Payment Party Name placeholder 164Payment Plan Installment Amount Due placeholder 118Payment Plan Installment Commission Amount placeholder 119Payment Plan Installment Currency placeholder 120Payment Plan Installment Date placeholder 118

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

199Table of Contents

Payment Plan Installment Gross Amount placeholder 119Payment Plan Installment Number placeholder 117Payment Plan Installment Tax Amount placeholder 118Payment Plan Installment Total Amount Due placeholder 119Payment Plan Installment Total Installment Amount placeholder 120Payment Plan Name placeholder 117Payment Reference Number placeholder 162Payment Status placeholder 162Payment Type placeholder 161Phone Number placeholder 152Pipe Character 17Placeholders 7Placeholders Within Formulas 4Policy Created Date placeholder 91Policy filter 57Policy First Quoted Date placeholder 91Policy Information 91, 141Policy Last Quoted Date placeholder 92Policy Number 12Policy Number placeholder 151Policy Numbering page 59Policy Term Billing Option placeholder 141Policy Term Effective Date placeholder 141Policy Term ID placeholder 141Policy Term Payment Plan placeholder 141Policy Term Policy Number placeholder 142Policy Term Valid Until Date placeholder 142Policy Transaction Effective Date placeholder 142Policy Transaction ID placeholder 142Policy Transaction Type placeholder 142Policy Transaction Valid Until Date placeholder 143PolicyTransaction filter 58PolicyTransactionStatus filter 58Postal Code placeholder 155Premium Amount by Quote Option and Premium Type placeholder 104Premium Currency Code placeholder 107Premium Currency Name placeholder 107Premium Details 7, 9, 11

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

200Table of Contents

Premium Type List page 15Premium Type Management page 15Premium Type Name placeholder 106Premium Types menu item 15Previous button 95Previous Term Commission Amount placeholder 116Previous Term Information 11, 115Previous Term Policy Number placeholder 115Previous Term Premium Amount placeholder 116Previous Term Premium Name by Premium Id placeholder 116Previous Term Tax Amount by Premium placeholder 117Previous Term Total Commission Amount placeholder 116Previous Term Total Premium Amount placeholder 116Previous Term Total Tax Amount placeholder 117Product Design menu 15Product filter 57Product placeholder 92QQuote Information 103RReference 73Reinstatement Reason placeholder 93Replace function 67Replace() function 67Retrieving Premium IDs 15Round function 62Round() function 62SSave & Refresh button 95Save Payment action 160Save To Field function 68Save To Grid function 41, 68SaveToField() function 68SaveToGrid() function 41, 68Separate Invoicing by Transaction checkbox 143Sequential "Case" Conditions - the MapValue() function 22Set Max function 66Set Min function 65

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

201Table of Contents

SetMax() function 66SetMin() function 65Short Date placeholder 122Simple Arithmetic Formulas 3State or Province placeholder 155Statement Closing Balance placeholder 131Statement Information 128Statement Total Amount Due placeholder 131Statement Transaction Amount Currency placeholder 131Statement Transaction Amount placeholder 131Statement Transaction Date placeholder 132Statement Transaction Due Date placeholder 132Statement Transaction Number placeholder 132Statement Transaction Reference placeholder 132Statement Transaction Remaining Balance Currency placeholder 133Statement Transaction Remaining Balance placeholder 133Statement Transaction Total Amount Currency placeholder 133Statement Transaction Total Amount placeholder 133Statement Transaction Total Remaining Balance Currency placeholder 134Statement Transaction Total Remaining Balance placeholder 133Statement Transaction Type placeholder 134Status placeholder 96Straight Quotes 5, 7String modifier 5Subtract operator 3Sum function 62Sum() function 62System Date 120System Number placeholder 148, 149, 150TTake First function 66Take Last function 66TakeFirst() function 66TakeLast() function 66Tax Amount by Quote Option, Premium Type, and Tax Type placeholder 104Tax Amount placeholder 108Tax Details 8, 10, 12Tax Name placeholder 108

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

202Table of Contents

Term Period Dates 10Test - Next Sequence Number field 59Text Area control type 70Text Area field 33Textbox field 34The $If() Function 18The If/Then Conditional Structure 18Today Long function 52Today Short function 52Today Xml function 52TodayLong() function 52TodayShort() function 52TodayXml() function 52Total Commission Amount function 61Total Commission Amount placeholder 107Total Commission by Quote Option placeholder 105Total Gross Premium Amount function 60Total Gross Premium Amount placeholder 107Total Net Premium Amount placeholder 108Total Online Payment Amount placeholder 143Total Premium by Quote Option placeholder 104Total Tax by Quote Option placeholder 105Total Taxes Amount function 61Total Taxes Amount placeholder 109TotalCommissionAmount() function 61TotalGrossPremiumAmount() function 60TotalTaxesAmount() function 61Tracked Fields 33Transaction ID field 94Transaction ID placeholder 94Transaction Information 94Trigger function 71Trigger() function 71Trim function 63Trim() function 63UU Case function 63UCase() function 63

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

203Table of Contents

URL to Current Transaction placeholder 123User Contains Role function 55User Contains Security Role function 56UserContainsRole() function 31, 55, 56UserContainsSecurityRole() function 56User's Browser Culture placeholder 123VValid Until Date placeholder 97Value Exists function 58ValueExists() function 58Verifying User Security Roles 31Void Reason Code placeholder 98Void Reason Details placeholder 98Void Reason Name placeholder 98WWhere function 69Where() function 69Word Ribbon placeholders 76, 126, 148Workflow Event 160Working with Boolean Values 29YYear Month placeholder 123Year placeholder 123Years Between function 50YearsBetween() function 50

Version 2.4.86 Bridge User Guide User Guide - Calculated Fields

Copyright Notice

Copyright © 1998 - 2017 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).