Role Manager Widget

<< Click to Display Table of Contents >>

Navigation:  Enterprise > Widgets >

Role Manager Widget

Widget Properties


The Role Manager widget is located on the Administration dashboard. Administrators may use this widget to view, modify, or create application roles.


Note: EarthSoft strongly recommends that the Role Manager widget not be added to any other dashboard apart from the Administration dashboard as it may cause permission issues.


Enterprise 7 introduces license-based roles. The license role appears at the top of the list in the Role Manager widget. New users are created with the STATUS_FLAG set to 'R'. When assigned to the licensed role, the user's STATUS_FLAG is set to 'A' and will consume an EQuIS Enterprise License upon logging in. When removed from the licensed role, the user's STATUS_FLAG is set to 'R' and the EQuIS Enterprise License will be released. Administrators cannot add more users to the licensed role than the number of licenses.


After redeploying on a licensed database, a new role is created for the EQuIS Enterprise license that lists the license type and count. Each active user who was consuming a license is added to the created role. Administrator users can see a menu when viewing other users' User Profiles and can disable other users by clicking the Disable option in the menu. After being disabled, the user's STATUS_FLAG is set to 'D' and the user no longer appears in the User Manager and cannot login to EQuIS Enterprise. Users cannot disable themselves.




The Role Manager widget displays a grid that lists roles in the system (aka the ST_ROLE table) and contains attributes of the role. The widget has the following five columns:

Role Icon – This column is for display purposes only and may not be changed. The column indicates a role Ent-Role-Icon, a licensed role Ent-License_Role-Icon, or an ALS (application-level security) role Ent-Role_ALS_Icon.

Name – Displays the name of the role. This value must be unique (within the ST_ROLE table). Click the role name to open the Role Profile Editor window for that role.

Assigned – Indicates the number of users assigned to the corresponding role.

Allowed – Indicates the maximum number of users allowed to be assigned to this role. This is particularly useful for license roles.

Available – Indicates the availability to assign further users.


The grid columns of the Role Manager widget can be sorted or filtered based on these properties.

Sorting – The columns are sortable by clicking on the column header (click again to reverse the sort). Note that sorting does not change the current page, and the first or last values of the sorted column may not be displayed, unless on the first or last page of the list.

Filtering – To filter the roles, enter a search term (one or more characters) in the appropriate search box beneath the column header. Only roles that contain the search term (name, description) will be displayed.


The grid header contains the following items:

New Role – Click the New Role Ent-New_Role_Button-Icon icon to create a new role. The button opens the Role Profile Editor window to enter the attributes of the role, assign role members, etc.

Delete Role – Select a role. Once the role is highlighted, click the Delete Role Ent-Delete_Icon icon to delete the selected role.


The bottom of the grid contains paging controls for displaying a limited number of roles at a time, as described below.  

Arrows – Use the left/right arrows to navigate through pages.

Go to Page List – Select a specific page to navigate directly to that page.

Rows per Page – Change the number of roles to be displayed per page by using the drop-down menu.

Count of Pages and Total Items – This control indicates the total number of items available in the grid, how many pages to display the items, and which page is currently selected.


The paging controls are specific to the current search. For example, if there are 15 roles, but only four roles match the current search term, then the paging controls will apply only to the four matching roles.



Widget Properties


The Role Manager widget has no specific properties. To change the title or color of this widget, open the Widget Editor by selecting the More Options Ent-More_Options-Icon icon in the upper right corner of the widget to display the drop-down menu and then select the Edit menu option.

Widget Title – By default, the widget title is Role Manager. The title can be modified.

Widget Color – The color of the widget can be changed using the Widget ThemeEnt-Theme_Color_Iconicon to the left of the widget title.

Widget Object Editor – To set various appearance properties of the widget, select the Object Editor Ent-Widget-Editor_Properties icon in the widget header to open the Widget Object Editor. See the Widget Editor article for more details.

Help – The Help Ent-Help-Icon icon connects to the online documentation related to the specific widget.

Copy Settings – Select the Copy Settings Ent-Copy_Settings-Icon icon to to copy the settings from another widget of the same type. See the Copy Widget Settings article for more information.

Cancel – Select the Close without Saving Ent-Close_icon icon to exit the Widget Editor without saving changes.

Save – Changes will be applied to the widget by clicking on the Save Ent-Widget_Save-Icon icon. The Widget Editor screen will close after the save operation is complete.