PolicyValues
The PolicyValues business rule should be configured at the plan level. This business rule is used with ValuesScreen business rule to display the value of the policy on the Values screen (Values screen can be invoked by clicking the Values button on the Policy screen). The PolicyValues business rule specifies the math variables that are to be used for calculating the policy value and displays the resulting values on the Values screen. The ValuesScreen business rule specifies how to display the value format (such as currency, text etc.) on the Values screen.
The PolicyValues business rule is invoked by processing the transaction that contains the <Valuation> element. When the PolicyValues business rule is not attached to a transaction, the system will not run any policy values calculation and hence the <PolicyValues> tag within the ValuationXML will be empty. As a result, the policy values section on the Values screen will be blank. Within the transaction XML, by using the POLICYVALUES attribute, the user can specify whether or not the PolicyValues business rule should be invoked and set to either Yes or No depending on the need.
-
When the attribute is set to Yes, policy values will be calculated.
-
When the attribute is set to No, calculation of policy values will be turned off.
-
When no attribute is present, it's treated as if the POLICYVALUES is set to
YESand so the policy values will be calculated.
Note: Specific values from the database can be retrieved without writing SQL statements, by using the available defined prefixes and fields for configuration. Please see the Available Prefixes and Fields for Configuration for a listing.
| Element/Tag | Attributes | Parent Element | Desciption | Element/Attribute Values |
|---|---|---|---|---|
|
<PolicyValues> |
|
The opening and closing tag of the PolicyValues business rule. |
|
|
|
<MathVariables> |
|
<PolicyValues> |
Opening tag for defining MathVariables. |
|
|
<MathVariable> |
|
<MathVariables> |
Required Element: This business rule supports all MathVariable
properties supported
by transactions. |
[Entity]:[MathVariable]:EffectiveDate [Entity]:[MathVariable]:MoneyType [Entity]:[MathVariable]:TypeCode [Entity]:[MathVariable]:Amount These configurations above allows access to the table column values for the GUID referenced in MathVariable [Entity]:[MathVariable]: Balance This configuration calculates total amount left at Financial Entry level for the GUID referenced in the MathVariable [Entity]:Balance This configuration calculates the total Balance Amount left at Policy level |
| VARIABLENAME | ||||
| TYPE | FIELD | |||
| DATATYPE |
XML Schema
<PolicyValues>
<MathVariables>
<MathVariable VARIABLENAME="" TYPE="" DATATYPE=""></MathVariable>
<MathVariable VARIABLENAME="[MathVariable]" TYPE="FIELD" DATATYPE="XXX">Entity:[MathVariable]:[ColumnName]</MathVariable>
<MathVariable VARIABLENAME="[MathVariable]" TYPE="FIELD" DATATYPE="XXX">Entity:[MathVariable]:Balance</MathVariable>
<MathVariable VARIABLENAME="[MathVariable]" TYPE="FIELD" DATATYPE="DECIMAL">Entity:Balance</MathVariable>
. . .
</MathVariables>
</PolicyValues>
XML Example
<PolicyValues>
<MathVariables>
<MathVariable VARIABLENAME="Blank" TYPE="VALUE" DATATYPE="TEXT"></MathVariable>
<MathVariable VARIABLENAME="Yes" TYPE="VALUE" DATATYPE="TEXT">Yes</MathVariable>
<MathVariable VARIABLENAME="No" TYPE="VALUE" DATATYPE="TEXT">No</MathVariable>
<MathVariable VARIABLENAME="Zero" TYPE="VALUE" DATATYPE="INTEGER">0</MathVariable>
<MathVariable VARIABLENAME="Checked" TYPE="VALUE" DATATYPE="TEXT">CHECKED</MathVariable>
<MathVariable VARIABLENAME="SegmentGUID" TYPE="SQL" DATATYPE="TEXT">SELECT AsSegment.SegmentGuid FROM AsSegment WHERE AsSegment.PolicyGUID = '[Policy:PolicyGUID]'</MathVariable>
<MathVariable VARIABLENAME="PolicyCashValue" TYPE="FIELD" DATATYPE="DECIMAL">Valuation:Policy:CashValue</MathVariable>
<MathVariable VARIABLENAME="ContractValue" TYPE="FIELD" DATATYPE="DECIMAL">Valuation:Policy:CashValue</MathVariable>
<MathVariable VARIABLENAME="PolicyIssueDate" TYPE="FIELD" DATATYPE="DATE">Policy:PolicyIssueDate</MathVariable>
<MathVariable VARIABLENAME="FundGUID" TYPE="EXPRESSION DATATYPE="TEXT">FundGUID</MathVariable>
<MathVariable VARIABLENAME="TestAmountAverage" TYPE="FIELD" DATATYPE="DECIMAL">Valuation:Fund:TestAmountAverage</MathVariable>
<MathVariable VARIABLENAME="Ratio" TYPE="FIELD" DATATYPE="DECIMAL">Valuation:Fund:Ratio</MathVariable>
<MathVariable VARIABLENAME="Yield" TYPE="FIELD" DATATYPE="DECIMAL">Valuation:Fund:Yield</MathVariable>
<!-- Financial Tracking Configuration-->
<MathVariable VARIABLENAME="PVFinancialEntryCalcMV" TYPE="EXPRESSION" DATATYPE="TEXT">IsValueFinancialEntry</MathVariable>
<MathIF IF="PVFinancialEntryCalcMV='Yes'">
<MathVariable VARIABLENAME="PVFinancialEntryEffectiveDateMV" TYPE="FIELD" DATATYPE="DATE">Policy:FinancialEntryEffectiveDate</MathVariable>
<MathVariable VARIABLENAME="PVFinancialEntryGUIDMV" TYPE="SQL" DATATYPE="TEXT">SELECT financialentryguid FROM asfinancialentry WHERE effectivedate = '[PVFinancialEntryEffectiveDateMV]' AND entityguid = '[Policy:PolicyGUID]' AND ActiveToDate is null and ROWNUM = 1</MathVariable>
<MathVariable VARIABLENAME="PVFinancialEntryEffectiveDateMV" TYPE="FIELD" DATATYPE="DATE">FinancialEntry:PVFinancialEntryGUIDMV:EffectiveDate</MathVariable>
<MathVariable VARIABLENAME="PVFinancialEntryMoneyTypeMV" TYPE="FIELD" DATATYPE="TEXT">FinancialEntry:PVFinancialEntryGUIDMV:MoneyType</MathVariable>
<MathVariable VARIABLENAME="PVFinancialEntryTypeCodeMV" TYPE="FIELD" DATATYPE="TEXT">FinancialEntry:PVFinancialEntryGUIDMV:TypeCode</MathVariable>
<MathVariable VARIABLENAME="PVFinancialEntryAmountMV" TYPE="FIELD" DATATYPE="DECIMAL">FinancialEntry:PVFinancialEntryGUIDMV:Amount</MathVariable>
<MathVariable VARIABLENAME="PVFinancialEntryBalanceMV" TYPE="FIELD" DATATYPE="DECIMAL">FinancialEntry:PVFinancialEntryGUIDMV:Balance</MathVariable>
<MathVariable VARIABLENAME="PVPolicyBalanceMV" TYPE="FIELD" DATATYPE="DECIMAL">FinancialEntry:Balance</MathVariable>
</MathIF>
</MathVariables>
</PolicyValues>