PolicySearchScreen
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 Elements/Attributes
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. |
|
<Filter> | |||
<Conditions> |
SecurityGroup Exclusion condition definition:
|
Comma separated security group names:
|
|
<Condition> |
ENTITY RELATIONSHIPKEY |
Repeatable |
Specifies the table to be used for the filter. Only requied when ENITITY is, CLIENTRELATIONSHIP OR CLIENTRELATIONSHIPFIELD. Should be set to either Primary or Secondary |
Repeatable |
Specifies the field name to be used. For the main tables, this would be the column name. For Field tables this would be the field name. |
||
Specifies the value to search on the attribute should correspond to the datatype of the field: TextValue/ IntValue/ FloatValue/ DateValue |
|||
<Search> |
|
Required, repeatable element:
|
|
<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 element:
|
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. |
||
<Table> |
|
Required element:
|
|
<Column> | The container element for column configuration. | ||
HIDDEN |
Optional attribute: Specifies if the column should be displayed in the results table. |
Yes: The column will not be displayed in the results table. No: The column will be displayed in the results table. This is the default value. |
|
<Display> | Defines the header for the search result table column. |
String |
|
<Name> |
Specifies the database column in which the field values are stored. |
String | |
<Group> | Indicates the table/screen that stores the field being referenced. The value used should be appropriate for the screen being configured. |
String Examples: Activity |
|
<DataType> |
Defines the datatype of the field. |
String |
|
MASK | Optional:
Used to specify the mask that will validate and format the field data for display purposes. |
Any mask name that has been defined. | |
<OrderBy> |
Optional, repeatable element: Specifies a structure to define the ordering of the data in the table. Note: This element is repeatable only when the <Name> element has a value of "Name" and the <Group> element has a value of "Client." |
||
ORDINAL | Required attribute:
Specifies priority of the column among the columns being sorted. |
An integer indicating the sort order of the column. | |
ORDER |
Optional attribute: Specifies the direction of the sort with respect to the value of each column's ORDINAL attribute. |
ASCENDING: The columns will sort in ascending order. This is the default value. DESCENDING: The columns will sort in descending order. |
|
COLUMN |
Optional attribute: This attribute is only valid and processed by the system for "Name=Name" and "Group=Client" and "Name=Address" and "Group=Address".
|
A database column name from AsClient. |
PolicySearchScreen Image
XML Example
<PolicySearchScreen>
<AutoSelect>Yes</AutoSelect>
<Filter>
<Conditions SecurityGroup = "AlamereGroupSuper,AlamereTest" type ="Exclusion" Operator = "AND" >
<Condition Entity = "ASPOLICYFIELD">Fieldname = 'Employee' and TextValue = 'GuideStone'</Condition>
</Conditions>
</Filter>
<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>
<OrderBy ORDINAL="1" ORDER="DESCENDING" COLUMN="PolicyNumber"></OrderBy>
</Column>
<Column ALIGN="LEFT">
<Display>Policy Name</Display>
<Name>PolicyName</Name>
<Group>Policy</Group>
<OrderBy ORDINAL="2" ORDER="DESCENDING" COLUMN="PolicyName"></OrderBy>
</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=""></Group>
<DataType></DataType>
<OrderBy ORDINAL="[integer]" ORDER="[ASCENDING|DESCENDING]" COLUMN="[database column name]"></OrderBy>
<Query TYPE="[SQL|FIXED|RADIO]">
<OptionValue></OptionValue>
<OptionText></OptionText>
</Query>
<Calculated TYPE="" METHOD="" PLAN=""></Calculated>
</Column>
</Table>
</Results>
</PolicySearchScreen>