Bridge User Guide - Calculated Fields - Oceanwidehelpdocs.oceanwide.com/ow_files/bridge_docs/help... · Web viewSome placeholders use single quotes ' to identify a specific version

0Table of Contents

Version 2.4.85 Bridge User Guide User Guide - Calculated Fields

Bridge

User Guide - Calculated Fields

Version 2.4.85

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


iiTable of Contents

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

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

Conditional Results – the If() Function..................................................................18Using Data and Comparison Operators as the Condition................................................18Using a Trigger as the Condition......................................................................................18Defining the Results.........................................................................................................18

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

Building Conditional Expressions..........................................................................24Operators.........................................................................................................................24Negative Conditions.........................................................................................................25Combined conditions........................................................................................................25Working with Boolean Values...........................................................................................26

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

Full Function Reference List...................................................................................47

REFERENCE......................................................................................................67

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

Appendix B - Full Placeholders List for Policy Information................................70Client Company Information.............................................................................................70Individual Client Information.............................................................................................74Distributor Information......................................................................................................76Insurer Information...........................................................................................................81Policy Information.............................................................................................................85Transaction Information...................................................................................................88Compliance Information...................................................................................................93Quote Information............................................................................................................97Current Transaction Premium, Commission, Tax Information........................................100Current Transaction Limit Information............................................................................103Current Transaction Deductible Information...................................................................104Current Term Information...............................................................................................107


iiiTable of Contents

Previous Term Information.............................................................................................109Billing Workflow Details..................................................................................................111System Date...................................................................................................................114Other.............................................................................................................................. 117

Appendix C - Full Placeholders List for Billing Information..............................120Invoice Information.........................................................................................................120Statement Information....................................................................................................122Client Information...........................................................................................................128Distributor Information....................................................................................................130Insurer Information.........................................................................................................131Bill To Party Information.................................................................................................133Policy Information...........................................................................................................135Charge Information........................................................................................................137Installment Information...................................................................................................140Billing Integration Fields.................................................................................................141

Appendix D - Full Placeholders List for Claims Information.............................142Claim Information...........................................................................................................142Claim Party Information..................................................................................................145Claim Payment Information, Single Instance..................................................................154Claim Payment Information, Multiple Filtered Payments................................................172

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

INDEX................................................................................................................179


1Table of Contents


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.


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:


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.


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.


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.


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


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



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


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


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


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


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


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


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


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


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


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


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



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



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.


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.


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


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.

The condition function can be constructed as follows:

If Condition then TrueValue else FalseValue endif

-or-

If(TriggerCode, TrueValue, FalseValue)

Using Data and Comparison Operators as the Condition

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.

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

Using a Trigger as the Condition

The TriggerCode identifies a trigger, which is created in the system and contains all necessary conditions to evaluate as true or false. For details about configuring triggers, see the Managing Triggers section of the User Guide - Product Design document.

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


19Table of Contents

Defining the Results

The TrueValue and FalseValue data can include placeholders, formulas, or even other functions (including other If() functions). When using the If then else structure, the else can be omitted which produces no result (null) if the function evaluates as false.

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

If(TriggerCode,[[FieldA]]*12,[[FieldA]])

-or-

If Value1 operator Value2 then [[FieldA]]*12 else [[FieldA]] endif

The function could return the user's name (concatenated from two fields with a space to divide them) or their spouse's name (also concatenated).

String:If(TriggerCode,[[UserFirstName]] [[UserLastName]],[[SpouseFirstName]] [[SpouseLastName]])(The String: option is included to ensure that the spaces are treated as text)

-or-

If Value1 operator Value2 then [[UserFirstName]] " " [[UserLastName]] else [[SpouseFirstName]] " " [[SpouseLastName]] endif

(The spaces between the names are enclosed in quotes, or they would be ignored)

Using functions in the True/False values allows these If() functions to return the sum of a table column, or the average of the values in that column.

If(TriggerCode,Sum([[Column1]]),Avg([[Column1]]))

-or-

If Value1 operator Value2 then Sum([[Column1]]) else Avg([[Column1]]) endif

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


20Table of Contents

concatenation to form the final value of the calculated field.

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

-or-

(If Value1 operator Value2 then TrueValue else FalseValue endif + [[Value]]) * If Value3 operator Value4 then TrueValue else FalseValue endif / 2

These functions take the conditional result of the first If() statement and add it to the amount in the Value field, then multiply that by the conditional result of the second If() statement, and divide the entire value by 2.

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


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


22Table 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".


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


24Table 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


25Table 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


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


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


28Table 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:


29Table 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:


30Table 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)


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


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


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


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


35Table 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".


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


37Table 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)


38Table 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


39Table 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








40Table of Contents


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






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.


41Table 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




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





42Table 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






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


Row 1 Field 1 Row 1 Field 2


Row 3 Field 1 Row 3 Field 2



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


44Table 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




Source Child Data for Source Parent Row 2


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


Source Child Data for Source Parent Row 4



45Table of Contents



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.


46Table 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




Target Child Data for Target Parent Row 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.


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


YearsBetween(p0, p1)


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


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.


49Table 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


50Table 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)


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


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


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


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


55Table 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)


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

NextPolicySequenceNumber()Retrieves the next sequence number, as it appears in the Next Sequence Number field in the Master Cover - Policy Numbering page.

No parameters.Returns (numeric): Returns the next sequence number.

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

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

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

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

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

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

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

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

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

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

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


57Table of Contents

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

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

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

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

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

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

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

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

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

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

$GetTransactionTaxAmount(p0)Calculates the total amount of a certain tax or fee across all premium types within the current transaction.

P0 (text): The Code of the tax or fee.Returns (numeric): Returns the total amount of the specified tax or fee for all premium types within the current transaction. This value is only available once quotes have been calculated and a quote option has been selected.

$GetTermTaxAmount(p0)Calculates the total amount of a certain tax or fee across all premium types, for all other transactions within the current term. This does not include the current transaction.

P0 (text): The Code of the tax or fee.


58Table of Contents

Returns (numeric): Returns the total amount of the specified tax or fee across all premium types, for all other transactions within the current term. This does not include the current transaction. Tax and fee details are only available for transactions where quotes have been calculated and a quote option has been selected.

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

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

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

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

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

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

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

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

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

P0 (any type): Any mix of fields and grid columns. See Defining Multiple Fields in a Function for details.Returns (numeric): Number of records in collection p0.

Sum(p0)


59Table of Contents

Calculates the sum of a range of fields.P0 (numeric collection): Any mix of numeric fields, grid columns, and policy details. See Defining Multiple Fields in a Function for details.Returns (numeric): The sum of elements in collection p0.

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

P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.Returns (numeric): The average value in collection p0.

Multiply(p0)Multiplies all values in a specified range of fields.

P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.Returns (numeric): The multiplied total of all values in collection p0.

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

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

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

Returns (numeric): Round off p0 parameter to the appropriate multiple of p1 according to the round mode p2eg. Round(10.7, 1, 0) will round to the nearest 1, resulting in 11.

Round(10.7, 1, 2) will round down to the nearest 1, resulting in 10.Round(1100, 500, 1) will round up to the nearest 500, resulting in 1500.

$Exp(p0, p1)Calculates exponential values.

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

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

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


60Table of Contents

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

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

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

See Interpolation/Extrapolation for a detailed description of the function.

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

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

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

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

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

P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.Returns (numeric): The minimum value in collection p0.

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

P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.


61Table of Contents

Returns (numeric): The maximum value in collection p0

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

P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.P1 (numeric): The minimum or maximum value returned, depending on the Mode.P2 (numeric): Mode

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

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

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

P0 (numeric collection): Any mix of numeric fields and grid columns. See Defining Multiple Fields in a Function for details.P1 (numeric): The maximum or minimum value returned, depending on the Mode.P2 (numeric): Mode:

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

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

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

P0 (text): The field (column) Code to be found among the parent grids. This condition is literal and must contain the Code of the field, no placeholders or functions can be used here.Returns (any): The correlated value from the selected field in the parent grid.Note: This function is no longer required, but is still supported for backwards compatibility. Using a normal placeholder to reference a field from a parent grid will now return just the data associated to the current child record.

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

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


62Table of Contents

For example: $Child(FieldCode)Returns (any): The correlated values from the selected field in the child grid. Multiple values are returned separated by pipe characters ( | ). The results can be displayed directly using a text field, but this function is primarily intended for use within other grid related functions such as Sum(), Count(), and Avg(). Since this function can return multiple values, it cannot be used in calculations or as a condition in functions that expect a single input value.Note: This function is no longer required, but is still supported for backwards compatibility. Using a normal placeholder to reference a field from a child grid will now return just the data associated to the current parent record.

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

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

selects, and radio buttons), the default [[Placeholder]] format will return the codes for the selected options. Using [[Placeholder:Label]] will return the labels for the selected options instead of the codes.If the option list is of Type: Static and Resource Type: Custom, alternate language versions may be defined for the labels. The appropriate version will be returned according to the browser language settings.

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

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

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

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

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

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

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


63Table of Contents

SaveToField(p0, p1)Saves a specific value to a specific field in the workflow.

P0 (text): The code of the target field to receive the data, not enclosed in brackets. The code can be entered directly, retrieved from a field by a placeholder, or calculated with conditional logic. Any method must return the code of the target field as straight text.

P1 (any): The value to be saved in the target field. This can be a literal value, a placeholder, or a calculated value.Returns (any): The calculated field itself will display the last value that was saved to the target field.

eg. SaveToField(TargetField, [[SourceField]]/2) will take the value in field [[SourceField]], divide it by 2, and save the result in field TargetField.SaveToField(TargetField, "Does not apply") will save the text Does not apply in field TargetField. This function will always save the same data in the field, so it would most likely be used within a conditional structure to only save the data under certain circumstances.

SaveToGrid(p0, p1_SequenceNo, p2, p3, p4, p3, p4, …)NewGrid(p0, p1_SequenceNo, p2, p3, p4, p3, p4, …)

Adds one or more rows to a grid, or edits a single row within a grid. The SaveToGrid() function adds new rows to a grid that may have existing data, while the NewGrid() function deletes all rows from the grid before adding new rows.

P0 (text): Code of the target grid. This must be a static code, not enclosed in brackets or quotes.P1 (text): This parameter is optional, and is used in conjunction with P2 to update a single row in the target grid. The format is the

Code of the target grid followed by "_SequenceNo", such as GridCode_SequenceNo. This must be a static code, not enclosed in brackets or quotes.

P2 (integer): This parameter is optional, and is used in conjunction with P1 to update a single row in the target grid. This is the row number to be updated. This must be an integer, and can be a static value, the result of an embedded formula, or a placeholder to retrieve the value from another field.

P3 (text): Code of the recipient field in the target grid. This must be a static code, not enclosed in brackets or quotes. There can be multiple recipient fields, but each P3 must be followed by an associated P4 parameter.

P4 (text): Value to be inserted into the recipient field. This can be a static value or a placeholder to retrieve the value from another field. Each P4 must follow an associated P3 parameter.

Returns (text): The row number for each row added or edited. See Functions to Enter Data Into Grids (Grid Mapping) for a detailed description of the function.

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)


64Table of Contents

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 scannedP1 (text): Code of the first list the data should be checked against. At least one list must be included, but additional lists can be

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

being no match. If more than one list is provided, the highest value is returned. See Compare Data Against Sanction or Watch Lists for a detailed description of the function.

CheckComplianceHit(p0, p1, p2, p3, p4, p5, p6)Takes a provided field and compares the text to one or more lists of names and places under sanctions, and stores the results in provided fields.

P0 (text): The field or static value identifying the type of scan to perform. The value must be one of the following options: Company = Scans against company names. Country = Scans against country names. Person = Scans against names of individuals. Unknown = If the type of data being scanned is unknown, this option will scan against all list types. This option will take

longer to process.P1 (text area): The field to receive the reasons for any failed scans. This should be a Text Area field, as the results could be

extensive. This will include the matching percentage score, entity type, and entity name, plus additional information provided by the scan.

P2 (any): The field to receive just the matching percentage scores for any failed scans. The resulting values will be from 0 to 100.P3 (text): The field to receive the list names where the scans failed.


65Table of Contents

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)Takes one or more condition fields and checks a lookup table for the value that matches the conditions, returning that value. Lookup tables are configured in the Lookup Tables option in the Product Design menu. For details about configuring lookup tables, see the Lookup Tables section of the User Guide - Product Design document.

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

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

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

If(p0, p1, p2)Evaluates a trigger and returns one value or another. For details on working with the If() functions, see Conditional Results.

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


66Table of Contents

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.


67Table 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


68Table 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


69Table of Contents

Unauthorized Banks Unauthorized Banks

World Bank Ineligible Firms World Bank Ineligible Firms


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



71Table of Contents


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

E-mail [[InsuredContactFirstName]]

Calculated Field [[InsuredContactFirstName]]


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

E-mail [[InsuredContactLastName]]

Calculated Field [[InsuredContactLastName]]


Client Company Contact Employee Number Word Ribbon Company Client / Client Contact Employee Number

E-mail [[InsuredContactEmployeeNumber]]

Calculated Field [[InsuredContactEmployeeNumber]]


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.



72Table of Contents

Client Company Contact Email Word Ribbon Company Client / Client Contact Email

E-mail [[InsuredEmail]]

Calculated Field [[InsuredEmail]]


Client Company Country Word Ribbon Company Client / Client Country

E-mail [[InsuredCountry]]

Calculated Field [[InsuredCountry]]


Client Company Fax Word Ribbon Company Client / Client Fax

E-mail [[InsuredFax]]

Calculated Field [[InsuredFax]]



Client Company Name Word Ribbon Company Client / Client Name

E-mail [[InsuredCompanyName]]

Calculated Field [[InsuredCompanyName]]


Client Company Phone Word Ribbon Company Client / Client Phone


73Table of Contents

E-mail [[InsuredPhone]]

Calculated Field [[InsuredPhone]]



Client Company State Word Ribbon Company Client / Client State

E-mail [[InsuredState]]

Calculated Field [[InsuredState]]


Client Company Website Word Ribbon Company Client / Client Website

E-mail [[InsuredWebsite]]

Calculated Field [[InsuredWebsite]]


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

E-mail [[InsuredZip]]

Calculated Field [[InsuredZip]]


Client Company Code Word Ribbon Company Client / Client Code

E-mail [[InsuredCode]]

Calculated Field [[InsuredCode]]


74Table of Contents

Individual Client Information


Individual Client First NameError! Bookmark not defined. Word Ribbon Individual Client / Client First Name

E-mail [[InsuredContactFirstName]]

Calculated Field [[InsuredContactFirstName]]


Individual Client Last NameError! Bookmark not defined. Word Ribbon Individual Client / Client Last Name

E-mail [[InsuredContactLastName]]

Calculated Field [[InsuredContactLastName]]


Individual Client AddressError! Bookmark not defined. Word Ribbon Individual Client / Client Address

E-mail [[InsuredAddress]]

Calculated Field [[InsuredAddress]]


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

E-mail [[InsuredCity]]


75Table of Contents

Calculated Field [[InsuredCity]]


Individual Client Country Word Ribbon Individual Client / Client Country

E-mail [[InsuredCountry]]

Calculated Field [[InsuredCountry]]


Individual Client State/ProvinceError! Bookmark not defined. Word Ribbon Individual Client / Client State

E-mail [[InsuredState]]

Calculated Field [[InsuredState]]


Individual Client Zip Word Ribbon Individual Client / Client Zip/Postal Code

E-mail [[InsuredZip]]

Calculated Field [[InsuredZip]]


Individual Client Email Word Ribbon Individual Client / Client Email

E-mail [[InsuredEmail]]

Calculated Field [[InsuredEmail]]



76Table of Contents

Individual Client PhoneError! Bookmark not defined. Word Ribbon Individual Client / Client Phone

E-mail [[InsuredPhone]]

Calculated Field [[InsuredPhone]]



Individual Client Code Word Ribbon Individual Client / Client Code

E-mail [[InsuredCode]]

Calculated Field [[InsuredCode]]

Distributor Information


Distributor Address Word Ribbon Distributor / Distributor Address

E-mail [[DistributorAddress]]

Calculated Field [[DistributorAddress]]


Distributor City Word Ribbon Distributor / Distributor City

E-mail [[DistributorCity]]

Calculated Field [[DistributorCity]]


77Table of Contents


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.


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.


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.


Distributor Commission Word Ribbon Distributor / Distributor Commission

E-mail [[DistributorCommission]]


78Table of Contents

Calculated Field [[DistributorCommission]]


Distributor Country Word Ribbon Distributor / Distributor Country

E-mail [[DistributorCountry]]

Calculated Field [[DistributorCountry]]


Distributor Fax Word Ribbon Distributor / Distributor Fax

E-mail [[DistributorFax]]

Calculated Field [[DistributorFax]]



Distributor Name Word Ribbon Distributor / Distributor Name

E-mail [[DistributorName]]

Calculated Field [[DistributorName]]


Distributor Phone Word Ribbon Distributor / Distributor Phone

E-mail [[DistributorPhone]]

Calculated Field [[DistributorPhone]]



79Table of Contents


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

E-mail [[DistributorStateProvince]]

Calculated Field [[DistributorStateProvince]]


Distributor Website Word Ribbon Distributor / Distributor Website

E-mail [[DistributorWebsite]]

Calculated Field [[DistributorWebsite]]


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

E-mail [[DistributorZipPostalCode]]

Calculated Field [[DistributorZipPostalCode]]


Distributor Primary Contact First NameError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact First Name

E-mail [[DistributorContactFirstName]]

Calculated Field [[DistributorContactFirstName]]


Distributor Primary Contact Last Name


80Table of Contents

Word Ribbon Distributor / Distributor Contact Last Name

E-mail [[DistributorContactLastName]]

Calculated Field [[DistributorContactLastName]]


Distributor Primary Contact Employee NumberError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact Employee Number

E-mail [[DistributorContactEmployeeNumber]]

Calculated Field [[DistributorContactEmployeeNumber]]


Distributor Primary Contact EmailError! Bookmark not defined. Word Ribbon Distributor / Distributor Contact Email

E-mail [[DistributorContactEmail]]

Calculated Field [[DistributorContactEmail]]


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

E-mail [[DistributorContactPhone]]

Calculated Field [[DistributorContactPhone]]


Insurer Information


81Table of Contents


Insurer Address Word Ribbon Insurer / Insurer Address

E-mail [[InsurerAddress]]

Calculated Field [[InsurerAddress]]


Insurer City Word Ribbon Insurer / Insurer City

E-mail [[InsurerCity]]

Calculated Field [[InsurerCity]]


Insurer Client Code Word Ribbon Insurer / Insurer Client Code

E-mail [[InsurerClientCode]]

Calculated Field [[InsurerClientCode]]


Insurer Code Word Ribbon Insurer / Insurer Code

E-mail [[InsurerCode]]

Calculated Field [[InsurerCode]]


Insurer Country Word Ribbon Insurer / Insurer Country


82Table of Contents

E-mail [[InsurerCountry]]

Calculated Field [[InsurerCountry]]


Insurer Fax Word Ribbon Insurer / Insurer Fax

E-mail [[InsurerFax]]

Calculated Field [[InsurerFax]]



Insurer Name Word Ribbon Insurer / Insurer Name

E-mail [[InsurerName]]

Calculated Field [[InsurerName]]


Insurer Phone Word Ribbon Insurer / Insurer Phone

E-mail [[InsurerPhone]]

Calculated Field [[InsurerPhone]]



Insurer Reference Code Word Ribbon Insurer / Insurer Reference Code

E-mail [[InsurerReferenceCode]]


83Table of Contents

Calculated Field [[InsurerReferenceCode]]


Insurer Risk Percentage Word Ribbon Insurer / Insurer Risk Percentage

E-mail [[InsurerRiskPercentage]]

Calculated Field [[InsurerRiskPercentage]]


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

E-mail [[InsurerStateProvince]]

Calculated Field [[InsurerStateProvince]]


Insurer Website Word Ribbon Insurer / Insurer Website

E-mail [[InsurerWebsite]]

Calculated Field [[InsurerWebsite]]


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

E-mail [[InsurerZipPostalCode]]

Calculated Field [[InsurerZipPostalCode]]



84Table of Contents

Insurer Primary Contact First NameError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact First Name

E-mail [[InsurerContactFirstName]]

Calculated Field [[InsurerContactFirstName]]


Insurer Primary Contact Last Name Word Ribbon Insurer / Insurer Contact Last Name

E-mail [[InsurerContactLastName]]

Calculated Field [[InsurerContactLastName]]


Insurer Primary Contact Employee NumberError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact Employee Number

E-mail [[InsurerContactEmployeeNumber]]

Calculated Field [[InsurerContactEmployeeNumber]]


Insurer Primary Contact EmailError! Bookmark not defined. Word Ribbon Insurer / Insurer Contact Email

E-mail [[InsurerContactEmail]]

Calculated Field [[InsurerContactEmail]]


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

E-mail [[InsurerContactPhone]]


85Table of Contents

Calculated Field [[InsurerContactPhone]]


Policy Information


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.


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

E-mail [[FirstQuotedDate]]

Calculated Field [[FirstQuotedDate]]



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

E-mail [[LastQuotedDate]]

Calculated Field [[LastQuotedDate]]


86Table of Contents



Product Word Ribbon Policy Information / Product

E-mail [[SubPolProduct]]

Calculated Field [[SubPolProduct]]


Cancellation Date Calculated Field [[CancellationInfoUserControl/CancellationDate]]



Cancellation Reason Word Ribbon Policy Information / Cancellation Reason Name

E-mail [[CancellationReason]]

Calculated Field [[CancellationInfoUserControl/CancellationReason]]


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

E-mail [[IfOtherSpecify]]

Calculated Field [[CancellationInfoUserControl/IfOtherSpecify]]



87Table of Contents

Reinstatement Reason Word Ribbon Policy Information / Reinstatement Reason Name

E-mail [[ReinstatementReason]]

Calculated Field [[ReinstatementReasonInfoUserControl/ReinstatementReason]]


Submission Version Name Word Ribbon Policy Information / Submission Version Name

E-mail [[SubmissionVersionName]]

Calculated Field [[SubmissionVersionName]]


Submission Version Number Word Ribbon Policy Information / Submission Version Number

E-mail [[SubmissionVersionNumber]]

Calculated Field [[SubmissionVersionNumber]]

Transaction Information


Transaction ID Word Ribbon Policy Information / System ID

E-mail [[SubPolSystemID]]

Calculated Field [[SubPolSystemID]]


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


Internal Transaction ID E-mail [[TransactionResourceId]]

Calculated Field [[TransactionResourceId]]

Notes: Retrieves the internal ID of the transaction, used for external services integrating with Bridge.


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

E-mail [[CreatedByFirstName]]

Calculated Field See the $CreatedByFirstName() function.


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

E-mail [[CreatedByLastName]]

Calculated Field See the $CreatedByLastName() function.


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

E-mail [[ModifiedByFirstName]]

Calculated Field See the $ModifiedByFirstName() function.


89Table of Contents


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

E-mail [[ModifiedByLastName]]

Calculated Field See the $ModifiedByLastName() function.


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.


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

E-mail [[LastStatusChangedByFirstName]]


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

E-mail [[LastStatusChangedByLastName]]


90Table of Contents


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.


Status Calculated Field [[SubPolStatus]]


Correction Type E-mail [[CorrectionType]


Effective Date Word Ribbon Policy Information / Effective Date

E-mail [[PolicyEffectiveDate]]

Calculated Field [[PolicyEffectiveDate]]



Valid Until Date Word Ribbon Policy Information / Valid Until Date

E-mail [[PolicyValidUntilDate]]


91Table of Contents

Calculated Field [[PolicyValidUntilDate]]



Bound Date Word Ribbon Policy Information / Bound Date

E-mail [[BoundDate]]

Calculated Field [[BoundDate]]



Endorsement Number Word Ribbon Policy Information / Endorsement Number

E-mail [[EndorsementNumber]]


Adjustment Number Word Ribbon Policy Information / Adjustment Number

E-mail [[AdjustmentNumber]]


Referral Reason E-mail [[Referral]]


Lost Reason


92Table of Contents

Word Ribbon Policy Information / Lost Reason

E-mail [[LostReasonLabel]]

Calculated Field [[LostReasonLabel]]


Void Reason Name E-mail [[VoidReasonName]]


Void Reason Code E-mail [[VoidReasonCode]]


Void Reason Details E-mail [[VoidReasonDetails]]

Compliance Information


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.


93Table of Contents


Compliance Message Word Ribbon Compliance Information / Compliance Message

E-mail [[ComplianceMessage]]

Calculated Field [[ComplianceMessage]]



Compliance Detailed Message Word Ribbon Compliance Information / Compliance Detailed Message

E-mail [[ComplianceDetailedMessage]]

Calculated Field [[ComplianceDetailedMessage]]



Compliance Executed On Word Ribbon Compliance Information / Compliance Executed On

E-mail [[ComplianceExecutedOn]]

Calculated Field [[ComplianceExecutedOn]]



Compliance Referral Requested By First Name Word Ribbon Compliance Information / Compliance Request User First Name


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


Compliance Referral Requested By Last Name Word Ribbon Compliance Information / Compliance Request User Last Name

E-mail [[ComplianceRequestUserLastName]]

Calculated Field [[ComplianceRequestUserLastName]]



Compliance Referral Requested On Date Word Ribbon Compliance Information / Compliance Request Date

E-mail [[ComplianceRequestDate]]

Calculated Field [[ComplianceRequestDate]]



Compliance Acceptance Reason Word Ribbon Compliance Information / Compliance Acceptance Reason

E-mail [[ComplianceAcceptanceReason]]

Calculated Field [[ComplianceAcceptanceReason]]


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


Compliance Accepted By First Name Word Ribbon Compliance Information / Compliance Acceptance User First Name

E-mail [[ComplianceAcceptanceUserFirstName]]

Calculated Field [[ComplianceAcceptanceUserFirstName]]



Compliance Accepted By Last Name Word Ribbon Compliance Information / Compliance Acceptance User Last Name

E-mail [[ComplianceAcceptanceUserLastName]]

Calculated Field [[ComplianceAcceptanceUserLastName]]



Compliance Accepted On Date Word Ribbon Compliance Information / Compliance Acceptance Date

E-mail [[ComplianceAcceptanceDate]]

Calculated Field [[ComplianceAcceptanceDate]]




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


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.


Compliance Rejected By First Name Word Ribbon Compliance Information / Compliance Rejection User First Name

E-mail [[ComplianceRejectionUserFirstName]]

Calculated Field [[ComplianceRejectionUserFirstName]]



Compliance Rejected By Last Name Word Ribbon Compliance Information / Compliance Rejection User Last Name

E-mail [[ComplianceRejectionUserLastName]]

Calculated Field [[ComplianceRejectionUserLastName]]


97Table of Contents



Compliance Rejected On Date Word Ribbon Compliance Information / Compliance Rejection Date

E-mail [[ComplianceRejectionDate]]

Calculated Field [[ComplianceRejectionDate]]


Quote Information


Selected Quote Option Code Calculated Field [[SelectedQuoteOptionCode]]

Notes: This value will only be available once a quote has been selected.


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.


Insurer Name by Quote Option


98Table of Contents

Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/InsurerName]]

Notes: QuoteCode should be the code of the quote option.


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.


Total Premium by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/TotalPremium]]



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.


Total Tax by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/TotalTax]]



Commission Amount by Quote Option and Premium Type


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


Total Commission by Quote Option Calculated Field [[QuoteInfoArray/QuoteInfo[QuoteCode='code']/TotalCommission]]



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.


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.


Insuring Conditions by Quote Option Calculated Field [[QuoteInsuringConditionInfoArray/QuoteInsuringConditionInfo[QuoteCode='code']/Text]]



100Table of Contents

Current Transaction Premium, Commission, Tax Information


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.


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.


Total Gross Premium Amount Word Ribbon Premium Summary / Total Gross Premium Amount

E-mail [[TotalGrossPremiumAmount]]

Calculated Field See the $TotalGrossPremiumAmount() function.


Premium Currency Name



Word Ribbon Premium Summary / Currency Name

E-mail [[PremiumCurrencyName]]

Calculated Field [[PremiumCurrencyName]]


Premium Currency Code Word Ribbon Premium Summary / Currency Code

E-mail [[PremiumCurrencyCode]]

Calculated Field [[PremiumCurrencyCode]]


Commission Word Ribbon Premium Information / Commission

E-mail [[Premium_CommissionAmount]]

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



Total Commission Amount Word Ribbon Premium Summary / Total Commission Amount

E-mail [[TotalCommissionAmount]]

Calculated Field See the $TotalCommissionAmount() function


Net Premium Word Ribbon Premium Information / Net Premium



E-mail [[Premium_NetPremium]]

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



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

E-mail [[TotalNetPremiumAmount]]


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

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


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



Total Taxes Amount Word Ribbon Premium Summary / Total Taxes Amount

E-mail [[TotalTaxesAmount]]

Calculated Field See the $TotalTaxesAmount() function



Current Transaction Limit Information


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

E-mail [[Limit_PremiumType]]

Notes: Use repeaters.


Limit Description Word Ribbon Limit Information / Limit Description

E-mail [[Limit_Description]]

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



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.


Limit Amount



Word Ribbon Limit Information / Limit Amount

E-mail [[Limit_Amount]]

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

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


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


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

E-mail [[Deductible_PremiumType]]

Notes: Use repeaters.




Deductible Description Word Ribbon Deductible Information / Deductible Description

E-mail [[Deductible_Description]]

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



Deductible Type Word Ribbon Deductible Information / Deductible Type

E-mail [[Deductible_DeductibleType]]

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



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.




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.


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


Current Term Policy Number Word Ribbon Policy Information / Policy Number

E-mail [[SubPolPolicyNo]]



Calculated Field [[SubPolPolicyNo]]

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


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.


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.


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

E-mail [[TermExpiryDate]]

Calculated Field [[CurrentTerm/ExpiryDate]]



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


Current Term Number Word Ribbon Term Information / Term Number

E-mail [[TermNumber]]


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.


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

E-mail [[TermTotalPremium]]

Calculated Field [[CurrentTerm/Premium/TotalPremiumAmount]]


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

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





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


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.


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

Previous Term Information


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.




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



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

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



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


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

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



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


Previous Term Tax Amount by Premium



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

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


Previous Term Total Tax Amount Calculated Field [[PreviousTerm/Premium/TotalTaxAmount]]

Billing Workflow Details


Payment Plan Name Word Ribbon Billing Information / Payment Plan

E-mail [[Billing_PaymentPlan]]

Calculated Field [[BillingInfo/PaymentPlan]]


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='#']).




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.


Payment Plan Installment Tax Amount Word Ribbon Installment Information / Tax Amount

E-mail [[Installment_TaxAmount]]

Calculated Field [[BillingInfo/Installments/Installment[Number='#']/TaxAmount]]



Payment Plan Installment Amount Due Word Ribbon Installment Information / Amount Due

E-mail [[Installment_AmountDue]]

Calculated Field [[BillingInfo/Installments/Installment[Number='#']/AmountDue]]





Payment Plan Installment Gross Amount Word Ribbon Installment Information / Gross Amount

E-mail [[Installment_GrossAmount]]

Calculated Field [[BillingInfo/Installments/Installment[Number='#']/GrossAmount]]



Payment Plan Installment Commission Amount Word Ribbon Installment Information / Commission Amount

E-mail [[Installment_CommissionAmount]]

Calculated Field [[BillingInfo/Installments/Installment[Number='#']/CommissionAmount]]



Payment Plan Installment Total Amount Due Word Ribbon Installment Information / Total Amount Due

E-mail [[Installment_TotalAmountDue]]

Calculated Field [[BillingInfo/Installments/Installment[Number='#']/TotalAmountDue]]



Payment Plan Installment Total Installment Amount Word Ribbon Installment Information / Total Installment Amount

E-mail [[Installment_TotalInstallmentAmount]]



Calculated Field [[BillingInfo/Installments/Installment[Number='#']/TotalInstallmentAmount]]



Payment Plan Installment Currency Word Ribbon Installment Information / Currency

E-mail [[Installment_Currency]]

Calculated Field [[BillingInfo/Installments/Installment[Number='#']/Currency]]


System Date


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

E-mail [[dd]]


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

E-mail [[%d]]


Formatted Date 1



Word Ribbon System Date / Formatted Date 1

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


Formatted Date 2 Word Ribbon System Date / Formatted Date 2

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



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



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


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


Full Month Name Word Ribbon System Date / Full Month Name

E-mail [[MMMM]]




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

E-mail [[D]]


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

E-mail [[MM]]


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

E-mail [[%M]]


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

E-mail [[M]]


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

E-mail [[d]]


Year



Word Ribbon System Date / Year

E-mail [[yyyy]]


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

E-mail [[Y]]

Other


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.


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.


e-Signature Tag



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.


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.


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



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.



Appendix C - Full Placeholders List for Billing Information


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






Invoice Information


Invoice Number Word Ribbon Invoice Information / Invoice Number

E-mail [[Billing_Invoice_Number]]


Invoice Issue Date



Word Ribbon Invoice Information / Invoice Issue Date

E-mail [[Billing_Invoice_IssueDate]]


Invoice Total Amount Word Ribbon Invoice Information / Invoice Total Amount

E-mail [[Billing_Invoice_TotalAmount]]


Invoice Net Amount Word Ribbon Invoice Information / Invoice Net Amount

E-mail [[Billing_Invoice_NetAmount]]


Invoice Total Commission Amount Word Ribbon Invoice Information / Invoice Total Commission Amount

E-mail [[Billing_Invoice_TotalCommissionAmount]]


Invoice Total Tax Amount Word Ribbon Invoice Information / Invoice Total Tax Amount

E-mail [[Billing_Invoice_TotalTaxAmount]]


Invoice Total Amount Due Word Ribbon Invoice Information / Invoice Total Amount Due

E-mail [[Billing_Invoice_TotalAmountDue]]




Invoice Outstanding Amount Word Ribbon Invoice Information / Invoice Outstanding Amount

E-mail [[Billing_Invoice_OutstandingAmount]]


Invoice Due Date Word Ribbon Invoice Information / Invoice Due Date

E-mail [[Billing_Invoice_DueDate]]


Invoice Currency Word Ribbon Invoice Information / Invoice Currency

E-mail [[Billing_Invoice_Currency]]


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.




Outstanding Invoice Amount Word Ribbon Outstanding Invoice / Outstanding Invoice Amount

E-mail [[Billing_OutstandingInvoice_Amount]]

Notes: Use repeaters for documents and e-mails.


Outstanding Invoice Amount Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Amount Currency

E-mail [[Billing_OutstandingInvoice_AmountCurrency]]



Outstanding Invoice Date Word Ribbon Outstanding Invoice / Outstanding Invoice Date

E-mail [[Billing_OutstandingInvoice_Date]]



Outstanding Invoice Due Date Word Ribbon Outstanding Invoice / Outstanding Invoice Due Date

E-mail [[Billing_OutstandingInvoice_DueDate]]



Outstanding Invoice Number Word Ribbon Outstanding Invoice / Outstanding Invoice Number

E-mail [[Billing_OutstandingInvoice_Number]]





Outstanding Invoice Remaining Balance Word Ribbon Outstanding Invoice / Outstanding Invoice Remaining Balance

E-mail [[Billing_OutstandingInvoice_RemainingBalance]]



Outstanding Invoice Remaining Balance Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Remaining Balance Currency

E-mail [[Billing_OutstandingInvoice_RemainingBalanceCurrency]]



Outstanding Invoice Total Amount Word Ribbon Outstanding Invoice / Outstanding Invoice Total Amount

E-mail [[Billing_OutstandingInvoice_TotalAmount]]


Outstanding Invoice Total Amount Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Total Amount Currency

E-mail [[Billing_OutstandingInvoice_TotalAmountCurrency]]


Outstanding Invoice Total Remaining Balance Word Ribbon Outstanding Invoice / Outstanding Invoice Total Remaining Balance



E-mail [[Billing_OutstandingInvoice_TotalRemainingBalance]]


Outstanding Invoice Total Remaining Balance Currency Word Ribbon Outstanding Invoice / Outstanding Invoice Total Remaining Balance Currency

E-mail [[Billing_OutstandingInvoice_TotalRemainingBalanceCurrency]]


Statement Closing Balance Word Ribbon Statement / Statement Closing Balance

E-mail [[Billing_Statement_ClosingBalance]]


Statement Total Amount Due Word Ribbon Statement / Statement Total Amount Due

E-mail [[Billing_Statement_TotalAmountDue]]


Statement Transaction Amount Word Ribbon Statement Transaction / Statement Transaction Amount

E-mail [[Billing_StatementTransaction_Amount]]



Statement Transaction Amount Currency Word Ribbon Statement Transaction / Statement Transaction Amount Currency

E-mail [[Billing_StatementTransaction_AmountCurrency]]





Statement Transaction Date Word Ribbon Statement Transaction / Statement Transaction Date

E-mail [[Billing_StatementTransaction_Date]]



Statement Transaction Due Date Word Ribbon Statement Transaction / Statement Transaction Due Date

E-mail [[Billing_StatementTransaction_DueDate]]



Statement Transaction Number Word Ribbon Statement Transaction / Statement Transaction Number

E-mail [[Billing_StatementTransaction_Number]]



Statement Transaction Reference Word Ribbon Statement Transaction / Statement Transaction Reference

E-mail [[Billing_StatementTransaction_Reference]]





Statement Transaction Remaining Balance Word Ribbon Statement Transaction / Statement Transaction Remaining Balance

E-mail [[Billing_StatementTransaction_RemainingBalance]]



Statement Transaction Remaining Balance Currency Word Ribbon Statement Transaction / Statement Transaction Remaining Balance Currency

E-mail [[Billing_StatementTransaction_RemainingBalanceCurrency]]



Statement Transaction Total Amount Word Ribbon Statement Transaction / Statement Transaction Total Amount

E-mail [[Billing_StatmentTransaction_TotalAmount]]


Statement Transaction Total Amount Currency Word Ribbon Statement Transaction / Statement Transaction Total Amount Currency

E-mail [[Billing_StatementTransaction_TotalAmountCurrency]]


Statement Transaction Total Remaining Balance Word Ribbon Statement Transaction / Statement Transaction Total Remaining Balance

E-mail [[Billing_StatementTransaction_TotalRemainingBalance]]




Statement Transaction Total Remaining Balance Currency Word Ribbon Statement Transaction / Statement Transaction Total Remaining Balance Currency

E-mail [[Billing_StatementTransaction_TotalRemainingBalanceCurrency]]


Statement Transaction Type Word Ribbon Statement Transaction / Statement Transaction Type

E-mail [[Billing_StatementTransaction_Type]]


Client Information


Client Name Word Ribbon Client Information / Client Name

E-mail [[Billing_Client_Name]]


Client Address Word Ribbon Client Information / Client Address

E-mail [[Billing_Client_Address]]


Client City Word Ribbon Client Information / Client City



E-mail [[Billing_Client_City]]


Client Zip Word Ribbon Client Information / Client Zip

E-mail [[Billing_Client_Zip]]


Client Country Word Ribbon Client Information / Client Country

E-mail [[Billing_Client_Country]]


Client State Word Ribbon Client Information / Client State

E-mail [[Billing_Client_State]]


Client Phone Word Ribbon Client Information / Client Phone

E-mail [[Billing_Client_Phone]]


Client Email Word Ribbon Client Information / Client Email

E-mail [[Billing_Client_Email]]



Distributor Information


Distributor Name Word Ribbon Distributor Information / Distributor Name

E-mail [[Billing_Distributor_Name]]


Distributor Address Word Ribbon Distributor Information / Distributor Address

E-mail [[Billing_Distributor_Address]]


Distributor City Word Ribbon Distributor Information / Distributor City

E-mail [[Billing_Distributor_City]]


Distributor Zip Word Ribbon Distributor Information / Distributor Zip

E-mail [[Billing_Distributor_Zip]]


Distributor Country Word Ribbon Distributor Information / Distributor Country

E-mail [[Billing_Distributor_Country]]




Distributor State Word Ribbon Distributor Information / Distributor State

E-mail [[Billing_Distributor_State]]


Distributor Phone Word Ribbon Distributor Information / Distributor Phone

E-mail [[Billing_Distributor_Phone]]


Distributor Email Word Ribbon Distributor Information / Distributor Email

E-mail [[Billing_Distributor_Email]]

Insurer Information


Insurer Name Word Ribbon Insurer Information / Insurer Name

E-mail [[Billing_Insurer_Name]]


Insurer Address Word Ribbon Insurer Information / Insurer Address

E-mail [[Billing_Insurer_Address]]




Insurer City Word Ribbon Insurer Information / Insurer City

E-mail [[Billing_Insurer_City]]


Insurer Zip Word Ribbon Insurer Information / Insurer Zip

E-mail [[Billing_Insurer_Zip]]


Insurer Country Word Ribbon Insurer Information / Insurer Country

E-mail [[Billing_Insurer_Country]]


Insurer State Word Ribbon Insurer Information / Insurer State

E-mail [[Billing_Insurer_State]]


Insurer Phone Word Ribbon Insurer Information / Insurer Phone

E-mail [[Billing_Insurer_Phone]]


Insurer Email



Word Ribbon Insurer Information / Insurer Email

E-mail [[Billing_Insurer_Email]]

Bill To Party Information


Bill to Party Name Word Ribbon Bill To Party Information / Bill to Party Name

E-mail [[Billing_BillToParty_Name]]


Bill to Party Address Word Ribbon Bill To Party Information / Bill to Party Address

E-mail [[Billing_BillToParty_Address]]


Bill to Party City Word Ribbon Bill To Party Information / Bill to Party City

E-mail [[Billing_BillToParty_City]]


Bill to Party Zip Word Ribbon Bill To Party Information / Bill to Party Zip

E-mail [[Billing_BillToParty_Zip]]




Bill to Party Country Word Ribbon Bill To Party Information / Bill to Party Country

E-mail [[Billing_BillToParty_Country]]


Bill to Party State Word Ribbon Bill To Party Information / Bill to Party State

E-mail [[Billing_BillToParty_State]]


Bill to Party Phone Word Ribbon Bill To Party Information / Bill to Party Phone

E-mail [[Billing_BillToParty_Phone]]


Bill to Party Email Word Ribbon Bill To Party Information / Bill to Party Email

E-mail [[Billing_BillToParty_Email]]


Bill to Party Account Number Word Ribbon Bill To Party Information / Bill to Party Account Number

E-mail [[Billing_BillToParty_AccountNumber]]


Bill to Party On Account Balance Word Ribbon Bill To Party Information / Bill to Party On Account Balance



E-mail [[Billing_BillToParty_OnAccountBalance]]


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


Policy Term Billing Option Word Ribbon Policy Information / Policy Term Billing Option

E-mail [[Billing_PolicyTerm_BillingOption]]


Policy Term Effective Date Word Ribbon Policy Information / Policy Term Effective Date

E-mail [[Billing_PolicyTerm_EffectiveDate]]


Policy Term ID Word Ribbon Policy Information / Policy Term ID

E-mail [[Billing_PolicyTerm_PolicyTermID]]


Policy Term Payment Plan



Word Ribbon Policy Information / Policy Term Payment Plan

E-mail [[Billing_PolicyTerm_PaymentPlan]]


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

E-mail [[Billing_PolicyTerm_PolicyNumber]]


Policy Term Valid Until Date Word Ribbon Policy Information / Policy Term Valid Until Date

E-mail [[Billing_PolicyTerm_ValidUntilDate]]


Policy Transaction Effective Date Word Ribbon Policy Information / Policy Transaction Effective Date

E-mail [[Billing_PolicyTransaction_EffectiveDate]]


Policy Transaction ID Word Ribbon Policy Information / Policy Transaction ID

E-mail [[Billing_PolicyTransaction_PolicyTransactionID]]


Policy Transaction Type Word Ribbon Policy Information / Policy Transaction Type

E-mail [[Billing_PolicyTransaction_TransactionType]]




Policy Transaction Valid Until Date Word Ribbon Policy Information / Policy Transaction Valid Until Date

E-mail [[Billing_PolicyTransaction_ValidUntilDate]]


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


Charge Adjustment Type Word Ribbon Charge / Charge Adjustment Type

Notes: Use repeaters for documents.


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.




Charge Currency Word Ribbon Charge / Charge Currency



Charge Date Word Ribbon Charge / Charge Date



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.


Charge Policy Transaction ID Word Ribbon Charge / Charge Policy Transaction ID



Charge Policy Number Word Ribbon Charge / Charge Policy Number



Charge System Claim Number



Word Ribbon Charge / Charge System Claim Number



Charge Gross Amount Word Ribbon Charge / Charge Gross Amount



Charge Premium Type Word Ribbon Charge / Charge Premium Type



Charge Total Amount Word Ribbon Charge / Charge Total Amount

Notes: Use repeaters for documents.This is the total charge amount, including taxes.


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.


Charge Total Commission Amount Word Ribbon Charge / Charge Total Commission Amount





Charge Total Tax Amount Word Ribbon Charge / Charge Total Tax Amount


Installment Information


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.


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.


Installment Next Date Word Ribbon Installment Information / Installment Next Date

E-mail [[Billing_Installment_NextDate]]



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.



Appendix D - Full Placeholders List for Claims Information


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





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.


Claim Information

Document E-mail Field Core

Claims Status E-mail [[Claim/Status]]

Calculated Field [[Claim/Status]]




Claims Sub-Status E-mail [[Claim/SubStatus]]

Calculated Field [[Claim/SubStatus]]


System Number E-mail [[Claim/SystemNumber]]

Calculated Field [[Claim/SystemNumber]]


Parent Claim Number E-mail [[Claim/ParentClaimNumber]]

Calculated Field [[Claim/ParentClaimNumber]]

Core Field Code [[Claim/ParentClaimNumber]]


Date of Loss E-mail [[Claim/DateOfLoss]]

Calculated Field [[Claim/DateOfLoss]]

Core Field Code [[Claim/DateOfLoss]]


Date Reported E-mail [[Claim/DateReported]]

Calculated Field [[Claim/DateReported]]

Core Field Code [[Claim/DateReported]]




Date Opened E-mail [[Claim/DateOpen]]

Calculated Field [[Claim/DateOpen]]


Date Created E-mail [[Claim/DateCreated]]

Calculated Field [[Claim/DateCreated]]


Loss Amount E-mail [[Claim/LossAmount/Amount]]

Calculated Field [[Claim/LossAmount/Amount]]

Core Field Code [[Claim/LossAmount/Amount]]


Loss Amount Currency E-mail [[Claim/LossAmount/Currency]]

Calculated Field [[Claim/LossAmount/Currency]]

Core Field Code [[Claim/LossAmount/Currency]]


Description of Loss E-mail [[Claim/DescriptionOfLoss]]

Calculated Field [[Claim/DescriptionOfLoss]]



Core Field Code [[Claim/DescriptionOfLoss]]


Policy Number E-mail [[Claim/ReportedPolicyNumber]]

Calculated Field [[Claim/ReportedPolicyNumber]]

Core Field Code [[Claim/ReportedPolicyNumber]]


Cause of Loss E-mail [[Claim/CauseOfLoss]]

Calculated Field [[Claim/CauseOfLoss]]

Core Field Code [[Claim/CauseOfLoss]]


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



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.


Party Role E-mail [[Party/PartyRole/PartyRole]]

Calculated Field [[Party/PartyRole/PartyRole]]


Party Claim Number E-mail [[Party/PartyRole/PartyClaimNumber]]

Calculated Field [[Party/PartyRole/PartyClaimNumber]]


Name E-mail [[Party/PartyRole/Name]]

Calculated Field [[Party/PartyRole/Name]]


Phone Number E-mail [[Party/PartyRole/Phone]]

Calculated Field [[Party/PartyRole/Phone]]




Email Address E-mail [[Party/PartyRole/Email]]

Calculated Field [[Party/PartyRole/Email]]


Fax Number E-mail [[Party/PartyRole/Fax]]

Calculated Field [[Party/PartyRole/Fax]]


Contact Name E-mail [[Party/PartyRole/ContactName]]

Calculated Field [[Party/PartyRole/ContactName]]


Payment Method E-mail [[Party/PartyRole/PaymentMethod]]

Calculated Field [[Party/PartyRole/PaymentMethod]]


Company Type E-mail [[Party/PartyRole/CompanyType]]

Calculated Field [[Party/PartyRole/CompanyType]]


Party General Purpose Field One E-mail [[Party/PartyRole/GeneralField1]]



Calculated Field [[Party/PartyRole/GeneralField1]]


Party General Purpose Field Two E-mail [[Party/PartyRole/GeneralField2]]



Party General Purpose Field Three E-mail [[Party/PartyRole/GeneralField3]]



Address Line One E-mail [[Party/PartyRole/Address/AddressLine1]]

Calculated Field [[Party/PartyRole/Address/AddressLine1]]


Address Line Two E-mail [[Party/PartyRole/Address/AddressLine2]]

Calculated Field [[Party/PartyRole/Address/AddressLine2]]


City E-mail [[Party/PartyRole/Address/City]]

Calculated Field [[Party/PartyRole/Address/City]]




State or Province E-mail [[Party/PartyRole/Address/StateProvince]]

Calculated Field [[Party/PartyRole/Address/StateProvince]]


Country E-mail [[Party/PartyRole/Address/Country]]

Calculated Field [[Party/PartyRole/Address/Country]]


Postal Code E-mail [[Party/PartyRole/Address/PostalCode]]

Calculated Field [[Party/PartyRole/Address/PostalCode]]


Payee Reference Number E-mail [[Party/PartyRole/PayeeInfo/ReferenceNumber]]

Calculated Field [[Party/PartyRole/PayeeInfo/ReferenceNumber]]


Payee Name E-mail [[Party/PartyRole/PayeeInfo/Name]]

Calculated Field [[Party/PartyRole/PayeeInfo/Name]]


Payee Address E-mail [[Party/PartyRole/PayeeInfo/Address]]



Calculated Field [[Party/PartyRole/PayeeInfo/Address]]


Payee City E-mail [[Party/PartyRole/PayeeInfo/City]]

Calculated Field [[Party/PartyRole/PayeeInfo/City]]


Payee State or Province E-mail [[Party/PartyRole/PayeeInfo/StateProvince]]

Calculated Field [[Party/PartyRole/PayeeInfo/StateProvince]]


Payee Country E-mail [[Party/PartyRole/PayeeInfo/Country]]

Calculated Field [[Party/PartyRole/PayeeInfo/Country]]


Payee Postal Code E-mail [[Party/PartyRole/PayeeInfo/PostalCode]]

Calculated Field [[Party/PartyRole/PayeeInfo/PostalCode]]


Payee Phone Number E-mail [[Party/PartyRole/PayeeInfo/Phone]]

Calculated Field [[Party/PartyRole/PayeeInfo/Phone]]




Payee Email Address E-mail [[Party/PartyRole/PayeeInfo/Email]]

Calculated Field [[Party/PartyRole/PayeeInfo/Email]]


Payee Fax Number E-mail [[Party/PartyRole/PayeeInfo/Fax]]

Calculated Field [[Party/PartyRole/PayeeInfo/Fax]]


Payment Method E-mail [[Party/PartyRole/PayeeInfo/PaymentMethod]]

Calculated Field [[Party/PartyRole/PayeeInfo/PaymentMethod]]


Payment Currency E-mail [[Party/PartyRole/PayeeInfo/Currency]]

Calculated Field [[Party/PartyRole/PayeeInfo/Currency]]


Payee General Purpose Field One E-mail [[Party/PartyRole/PayeeInfo/GeneralField1]]

Calculated Field [[Party/PartyRole/PayeeInfo/GeneralField1]]


Payee General Purpose Field Two E-mail [[Party/PartyRole/PayeeInfo/GeneralField2]]





Payee General Purpose Field Three E-mail [[Party/PartyRole/PayeeInfo/GeneralField3]]



Bank Details, Account Number E-mail [[Party/PartyRole/BankInfo/AccountNumber]]

Calculated Field [[Party/PartyRole/BankInfo/AccountNumber]]


Bank Details, Routing Number E-mail [[Party/PartyRole/BankInfo/RoutingNumber]]

Calculated Field [[Party/PartyRole/BankInfo/RoutingNumber]]


Bank Details, Name E-mail [[Party/PartyRole/BankInfo/Name]]

Calculated Field [[Party/PartyRole/BankInfo/Name]]


Bank Details, Address E-mail [[Party/PartyRole/BankInfo/Address]]

Calculated Field [[Party/PartyRole/BankInfo/Address]]




Bank Details, City E-mail [[Party/PartyRole/BankInfo/City]]

Calculated Field [[Party/PartyRole/BankInfo/City]]


Bank Details, State or Province E-mail [[Party/PartyRole/BankInfo/StateProvince]]

Calculated Field [[Party/PartyRole/BankInfo/StateProvince]]


Bank Details, Country E-mail [[Party/PartyRole/BankInfo/Country]]

Calculated Field [[Party/PartyRole/BankInfo/Country]]


Bank Details, Postal Code E-mail [[Party/PartyRole/BankInfo/PostalCode]]

Calculated Field [[Party/PartyRole/BankInfo/PostalCode]]


Bank Details General Purpose Field One E-mail [[Party/PartyRole/BankInfo/GeneralField1]]

Calculated Field [[Party/PartyRole/BankInfo/GeneralField1]]


Bank Details General Purpose Field Two E-mail [[Party/PartyRole/BankInfo/GeneralField2]]





Bank Details General Purpose Field Three E-mail [[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.




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.


Payment Date E-mail [[CurrentPayment/PaymentDate]]

Calculated Field [[CurrentPayment/PaymentDate]]



Payment Amount E-mail [[CurrentPayment/PaymentAmount/Amount]]

Calculated Field [[CurrentPayment/PaymentAmount/Amount]]



Payment Currency



E-mail [[CurrentPayment/PaymentAmount/Currency]]

Calculated Field [[CurrentPayment/PaymentAmount/Currency]]



Payment Status E-mail [[CurrentPayment/Status]]

Calculated Field [[CurrentPayment/Status]]



Payment Check Number E-mail [[CurrentPayment/CheckNumber]]

Calculated Field [[CurrentPayment/CheckNumber]]



Payment Reference Number E-mail [[CurrentPayment/ReferenceNumber]]

Calculated Field [[CurrentPayment/ReferenceNumber]]





Payment Category E-mail [[CurrentPayment/Category]]

Calculated Field [[CurrentPayment/Category]]



Payment Description E-mail [[CurrentPayment/Description]]

Calculated Field [[CurrentPayment/Description]]



Payment Coverage E-mail [[CurrentPayment/Coverage]]

Calculated Field [[CurrentPayment/Coverage]]





Payment Party Name E-mail [[CurrentPayment/Party/Name]]

Calculated Field [[CurrentPayment/Party/Name]]



Payment Party Code E-mail [[CurrentPayment/Party/Code]]

Calculated Field [[CurrentPayment/Party/Code]]



Payment Party Phone Number E-mail [[CurrentPayment/Party/Phone]]

Calculated Field [[CurrentPayment/Party/Phone]]





Payment Party Email Address E-mail [[CurrentPayment/Party/Email]]

Calculated Field [[CurrentPayment/Party/Email]]



Payment Party Fax Number E-mail [[CurrentPayment/Party/Fax]]

Calculated Field [[CurrentPayment/Party/Fax]]



Payment Party Contact Name E-mail [[CurrentPayment/Party/ContactName]]

Calculated Field [[CurrentPayment/Party/ContactName]]





Payment Party Payment Method E-mail [[CurrentPayment/Party/PaymentMethod]]

Calculated Field [[CurrentPayment/Party/PaymentMethod]]



Payment Party Company Type E-mail [[CurrentPayment/Party/CompanyType]]

Calculated Field [[CurrentPayment/Party/CompanyType]]



Payment Party General Purpose Field One E-mail [[CurrentPayment/Party/GeneralField1]]

Calculated Field [[CurrentPayment/Party/GeneralField1]]





Payment Party General Purpose Field Two E-mail [[CurrentPayment/Party/GeneralField2]]




Payment Party General Purpose Field Three E-mail [[CurrentPayment/Party/GeneralField3]]




Payment Party Address Line 1 E-mail [[CurrentPayment/Party/Address/AddressLine1]]

Calculated Field [[CurrentPayment/Party/Address/AddressLine1]]





Payment Party Address Line 2 E-mail [[CurrentPayment/Party/Address/AddressLine2]]

Calculated Field [[CurrentPayment/Party/Address/AddressLine2]]



Payment Party City E-mail [[CurrentPayment/Party/Address/City]]

Calculated Field [[CurrentPayment/Party/Address/City]]



Payment Party State/Province E-mail [[CurrentPayment/Party/Address/StateProvince]]

Calculated Field [[CurrentPayment/Party/Address/StateProvince]]





Payment Party Country E-mail [[CurrentPayment/Party/Address/Country]]

Calculated Field [[CurrentPayment/Party/Address/Country]]



Payment Party Postal Code E-mail [[CurrentPayment/Party/Address/PostalCode]]

Calculated Field [[CurrentPayment/Party/Address/PostalCode]]



Payment Party, Payee Reference Number E-mail [[CurrentPayment/Party/PayeeInfo/ReferenceNumber]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/ReferenceNumber]]





Payment Party, Payee Name E-mail [[CurrentPayment/Party/PayeeInfo/Name]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Name]]



Payment Party, Payee Address E-mail [[CurrentPayment/Party/PayeeInfo/Address]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Address]]



Payment Party, Payee City E-mail [[CurrentPayment/Party/PayeeInfo/City]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/City]]





Payment Party, Payee State/Province E-mail [[CurrentPayment/Party/PayeeInfo/StateProvince]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/StateProvince]]



Payment Party, Payee Country E-mail [[CurrentPayment/Party/PayeeInfo/Country]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Country]]



Payment Party, Payee Postal Code E-mail [[CurrentPayment/Party/PayeeInfo/PostalCode]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/PostalCode]]





Payment Party, Payee Phone Number E-mail [[CurrentPayment/Party/PayeeInfo/Phone]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Phone]]



Payment Party, Payee Email Address E-mail [[CurrentPayment/Party/PayeeInfo/Email]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Email]]



Payment Party, Payee Fax Number E-mail [[CurrentPayment/Party/PayeeInfo/Fax]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Fax]]





Payment Party, Payee Payment Method E-mail [[CurrentPayment/Party/PayeeInfo/PaymentMethod]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/PaymentMethod]]



Payment Party, Payee Currency E-mail [[CurrentPayment/Party/PayeeInfo/Currency]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/Currency]]



Payment Party, Payee General Purpose Field One E-mail [[CurrentPayment/Party/PayeeInfo/GeneralField1]]

Calculated Field [[CurrentPayment/Party/PayeeInfo/GeneralField1]]





Payment Party, Payee General Purpose Field Two E-mail [[CurrentPayment/Party/PayeeInfo/GeneralField2]]




Payment Party, Payee General Purpose Field Three E-mail [[CurrentPayment/Party/PayeeInfo/GeneralField3]]




Payment Party, Bank Account Number E-mail [[CurrentPayment/Party/BankInfo/AccountNumber]]

Calculated Field [[CurrentPayment/Party/BankInfo/AccountNumber]]





Payment Party, Bank Routing Number E-mail [[CurrentPayment/Party/BankInfo/RoutingNumber]]

Calculated Field [[CurrentPayment/Party/BankInfo/RoutingNumber]]



Payment Party, Bank Name E-mail [[CurrentPayment/Party/BankInfo/Name]]

Calculated Field [[CurrentPayment/Party/BankInfo/Name]]



Payment Party, Bank Address E-mail [[CurrentPayment/Party/BankInfo/Address]]

Calculated Field [[CurrentPayment/Party/BankInfo/Address]]





Payment Party, Bank City E-mail [[CurrentPayment/Party/BankInfo/City]]

Calculated Field [[CurrentPayment/Party/BankInfo/City]]



Payment Party, Bank State/Province E-mail [[CurrentPayment/Party/BankInfo/StateProvince]]

Calculated Field [[CurrentPayment/Party/BankInfo/StateProvince]]



Payment Party, Bank Country E-mail [[CurrentPayment/Party/BankInfo/Country]]

Calculated Field [[CurrentPayment/Party/BankInfo/Country]]





Payment Party, Bank Postal Code E-mail [[CurrentPayment/Party/BankInfo/PostalCode]]

Calculated Field [[CurrentPayment/Party/BankInfo/PostalCode]]



Payment Party, Bank General Purpose Field One E-mail [[CurrentPayment/Party/BankInfo/GeneralField1]]

Calculated Field [[CurrentPayment/Party/BankInfo/GeneralField1]]



Payment Party, Bank General Purpose Field Two E-mail [[CurrentPayment/Party/BankInfo/GeneralField2]]






Payment Party, Bank General Purpose Field Three E-mail [[CurrentPayment/Party/BankInfo/GeneralField3]]



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.


Certificate Number E-mail [[CertificateNumber]]

Notes: This is a table field for use in repeaters. The table Code is ClaimPayments.


System Claim Number E-mail [[SystemClaimNumber]]





Policy Number E-mail [[PolicyNumber]]



Type E-mail [[Type]]



Category E-mail [[Category]]



Date E-mail [[Date]]



Amount E-mail [[Amount]]





Currency E-mail [[Currency]]



Payee E-mail [[Payee]]



Status E-mail [[Status]]



Coverage E-mail [[Coverage]]



CheckNumber E-mail [[CheckNumber]]



Reference E-mail [[Reference]]





Description E-mail [[Description]]




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.


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.


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





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


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.


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



Next Child Row Number Calculated Field [[gridcode_NextChildSequenceNo]]



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




Index

AAdd Days function 50Add Hours function 49Add Months function 50Add operator 3Add Years function 50AddDays() function 50AddHours() function 49AddMonths() function 50Address Line One placeholder 148Address Line Two placeholder 148AddYears() function 50Adjusted Months function 60AdjustedMonths() function 60Adjuster party role 146Adjustment Number placeholder 92Alias field 55And condition 25Appendix A – Compliance() Function Parameters 67Appendix B - Full Placeholders List for Policy Information 70Appendix C - Full Placeholders List for Billing Information 120Appendix D - Full Placeholders List for Claims Information 142Appendix E - Full Placeholders List for General System Information 176Arithmetic Expressions 5Assured filter 54Attachments 89Avg function 58Avg() function 58BBank Details General Purpose Field One placeholder 153Bank Details General Purpose Field Three placeholder 154, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171,

172Bank Details General Purpose Field Two placeholder 154Bank Details, Account Number placeholder 152



Bank Details, Address placeholder 152Bank Details, City placeholder 153Bank Details, Country placeholder 153Bank Details, Name placeholder 152Bank Details, Postal Code placeholder 153Bank Details, Routing Number placeholder 152Bank Details, State or Province placeholder 153Bill to Party Account Number placeholder 134Bill to Party Address placeholder 133Bill to Party City placeholder 133Bill to Party Country placeholder 134Bill to Party Email placeholder 134Bill To Party Information 133Bill to Party Name placeholder 133Bill to Party On Account Balance Currency placeholder 135Bill to Party On Account Balance placeholder 134Bill to Party Phone placeholder 134Bill to Party State placeholder 134Bill to Party Zip placeholder 133Billing Integration Fields 141Billing Workflow Details 111Bound Date placeholder 91Building Conditional Expressions 24Building Formulas 3CCalculated Field placeholders 70, 120, 142Cancellation Date placeholder 86Cancellation Reason - Other placeholder 87Cancellation Reason placeholder 86Cause of Loss placeholder 145Certificate Number placeholder 172, 173, 174, 175Charge Adjustment Type placeholder 137Charge Amount Due placeholder 137Charge Currency placeholder 137Charge Date placeholder 138Charge Description placeholder 138Charge Gross Amount placeholder 139Charge Information 137



Charge Policy Number placeholder 138Charge Policy Transaction ID placeholder 138Charge Premium Type placeholder 139Charge System Claim Number placeholder 138Charge Total Amount Due placeholder 139Charge Total Amount placeholder 139Charge Total Commission Amount placeholder 139Charge Total Tax Amount placeholder 140Check Compliance Hit function 64CheckComplianceHit() function 64Child function 61Child() function 61City placeholder 148Claim Information 142Claim Party Information 145Claim Payment Information, Multiple Filtered Payments 172Claim Payment Information, Single Instance 154Claimant party role 145Client Address placeholder 128Client City placeholder 128Client Company Address placeholder 70Client Company City placeholder 70Client Company Code placeholder 74Client Company Contact Email placeholder 72Client Company Contact Employee Number placeholder 71Client Company Contact First Name placeholder 71Client Company Contact Last Name placeholder 71Client Company Contact Phone placeholder 71Client Company Country placeholder 72Client Company Fax placeholder 72Client Company Information 70Client Company Name placeholder 72Client Company Phone placeholder 73Client Company State placeholder 73Client Company Website placeholder 73Client Company Zip/Postal Code placeholder 73Client Country placeholder 129Client Email placeholder 129



Client Information 128Client Name placeholder 128Client Phone placeholder 129Client State placeholder 129Client Zip placeholder 129Close Bracket operator 3Code field 4, 7, 30, 31, 32, 54, 55Combined conditions 25Commas 17Commission Amount by Quote Option and Premium Type placeholder 99Commission Details 7, 9, 11Commission placeholder 101Compare Data Against Sanction or Watch Lists 28Compare function 53Compare() function 53Compliance Acceptance Reason placeholder 95Compliance Accepted By First Name placeholder 95Compliance Accepted By Last Name placeholder 95Compliance Accepted On Date placeholder 96Compliance Accepted placeholder 96Compliance Detailed Message placeholder 93Compliance Executed On placeholder 93Compliance function 64, 67Compliance Information 93Compliance Message placeholder 93Compliance Referral Requested By First Name placeholder 94Compliance Referral Requested By Last Name placeholder 94Compliance Referral Requested On Date placeholder 94Compliance Rejected By First Name placeholder 96Compliance Rejected By Last Name placeholder 97Compliance Rejected On Date placeholder 97Compliance Rejection Reason placeholder 96Compliance Successful placeholder 93Compliance() function 64, 67Concatenation (combining data) 5Conditional Results – the If() Function 18Conditional Selection of Grid Rows - the Where() function 21Contact Name placeholder 147, 148



Core Field Code placeholders 142Correction Type placeholder 90Count function 58Count() function 58Country placeholder 149Created By First Name function 57Created By First Name placeholder 88Created By Last Name function 58Created By Last Name placeholder 88CreatedByFirstName() function 57CreatedByLastName() function 58Cross Policy Exact Match function 54Cross Policy Fuzzy Match function 54Cross-Policy Data Configuration 54CrossPolicyExactMatch() function 54CrossPolicyFuzzyMatch() function 54Current Date Time function 49Current Term Commission Amount placeholder 109Current Term Effective Date placeholder 107Current Term Expiry Date placeholder 108Current Term ID placeholder 107Current Term Information 9, 107Current Term Number placeholder 108Current Term Policy Number placeholder 107Current Term Premium Amount placeholder 108Current Term Tax Amount by Premium placeholder 109Current Term Total Commission Amount placeholder 109Current Term Total Premium Amount placeholder 108Current Term Total Tax Amount placeholder 109Current Transaction Deductible Information 104Current Transaction Information 7Current Transaction Limit Information 103Current Transaction Premium, Commission, Tax Information 100CurrentDateTime() function 49Custom Date Format function 52Custom Date Format Function 34CustomDateFormat() function 52



DDate Comparison Field 31, 32Date Long function 51Date of Loss placeholder 143Date Overlap function 49Date Picker field 31Date Reported placeholder 143Date Short function 52Date Time Long function 51Date Time Short function 52DateLong() function 51DateOverlap() function 49DateShort() function 52DateTimeLong() function 51DateTimeShort() function 52Day - Double Digit placeholder 114Day - Single Digit placeholder 114Days Between function 47Days In Period function 48DaysBetween() function 47DaysInPeriod() function 48Deductible Amount by Quote Option, Premium Type, and Deductible Type placeholder 99Deductible Amount or Percentage placeholder 105Deductible Amount placeholder 106Deductible Currency placeholder 106Deductible Description placeholder 105Deductible Premium Type Name placeholder 105Deductible Type placeholder 105Deductibles 14Defining Multiple Fields in a Function 17Defining String Data 4Defining the Results 19Description of Loss placeholder 144Detailed Function Descriptions 28Detected Changes Timestamp Field 30, 31Distributor Address placeholder 76, 130Distributor City placeholder 77, 130Distributor Commission placeholder 78



Distributor Country placeholder 78, 130Distributor Email placeholder 131Distributor Fax placeholder 78Distributor filter 54Distributor Information 76, 130Distributor Name placeholder 78, 130Distributor party role 146Distributor Phone placeholder 79, 131Distributor Primary Contact Email placeholder 80Distributor Primary Contact Employee Number placeholder 80Distributor Primary Contact First Name placeholder 79Distributor Primary Contact Last Name placeholder 80Distributor Primary Contact Phone placeholder 80Distributor State placeholder 131Distributor State/Province placeholder 79Distributor Website placeholder 79Distributor Zip placeholder 130Distributor Zip/Postal Code placeholder 79Divide operator 3EEffective Date 65Effective Date placeholder 90Email Address placeholder 146E-mail placeholders 70, 120, 142Endorsement Number placeholder 91e-Signature Document Created By Name placeholder 118e-Signature Document Status Modified On Date placeholder 119e-Signature Tag placeholder 118Exp function 59Exp() function 59External Code field 141FFax Number placeholder 147Field Indexing 55Field Management page 4, 141File Upload field 89Filter type 54Filter Values 54



Formatted Date 1 placeholder 115Formatted Date 2 placeholder 115Formatted Date 3 placeholder 115Formatted Date 4 placeholder 115Full Date placeholder 115Full Function Reference List 47Full Month Name placeholder 116Functions 16Functions to Enter Data Into Grids (Grid Mapping) 37GGet Day Of Month function 51Get Day Of Year function 50Get Days From Current function 51Get Month function 50Get Months From Current function 51Get OFAC Scan function 63, 64Get Term Number function 56Get Term Status function 56Get Term Tax Amount function 57Get Transaction Status function 56Get Transaction Type function 56Get TransactionTax Amount function 57Get User function 52Get Year function 50Get Years From Current function 51GetDayOfMonth() function 51GetDayOfYear() function 50GetDaysFromCurrent() function 51GetMonth() function 50GetMonthsFromCurrent() function 51GetOFACScan() function 63, 64GetTermNumber() function 56GetTermStatus() function 56GetTermTaxAmount() function 57GetTransactionStatus() function 56GetTransactionTaxAmount() function 57GetTransactionType() function 56GetYear() function 50



GetYearsFromCurrent() function 51Grid Information 176Gross Premium Amount placeholder 100Guide 2HHash And Modified On function 53Hash Function Field 30Hash Reference Field 30HashAndModifiedOn() function 29, 53IIdentifying When Fields Have Changed After an Integration 29If function 65If not 25If() function 18, 65Individual Client Address placeholder 74Individual Client City placeholder 75Individual Client Code placeholder 76Individual Client Country placeholder 75Individual Client Email placeholder 75Individual Client First Name placeholder 74Individual Client Information 74Individual Client Last Name placeholder 74Individual Client Phone placeholder 76, 77Individual Client State/Province placeholder 75Individual Client Zip placeholder 75Installment Date placeholder 140Installment Information 140Installment Next Date placeholder 140Installment Number placeholder 140Insured party role 146Insurer Address placeholder 81, 131Insurer City placeholder 81, 132Insurer Client Code placeholder 81Insurer Code placeholder 81Insurer Country placeholder 82, 132Insurer Email placeholder 132Insurer Fax placeholder 82Insurer Information 81, 131



Insurer Name by Quote Option placeholder 97, 98Insurer Name placeholder 82, 131Insurer party role 146Insurer Phone placeholder 82, 132Insurer Primary Contact Email placeholder 84Insurer Primary Contact Employee Number placeholder 84Insurer Primary Contact First Name placeholder 84Insurer Primary Contact Last Name placeholder 84Insurer Primary Contact Phone placeholder 85Insurer Reference Code placeholder 83Insurer Risk Percentage placeholder 83Insurer State placeholder 132Insurer State/Province placeholder 83Insurer Website placeholder 83Insurer Zip placeholder 132Insurer Zip/Postal Code placeholder 84Insuring Conditions by Quote Option placeholder 100Integration Flag Field 31, 32Internal Transaction ID placeholder 88Interpolated Lookup function 59InterpolatedLookup() function 32, 59Interpolation/Extrapolation 32Introduction 2Invoice Created On Date placeholder 122Invoice Currency placeholder 122Invoice Due Date placeholder 122Invoice Information 120Invoice Issue Date placeholder 120Invoice Net Amount placeholder 121Invoice Number placeholder 120Invoice Outstanding Amount placeholder 122Invoice Total Amount Due placeholder 121Invoice Total Amount placeholder 121Invoice Total Commission Amount placeholder 121Invoice Total Tax Amount placeholder 121Is Abn Valid function 52Is Date Greater Than function 48Is New Business function 53



IsAbnValid() function 52IsDateGreaterThan() function 30, 48IsNewBusiness() function 53LLast Integration Run Date and Time placeholder 90Last Modified By First Name placeholder 89Last Modified By Last Name placeholder 89Last Modified Date placeholder 89Last Status Changed By First Name placeholder 90Last Status Changed By Last Name placeholder 90Limit Amount by Quote Option, Premium Type, and Limit Type placeholder 99Limit Amount placeholder 104Limit Currency placeholder 104Limit Description placeholder 103Limit Premium Type Name placeholder 103Limit Type placeholder 103Limits 13Long Date placeholder 116Lookup function 65Lookup Tables 65Lookup() function 65Loss Amount Currency placeholder 144Loss Amount placeholder 144Lost Reason placeholder 92MMax function 60Max() function 60Min function 60Min() function 60Modified By First Name function 58Modified By Last Name function 58ModifiedByFirstName() function 58ModifiedByLastName() function 58Month - Double Digit placeholder 116Month - Single Digit placeholder 116Month Day placeholder 116Months Between function 47MonthsBetween() function 47



Multiply function 59Multiply operator 3Multiply() function 59NName column 15Name placeholder 146Negative Conditions 25Net Premium placeholder 102New Grid function 38, 63NewGrid() function 38, 63Next Adjustment Number function 56Next button 89Next Endorsement Number function 56Next Policy Sequence Number function 55Next Sequence Number field 56NextAdjustmentNumber() function 56NextEndorsementNumber() function 56NextPolicySequenceNumber() function 55OOpen Bracket operator 3Operator 24Operators 3, 5, 24Or condition 25Other 117Outstanding Invoice Amount Currency placeholder 123Outstanding Invoice Amount placeholder 122Outstanding Invoice Date placeholder 123Outstanding Invoice Due Date placeholder 123Outstanding Invoice Number placeholder 123Outstanding Invoice Remaining Balance Currency placeholder 124Outstanding Invoice Remaining Balance placeholder 124Outstanding Invoice Total Amount Currency placeholder 124Outstanding Invoice Total Amount placeholder 124Outstanding Invoice Total Remaining Balance Currency placeholder 125Outstanding Invoice Total Remaining Balance placeholder 124PParent function 61Parent() function 61



Party Claim Number placeholder 146Party Role placeholder 146Payee Address placeholder 149Payee City placeholder 150Payee Country placeholder 150Payee Email Address placeholder 151Payee Fax Number placeholder 151Payee General Purpose Field One placeholder 151Payee General Purpose Field Three placeholder 152Payee General Purpose Field Two placeholder 151Payee Name placeholder 149Payee Phone Number placeholder 150Payee Postal Code placeholder 150Payee Reference Number placeholder 149Payee State or Province placeholder 150Payment Amount placeholder 155Payment Category placeholder 157Payment Check Number placeholder 156Payment Coverage placeholder 157Payment Currency placeholder 151, 156Payment Date placeholder 155Payment Description placeholder 157Payment Method placeholder 151Payment Party Code placeholder 158Payment Party Name placeholder 158Payment Plan Installment Amount Due placeholder 112Payment Plan Installment Commission Amount placeholder 113Payment Plan Installment Currency placeholder 114Payment Plan Installment Date placeholder 112Payment Plan Installment Gross Amount placeholder 113Payment Plan Installment Number placeholder 111Payment Plan Installment Tax Amount placeholder 112Payment Plan Installment Total Amount Due placeholder 113Payment Plan Installment Total Installment Amount placeholder 114Payment Plan Name placeholder 111Payment Reference Number placeholder 156Payment Status placeholder 156Payment Type placeholder 155



Phone Number placeholder 146Pipe Character 17Placeholders 7Placeholders Within Formulas 4Policy Created Date placeholder 85Policy filter 54Policy First Quoted Date placeholder 85Policy Information 85, 135Policy Last Quoted Date placeholder 86Policy Number 12Policy Number placeholder 145Policy Numbering page 56Policy Term Billing Option placeholder 135Policy Term Effective Date placeholder 135Policy Term ID placeholder 135Policy Term Payment Plan placeholder 135Policy Term Policy Number placeholder 136Policy Term Valid Until Date placeholder 136Policy Transaction Effective Date placeholder 136Policy Transaction ID placeholder 136Policy Transaction Type placeholder 136Policy Transaction Valid Until Date placeholder 137PolicyTransaction filter 55PolicyTransactionStatus filter 55Postal Code placeholder 149Premium Amount by Quote Option and Premium Type placeholder 98Premium Currency Code placeholder 101Premium Currency Name placeholder 101Premium Details 7, 9, 11Premium Type List page 15Premium Type Management page 15Premium Type Name placeholder 100Premium Types menu item 15Previous button 89Previous Term Commission Amount placeholder 110Previous Term Information 11, 109Previous Term Policy Number placeholder 109Previous Term Premium Amount placeholder 110



Previous Term Premium Name by Premium Id placeholder 110Previous Term Tax Amount by Premium placeholder 111Previous Term Total Commission Amount placeholder 110Previous Term Total Premium Amount placeholder 110Previous Term Total Tax Amount placeholder 111Product Design menu 15Product filter 54Product placeholder 86QQuote Information 97RReference 67Reinstatement Reason placeholder 87Replace function 62Replace() function 62Retrieving Premium IDs 15Round function 59Round() function 59SSave & Refresh button 89Save Payment action 154Save To Field function 62Save To Grid function 38, 63SaveToField() function 62SaveToGrid() function 38, 63Separate Invoicing by Transaction checkbox 137Set Max function 61Set Min function 60SetMax() function 61SetMin() function 60Short Date placeholder 116Simple Arithmetic Formulas 3State or Province placeholder 149Statement Closing Balance placeholder 125Statement Information 122Statement Total Amount Due placeholder 125Statement Transaction Amount Currency placeholder 125Statement Transaction Amount placeholder 125



Statement Transaction Date placeholder 126Statement Transaction Due Date placeholder 126Statement Transaction Number placeholder 126Statement Transaction Reference placeholder 126Statement Transaction Remaining Balance Currency placeholder 127Statement Transaction Remaining Balance placeholder 127Statement Transaction Total Amount Currency placeholder 127Statement Transaction Total Amount placeholder 127Statement Transaction Total Remaining Balance Currency placeholder 128Statement Transaction Total Remaining Balance placeholder 127Statement Transaction Type placeholder 128Status placeholder 90Straight Quotes 5, 7String modifier 5Subtract operator 3Sum function 58Sum() function 58System Date 114System Number placeholder 142, 143, 144TTax Amount by Quote Option, Premium Type, and Tax Type placeholder 98Tax Amount placeholder 102Tax Details 8, 10, 12Tax Name placeholder 102Term Period Dates 10Text Area control type 64Text Area field 30Textbox field 31Today Long function 49Today Short function 49Today Xml function 49TodayLong() function 49TodayShort() function 49TodayXml() function 49, 52Total Commission Amount function 57Total Commission Amount placeholder 101Total Commission by Quote Option placeholder 99Total Gross Premium Amount function 57



Total Gross Premium Amount placeholder 101Total Net Premium Amount placeholder 102Total Online Payment Amount placeholder 137Total Premium by Quote Option placeholder 98Total Tax by Quote Option placeholder 99Total Taxes Amount function 57Total Taxes Amount placeholder 103TotalCommissionAmount() function 57TotalGrossPremiumAmount() function 57TotalTaxesAmount() function 57Tracked Fields 30Transaction ID field 88Transaction ID placeholder 88Transaction Information 88UURL to Current Transaction placeholder 117User Contains Role function 52User Contains Security Role function 53UserContainsRole() function 28, 52, 53User's Browser Culture placeholder 117Using a Trigger as the Condition 18Using Data and Comparison Operators as the Condition 18VValid Until Date placeholder 91Value Exists function 55ValueExists() function 55Verifying User Security Roles 28Void Reason Code placeholder 92Void Reason Details placeholder 92Void Reason Name placeholder 92WWord Ribbon placeholders 70, 120, 142Workflow Event 154Working with Boolean Values 26YYear Month placeholder 117Year placeholder 117Years Between function 47



YearsBetween() function 47


Copyright Notice

Copyright © 1998 - 2016 Oceanwide Canada Inc. All Rights Reserved.

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

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

Trademarks

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

Disclaimer

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