You are here: Business Rules > Plan Rules > PolicyScreen

Oracle® Insurance XML Configuration Guide Release 9.4.1.0 E23637_01

# PolicyScreen

## Description

Policy screen is the foundation of an insurance contract. It is a main screen of OIPA. This screen rule is overridden at the plan level for each product and houses product specific information. This business rule is used to configure the fixed fields of the Policy screen in order to:

1. Capture the basic information required for the policy like effective date, issue date, issue state, policy number, etc.
2. Perform policy level allocations.
3. Define roles, role counts, role percents and client types for roles that are required for a policy.
4. Define segment requirements.
5. Enable/Disable policy field and state approvals.

## PolicyScreen Element/Attribute Table

Element/Tag | Definition | Attribute | Element/Attribute Value and Description
--- | --- | --- | ---
<PolicyScreen> | The opening and closing tag of the business rule. |  |
<Fixed Fields> | Optional element; This element allows the fixed fields to have the same configuration capabilities as dynamic ( below the line ) fields; the only exception being the ability to change the fixed field data types. Note:Only Issue State fixed field display can be changed. |  |
<Fields> | Required element; Allows configuration of dynamic fields. See Fields. Note:Icons for PolicySearchScreen and ClientSearchScreen can be configured in the PolicyScreen by using the policy and client datatype, which will be displayed as disabled text boxes with search and people icons, respectively. Searching returns the respective GUIDs. |  |
<MultiFields> | Optional element; Allows configuration of MultiFields in the PolicyScreen See MultiFields element for additional information. |  | MultiFields enables and allows Policy Screen with multiple sets of dynamic field values.
<Buttons> | Requiredelement; Allows configuration of buttons. |  |
<Button> | Optionalelement; Defines the display of function buttons on the Policy screen. |  | Required Element value; ButtonName Allows the display of specified buttons on the Policy screen Note: The Save button is the only button configured on the Policy screen.
<Events> | See Action Events |  |
<ScreenMath> | See Math Elements |  |
<Actions> | See Action Events |  |
<SegmentsAllowed> | Optional element; Specifies the number of segments that are allowed on the policy. |  | Required element value; Integer / * Number of segments. Allows the user to add only up to specified number of segments to the policy. Note:The star * symbol indicates that unlimited number of segments can be allowed for a policy.
<MinimumSegments> | Optional element; Specifies the minimum number of segments that MUST be attached to a policy before any activity can be processed. |  | Optional element value; Integer Number of segments. This forces the user to add at least the minimum number of segments prior to processing the policy activities.
<ShowSegmentRoles> | Optional element; Shows segment roles on policy Roles screen and in the Client's drop down box on the policy Client screen. Note: Segment should have at least one field of datatype, "Role" and the same should be assigned a role. |  | Optional element value; Yes/No Yes- Allows display of Segment roles on Segment tab of Policy and the added segment roles, in the Policy's Client drop down box No- When set to "No" Segment roles will not be displayed on Segment tab of Policy or in the drop down box of Clients on the Clients tab of the Policy.
<DisablePolicyFields> | Optional element; Specifies when fields on the Policy screen can or cannot be edited, based on policy status. Disables policy fields for the specified policy status if the policy status code matches a code in the DisabledStatus section for the particular policy. Note: When AutomaticPolicyNumber generator is not used, PolicyNumber field should be editable even after saving the policy that allows the entering and editing in that field until another policy event (calculating a coverage, issue of the policy). |  |
<DisabledStatus> | Required element; Indicates which applicable status(es) would trigger the lock-down of editable fields. This element defines policy status codes for the policy fields that will be disabled on the Policy screen. |  | Required element value; PolicyStatusCode Policy Status Code from AsCode=>AsCodeStatus
<SegmentCount> | Optional element; This element specifies the segment count that will be used only when policy status does not match a code in the DisabledStatus section for the particular policy. When policy status does not match a code in the DisabledStatus section then policy fields will be disabled. |  | Optional element value; _ * / + _ " * ": Disables policy fields in all conditions. " + ": Disables policy fields when policy has at least a minimum of one segment in active status.
<AutomaticPolicyNumber> | Optional element; Allows generating automatic policy number when a new policy is created as per the format specified in AutomaticPolicyNumber business rule. |  | Optional element value; Yes: Allows generating automatic policy number when new policy is created. No:Automatic policy number will not be generated when new policy is created and allows the user to enter the policy number in to the PolicyNumber field. If this element is not present default is "No".
<AutomaticPolicyName> | Optional element; Allows generating Automatic Policy Name when a new policy is created as per the format specified in AutomaticPolicyName Business Rule. |  | Optional element value; Yes: Allows generating automatic policy name when new policy is created. No:Automatic policy name will not be generated when new policy is created and allows the user to enter the policy name in to the PolicyName field. If this element is not present default is "No".
<UseStateApproval> | Optional element; Defines whether or not state approval is enforced. This also controls the display of eligible states in IssueState drop down box. |  | Optional element value; String: Yes/No Yes: State Approval is enforced for this policy and only eligible states will be displayed in the Issue State drop down box. No: Not State Approved, all states will be displayed in the Issue State drop down box. If this element is not present default is "Yes".
<Roles> | Opening tag for defining roles on the policy. | ALWAYSEQUALPERCENT | Optional attribute; Yes: >Allows equal percent for even and odd number of roles for a role type upon clicking the EqualPercent check box. When Equal Percent check box is checked and the amounts aren't equal, the remaining amount is allocated to the last client
<Role> | Required and repeatable element; This element defines the description of the role that will be added to the policy. Note: A role is a policy-driven position held by a person or entity. Roles can be attached to the policy, when creating a new policy or attach to an existing policy. Each role tag will result in the addition of one or more clients to a specific role on a policy. By having multiple <Role> tags, more than one role can be added to a policy at the same time. | NAME | Optional attribute; RoleName A short description of the name as per AsCodeRole.
| DISABLEBYPOLICYSTATUS | Optional Attribute; PolicyStatusCode Used to prevent disabled roles from being disabled. It is also used to disable role fields, role percents and prevent disabled fields from being added to a policy.
<RoleCode> | Required element; Code values of a role that is applicable to this plan. |  | Required element value; RoleCode Role code of the role as per AsCodeRole.
<RoleCount> | Optional element; Specifies number of times a role can be assigned to policy. |  | Required element value; Integer Allows the user to assign this type of role only specified number of times to the policy.
<RolePercent> | Required element; Defines the total percent value that OIPA will validate against when a role is created. OIPA will only accept a role with a value that matches <RolePercent>. | ALLOWPERCENT | Required element value;0-100 percent is a valid value. Integer Allows a specific percent to be assigned to the role. Yes: Role Percent box is visible on the PolicyRole screen. No: hides the Role Percent box on the PolicyRole screen where the list of policy roles are displayed.
<ClientType> | Optional element; Define the client types that can be assigned to the role. Only these client types will be displayed in the Client Type drop-down box in the Client screen, for the specific role. Example:An insured may need to be an individual client type for a particular plan. |  | Required element value; ClientTypeCode Client type code from AsCode table=>AsCodeClient.
<Tests> | Optional Element; Allows configuration of test(s) condition. The evaluation of the condition decides whether or not the particular role section can be executed. |  |
<Test> | Required/Repeatable Element; Expression used to determine if role should be displayed/allowed for policy. |  | Expression; Literal values can be used for the test condition.
| TYPE |
<AllowZeroPercent> | Optional element; Allows Zero percent in Role percent fields. |  | Required element value; Yes/No Yes:Allows user to enter zero percent in the Rolepercent field. No:When set to "No" then Zero Percent is not allowed. Note: If this element is not present then the default is "Yes".
<AllowNoPercent> | Optional element; Controls the display of the Percent box next to the name of the individuals that have been assigned to the specified role. |  | Required element value; Yes/No Yes:Percentage box will not be listed next to the name of the individuals that has been assigned to the specified role. No:When set to "No" the Percentage box will be displayed next to name of the individual that has been assigned to the specified role. Note: If this tag is not present default is "No".

## PolicyScreen Image

## XML Example

    <PolicyScreen>

    <Fields>

    <Field>

    <Name>SortCompany</Name>

    <Display>Company</Display>

    <DataType>Combo</DataType>

    <Query TYPE="SQL">SELECT FundClassGUID, FundClassName FROM
    AsFundClass ORDER BY 2 DESC</Query>

    <Disabled>Yes</Disabled>

    </Field>

    <Field>

    <Name>ActiveDate</Name>

    <Display>Date
     Activated</Display>

    <DataType>Date</DataType>

    <Disabled>Readonly</Disabled>

    </Field>

    <Field>

    <Name>Carrier</Name>

    <Display>Carrier Company Name</Display>

    <DataType>Combo</DataType>
    <Query TYPE="SQL">SELECT ClientGuid, CompanyName FROM
    AsClient WHERE TypeCode = '19'</Query>

    </Field>

    </Fields>

    <Buttons>

    <Button>Save</Button>

    <Button>New</Button>

    <Button>Close</Button>

    </Buttons>

    <Roles ALWAYSEQUALPERCENT="No">

    <Role
    DISABLEBYPOLICYSTATUS=Ã¢â‚¬01,02,95Ã¢â‚¬>

    <RoleCode>01</RoleCode>

    <RoleCount>1</RoleCount>

    <RolePercent>100</RolePercent>

    </Role>

    <Role>

    <RoleCode>37</RoleCode>

    <RoleCount>1</RoleCount>

    <RolePercent>100</RolePercent>

    </Role>

    </Roles>

    <SegmentsAllowed>4</SegmentsAllowed>

    <MinimumSegments>1</MinimumSegments>

    <AutomaticPolicyNumber>Yes</AutomaticPolicyNumber>

    <UseStateApproval>Yes</UseStateApproval>

    </PolicyScreen>

## Schema Example

    <PolicyScreen>

    <FixedFields> </FixedFields>
    <Fields>

    <Field>

    <Name>[Name of the dynamic field]</Name>

    <Display>[Display name]</Display>

    <DataType>[Text, Money, Date, etc.]</DataType>

    <Disabled>Yes/No</Disabled>

    <Default>[Default value]</Default>

    <Hidden>[Yes/No]</Hidden>

    </Field>

    </Fields>

    <Buttons>

    <Button>[ButtonName]</Button>

    </Buttons>

    <Events></Events>

    <SegmentsAllowed>[Integer|*]</SegmentsAllowed>

    <MinimumSegments>[Integer]</MinimumSegments>

    <DisablePolicyFields>

    <DisabledByStatus>[Code]</DisabledStatus>

    <SegmentCount>[*/+]</SegmentCount>

    </DisablePolicyFields>

    <AutomaticPolicyNumber>[Yes|No|Optional]</AutomaticPolicyNumber>

    <UseStateApproval>[Yes|No]</UseStateApproval>

    <Roles ALWAYSEQUALPERCENT="[Yes|No]">

    <Role NAME="[RoleName]" DISABLEPOLICYSTATUS="[PolicyStatusCode]">

    <RoleCode>[RoleCode]</RoleCode>

    <RoleCount>[Integer]</RoleCount>

    <RolePercent>[Integer]</RolePercent>

    <Tests>

    <Test>[Expression]</Test>

    </Tests>

    </Role>

    </Roles>

    </PolicyScreen>

Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices

Open table of contents