diff --git a/docs/system-admin-guide/users-permissions/users/README.md b/docs/system-admin-guide/users-permissions/users/README.md index 72414a19f3..d11a06d4fb 100644 --- a/docs/system-admin-guide/users-permissions/users/README.md +++ b/docs/system-admin-guide/users-permissions/users/README.md @@ -13,7 +13,7 @@ The user list provides an overview of all users in OpenProject. You can create n
**User** is defined as a person (described by an identifier) who uses OpenProject. Users can become project members by assigning them a role and adding them via the project settings.
-To manage users click on your avatar (top right corner) and select *Administration*. Select *Users and permissions -> Users*. The list of current users is shown. +To manage users click on your avatar (top right corner) and select **Administration**. Select ***Users and permissions -> Users**. The list of current users is shown. In the Community edition there is no limit to the number of users. In Enterprise editions (cloud and on-premises) the user limit is based on your subscription. The number of users for your subscription is thus not bound to names. For example, if you block a user you can add a new one without upgrading. @@ -108,33 +108,33 @@ In the top right, click the **Send invitation** button in order to send the emai ### Delete user invitations To invalidate or revoke a user's invitation click on the user name and then on **Delete** in the upper right corner. This will prevent the invited user from logging in. -Please note: This only works for users who haven't logged in yet. If the user is already active this will delete his/her whole profile and account. Deleting users can't be easily revoked. +Please note: this only works for users who haven't logged in yet. If the user is already active this will delete his/her whole profile and account. Deleting users can't be revoked. ## Manage user settings -You can manage individual user details if you click on the user name in the list. These settings will overwrite the individual user's settings set in their My Account settings. +You can manage individual user details if you click on the user name in the list. These settings will overwrite the individual user's settings set in their **My Account** settings. ### General settings -On the General tab the following fields are shown: +![administration-user-settings-manage-user](User settings general tab.png) + +On the **General** tab the following fields are shown: 1. User's master date - **Status** - this is set by the system. - **Username** - this defaults to the email address for a new user (unless the user used the self registration). It can be changed on this page. Users cannot change their own user name. - - **First name**, **Last name**, **Email** - these fields are filled from the New user page. Users can change them on their Profile page; they are mandatory. - - **Language** - this defaults from the [user settings](../settings/#default-preferences). Users can change this on their Profile page. + - **First name**, **Last name**, **Email** - these fields are filled from the **New user** page. Users can change them under their **Profile** page; they are mandatory. + - **Language** - this defaults from the [user settings](../settings/#default-preferences). Users can change this on their **Profile** page. - **Administrator** - activate or deactivate this global role. Users cannot change this. - - **Custom Fields** - if these have been created they are shown here. Use it for e.g. department or phone number. -2. **User consent** - if this has been [configured](../settings/#user-consent) (i.e. if the box next to "Consent required" is ticked) the consent status is shown here. + - **Custom Fields** - if these have been created they are shown here. Use it for e.g. department or phone number. If not, this is how [custom fields](../../custom-fields/) can be created. + - **User consent** - if this has been [configured](../settings/#user-consent) (i.e. if the box next to "Consent required" is ticked) the consent status is shown here. 3. **Authentication** - the content of this section depends on the type of [authentication method](#authentication) being used (e.g. password, OpenID, Kerberos, etc.) -4. **Preferences** - users can change these on their Profile page. Time zone defaults from chosen language. "Auto-hide success notifications" means that notifications will automatically be removed after some seconds, not that there are no success notifications at all. +4. **Preferences** - users can change these on their **Profile** page. Time zone defaults from chosen language. **Auto-hide success notifications** means that notifications will automatically be removed after some seconds, not that there are no success notifications at all. 5. Do not forget to **Save** your changes. -![administration-user-settings-manage-user](User settings general tab.png) - #### Reset a user's password -To create a new password for a user (e.g. if he/she lost it) navigate to the **Authentication** section of the **General** tab. You can either **Aassign a random password**(check the box on top) or set a new password manually and send it to them (preferably through secured communication). Consider checking the box next to **Enforce password change on next login**. +To create a new password for a user (e.g. if he/she lost it) navigate to the **Authentication** section of the **General** tab. You can either **Assign a random password**(check the box on top) or set a new password manually and send it to them (preferably through secured communication). Consider checking the box next to **Enforce password change on next login**. ![reset-user-password](Authentication.png) @@ -144,7 +144,7 @@ In order to see and work in a project, a user has to be a member of a project an On the **Projects** tab, select the new project from the drop-down list, choose the [**roles**](../roles-permissions) for this project and click the blue **Add** button. -![Sys-admin-add-project](Sys-admin-add-project.gif) +![Sys-admin-add-project](Sys-admin-add-project1.gif) ### Add users to groups @@ -156,7 +156,7 @@ If no groups are shown (i.e. the user does not belong to any group, yet), click ![manage-groups](Manage groups.png) -**Please note**: The Groups tab is only shown if at least one user group exists in OpenProject. +**Please note**: The **Groups** tab is only shown if at least one user group exists in OpenProject. ### Global roles @@ -176,9 +176,9 @@ Under **Email reminders** tab you can edit the [email reminders settings](../../ ### Rate history -The rate history tab shows the hourly rates that have been defined for the user. The "Default rate" is applied to projects with no rate defined. All projects that the user is a member of are listed with the user's rates. +The rate history tab shows the hourly rates that have been defined for the user. The **Default rate** is applied to projects with no rate defined. All projects that the user is a member of are listed with the user's rates. -The "Valid from" date will effect the rate used when creating a [budget](../../../user-guide/budgets/) and when [logging time](../../../user-guide/time-and-costs/time-tracking/). +The **Valid from** date will effect the rate used when creating a [budget](../../../user-guide/budgets/) and when [logging time](../../../user-guide/time-and-costs/time-tracking/). If you want to set a different hourly rate for the user on different projects, you can overwrite the default rate with a different rate below in the respective projects. @@ -204,7 +204,7 @@ This tab shows whether a user has activated a device for two-factor authenticati ## Authentication -The available authentication methods affect the content of the Authentication section in the General tab of the user details. +The available authentication methods affect the content of the **Authentication** section in the **General** tab of the user details. Use the **self-registration** field to give the following controls over a new user's access. @@ -212,9 +212,9 @@ Use the **self-registration** field to give the following controls over a new us The user details Authentication section has fields **Assign random password**, **Password**, **Confirmation** and **Enforce password change**. -* If you are near the new user, you can enter a password and confirmation then tell the user what it is. They can then sign in. It is recommended that you also tick the enforce password change tickbox, so that the user is prompted to change their password after they sign in. -* You can phone the new user or send them an email, not using OpenProject, to give them the password. In this case it is more important to tick the enforce password change tickbox. -* Tick the Assign random password, and probably the enforce password change tickbox. When the details are saved OpenProject will send an email to the new user with their password. +* If you are near the new user, you can enter a password and confirmation then tell the user what it is. They can then sign in. It is recommended that you also tick the enforce password change checkbox, so that the user is prompted to change their password after they sign in. +* You can phone the new user or send them an email, not using OpenProject, to give them the password. In this case it is more important to tick the enforce password change checkbox. +* Tick the Assign random password, and probably the enforce password change checkbox. When the details are saved OpenProject will send an email to the new user with their password. ### Account activation by email @@ -223,15 +223,15 @@ Leave all fields blank. When the details are saved OpenProject will send an emai ## Delete users Two [settings](../settings/#user-deletion/) allow users to be deleted from the system: -* **User accounts deletable by admins** - if ticked, a "Delete" button is shown on the user details page. -* **Users allowed to delete their accounts** - if ticked, a "Delete account" menu entry is shown in the "My Account" page. +* **User accounts deletable by admins** - if ticked, a **Delete** button is shown on the user details page. +* **Users allowed to delete their accounts** - if ticked, a **Delete account** menu entry is shown in the **My Account** page. To delete another user's account open the [user list](#user-list). Click on the **user name** of the user which you want to delete. Click the **Delete** button at the top right. -![Sys-admin-delete-user](Sys-admin-delete-user.png) +![Sys-admin-delete-user](openproject_system_guide_delete_user.png) You will then be asked to type in the username in order to delete the user permanently from the system, then confirm this with your password. -![delete user](image-20200115162533470.png) +![delete user](delete-user-confirmation.png) -> **Note**: Deleting a user account is a permanent action and cannot be reversed. The previous activities from this user will still be displayed in the system but reassigned to "Deleted user". This is also true for the Time and cost and the Budget modules. Spent time will be still be visible for "Deleted user" inside a Work package. Time and cost reports will contain the entries with reference to "Deleted user". Labor budgets that have been setup for the user are displayed under "Deleted user", too. If you would like to keep track of the user's name in connection with the mentioned activities, the spent time and the budget, you are able to keep the user's name in the historical data by simply [locking the user](#lock-and-unlock-users). +> **Note**: Deleting a user account is a permanent action and cannot be reversed. The previous activities from this user will still be displayed in the system but reassigned to **Deleted user**. This is also true for the Time and cost and the Budget modules. Spent time will be still be visible for **Deleted user** inside a Work package. Time and cost reports will contain the entries with reference to **Deleted user**. Labor budgets that have been setup for the user are displayed under **Deleted user**, too. If you would like to keep track of the user's name in connection with the mentioned activities, the spent time and the budget, you are able to keep the user's name in the historical data by simply [locking the user](#lock-and-unlock-users). diff --git a/docs/system-admin-guide/users-permissions/users/Rate-history-change.png b/docs/system-admin-guide/users-permissions/users/Rate-history-change.png deleted file mode 100644 index 454fc2cb96..0000000000 Binary files a/docs/system-admin-guide/users-permissions/users/Rate-history-change.png and /dev/null differ diff --git a/docs/system-admin-guide/users-permissions/users/Sys-admin-add-project.gif b/docs/system-admin-guide/users-permissions/users/Sys-admin-add-project.gif deleted file mode 100644 index 4f9251a673..0000000000 Binary files a/docs/system-admin-guide/users-permissions/users/Sys-admin-add-project.gif and /dev/null differ diff --git a/docs/system-admin-guide/users-permissions/users/Sys-admin-add-project1.gif b/docs/system-admin-guide/users-permissions/users/Sys-admin-add-project1.gif new file mode 100644 index 0000000000..0303557614 Binary files /dev/null and b/docs/system-admin-guide/users-permissions/users/Sys-admin-add-project1.gif differ diff --git a/docs/system-admin-guide/users-permissions/users/Sys-admin-delete-user.png b/docs/system-admin-guide/users-permissions/users/Sys-admin-delete-user.png deleted file mode 100644 index 75d7bd8c4e..0000000000 Binary files a/docs/system-admin-guide/users-permissions/users/Sys-admin-delete-user.png and /dev/null differ diff --git a/docs/system-admin-guide/users-permissions/users/Sys-admin-resend-invitation.png b/docs/system-admin-guide/users-permissions/users/Sys-admin-resend-invitation.png deleted file mode 100644 index 2fba1c3b88..0000000000 Binary files a/docs/system-admin-guide/users-permissions/users/Sys-admin-resend-invitation.png and /dev/null differ diff --git a/docs/system-admin-guide/users-permissions/users/System-admin-guide_lock-users.png b/docs/system-admin-guide/users-permissions/users/System-admin-guide_lock-users.png deleted file mode 100644 index c88d04a8a5..0000000000 Binary files a/docs/system-admin-guide/users-permissions/users/System-admin-guide_lock-users.png and /dev/null differ diff --git a/docs/system-admin-guide/users-permissions/users/User settings general tab.png b/docs/system-admin-guide/users-permissions/users/User settings general tab.png index 709aec4c86..1506d5b3d1 100644 Binary files a/docs/system-admin-guide/users-permissions/users/User settings general tab.png and b/docs/system-admin-guide/users-permissions/users/User settings general tab.png differ diff --git a/docs/system-admin-guide/users-permissions/users/activate user from the list.png b/docs/system-admin-guide/users-permissions/users/activate user from the list.png index 9555942dd4..cadec7a92b 100644 Binary files a/docs/system-admin-guide/users-permissions/users/activate user from the list.png and b/docs/system-admin-guide/users-permissions/users/activate user from the list.png differ diff --git a/docs/system-admin-guide/users-permissions/users/activate user.png b/docs/system-admin-guide/users-permissions/users/activate user.png index 4f4af92b47..a7e1e1f64d 100644 Binary files a/docs/system-admin-guide/users-permissions/users/activate user.png and b/docs/system-admin-guide/users-permissions/users/activate user.png differ diff --git a/docs/system-admin-guide/users-permissions/users/delete-user-confirmation.png b/docs/system-admin-guide/users-permissions/users/delete-user-confirmation.png new file mode 100644 index 0000000000..eb8a19c7b5 Binary files /dev/null and b/docs/system-admin-guide/users-permissions/users/delete-user-confirmation.png differ diff --git a/docs/system-admin-guide/users-permissions/users/image-20200115162533470.png b/docs/system-admin-guide/users-permissions/users/image-20200115162533470.png deleted file mode 100644 index 298153cce9..0000000000 Binary files a/docs/system-admin-guide/users-permissions/users/image-20200115162533470.png and /dev/null differ diff --git a/docs/system-admin-guide/users-permissions/users/openproject_system_guide_create_user.png b/docs/system-admin-guide/users-permissions/users/openproject_system_guide_create_user.png index 8efe7a1f26..01f3486f46 100644 Binary files a/docs/system-admin-guide/users-permissions/users/openproject_system_guide_create_user.png and b/docs/system-admin-guide/users-permissions/users/openproject_system_guide_create_user.png differ diff --git a/docs/system-admin-guide/users-permissions/users/openproject_system_guide_delete_user.png b/docs/system-admin-guide/users-permissions/users/openproject_system_guide_delete_user.png new file mode 100644 index 0000000000..d8cf5275ee Binary files /dev/null and b/docs/system-admin-guide/users-permissions/users/openproject_system_guide_delete_user.png differ