User Role Management

User Roles are used to control which portlets and data will be available for a given group users, as well as the actions one will be able to perform. Any changes can be applied once to a role, rather than having to apply them to each individual user.

To open User Role Management portlet, go to Menu > Admin > User Role Management.

All existent user roles are shown on grid ordered by Role name; the Size column indicates how many users have this role assigned. When tdsvisitor is first installed, two standard roles are created:

  • all - 'Administrator' type, has full access to the system;
  • default - automatically assigned if no other role is informed when registering a Username; 'Read Only' type, only has access to Quick Register page.

Permissions to default need to be set so users can view and select Hosts on Quick Register page; this can be done through Edit User Role wizard.

Add a new user role

1. On User Role Management portlet, click Add.

2. Add User Role wizard is shown. The data presented in each one of the steps depends on tdsvisitor install configuration.

3. On Step 1, fill out Name, a brief Description on what this role is designed to do (e.g. 'Access to all portlets') and its Type:

  • Read Only: can view portlets data, register Visits and check out Guests on Quick Register page.
  • Administrator: can view, add, edit and delete data from any portlets.

4. Click Next to proceed to the next step;

5. Select all the portlets you wish to give this user role access on Step 2;

6. Define the areas to which this role will have data access on Step 3; you can do so by selecting a Site/Location or a Cluster. The Add New User Role button can be used if necessary, opening the same add form as Cluster Management portlet (read more on Cluster Management section).

7. On Step 4, select the Person Types that users with this role should be able to see;

8. On Step 6, select the Departments which data will be available for this user role;

9. Once you are done setting your user role, click Finish to commit the inclusion.

Edit user role

1. Click the Edit icon on Action column;

2. Edit User Role wizard is shown with all data associated to this user role being retrieved.

3. Once you are done performing the changes, click Finish to update.

The Finish button is only enabled on Edit User Role wizard when some change in any of the steps is performed.

Clone user role

1. Click the Clone user role icon on Action column;

2. All menus and permissions will be copied; just fill out a Name and click Finish.

3. The new user role will be presented on grid.

Delete user role

1. Click the Bin icon on Action column.

If a user role is currently in use (i.e. associated to some Username), the delete icon will be greyed out.

2. A confirmation dialog will appear. Click Yes to confirm the operation, or No to abort it.

3. Once deleted, the role disappears from User Role Management portlet.