ClientRoleScreen

The ClientRoleScreen supports four tabs "Policy Roles, Application Roles, Agreement Roles and Class Member Roles" and this rule defines the data presentation for each. Each tab presents a specific type of Role to which the Client is associated.

When data contains sensitive information that should be viewed by limited user roles, the Filter functionality can define the data to exclude by the user's security group.

ClientRoleScreen Elements and Attributes
Elements	Attributes	Parent Element	Description	Element/Attribute Value
<ClientRoleScreen>			Required: This is the opening element and matches the name of the business rule.
<Filter>		<ClientRoleScreen>	Optional: The filter structure expresses conditions upon which the entity's data will not be displayed to a user. The restrictions are based on the user's SecurityGroup membership and the entity's data values.
<Conditions>		<Filter>	Required, Repeatable: This structure defines one or more conditions for one or more sets of SecurityGroups. A set of SecurityGroups in one <Conditions> element shares the same conditional statements. This element is repeated for each combination of SecurityGroups and conditional statements needed to filter data from a user's view.
	SECURITYGROUP	<Conditions>	Required: The attribute provides a comma delimited list of Security Group names to associate with the conditional statements contained within this structure. When the user is a member of one of the listed Security Groups, the condition(s) are applied to the searched entity's resulting record data to determine removal from the results.	Comma delimited list of Security Groups
	TYPE	<Conditions>	Required: This attribute indicates when the conditions express an exclusion or inclusion of data from the presentation. The system currently supports exclusion only.	Exclusion The filter will remove the entity record from the screen's presentation when the conditions evaluate to true.
	OPERATOR		Optional: The <Conditions> element may contain multiple <Condition> elements as each represents a conditional statement. This attribute indicates the relationship between multiple <Condition> elements. All <Condition> elements apply the same OPERATOR value.	AND default All conditionals are connected by an AND relationship and all must evaluate to be true for the filter to impact the resulting presentation. OR All conditionals are connected by an OR relationship and any one evaluating to true will impact the resulting presentation.
<Condition>		<Conditions>	Required, Repeatable: The element provides a single condition referencing data from the database table provided by its associated ENTITY attribute. This element is repeated to provide multiple conditions with each referencing a different table name.	Conditional statement in the form of a SQL predicate
	ENTITY	<Condition>	Required: The attribute provides a database table name upon which the condition will apply.	ASAGREEMENT and ASAGREEMENTFIELD ASAGREEMENTROLE and ASAGREEMENTROLEFIELD ASCLASS and ASCLASSFIELD ASCLASSGROUP and ASCLASSGROUPFIELD ASCLIENT and ASCLIENTFIELD ASGROUPCUSTOMER and ASGROUPCUSTOMERFIELD ASPOLICY and ASPOLICYFIELD ASROLE and ASROLEFIELD ASSEGMENT and ASSEGMENTFIELD
	FIELDNAME	<Condition>	Optional: This attribute helps identify the Role or Client that the <Condition>'s value is tested against. This applies to Role, RoleField, Client and ClientField entities only.	RoleCode This is applicable for ASROLE and ASROLEFIELD entities. TypeCode This is applicable for ASCLIENT and ASCLIENTFIELD entities.
	VALUE	<Condition>	Optional: This attribute provides a Role's RoleCode or Client's TypeCode value.	code value If the entity is ASROLE or ASROLEFIELD the code value must be a value from AsCodeRole. If the entity is ASCLIENT or ASCLIENTFIELD the code value must be a value from AsCodeClientType.
<PolicyRole>		<ClientRoleScreen>	Optional: This element controls the display of the Policy Roles tab. This tab displays both Policy and Segment level Roles. Absence of this element prevents the Policy Roles tab from being displayed.
	SHOW	<PolicyRole>	Required: The attribute indicates presentation of the Policy Roles tab.	No default The Policy Roles tab will not display. Yes The Policy Roles tab will display.
<Table>		<PolicyRole>	Optional: The structure under this element defines Role data presentation in the form of a table. If this element is not configured for the Policy Roles "tab" the default columns are Policy Number, Policy Name, Plan Name, Segment Name, and Role.
<Column>		<Table>	Required, Repeatable: See "Common <Table> sub-structure description" below.	The values available for the <Group> element are: Plan and PlanField Policy and PolicyField Role and RoleField Segment and SegmentField
<ApplicationRole>		<ClientRoleScreen>	Optional: This element controls the display of the Application Roles tab. This tab displays both Application and Segment level Roles. Absence of this element prevents the Application Roles tab from being displayed.
	SHOW	<ApplicationRole>	Required: The attribute indicates presentation of the Application Roles tab.	No default The Application Roles tab will not display. Yes The Application Roles tab will display.
<Table>		<ApplicationRole>	Optional: The structure under this element defines Role data presentation in the form of a table. If this element is not configured for the Application Roles "tab" the default columns are Policy Number, Policy Name, Plan Name, Segment Name, and Role.
<Column>		<Table>	Required, Repeatable: See "Common <Table> sub-structure description" below.	The values available for the <Group> element are: Plan and PlanField Policy and PolicyField Role and RoleField Segment and SegmentField
<AgreementRole>		<ClientRoleScreen>	Optional: This element controls the display of the Agreement Roles tab. Absence of this element prevents the Agreement Roles tab from being displayed.
	SHOW	<AgreementRole>	Required: The attribute indicates presentation of the Agreement Roles tab.	No default The Agreement Roles tab will not display. Yes The Agreement Roles tab will display.
<Table>		<AgreementRole>	Optional: The structure under this element defines Role data presentation in the form of a table. If this element is not configured for the Agreement Roles "tab" the default columns are Group Customer Name, Agreement Name, and Role.
<Column>		<Table>	Required, Repeatable: See "Common <Table> sub-structure description" below.	The values available for the <Group> element are: Agreement and AgreementField AgreementRole and AgreementRoleField GroupCustomer and GroupCustomerField
<ClassMemberRole>		<ClientRoleScreen>	Optional: This element controls the display of the Class Membership Roles tab. Absence of this element prevents the Class Membership Roles tab from being displayed.
	SHOW	<ClassMemberRole>	Required: The attribute indicates presentation of the Agreement Roles tab.	No default The Class Membership Roles tab will not display. Yes The Class Membership Roles tab will display.
<Table>		<ApplicationRole>	Optional: The structure under this element defines Role data presentation in the form of a table. If this element is not configured for the Class Member Roles "tab" the default columns are Group Customer Name, Class Group Name, Class Group Description, and Class Group Type.
<Column>		<Table>	Required, Repeatable: See "Common <Table> sub-structure description" below.	The values available for the <Group> element are: Class and ClassField ClassGroup and ClassGroupField ClassMembership GroupCustomer and GroupCustomerField
Common <Table> sub-structure description
<Column>		<Table>	Required, Repeatable: This element defines one column of data to display in a Table format. It is repeated for each column to present in the Table.
	WIDTH	<Column>	Optional: This attribute defines the column's width in number of characters.	Integer Must be a positive value
	ALIGN	<Column>	Optional: This attribute defines the alignment of data in the column.	LEFT default Aligns data to the left side of the column. RIGHT Aligns data to the right side of the column. CENTER Aligns data in the center of the column.
<Name>		<Column>	Required: This element identifies the data column or dynamic field name in the source table providing data to the presentation. Only fixed fields are available from the ClassMembership database table.	literal Database column name or dynamic field name.
<Display>		<Column>	Required: This element provides the column header label. This label can be translated.	literal
<DataType>		<Column>	Required: This element defines the datatype of the data presented in the column.	Date Decimal Integer Money Percent Text
<Group>		<Column>	Required: This element provides the common name of the database table where the data has been stored. Each tab has a defined set of tables available to the tab.	literal List of literals are described by the <Table> element above in its appropriate "tab".

XML Schema

<ClientRoleScreen>
    <Filter>
        <Conditions SECURITYGROUP="[list]" TYPE="Exclusion" OPERATOR="[AND | OR]">
            <Condition ENTITY="[ASAGREEMENT | ASAGREEMENTFIELD | ASAGREEMENTROLE | ASAGREEMENTROLEFIELD | ASCLASS | ASCLASSFIELD | ASCLASSGROUP | ASCLASSGROUPFIELD | ASCLIENT | ASCLIENTFIELD | ASGROUPCUSTOMER | ASGROUPCUSTOMERFIELD | ASPOLICY | ASPOLICYFIELD | ASROLE | ASROLEFIELD | ASSEGMENT | ASSEGMENTFIELD]">[sql predicate]</Condition>
            <Condition ENTITY="[ASROLE | ASROLEFIELD]" FIELDNAME="RoleCode" VALUE="[role code]">[SQL predicate]</Condition>
            <Condition ENTITY="[ASCLIENT | ASCLIENTFIELD]" FIELDNAME="TypeCode" VALUE="[client typecode]">[SQL predicate]</Condition>
            <Condition>...</Condition>
        </Conditions>
        <Conditions>...</Conditions>
    </Filter>
    <PolicyRole SHOW="[No | Yes]">
        <Table>
            <Column WIDTH="[integer]" ALIGN="[LEFT | RIGHT | CENTER]">
                <Name>[column name | table name]</Name>
                <Display>[literal]</Display>
                <DataType>[Date | Decimal | Integer | Money | Percent | Text]</DataType>
                <Group>[Plan | PlanField | Policy | PolicyField | Role | RoleField | Segment | SegmentField]</Group>
            </Column>
            <Column>...</Column>
        </Table>
    </PolicyRole>
    <ApplicationRole SHOW="[No | Yes]">
        <Table>
            <Column WIDTH="[integer]" ALIGN="[LEFT | RIGHT | CENTER]">
                <Name>[column name | table name]</Name>
                <Display>[literal]</Display>
                <DataType>[Date | Decimal | Integer | Money | Percent | Text]</DataType>
                <Group>[Plan | PlanField | Policy | PolicyField | Role | RoleField | Segment | SegmentField]</Group>
            </Column>
            <Column>...</Column>
        </Table>
    </ApplicationRole>
    <AgreementRole SHOW="[No | Yes]">
        <Table>
            <Column WIDTH="[integer]" ALIGN="[LEFT | RIGHT | CENTER]">
                <Name>[column name | table name]</Name>
                <Display>[literal]</Display>
                <DataType>[Date | Decimal | Integer | Money | Percent | Text]</DataType>
                <Group>[Agreement | AgreementField | AgreementRole | AgreementRoleField | GroupCustomer | GroupCustomerField]</Group>
            </Column>
            <Column>...</Column>
        </Table>
            </AgreementRole>
    <ClassMemberRole SHOW="[No | Yes]">
        <Table>
            <Column WIDTH="[integer]" ALIGN="[LEFT | RIGHT | CENTER]">
                <Name>[column name | table name]</Name>
                <Display>[literal]</Display>
                <DataType>[Date | Decimal | Integer | Money | Percent | Text]</DataType>
                <Group>[Class | ClassField | ClassGroup | ClassGroupField | ClassMembership | GroupCustomer | GroupCustomerField]</Group>
            </Column>
            <Column>...</Column>
        </Table>
    </ClassMemberRole>
</ClientRoleScreen>

XML Example

<ClientRoleScreen>
    <PolicyRole SHOW="Yes">
        <Table>
            <Column>
                <Name>PolicyNumber</Name>
                <Display>Policy Number</Display>
                <Group>Policy</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>PolicyName</Name>
                <Display>Policy Name</Display>
                <Group>Policy</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>SegmentName</Name>
                <Display>Segment Name</Display>
                <Group>Segment</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>RoleCode</Name>
                <Display>Role Name</Display>
                <Group>Role</Group>
                <DataType>Text</DataType>
            </Column>
        </Table>
    </PolicyRole>
    <ApplicationRole SHOW="Yes">
        <Table>
            <Column>
                <Name>PolicyNumber</Name>
                <Display>Policy Number</Display>
                <Group>Policy</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>PolicyName</Name>
                <Display>Policy Name</Display>
                <Group>Policy</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>SegmentName</Name>
                <Display>Segment Name</Display>
                <Group>Segment</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>RoleCode</Name>
                <Display>Role Name</Display>
                <Group>Role</Group>
                <DataType>Text</DataType>
            </Column>
        </Table>
    </ApplicationRole>
    <AgreementRole SHOW="Yes">
        <Table>
            <Column>
                <Name>CompanyName</Name>
                <Display>Group Customer Name</Display>
                <Group>Client</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>AgreementName</Name>
                <Display>Agreement</Display>
                <Group>Agreement</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>TypeCode</Name>
                <Display>Agreement Role</Display>
                <Group>AgreementRole</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>AgreementNumber</Name>
                <Display>Agreement Number</Display>
                <Group>AgreementField</Group>
                <DataType>Text</DataType>
            </Column>
        </Table>
    </AgreementRole>
    <ClassMemberRole SHOW="Yes">
        <Table>
            <Column>
                <Name>CompanyName</Name>
                <Display>Group Customer Name</Display>
                <Group>Client</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>ClassGroupName</Name>
                <Display>Class Group Name</Display>
                <Group>ClassGroup</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>ClassName</Name>
                <Display>Class Name</Display>
                <Group>Class</Group>
                <DataType>Text</DataType>
            </Column>
            <Column>
                <Name>TypeCode</Name>
                <Display>Class Type</Display>
                <Group>Class</Group>
                <DataType>Text</DataType>
            </Column>
        </Table>
    </ClassMemberRole>
</ClientRoleScreen>