VerificationScreen
The Verification screen business rule may be attached to Client Financial and Policy Financial transactions – including any lower sub-categories of these transaction types (e.g. Policy-Financial-Reversible-Nonreversing, Policy-Financial-Nonreversible-Nonreversing, Client-Financial-Nonreversible-Nonreversing). This rule allows the transaction to preview three optional non-editable sections before the activity processes:
- Verification section is fully configurable, and will contain its Title (Verification Section heading), Messages (static and dynamic), Fields and MathVariables. Only those fields and math variables configured within the main body of the transaction will be available for display in the Verification section. Dynamic Messages will include substitution fields and/or math variables from transaction’s configuration.
- Allocation section is a “whole-sale” representation of information normally found in the Activity Result screen’s Allocation tab’s Fund Allocations table contents.
- Errors section is a “whole-sale” representation of Errors and Warnings that may occur on the activity.
Access to the Verification screen is granted via a Verify button on the Activity Detail screen (available only if the VerificationScreen business rule is attached to the transaction). Security must also be applied to the button using the Rules Palette.
The Verification screen is one of several features added to the transaction. Another such feature is the Activity Result Display in Quote mode (driven by the QuoteScreen business rule).The VerificationScreen and the QuoteScreen rules are mutually exclusive. If the VerificationScreen rule is attached to a transaction, then the QuoteScreen rule cannot be attached, and vice-versa.
This rule cannot be added to the TransactionBusinessRulePacket. If it is added, then the rule will not function properly.
| Element/Tag | Attribute | Definition | Element/Attribute Value and Description |
|---|---|---|---|
|
<VerificationScreen>
|
|
Required element: Opening opening element for Verification Screen business rule. |
|
|
TITLE |
Optional attribute: Verification screen title. |
String |
|
|
<Fields> |
|
Optional element: Opening and closing tag of the Fields and Messages section, within the Verification Section of the Verification Screen. |
|
|
<Field> |
|
Required element: The Field element configures messages and values from transaction fields and math variables. |
Fields and Note: If math variables from PostAssignmentValidateExpressions are used, and prices for the effective date are required but not available, their values will be calculated with assignments simulated using the last available prices. Messages (dynamic or static). For dynamic messages, the replacement items (activity fields and math variables) are enclosed by triple dollar-signs ($$$). Messages also may include fillers and lines. |
|
<Name> |
|
Required element: The Name element contains the name of a field or math variable configured within the main body of the transaction. If the DataType of the field is “Message”, the name is ignored by the system. |
String |
|
<Display> |
|
Required element: The display name of the field. |
String |
|
<DataType> |
|
Required element: The data type of the field. |
Blank
|
|
<Calculated> |
|
Required when <DataType> is set to “Message”: Contains the body of the static and dynamic messages. |
String or combinations of string and dynamic replacement items. For dynamic messages, the replacement items (fields and math variables from the transaction) are enclosed by triple dollar-signs ($$$). |
|
TYPE |
Required attribute: One attribute value is allowed, MESSAGE, for displaying messages only. |
MESSAGE | |
|
<Expanded> |
|
Optional element: If a field is expanded, it is the only field in the line. |
Yes or No The default is No. |
|
<Allocations>
|
|
Optional element: Indicates whether the allocation section is displayed |
Yes or No The default is No. |
|
SHOWORIGINAL |
Optional attribute: Indicates which allocations are displayed: both original and final, or final only. If this attribute is present and equal to "Yes", original allocations are displayed above final allocations. |
Yes or No The default is No. Yes – displays both original and final allocations. No – displays final allocations only. |
|
| <DisableOkButton> | Optional element:
Defines specific errors that result in the disabling of the OK button, which prevents the activity from being saved. If an error identified within this element is defined as a warning or overridable error elsewhere in the configuration, the OK button will not be disabled. |
||
| ALLERRORS | Optional attribute:
Defines whether the OK button should be disabled for any error(s) that occur on the activity. |
Yes or No The default is No. Yes – All errors that occur on the activity will result in the disabling of the OK button. No – Errors on the activity will not disable the OK button. |
|
| <ErrorNumberIs> | Optional and repeatable element:
Defines specific errors (by error number) that, if returned by the system, should disable the OK button. This will prevent the user from saving an activity that has returned certain errors. |
The error number of the error that should disable the OK button. | |
| <ErrorNumberStartsWith> | Optional and repeatable element:
Defines the leading characters of the error numbers that, if returned by the system, should disable the OK button. This will prevent the user from saving an activity that has returned a certain type of error. |
The leading characters of the error numbers of the errors that should disable the OK button. | |
| IGNORECASE | Optional element:
Defines whether the character case of the error number is relevant to the identification of the error. |
Yes or No The default is No. Yes – The character case of the error number will not be considered in identifying the error. No – The character case of the error number will be considered in identifying the error. |
|
|
<Errors> |
|
Optional element: Defines whether the Errors section is displayed. |
Yes or No The default is No. Yes – The Errors section is displayed. No – The Errors section is not displayed. Note: If this element is absent from the configuration but the <Warnings> element is present, and an error occurs on the activity, a warning message will be displayed informing the user that the <Errors> element is absent, but an error has occurred on the activity. |
| <Warnings> | Optional element:
Defines whether the Warnings section is displayed. |
Yes or No The default is No. Yes – The Warnings section is displayed. No – The Warnings section is not displayed. Note: If this element is absent from the configuration but the <Errors> element is present, and a warning occurs on the activity, the Errors section of the screen will display as "Errors/Warnings." Both errors and warnings will display in this section. |
XML Example
<VerificationScreen TITLE="Verification Screen">
<Fields>
<Field>
<Name>AmountTotal</Name>
<Display>Amount Total</Display>
<DataType>Message</DataType>
<Calculated TYPE="MESSAGE">In annuity contract $$$QuotePolicyNumber$$$ a
$$$QuoteTransactionName$$$ transaction will occur with a return amount of
$$$TransactionAmountTotal$$$.</Calculated>
</Field>
<Field>
<Name>QuotePrimaryOwnerRoleInfo</Name>
<Display>Primary Owner</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>JointOwner</Name>
<Display>Joint Owner</Display>
<DataType>Text</DataType>
</Field>
<Field>
<Name>Line1</Name>
<Display/>
<DataType>Line</DataType>
</Field>
<Field>
<Name>WithholdingInfo</Name>
<Display>Withholding Info</Display>
<DataType>Message</DataType>
<Calculated TYPE="MESSAGE">For tax purposes, we will withhold the following
percentage/dollar amount:</Calculated>
</Field>
<Field>
<Name>FederalPercentQuote</Name>
<Display>Federal Percent</Display>
<DataType>Percent</DataType>
</Field>
<Field>
<Name>StatePercentQuote</Name>
<Display>State Percent</Display>
<DataType>Percent</DataType>
</Field>
<Field>
<Name>Blank1</Name>
<Display/>
<DataType>Blank</DataType>
</Field>
<Field>
<Name>FederalUseTablesQuote</Name>
<Display>Federal Withholding</Display>
<Expanded>Yes</Expanded>
<DataType>Money</DataType>
</Field>
<Field>
<Name>StateUseTablesQuote</Name>
<Display>State Withholding</Display>
<Expanded>Yes</Expanded>
<DataType>Money</DataType>
</Field>
</Fields>
<Allocations SHOWORIGINAL="Yes">Yes</Allocations>
<DisableOKButton>
<ErrorNumberIs>W007</ErrorNumberIs>
<ErrorNumberStartsWith IGNORECASE="Yes">Y</ErrorNumberStartsWith>
</DisableOKButton>
<Errors>Yes</Errors>
<Warnings>Yes</Warnings>
</VerificationScreen>
