Manage Users and Groups: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(305347)
No edit summary
 
(89 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The User Manager dialog is used to create, edit, and delete users and user groups and manage user roles. In addition, you can access the User Rights Report and Operation Log.
The Manage Users dialog is used to create and modify users and groups, and manage roles and permissions. Only users with ''[[Roles_and_Permissions#Global_and_Project_Roles|ManageUsers]]'' permission can use the Manage Users dialog. This page contains information how to use the User Management dialog. For more information how permissions work in conceptual level, please read [[Roles and Permissions]].


== Viewing and Editing User Properties ==
User can be ''active'' or ''inactive''. Inactive users are not allowed to login and thus use their assigned permissions. Users can be inactivated both temporary or permanently to prevent them from login into the system. When using the built-in authentication, user not using the system anymore, need to be inactivated (as users cannot be deleted). When using the federated authentication, it's not necessary to inactivate users, because those users are anyways not able to login through the external authentication.
As a non-administrator user, you can view and edit only your own user properties.
#Select the user name from the list and click the '''Properties''' button.
#In the User Properties dialog that opens, you can change the User Name, E-Mail address, Password, and Description.
#To apply the changes, click '''OK'''.


To join a group, click '''Join''', input the '''Group Member Join-In Token''', and click '''OK'''.
The dialog shows which users have a password defined. If user has a password, the user can authenticate via the built-in authentication method. If the SAML authentication is configured, users can also authenticate via it without a password in the QPR ProcessAnalyzer user management. If users are meant to authenticate only using the SAML, it's strongly recommended to remove the password from the user management to prevent the built-in authentication method.


== Viewing the User Rights Report ==
All changes made in the Manage Users dialog are effective immediately. The bottom of the screen shows either ''Saving'' when saving is currently in progress and, ''Saved'' when saving changes is completed. Note that when making changes to your own roles or groups, in order for them to take effect, you should relogin to the system.
As a non-administrator user, you can view only your own User Rights Report.


The User Rights Report can be opened by clicking the '''Report''' button. A sheet containing the User Rights is created. Additionally, you can select the '''Show Permissions''' check box to have the sheet display the Permission IDs and Permission Names. The report can be filtered, so you can quickly list users, for example according to their Roles.
'''Effective permissions''' show the actual permissions that users have when using the system. The effective permissions are calculated from permissions that are in the groups of the user and also permissions that are assigned directly to the user.


== Creating User ==
# In the '''Manage Users''' dialog, open the '''Users''' tab, and click '''Add user'''.
# Fill in '''Login name''' and optionally '''Full name''' and '''Email'''. Note that each user in the system must have a different login name.
# Click the '''Add user''' button.


'''Depending on the role, the following actions are available.'''
== Editing User Information ==
# In the '''Manage Users''' dialog, open the '''Users''' tab.
# Select a user from the table and click the '''Edit''' button (or double-click the user in the table).
# Change the user information and click the '''Save''' button.


== Creating a User or a User Group ==
== Setting User Password ==
#In the left side of the dialog, select either '''Users''' or '''Groups''' according to which one you want to create.
# In the '''Manage Users''' dialog, open the '''Users''' tab.
#Click the '''Create''' button and define the properties in the dialog that opens.
# Select a user from the left-side table and click '''Change password'''.
#Close the creation dialog by clicking '''OK'''.
# Define a password for the user and confirm the password.
# Click the '''Change Password''' button.


Note that creating a User Group requires that the creator has the Administrator, Model Creator, or Evaluator role for the <All> Model level.
== Removing User Password ==
# In the '''Manage Users''' dialog, open the '''Users''' tab.
# Select a user (or several users) from the left-side table and click '''Remove password'''.
# Click the '''Remove''' button in the confirmation dialog.


When creating a new User Group or viewing the properties of a User Group, you can create a '''Join-In Token''' for a regular group member or a hidden group member. By clicking '''Join''' in the User Properties dialog and inputting the token there, the user can join the group for which the token was made.
It's recommended to remove password from users that switch to use the SAML authentication, and thus don't need to authenticate using the built-in method.


== Assigning a User to a User Group ==
== Editing User Description ==
#Select the user from the list on the left side of the dialog.
# In the '''Manage Users''' dialog, open the '''Users''' tab.
#In the right side of the dialog, select '''Group Memberships'''.
# Select a user from the table and click '''Edit description'''.
#Select the group from the '''Group''' drop-down menu.
# Change the user description and click the '''Save''' button.
#Click '''Add'''.


== Assigning a User Role to a User or a User Group ==
== Creating Groups ==
#Select the user or the user group from the list on the left side of the dialog.
# In the '''Manage Users''' dialog, open the '''Groups''' tab, and click '''Add group'''.
#Select the specific model to which you want to assign the role from the '''Model''' drop-down list. Selecting "<All>" will apply the role to all models available.
# Fill in '''Group name''' and optionally '''Email'''. Note that each group in the system must have a different name.
#Select the Role from the '''Role''' drop-down list.
# Click the '''Add group''' button.
#Click '''Add'''.


== Editing Group Information ==
# In the '''Manage Users''' dialog, open the '''Groups''' tab.
# Select a group from the table and click the '''Edit''' button (or double-click the group in the table).
# Change the group information and click the '''Save''' button.


=== User Roles and Rights: <All> ===
== Editing Group Description ==
{| style="color:black; cellpadding="10" class="wikitable"
# In the '''Manage Users''' dialog, open the '''Groups''' tab.
!Role||Rights
# Select a group from the table and click '''Edit description'''.
|-
# Change the group description and click the '''Save''' button.
|Administrator  ||
*rights to do everything, for example to create users and assign user roles.
|-
|Model Creator  ||
*can create new models, to which the user gets the model Administrator role
|-
|Evaluator  || 
*has rights to create simple models and administrate them. There's a 10 model limit, each containing a maximum of 1000 events.
|}


== Adding Specific User to Groups ==
# In the '''Manage Users''' dialog, open the '''Users''' tab.
# Select a user from the left-side table.
# In the '''User belongs to groups''' table, click the '''Add to group''' button.
# Select a group and '''Membership type''', and click the '''Save''' button.


=== User Roles and Rights for Individual Models ===
Notes:
{| style="color:black; cellpadding="10" class="wikitable"
* You can edit an existing memberships by selecting it from the table and clicking the '''Edit''' button.
!Role||Rights
* You can delete an existing memberships by selecting it from the table and clicking the '''Delete''' button.
|-
* You can cancel the editing by clicking the '''Cancel'' button.
|Administrator  ||
* The ''Membership type'' is usually ''Member'' (other membership types are for legacy use cases).
*rights to do everything, for example to assign user roles for the model.
* Note that a user can be added to a group only once.
|-
|Analyzer  ||
*can analyze the model, i.e. create views, but can't load new events, case attributes, or other new data.
|-
|Designer  ||
*can analyze the model and upload new data, but can't grant or modify user or group access rights
|-
|Viewer  ||
*can view model contents, but can't use filtering, i.e. can't create new views
|}


== Adding Users to Specific Group ==
# In the '''Manage Users''' dialog, open the ''Groups'' tab.
# Select a group from the left-side table.
# In the '''Group contains users''' table, click the '''Add user to group''' button.
# Select a user and '''Membership type''', and click the '''Save''' button.


=== User Group Roles and Rights ===
See also notes in the [[#Adding Specific User to Groups|Adding Specific User to Groups]] section.
{| style="color:black; cellpadding="10" class="wikitable"
!Role||Rights
|-
|Administrator  ||
*add and remove group members
*create new users to the group
*add and remove model specific access rights for the group or any individual user
*open any model accessible to the group members
*see all group members (including hidden members)
|-
|Member  ||
*add and remove model specific access rights for the group or for any individual member of any model for which the member is a model administrator
*open any model accessible to the group members
*see all group members and group administrators belonging to the group (excluding hidden members)
|-
|Hidden Member  ||
*open any model that is accessible to the group members
|}


== Removing a User Role from a User or a User Group ==
== Assigning Project-Level Roles to Users and Groups ==
#Select the user or the user group from the list on the left side of the dialog.
# In the ''Manage Users'' dialog, open the ''Users'' tab (or '''Groups''' tab if assigning permissions to a group).
#Select the model from the right side of the dialog.
# Select a user/group from the left-side table.
#Click '''Remove'''.
# In the '''Project roles of user/group''' table, click the '''Assign role for project''' button.
# Select a project and '''Role''', and click the '''Save''' button.
 
Notes:
* You can edit an existing role assignment by selecting it from the table and clicking the '''Edit''' button.
* You can delete an existing role assignment by selecting it from the table and clicking the '''Delete''' button.
* You can cancel the role assignment editing by clicking the '''Cancel'' button.
* User can have several roles for a project.
 
== Assigning Global Roles to Users and Groups ==
# In the ''Manage Users'' dialog, open the ''Users'' tab (or '''Groups''' tab if assigning permissions to a group).
# Select a user/group from the left-side table.
# In the '''Global roles of user/group''' section, check/uncheck one of the global role checkboxes. Changes are saved.
 
== Inactivating Users ==
# In the '''Manage Users''' dialog, open the '''Users''' tab.
# Select one or several users to be inactivated from the left-side table, and click the '''Inactivate users''' button.
# In the confirmation dialog, click the '''Inactivate''' button.
 
In QPR ProcessAnalyzer users cannot be removed (to preserve the audit data). Instead if user is not using the system anymore, the user account needs to be inactivated. Inactive users cannot login to the system.
 
Note that inactive users information cannot be changed - the user needs to be activated first.
 
== Activating Users ==
# In the '''Manage Users''' dialog, open the '''Inactive users''' tab.
# Select one or several users to be activated from the table, and click the '''Activate users''' button.
# In the confirmation dialog, click the '''Activate''' button.
 
== Checking User or Project Effective Permissions ==
# In the '''Manage Users''' dialog, open the '''Effective permissions''' tab.
# Select either a project from the '''Project''' list or a user from the '''User''' list.
# Table is showing the effective permissions for the selected project or user.
 
When showing effective permissions for a project, the effective permissions table shows all users that have any permissions to the project. The checkboxes are showing the individual [[Roles_and_Permissions#Global_and_Project_Roles|permissions]] for each user. When showing effective permissions for a user, the effective permissions table shows all projects where the user has any permissions. The checkboxes are showing the individual [[Roles_and_Permissions#Global_and_Project_Roles|permissions]] for each project.
 
[[Category: QPR ProcessAnalyzer]]

Latest revision as of 15:30, 10 February 2024

The Manage Users dialog is used to create and modify users and groups, and manage roles and permissions. Only users with ManageUsers permission can use the Manage Users dialog. This page contains information how to use the User Management dialog. For more information how permissions work in conceptual level, please read Roles and Permissions.

User can be active or inactive. Inactive users are not allowed to login and thus use their assigned permissions. Users can be inactivated both temporary or permanently to prevent them from login into the system. When using the built-in authentication, user not using the system anymore, need to be inactivated (as users cannot be deleted). When using the federated authentication, it's not necessary to inactivate users, because those users are anyways not able to login through the external authentication.

The dialog shows which users have a password defined. If user has a password, the user can authenticate via the built-in authentication method. If the SAML authentication is configured, users can also authenticate via it without a password in the QPR ProcessAnalyzer user management. If users are meant to authenticate only using the SAML, it's strongly recommended to remove the password from the user management to prevent the built-in authentication method.

All changes made in the Manage Users dialog are effective immediately. The bottom of the screen shows either Saving when saving is currently in progress and, Saved when saving changes is completed. Note that when making changes to your own roles or groups, in order for them to take effect, you should relogin to the system.

Effective permissions show the actual permissions that users have when using the system. The effective permissions are calculated from permissions that are in the groups of the user and also permissions that are assigned directly to the user.

Creating User

  1. In the Manage Users dialog, open the Users tab, and click Add user.
  2. Fill in Login name and optionally Full name and Email. Note that each user in the system must have a different login name.
  3. Click the Add user button.

Editing User Information

  1. In the Manage Users dialog, open the Users tab.
  2. Select a user from the table and click the Edit button (or double-click the user in the table).
  3. Change the user information and click the Save button.

Setting User Password

  1. In the Manage Users dialog, open the Users tab.
  2. Select a user from the left-side table and click Change password.
  3. Define a password for the user and confirm the password.
  4. Click the Change Password button.

Removing User Password

  1. In the Manage Users dialog, open the Users tab.
  2. Select a user (or several users) from the left-side table and click Remove password.
  3. Click the Remove button in the confirmation dialog.

It's recommended to remove password from users that switch to use the SAML authentication, and thus don't need to authenticate using the built-in method.

Editing User Description

  1. In the Manage Users dialog, open the Users tab.
  2. Select a user from the table and click Edit description.
  3. Change the user description and click the Save button.

Creating Groups

  1. In the Manage Users dialog, open the Groups tab, and click Add group.
  2. Fill in Group name and optionally Email. Note that each group in the system must have a different name.
  3. Click the Add group button.

Editing Group Information

  1. In the Manage Users dialog, open the Groups tab.
  2. Select a group from the table and click the Edit button (or double-click the group in the table).
  3. Change the group information and click the Save button.

Editing Group Description

  1. In the Manage Users dialog, open the Groups tab.
  2. Select a group from the table and click Edit description.
  3. Change the group description and click the Save button.

Adding Specific User to Groups

  1. In the Manage Users dialog, open the Users tab.
  2. Select a user from the left-side table.
  3. In the User belongs to groups table, click the Add to group button.
  4. Select a group and Membership type, and click the Save button.

Notes:

  • You can edit an existing memberships by selecting it from the table and clicking the Edit button.
  • You can delete an existing memberships by selecting it from the table and clicking the Delete button.
  • You can cancel the editing by clicking the 'Cancel button.
  • The Membership type is usually Member (other membership types are for legacy use cases).
  • Note that a user can be added to a group only once.

Adding Users to Specific Group

  1. In the Manage Users dialog, open the Groups tab.
  2. Select a group from the left-side table.
  3. In the Group contains users table, click the Add user to group button.
  4. Select a user and Membership type, and click the Save button.

See also notes in the Adding Specific User to Groups section.

Assigning Project-Level Roles to Users and Groups

  1. In the Manage Users dialog, open the Users tab (or Groups tab if assigning permissions to a group).
  2. Select a user/group from the left-side table.
  3. In the Project roles of user/group table, click the Assign role for project button.
  4. Select a project and Role, and click the Save button.

Notes:

  • You can edit an existing role assignment by selecting it from the table and clicking the Edit button.
  • You can delete an existing role assignment by selecting it from the table and clicking the Delete button.
  • You can cancel the role assignment editing by clicking the 'Cancel button.
  • User can have several roles for a project.

Assigning Global Roles to Users and Groups

  1. In the Manage Users dialog, open the Users tab (or Groups tab if assigning permissions to a group).
  2. Select a user/group from the left-side table.
  3. In the Global roles of user/group section, check/uncheck one of the global role checkboxes. Changes are saved.

Inactivating Users

  1. In the Manage Users dialog, open the Users tab.
  2. Select one or several users to be inactivated from the left-side table, and click the Inactivate users button.
  3. In the confirmation dialog, click the Inactivate button.

In QPR ProcessAnalyzer users cannot be removed (to preserve the audit data). Instead if user is not using the system anymore, the user account needs to be inactivated. Inactive users cannot login to the system.

Note that inactive users information cannot be changed - the user needs to be activated first.

Activating Users

  1. In the Manage Users dialog, open the Inactive users tab.
  2. Select one or several users to be activated from the table, and click the Activate users button.
  3. In the confirmation dialog, click the Activate button.

Checking User or Project Effective Permissions

  1. In the Manage Users dialog, open the Effective permissions tab.
  2. Select either a project from the Project list or a user from the User list.
  3. Table is showing the effective permissions for the selected project or user.

When showing effective permissions for a project, the effective permissions table shows all users that have any permissions to the project. The checkboxes are showing the individual permissions for each user. When showing effective permissions for a user, the effective permissions table shows all projects where the user has any permissions. The checkboxes are showing the individual permissions for each project.

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=Manage_Users_and_Groups&oldid=24319"