PolicySearchScreen

Definition

This business rule is used to configure the PolicySearchScreen. It defines the fields that are used to store the results of a search. 

Both the search criteria (Fields & FixedFields) and results (Columns) will accept mask attributes in the DataType elements. Refer to the Fields and Tables sections to see mask attribute configuration.

PolicySearchScreen Element/Attribute Table

Element/Tag

Attribute

Definition

Element/Attribute Value and Description

<PolicySearchScreen>

 

The opening and closing tags of the PolicySearchScreen business rule.

 

<AutoSelect>   Allows configuration of automatic navigation. Yes: If a search for a policy in OIPA returns a single result, then the Policy screen—or the Policy Overview screen, if configured—for that policy will automatically load.

No: Even if a search for a policy returns a single result, the Policy screen/Policy Overview screen will not automatically load, and the user will have to manually select the policy from the policy search results.

<Search>

 

Required and Repeatable Element:
Indicates and defines search criteria and the fields to be included as part of the Policy Search screen activity.

 

<FixedFields>

 

Changes the labels on the "above the line" fixed fields.

 

<Fields>

 

Dynamically changes labels on the "below the line" fields. See Fields Elements.

 

<Results>

 

Required:
Defines the results.

This element provides the return of the search and the data in the Results override the fixed fields.

INITIALRESULTS

 

This attribute specifies the initial results that should display on the screen when it initially loads.
User: Indicates Policy search results tied to the client login should be displayed.
None: Indicates no Policy search results should be displayed. This is the default behavior.

<Table>

 

Required:
The element that defines the screen as a table format and controls the display of results, formats results in a table. See Table Element.

 

PolicySearchScreen Image

OIPA Policy Search Screen

XML Example

<PolicySearchScreen>
<AutoSelect>Yes</AutoSelect>
<Search> 
<FixedFields> 
<Field>
<Name>Company</Name> 
<Display>Company</Display> 
</Field>
<Field>
<Name>Plan</Name>
<Display>Plan</Display>
</Field>
</FixedFields> 
<Fields> 
<Field> 
<Name>PolicyNumber</Name>
<Display>Policy Number</Display>
<DataType>Text</DataType>
<Group>Policy</Group>
<InputFocus>Yes</InputFocus>
</Field> 
<Field> 
<Name>LastName</Name> 
<Display>Annuitant Last Name</Display> 
<DataType>Text</DataType> 
<Group ROLECODE="27">Client</Group> 
</Field> 
<Field> 
<Name>FirstName</Name> 
<Display>Annuitant First Name</Display> 
<Group ROLECODE="27">Client</Group> 
</Field> 
<Field> 
<Name>AppSignDate</Name> 
<Display>Signed Date</Display> 
<DataType>Date</DataType> 
<Group>PolicyField</Group> 
</Field>
</Fields>
</Search> 
<Results> 
<Table>
<Column ALIGN="LEFT"> 
<Display>PolicyNumber</Display>
<Name>Policy Number</Name>
<Group>Policy</Group>
</Column> 
<Column ALIGN="LEFT"> 
<Display>Policy Name</Display> 
<Name>PolicyName</Name> 
<Group>Policy</Group> 
</Column> 
<Column ALIGN="LEFT"> 
<Display>Status</Display>
<Name>StatusCode</Name>
<Group>Policy</Group>
</Column> 
<Column ALIGN="LEFT"> 
<Display>Insured</Display>
<Name>Name</Name>
<Group ROLECODE="01">Client</Group>
</Column> 
<Column ALIGN="LEFT"> 
<Display>Tax ID</Display>
<Name>TaxID</Name>
<Group ROLECODE="01">Client</Group>
</Column> 
<Column ALIGN="LEFT"> 
<Display>Issue State</Display>
<Name>StateCode</Name>
<Group>Policy</Group>
</Column> 
<Column ALIGN="LEFT"> 
<Display>PlanDate</Display>
<Name>PlanDate</Name>
<Group>Policy</Group>
</Column> 
</Table>
</Results> 
</PolicySearchScreen>

XML Schema

<PolicySearchScreen>
<AutoSelect>Yes|No</AutoSelect>
<Search> 
<FixedFields>  
<Fields>  
<Field>  
<Name></Name>
<Group ROLECODE=""></Group>
<Display MASK=""></Display>
<DataType></DataType>
<Encrypt ERASE="Yes|No">Yes|No</Encrypt>
<Value></Value>
<Disabled>ReadOnly|Exists|   </Disabled>
<Hidden></Hidden> 
<Length></Length>  
</Field>
</Fields> 
</FixedFields>  
<Fields> 
<Field> 
<Name></Name> 
<Group ROLECODE=""></Group> 
<Display MASK=""></Display> 
<DataType></DataType> 
<Encrypt ERASE="Yes|No">Yes|No</Encrypt> 
<Value></Value> 
<Disabled>ReadOnly|Exists|...</Disabled> 
<Hidden></Hidden> 
<Length></Length> 
<DefaultValue></DefaultValue> 
<Query TYPE="SQL|FIXED|RADIO"></Query>
<Calculated TYPE="" METHOD="" PLAN=""></Calculated> 
</Field> 
</Fields> 
</Search> 
<Results>
<Table NAME="">
<Column ALIGN="" FORMAT="" EDITABLE="" RECONCILE="Yes|No" FIELD="" TOTAL="Yes|No"> 
<Display></Display> 
<Name></Name> 
<Group ROLECODE="">Role|Client|Address</Group>
<DataType></DataType> 
<Query TYPE="SQL|FIXED|RADIO">
<OptionValue></OptionValue> 
<OptionText></OptionText> 
</Query> 
<Calculated TYPE="" METHOD="" PLAN=""></Calculated> 
</Column> 
</Table> 
</Results> 
</PolicySearchScreen>