RoleScreen

This business rule allows for the configuration of the Role screen and defines the dynamic fields that can be displayed and updated on the specified Role Detail(s) screens.  The plan selected during the policy entry process dictates which role options are visible and available on the Role screen. 

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

<RoleScreen>

 

The opening and closing tag for the business rule.

 
<Filter>   Restrict access to clients for certain security groups based in client related data.  
<DisplayRoleFields>   Will control whether role codes will be displayed as drop down list or checkboxes.

Yes: the role codes will be listed in a drop down box. The role details for the role selected will be displayed above the ‘Add’ button.

No: this is the default behavior. The role codes will be displayed as checkboxes. The role details will not be displayed for the role selected.

Note: In order for the Role screen to validate data, this element must have a value of Yes.

<Role>

  

Required/Repeatable Element:  

Parent element that has sub- elements to hold required information or have available information for a specific role that is defined separately by this tag.

  

ROLECODE

 Required Attribute: 

The role code (as defined in AsCodeRole) that is to receive the definition described within the parent element.

The type of role the client added depends on the value of the ROLECODE attribute. The MathVariable must contain a valid RoleCode from AsCode=>AsCodeRole table.

RoleCode

String: A code value from AsCode.

NAME

Provides a user-friendly description of the role affected by this definition.

  

<SuccessorOnDelete>

 

Optional element:  

This element allows the system to replace one role with another upon deletion of the original role. This is the role with which the original role should be replaced, upon its deletion.

Note: The original role's RoleCode is specified in the <Role> tag. If the new role does not exist, then the user is warned with the same.

Required element value:  
RoleCode

DELETEOLDROLE

  

Yes: Delete old role.

No: Keep old role.

IGNOREONSTATUS

Optional Attribute:

Indicates the case statuses where the role will not be replaced.

StatusCodes   

The status codes are defined by the AsCodeStatus table.

<Ordinal>

 

Optional element:  

This element allows roles to be displayed in a specific order, according to the ordinal value.

Note: Each role must have a unique ordinal value, and all ordinal values must be non-negative integers.

Integer  

Roles without an ordinal value are listed alphabetically by role description, with a secondary order that is alphabetical by client name.

<Fields>

 

Allows configuration of dynamic fields. See Fields Elements.

 

<Events>

 

 Allows configuration of events on the Role screen. Although the Events element is widely used in configuration, the configuration explained here is specific to the RoleScreen rule. See the Action/Events page for an explanation of the elements and attributes generally available for Event configuration.

 
TYPE Defines the type of event that should occur.

ONSUBMIT: Creates a Save button on the Role screen for existing roles. This button is used when updating role information.

ONCLICK: The event will take place upon the user clicking the button. This value is used with BUTTON="Add" and BUTTON="Delete".
BUTTON Defines the type of button that will display on the Role screen.

Add: Creates an Add button, which will add a new role to the policy.

Delete: Creates a Delete button, which will delete an existing role from the policy.

<ScreenMath>

   See ScreenMath Element.  

<Actions>

  

See Action/Events.

 

<RoleViews>

 

Optional:    

Opening tag for role view configuration.

 The absence of RoleViews configuration results in the display of a default view (defined as Client Name, Role, Status, Tax ID and Percent Box). This default view applies to each role for which the optional RoleView has not been configured.

<DisplayStatus>

 

Optional:   

Configures the status filter for the views.

If <DisplayStatus> is absent from the configuration, only active roles are included.

  

<Status>

 

Required if DisplayStatus is configured, Repeatable:   

Identifies the role status(es) that may be displayed for the view.

Single role status code (no comma-delimited lists). Role statuses allowed (AsCodeRoleStatus code): Active (01), Inactive (98), and Deleted (99).

<View>

 

Optional, Repeatable:    

Opening tag for view configuration.

 
NAME  

Required Attribute (if View element is configured):

The name of each View element.

<Roles>

 

Required (if Views are configured):

Optional and Repeatable: Defines the roles that are included in the view.

 
ALLROLES Optional:   

Specifies that a view contains all policy level roles.Do not specify <Role> element if ALLROLES is specified.

Yes|No   

The default value is No.

<Role>

 

Required, Repeatable:

Defines the role(s) that are included in the view. Do not specify <Role> element if ALLROLES is specified.

Single role code (no comma-delimited lists).

<Table>

 

Optional:   

Common column definition to define the columns for the view. See Tables.

 Available Groups are: Role, RoleField, Client, ClientField, Policy, and PolicyField.

XML Schema

<RoleScreen> 

<Role ROLECODE="[CodeString]"> 
<Ordinal>[integer]</Ordinal>
<Fields> </Fields>
<SuccessorOnDelete DELETETOLDROLE="[Yes|No]" IGNOREONSTATUS="[StatusCode]">[RoleCode]</SuccessorOnDelete> 

</Role> 

<RoleViews>
<DisplayStatus>
<Status>[role status code]</Status>
</DisplayStatus>
<View NAME="[name of the view]">
<Roles ALLROLES="Yes|No">
<Role>[role code]</Role>
</Roles>
<Table>[common column definition]</Table>
</View>
</RoleViews>
</RoleScreen>

XML Example

<RoleScreen>
<DisplayRoleFields>Yes</DisplayRoleFields>
<Role ROLECODE=”13”>
<Ordinal>1</Ordinal>
</Role>
<RoleViews>
<DisplayStatus>
<Status>98</Status>
</DisplayStatus>
<View NAME="Beneficiaries">
<Roles ALLROLES="No">
<Role>01</Role>
</Roles>
</View>
</RoleViews>
</RoleScreen>