diff --git a/docs/getting_started/dashboard/dashboard_block_reference.md b/docs/getting_started/dashboard/dashboard_block_reference.md index d1e63625..6da3806f 100644 --- a/docs/getting_started/dashboard/dashboard_block_reference.md +++ b/docs/getting_started/dashboard/dashboard_block_reference.md @@ -111,11 +111,19 @@ On the **Design** tab, in the **View** field, select the layout to be used to pr ## Recent activity block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] -Displays a list of recent activity of all or selected users. -It also includes a link to view all activities available in Admin tab. +Displays recent activity of all or selected users, and for selected object classes. Lists the following details: + +- action time +- user reference (avatar, first and last name) with a link to the user profile (if available) +- activity type with context + +It also includes a link to view all activities in the Admin tab of the Back Office. + +!!! note + + For the [recent activity](recent_activity.md) log to be displayed, your [user role](permission_system.md) must have the **Activity Log / Read** permission. + -Recent activity block contains the following data: action time, User reference (avatar, first and last name) with a link to the user profile (if available), -Activity type with the context. On the **Properties** tab, set values in the following fields: diff --git a/docs/getting_started/discover_ui.md b/docs/getting_started/discover_ui.md index 9159fa49..dd6696cf 100644 --- a/docs/getting_started/discover_ui.md +++ b/docs/getting_started/discover_ui.md @@ -14,7 +14,7 @@ Depending on your location within the Back Office, it can contain the following - Global search field that allows you to [find content](../search/search_for_content.md) by checking all searchable Fields - Drop-down that changes the site context - Notification icon that informs you about incoming assignments, for example, items assigned for [your review](../content_management/workflow_management/editorial_workflow.md#review-queue) -- User avatar with a drop-down menu with access to [user profile and settings](get_started.md#edit-user-profile) +- User avatar with a drop-down menu with access to [user profile and settings](get_started.md#view-and-edit-user-profile) !!! note "Site context" diff --git a/docs/getting_started/get_started.md b/docs/getting_started/get_started.md index 8e9f0ccc..99213003 100644 --- a/docs/getting_started/get_started.md +++ b/docs/getting_started/get_started.md @@ -35,34 +35,47 @@ Otherwise, to login, you must get your user credentials from the administrator a ![Login screen](img/login_form.png "Login screen") -### Edit user profile +### View and edit user profile -You can edit your profile and modify the following data: +If you are an editor, depending of the system configuration, you may be able to view and edit the user profile, which can contain the following information: -- Avatar image -- First and last name -- Signature +- Email - Department +- Position +- Location +- Signature +- Roles the user is assigned to +- Recent activity !!! note - The fields may differ depending on your system configuration. -1\. To modify profile, in the upper-right corner, click the avatar icon. + For the [recent activity](recent_activity.md) log to be displayed, your [user role](../permission_management/permissions_and_users.md) must have the **Activity Log / Read** permission. + +![User profile](img/user_profile_preview.png "User profile") + +To access the user profile, in the upper-right corner of the screen, click the avatar icon. +Then, from the drop-down menu, select **Profile**. -2\.From the drop-down menu, select **Profile**. +To edit the user profile, in the User profile screen, the **Summary** section, click **Edit**. -3\. In the User profile screen, in the **Summary** section, click **Edit**. +You can now modify the following entries: -4\. Go to **Image** and click **Upload file** or drag and drop your photo. -If necessary, you can edit the foto with the Image Editor. +- Avatar image +- First and last name +- Signature +- Department + +To edit your avatar, in the **Image** area, click **Upload file** or drag and drop your photo. +If necessary, you can edit the photo with the Image Editor. +After you finish, the avatar is uploaded and is visible in the Back Office. ![Edit avatar](img/user_profile_avatar.png "Edit avatar") -5\. Now your avatar photo has been uploaded and is visible in the Back Office. +!!! note -6\. To save changes, click **Update**. + If you don't set your own image, a default avatar with your initials is displayed. -If you don't set your own image, a default avatar with your initials is displayed. +To save changes to the user profile, click **Update**. ### Change the password and other user settings diff --git a/docs/getting_started/img/user_profile_preview.png b/docs/getting_started/img/user_profile_preview.png new file mode 100644 index 00000000..93842e35 Binary files /dev/null and b/docs/getting_started/img/user_profile_preview.png differ diff --git a/docs/permission_management/permissions_and_users.md b/docs/permission_management/permissions_and_users.md index 637e0382..103db048 100644 --- a/docs/permission_management/permissions_and_users.md +++ b/docs/permission_management/permissions_and_users.md @@ -10,4 +10,5 @@ With the permission system of [[= product_name =]] you can control which users h "permission_management/permission_system", "permission_management/work_with_permissions", "user_management/manage_users", + "recent_activity/recent_activity" ], columns=4) =]] diff --git a/docs/recent_activity/recent_activity.md b/docs/recent_activity/recent_activity.md index 01a069d8..f4d08e74 100644 --- a/docs/recent_activity/recent_activity.md +++ b/docs/recent_activity/recent_activity.md @@ -1,19 +1,29 @@ --- -description: Monitor recent activity logged actions. +description: Monitor recently logged user actions. +edition: experience --- -# Recent activity log [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] +# Review recent user activity -## Activity list +[[= product_name =]] logs various operations on the repository and in the application. +If you have administrator permissions and your [user role](permission_system.md) has the **Activity Log / Read** permission, you can review the most recent activity log in the Back Office, the Admin tab. -In the Back Office, **Admin** -> **Activity list**, you can see a list of recent activity of all or selected users. +Depending on the system configuration, activity logs may also be shown: + +- on the Dashboard, the [Recent activity block](dashboard_block_reference.md#recent-activity-block) +- within the [user profile](../getting_started/get_started.md#view-and-edit-user-profile) !!! note - To see the **Admin** menu, you need the **Setup / Administrate** [permission](permission_system.md). - To see the Activity list, you need the **Activity Log / Read** permission (this permission can be limited to allow seeing your own activity only). + By default, log entries are kept for 30 days. + This time can be modified through configuration. + For more information, see [developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#configuration-and-cronjob). + +## View user activity in Back Office -By default, the following actions are displayed: +In the Back Office, go to **Admin** -> **Activity list**, to see recent activity of all or selected users. + +The following actions are displayed: - [Content](content_items.md) create, create draft, publish, update, trash, recover, delete, delete translation, hide, and reveal - [Location](manage_locations_urls.md#content-locations) create, delete, hide, reveal, update, move, swap, and subtree copy @@ -21,50 +31,24 @@ By default, the following actions are displayed: - [Product variant](work_with_product_variants.md) create, update, and delete - [Site](work_with_sites.md) create, update, and delete -By default, log entries are kept 30 days. - Log entries are grouped by logical bonds like web requests, events, batches, or sessions. -![Activity list](img/4.6_activity_list.png) +![Activity list](img/4.6_activity_list.png "Activity list") !!! note - With some development, some other actions could be logged, see [custom log entry developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#adding-custom-activity-log-entries) - - The log entries' life time can be shorten or extended through configuration, see [configuration developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#configuration-and-cronjob) - -### Filter activities - -You can filter the activities to: - -* follow the activity of selected users or user group, -* narrow the results to selected item types, or actions. - -To do it, on the right side, in the **Filters** menu, choose selected filters, and click the **Apply** button. -Click the **Clear** button to reset all the filters. - -The following example shows, how to narrow the results by selecting **Action** and **Time** filters. -With these settings, activity list displays only `Publish` actions from `Last week` time period. - -![Published last week](img/filters.png) - -## Recent activity dashboard block [[% include 'snippets/experience_badge.md' %]] [[% include 'snippets/commerce_badge.md' %]] - -You can add a [**Recent activity** block](dashboard_block_reference.md#recent-activity-block) to your [dashboard](dashboard.md). -To be able to customize a dashboard, you need the **Dashboard / Customize** permission. -To be able to see the content of this block, you need the **Activity Log / Read** permission. - -!["Recent activity" block](img/recent_activity_block.png) + If your implementation requires that other actions are logged, see [custom log entry developer documentation]([[= developer_doc =]]/administration/recent_activity/recent_activity/#adding-custom-activity-log-entries). -You can set the block to display only activities of selected users, or concerning particular object classes. +### Filter activity -For example, the following dashboard block focuses on Content and Location activity. +You can filter the actions to: -!["Content recent activity" block settings](img/recent_activity_block_settings.png) +* follow the activity of a selected user or user group +* narrow down the results to selected item types or actions -## User profile +To do it, in the **Filters** area, select filters of your choice, and click **Apply**. +Click **Clear** to reset all the filters. -User profile displays recent activity of the user. -To be able to see recent activity log, you need the **Activity Log / Read** permission. +For example, you can narrow down the results by selecting the **Action** and **Time** filters, so that the activity list displays actions only of the `Publish` type from `Last week`. -![Recent activity in the user profile](img/recent_activity_user_profile.png) +![Published last week filter set](img/filters.png "Published last week filter set") \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 01c8b4ff..59212b83 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -114,7 +114,7 @@ nav: - Permission system: permission_management/permission_system.md - Work with permissions: permission_management/work_with_permissions.md - Manage users: user_management/manage_users.md - - Recent activity: recent_activity/recent_activity.md + - Review recent activity: recent_activity/recent_activity.md - User paths: - Explorer: persona_paths/explorer.md - Administrator: