ClientRoleScreen

The ClientRoleScreen

ClientRoleScreen Elements and Attributes
Element/Tag Attribute Definition Element/Attribute Value and Description

<ClientRoleScreen>

 

The opening and Closing element

 

<Filter>   Restrict access to policies for certain security groups based on policy related data.  

<PolicyRole>

 

Optional element:

This element controls the display of Policy and Segment Roles.

 

 

SHOW

Required Attribute:

Specifies whether or not to display the PolicyRole tab.

Yes | No

<Table>

 

Optional element:   

Controls the display of results. This tag allows configuring the columns in a table.

If this element is not specified, the default columns are displayed:
  • Policy Number
  • Policy Name
  • Plan Name
  • Segment Name
  • Role

<Column>

 

Optional, repeatable element:   

 

  WIDTH

Optional Attribute:   

Defines the column width of the table and the number of characters that can be displayed in the specified column

Number
  ALIGN

Optional Attribute: 

Defines the data alignment of the column.

Text  

LEFT,RIGHT, CENTER

<Name>

 

Exact name of the field (database name).

Text:

<Display>

 

Provides the column header label.

Text:

<Group>

 

Indicates the table/screen that stores the field being referenced.

Text:

Plan
PlanField
Policy
PolicyField
Segment
SegmentField
Role
RoleField

<DataType>

 

Defines the data type of the field.

 

<ApplicationRole>  

Optional element:

This element controls the display of Application Roles tab.

 
  SHOW

Required Attribute:

Specifies whether or not to display the Application Roles tab.

Yes | No
<Table>  

Optional element:   

Controls the display of results. This tag allows configuring the columns in a table.

If this element is not specified, the default columns are displayed:
  • Policy Number
  • Policy Name
  • Plan Name
  • Segment Name
  • Role
<Column>   Optional, repeatable element:  
  WIDTH

Optional Attribute:   

Defines the column width of the table and the number of characters that can be displayed in the specified column

NUMBER
  ALIGN Optional Attribute: 

Defines the data alignment of the column.

Text  

LEFT,RIGHT, CENTER

<Name>   Exact name of the field (database name). Text:
<Display>   Provides the column header label. Text:
<Group>   Indicates the table/screen that stores the field being referenced. Text:

Plan, PlanField, Policy PolicyField, Segment, SegmentField, Role, RoleField

<Datatype>   Defines the data type of the field.  

<AgreementRole>

 

Optional element:

The element controls the display of Agreement Roles.

 

 

SHOW

Required Attribute:   

Specifies whether or not to display the AgreementRole tab

Yes | No

<Table>

 

Optional element:   

Controls the display of results. This tag allows configuring the columns in a table.

If this element is not specified, the default columns are displayed:
  • Group Customer Name
  • Agreement Name
  • Role

<Column>

 

Optional, repeatable element:  

 

  WIDTH

Optional Attribute:   

Defines the column width of the table and the number of characters that can be displayed in the specified column

Number
  ALIGN

Optional Attribute: 

Defines the data alignment of the column.

Text  

LEFT,RIGHT, CENTER

<Name>

 

Exact name of the field (database name). Fixed and Dynamic Fields

Text:

<Display>

 

Provides the column header label.

Text:

<Group>

 

Indicates the table/screen that stores the field being referenced.

Text:

AgreementRole
AgreementRoleField
Agreement
AgreementField
GroupCustomer
GroupCustomerField

<DataType>

 

Defines the Datatype of the field.  

<ClassMemberRole>

 

Optional element:

The element controls the display of Class Membership Roles.

 

 

SHOW

Required Attribute:   

Specifies whether or not to display the ClassMemberRole tab

Yes | No

<Table>

 

Optional element:   

Controls the display of results. This tag allows configuring the columns in a table.

If this element is not specified, the default columns are displayed:
  • Group Customer Name
  • Class Group Name
  • Class Group Description
  • Class Group Type

<Column>

 

Optional, repeatable element:  

 

  WIDTH

Optional Attribute:   

Defines the column width of the table and the number of characters that can be displayed in the specified column

Number
  ALIGN

Optional Attribute: 

Defines the data alignment of the column.

Text  

LEFT,RIGHT, CENTER

<Name>

 

Exact name of the field (database name). In the case of Class membership ONLY fixed fields are available

Text:

<Display>

 

Provides the column header label.

Text:

<Group>

 

Indicates the table/screen that stores the field being referenced. Supported Groups:

Text:

ClassMembership
Class
ClassField
ClassGroup
ClassGroupField
GroupCustomer
GroupCustomerField

<DataType>

 

Defines the Datatype of the field.  

XML Example

<ClientRoleScreen>
<PolicyRole SHOW="Yes">
<Table>
<Column WIDTH="150" ALIGN="LEFT">
<Name>PolicyNumber</Name>
<Display>Policy Number</Display>
<Group>Policy</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>PolicyName</Name>
<Display>Policy Name</Display>
<Group>Policy</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>SegmentName</Name>
<Display>Segment Name</Display>
<Group>Segment</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>Role</Name>
<Display>Role Name</Display>
<Group>Role</Group>
<DataType>Text</DataType>
</Column>
</Table>
</PolicyRole>
<ApplicationRole SHOW="Yes">
<Table>
<Column WIDTH="150" ALIGN="LEFT">
<Name>PolicyNumber</Name>
<Display>Policy Number</Display>
<Group>Policy</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>PolicyName</Name>
<Display>Policy Name</Display>
<Group>Policy</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>SegmentName</Name>
<Display>Segment Name</Display>
<Group>Segment</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>RoleCode</Name>
<Display>Role Name</Display>
<Group>Role</Group>
<DataType>Text</DataType>
</Column>
</Table>
</ApplicationRole>
<AgreementRole SHOW="Yes">
<Table>
<Column WIDTH="150" ALIGN="LEFT">
<Name>AgreementName</Name>
<Display>Agreement Name</Display>
<Group>Agreement</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Name>TypeCode</Name>
<Display>Agreement Type</Display>
<Group>Agreement</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Display>Agreement Number</Display>
<Name>Agreement Number</Name>
<Group>AgreementField</Group>
<DataType>Text</DataType>
</Column>
</Table>
</AgreementRole>
<ClassMemberRole SHOW="Yes">
<Table>
<Column WIDTH="150" ALIGN="LEFT">
<Name>ClassName</Name>
<Display>Class  Name</Display>
<Group>Class</Group>
<DataType>Text</DataType>
</Column>
<Column WIDTH="100" ALIGN="LEFT">
<Display>Effective Date</Display>
<Name>EffectiveFrom</Name>
<Group>ClassMembership</Group>
<DataType>Date</DataType>
</Column>
</Table>
</ClassMemberRole>
</ClientRoleScreen>