InquiryScreen
The Inquiry screen enables users to access information via a rules defined format. The rule can be created at the Main Menu or Policy level. The level determines which screen this Inquiry screen can be accessed from. It also determines which GUID is passed to the Inquiry screen rule: PrimaryCompanyGUID for Main Menu or PolicyGUID for Policy.
Specific values from the database can be retrieved without writing SQL statements, by using the available defined prefixes and fields. Please see the Available Prefixes and Fields for Configuration for a listing.
OIPA supports a "Total" Attribute for the output column specification in the Inquiry screen wherein if the Column Data is numeric, a total of the results would display. The total that referred here is the entire results set, the new attribute "Total" added to the Column will fetch the value results for the numeric column data at the bottom of the grid via configured SQL statement.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<InquiryScreen> |
The opening and closing elements of the rule. |
DISPLAYONLOAD |
Controls the display of the Output section. Yes: When the screen is loaded the output section will display immediately. No: The output section will only display when the OK button is clicked. |
<Input> |
Defines the Input section of the Inquiry screen. |
|
|
<Fields> |
Defines the Input fields. See Fields. |
|
|
<Output> |
Defines the Output section of the Inquiry screen. Configured differently for field display and table display. |
|
|
<Result> |
|
DISPLAY |
String: Name of the result set. |
<Fields> |
Defines the output fields. See Fields. |
|
|
<Query> |
|
TYPE |
Math: Indicates a field display with a MathVariables section. The Query element is a descendent of the Result XML element. SQL: Indicates a table display supported by a SQL statement that may return multiple columns and multiple rows. The Query element is a descendent of a Results XML element. |
|
VALUATION |
Yes: Allows valuation to execute and make valuation fields available to the MathVariables section. No:No valuation is executed. The valuation fields are not available to the MathVariables section. |
|
|
VALUATIONDATE |
NEXTSYSTEM |
|
VALUEFINANCIALENTRY |
Optional: 'Yes' or 'No', or a Field with a value of 'Yes' or 'No'. Yes : Financial entry calcualtions 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 is "No" |
||
<Fields> |
Used when Query TYPE="SQL" to define the table. Standard column attributes are available. |
||
<MathVariables> |
Used when Query TYPE="MATH" Standard math variables functionality is available. |
|
|
<Table> |
Used with Query TYPE="SQL" to indicate that results will be returned in a table format. See Tablefor more details. |
|
|
<Table> | |||
<Column> | TOTAL |
Optional Attribute: Yes/No Yes: Displays a sum of a numeric column at the bottom of the column. No: No does not display a sum for the column. Default Value is “No”. |
|
<Query> |
|
TYPE |
Math: Indicates a field display with a MathVariables section. The Query element is a descendent of the Result XML element. SQL: Indicates a table display supported by a SQL statement that may return multiple columns and multiple rows. The Query element is a descendent of a Results XML element. |
|
VALUATION |
Yes: Allows valuation to execute and make valuation fields available to the MathVariables section. No: No valuation is executed. The valuation fields are not available to the MathVariables section. |
|
|
VALUATIONDATE |
NEXTSYSTEM |
|
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> |
Used when Query TYPE="SQL" to define the table. Standard column attributes are available. |
|
|
<MathVariables> |
Used when Query TYPE="MATH" Standard math variables functionality is available. |
|
|
XML Example
<InquiryScreen>
<Input>
<Fields>
<Field>
<Name>EffectiveDate</Name>
<Display>Valuation Date</Display>
<DataType>Date</DataType>
</Field>
</Fields>
</Input>
<Output>
<Result DISPLAY="Policy Values">
<Query VALUATION="Yes|No" VALUEFINANCIALENTRY="Yes|No" OR "FieldName">
<Valuation/>
<MathVariables>
<MathVariable VARIABLENAME="PaidToDate" TYPE="POLICYFIELD">PaidToDate</MathVariable>
<MathVariable VARIABLENAME="PolicyYear" TYPE="POLICYFIELD">PolicyYear</MathVariable>
<MathVariable VARIABLENAME="Mode" TYPE="POLICYFIELD">PaymentMode</MathVariable>
<MathVariable VARIABLENAME="ModeValue" TYPE="SQL">SELECT ShortDescription FROM AsCode WHERE CodeName='AsCodeMode' AND CodeValue='[Mode]'</MathVariable>
<MathVariable VARIABLENAME="MonthsInMode" TYPE="EXPRESSION">12 / Mode</MathVariable>
<MathVariable VARIABLENAME="ModalPremium" TYPE="POLICYFIELD">ModalPremiumAmt</MathVariable>
</MathVariables>
</Query>
<Fields>
<Field>
<Display>Policy Year</Display>
<Name>PolicyYear</Name>
<DataType>Integer</DataType>
</Field>
<Field>
<Display>Paid To Date</Display>
<Name>PaidToDate</Name>
<DataType>Date</DataType>
</Field>
<Field>
<Display>Modal Premium</Display>
<Name>ModalPremium</Name>
<DataType>Money</DataType>
</Field>
<Field>
<Display>Mode</Display>
<Name>ModeValue</Name>
<DataType>Text</DataType>
</Field>
</Fields>
</Result>
<Result DISPLAY="Paid To Date">
<Table>
<Results>
<Query TYPE="SQL">SELECT DATEVALUE PAIDTO FROM AsPolicyField WHEREPolicyGUID='[PolicyGUID]' AND FieldName='PaidToDate'></Query>
</Results>
<Column ALIGN="RIGHT">
<Display>Paid To Date</Display>
<Name>PAIDTO</Name> <DataType>Date</DataType>
</Column>
<Column ALIGN="[Left|Center|Right]" FORMAT="[Text|Currency|Date]" TOTAL="[Yes|No]">
<Group ROLECODE="[role code]">[entity name]</Group>
<Display BOLD="[Yes|No]" ITALICS="[Yes|No]">[header name]</Display>
<Name BOLD="[Yes|No]" ITALICS="[Yes|No]">[name of source]</Name>
<DataType MASK="[mask name]" CALENDAR="[calendar name]" FORMAT="[translation key]">[Text]</DataType>
</Column>
</Table>
</Result>
</Output>
</InquiryScreen>