ValuesScreen
ValuesScreen business rule is configured at the plan level. This rule is used with the PolicyValues business rule to display the policy's values on the Values screen (invoked by clicking the Values link on the Policy screen). PolicyValues business rule must be configured prior to configuring the ValuesScreen business rule.
ValuesScreen business rule dictates how to display (format) the item/variable (such as currency, text, etc.) on the Values screen whereas the PolicyValues business rule specifies the math variables that are to be calculated and displayed on the Values screen.
In addition, the ValuesScreen business rule can also perform the following:
-
display the valuation date (from PolicyValues) on the Values screen (policy level).
-
process the validations on the Values screen.
-
display the fund details and pie charts for allocations and assets.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<ValuesScreen> |
The opening and closing tag of the business rule. |
|
|
<PolicyValues> |
Required element: This tag is used to control the display of policy values in the PolicyValue section of the Values screen. |
|
|
ALIGNMENT |
Optional attribute: To align the Field Names in the PolicyValue section of the Vales Screen. ="Left / Right" Left: Policy values are assigned to the Left. Right: Policy values are assigned to the Right. |
||
VALUEFINANCIALENTRY |
Optional: 'Yes' or 'No', or a Field with a value of 'Yes' or 'No'. Yes: Financial entry calculations and math will need to be executed in PolicyValues BR. IsValueFinancialEntry context value will be assigned a values Yes. No: No financial entry calculation in PolicyValues IsValueFinancialEntry will have value No. Default Value ="No" |
||
<Fields> |
Required element: This tag is used to configure the properties of the fields that should be displayed in the Policy Values section. See Fields Element. |
|
|
<Field> |
Defines the description and display of the fields in the Policy Values section of the screen. |
|
Required element value: : MathVariable / Policy_FieldName / Blank / Line MathVariable: To retrieve the mathvariable values defined in the PolicyValues business rule. Policy_FieldName: To retrieve the values from the PolicyScreen fields. (i.e.,Policy_PolicyNumber). Blank: To display blank space. |
TITLE |
Optional attribute: To define the display name of the Fields in the ValuesScreen. |
||
FORMAT |
Optional attribute: To define the formatting of the Field values in the ValuesScreen. CURRENCY / TEXT / DATE / PERCENT CURRENCY: Formats the policy value to CURRENCY. TEXT: Formats the policy value to TEXT . DATE: Formats the policy value to DATE . PERCENT: Formats the policy value to PERCENT. |
||
<FundDetails> |
Required element: Fund details are displayed within a table in the fund section of the Values screen. This tag is used to configure the properties with which these fund details should be displayed in various columns. Note: By default, Fund Name and Cash Value columns are always displayed in the Fund Details section. |
|
|
<Exclude> |
Optional element: To exclude the funds (in which the policy has invested money) from being displayed in the Fund Details section of the Values screen. |
|
|
CASHVALUEZERO |
Optional attribute: To indicate whether the fund should be excluded only when the Cash Value is zero. ="Yes / No" Yes: To indicate that the specified fund can be excluded only if its Cash Value is zero. No: To indicate that the specified fund can be excluded even if its Cash Value is not zero. |
||
<Fund> |
Required/Repeatable element: Name of fund to be excluded from displaying in the Fund Details table. |
|
Required element value: : FundName Name of the fund that needs to be excluded. |
<Include> |
Optional element: To include the Funds (in which the Policy has invested money) that are to be displayed in the Asset or Allocation pie chart in the Values Screen. | ||
<Fund> |
Required element: Name of the fund to be included in the list. | Required element value: :FundNameName of the Fund that needs to be included. | |
<Columns> |
Optional element: Defines the columns that will be displayed within the table in the Fund Details section. |
|
|
<Units> |
Optional element: Defines the description of the column "Units" for a particular fund. Units is defined as the number of Units owned for an investment on the fund. |
TITLE |
Optional attribute: To define the display name of the Columns within the Fund details table. |
<UnitValue> |
Optional element: Defines the description of the column "UnitValue" for a particular fund. Displays the unit value price of each unit. |
TITLE |
Optional attribute: ="String" To define the display name of the Columns within the Fund details table. |
FORMAT |
Optional attribute: ="CURRENCY" To define the formatting of the UnitValue column values in the ValuesScreen CURRENCY: Formats the policy value to CURRENCY. |
||
<SurrenderValue>
|
Optional element: Defines the description of the column "SurrenderValue" for a particular fund Surrender value is sum of money an insurance company will pay to the policyholder or annuity holder in the event his or her policy is voluntarily terminated before its maturity or the insured event occurs. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<Principal>
|
Optional element: Defines the description of the column "Principal" for a particular fund Original amount of a investment on which interest is calculated. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<Gain>
|
Optional element: Defines the description of the column "Gain" for a particular fund Gain is an increase in value, as of an asset, including most charges. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<NetGain>
|
Controls what appears in the deposit details section. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<FreeAmount>
|
Name of fund to exclude from the list. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<MVAAmount>
|
Funds to include in the list. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<GuaranteedAmount>
|
Controls what appears in the deposit details section. |
|
|
|
TITLE |
See the description of TITLE for the UnitValue element. |
|
|
FORMAT |
See the description of FORMAT for the UnitValue element. |
|
<Graphs> |
Optional element: To configure the display of pie charts for assets and allocations. |
ASSETS |
Optional attribute: Yes / No Yes: Displays the pie chart for Assets. No: When set to "No" pie chart for Assets will not be displayed. If this attribute is not present pie chart for Assets will not be displayed. |
ALLOCATIONS |
Optional attribute: Yes / No Yes: Displays the pie chart for Allocations. No: Pie chart for allocations will not be displayed. If this attribute is not present pie chart for allocations will not be displayed. |
||
<DefaultValuationDate>
|
Optional element: Defines the valuation date to be set on Values screen. Note: If the <DefaultValuationDate> element is not included in this Business Rule or if the TYPE attribute is omitted in this element, then the current system date will be the default valuation date. |
|
Element value is required only when the TYPE attributes values are SQL or SQLPATH.
|
|
TYPE |
Optional attribute: To indicate the source using which default valuation date should be determined. ="SystemDate / SQL / SQLXPATH" SystemDate: Defaults valuation date to the current system date. SQL: Defaults valuation date to the resulting date of the SQL . SQLXPATH: When this TYPE="SQLXPATH", it uses a second attribute XPATH, value of the XPATH attribute will be run against the results of the SQL. If the tag is not present default valuation date is current system date. |
|
|
XPATH |
Optional attribute: applicable only when TYPE="SQLXPATH": ="String" Examples: XPATH is used to parse the XML in order to access a particular value within the ValuationXML from the SQL query result. Any date element can be used as sub element within the ValuationXML from the SQL query result. |
XML Example
<ValuesScreen>
<PolicyDetails></PolicyDetails>
<PolicyValues VALUEFINANCIALENTRY="Yes|No" OR FieldName>
<Fields>
<Field>
<Name>PolicyCashValue</Name>
<Display>Policy Cash Value</Display>
<DataType>Money</DataType>
<Disabled>Yes</Disabled>
</Field>
<Field> </Field>
</Fields>
</PolicyValues>
<FundDetails >
<Exclude>
<Fund>GMDB Rollup</Fund>
<Fund>GMIB</Fund>
<Fund>GMWB</Fund>
</Exclude>
<Columns>
<Column ALIGN="RIGHT">
<Name>Principal</Name>
<Display>Principal</Display>
<DataType>Money</DataType>
</Column>
<Column ALIGN="RIGHT">
<Name>Gain</Name>
<Display>Gain</Display>
<DataType>Money</DataType>
</Column>
</Columns>
</FundDetails>
<Graphs ALLOCATIONS="No" ASSETS="Yes"/>
</ValuesScreen>