User Manager Widget

<< Click to Display Table of Contents >>

Navigation:  Enterprise > Widgets >

User Manager Widget

Widget Properties

 

The User Manager widget is located on the Administration dashboard. Administrators may use the User Manager widget to view, modify, or create users. This widget is only available to administrators. Even if a non-administrator is granted permission to use this widget, the widget will be empty/blank for non-administrators.

 

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

 

Ent-User_Manager_Widget-Sample

 

The User Manager widget displays a grid that lists users in the system (aka the ST_USER table) and contains attributes of the user. The widget has the following six columns:

User Icon Ent-User-Icon – The icon used to indicate a user. This column is for display purposes only and may not be changed. The same icon is used regardless of status.

User Name – The name of the user. This value must be unique (within the ST_USER table) and is immutable (may not be changed). Click the user name to open the User Profile Editor window for that user.

 

Note: Whenever a user is assigned to the Admin role, double asterisks (**) will appear after the username in the User Name Column. Do not add double asterisks when creating a username.

 

First Name – The user's first name. This value is optional.

Last Name – The user's last name. This value is optional.

Email Address – The email address of the user. The email address must be unique (within the ST_USER table). Click on the email address to use a "mailto:" link to send an email to the user.

StatusThis indicates the status of the user.

A – Active user assigned to at least one role based license. User can login and use the application (based on applicable permissions).

B – Pending review. Users that have registered and are pending approval and activation.

R – Inactive users and not part of any licensed role. These users may not login and are unable to use the application.

 

Note: Only use the 'Disable' function in the User Profile Editor for a user if you plan on not re-activating them. If you plan on reactivating a user, EarthSoft strongly recommends to remove the user from a license role and NOT disable them.  

 

The grid columns of the User 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 users, enter a search term (one or more characters) in the appropriate search box beneath the column header. Only users that contain the search term will be displayed.

 

The grid header contains the following items:

New User – Click the New User Ent-New_Role_Button-Icon button to create a new user. The button opens the User Profile Editor window to enter attributes of the user.

 

The bottom of the grid contains paging controls for displaying a limited number of users 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 users to be displayed per page by using the drop-down menu.

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

 

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

 

Widget Properties

 

The User 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 User 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.