SegmentScreen
This business rule defines all the fields for the Segment screen. The business rule is configured to allow modifications to the sort order of the items displayed above the line within the Segment section of the screen.
The Segment screen business rule defines the segment columns that will display in the segment table grid. It also defines the case statuses when the segment fields are disabled.
Note: The StateApproval element is valid if the plan is configured to use state approval (with the UseStateApproval element in PlanScreen equal to Yes). If the plan is not configured to use state approval, the StateApproval element in SegmentScreen is ignored.
Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
---|---|---|---|
<SegmentScreen> |
The opening and closing tag for the business rule. |
|
|
<DefaultSegment> |
Optional element:Displays the column with 'Default' name in the segment table grid. |
|
Required Element value:Yes/NoYes: Adds an additional column called "Default" in the Segment grid. No: No additional column will be added. This is the default behavior in the absence of this element. |
<DefaultSegmentName> |
Optional element:Defines what segment name to select by default in the coverage drop-down box when the Segment screen is loaded. |
|
Required Element value:SegmentNameSpecified Segment name will be set as default in the Coverage drop-down box. Note: If this element is not present then the first alphabetical segment will be selected. When an invalid segment is specified or the specified valid segment is not valid for the plan the first alphabetical segment will be selected. |
<Table> |
Required element:See Table Element |
|
|
<DisableSegmentFields> |
Optional element:Used to disable segment and role fields for the specified policy status.
|
|
|
<DisabledPolicyStatus> |
Required element:Defines policy status codes for the segment fields and role fields on the
Segment screen that should be disabled.
|
|
Required Element value:
|
<StateApproval> |
Optional element:Defines a section in the rule to control state approval filtering. |
|
|
<SegmentNames> |
Required element:Defines a section to identify segments that are controlled by state approval filtering. |
|
|
<SegmentName>
|
Required and Repeatable: Indicates a segment that is participating in state approval filtering. |
|
Required Element value:
|
|
APPROVALDATE |
Required Attribute: Identifies a fixed or dynamic policy field with a data type of DATE. This value is compared to the state approval's effective date and expiration date. |
XML Example
<SegmentScreen>
<DefaultSegment>No</DefaultSegment>
<DefaultSegmentName>Base Coverage</DefaultSegmentName>
<StateApproval>
<SegmentNames>
<SegmentName APPROVALDATE=”PlanDate”>BaseCoverage</SegmentName>
<SegmentName APPROVALDATE=”PlanDate”>DisabilityWaiver</SegmentName>
</SegmentNames>
</StateApproval>
<Table>
<Column ALIGN="Left">
<Display>Issue Date</Display>
<Name>SegmentIssueDate</Name>
<Group>SegmentField</Group>
<DataType>Date</DataType>
</Column>
<Column ALIGN="Left">
<Display>Type</Display>
<Name>SegmentName</Name>
<Group>SegmentName</Group>
<DataType>Text</DataType>
</Column>
<Column ALIGN="Left">
<Display>Amount</Display>
<Name>SegmentAmount</Name>
<Group>SegmentField</Group>
<DataType>Money</DataType>
</Column>
<Column ALIGN="Left">
<Display>Maturity Date</Display>
<Name>SegmentMaturityDate</Name>
<Group>SegmentField</Group>
<DataType>Date</DataType>
</Column>
<Column ALIGN="Left">
<Display>Status</Display>
<Name>SegmentActiveCode</Name>
<Group>SegmentField</Group>
<DataType>Text</DataType>
</Column>
</Table>
<DisableSegmentFields>
<DisabledPolicyStatus>01,09,10,21,05,29</DisabledPolicyStatus>
</DisableSegmentFields>
</SegmentScreen>
XML Schema
<SegmentScreen>
<DefaultSegment>[Yes|No]</DefaultSegment>
<Table ORDERBY="[Fields from SegmentName business rule | System defined Fields]">
<Column ALIGN="[LEFT|RIGHT]">
<Display>[String]</Display>
<Name>[String]</Name>
</Column>
</Table>
<DisableSegmentFields>
<DisabledPolicyStatus>[StatusCode]</DisabledPolicyStatus>
</DisableSegmentFields>
</SegmentScreen>