IBX-6717: Recent activity

docs/administration/recent_activity/activity_log_search.md

@@ -0,0 +1,20 @@
+---
+description: Activity Log Search
+page_type: reference
+---
+
+# Activity Log Search reference
+
+Activity Log Search Criteria and Sort Clauses are used to build `Ibexa\Contracts\ActivityLog\Values\ActivityLog\Query` for `ActivityLogService::find`.
+
+## Activity Log Search Criteria reference
+
+TODO: List and describe criteria from Ibexa\Contracts\ActivityLog\Values\ActivityLog\Criterion\ namespace
+
+### Value Criterion
+
+### Logical Criterion
+
+## Activity Log Search Sort Clauses reference
+
+TODO: List and describe Sort Clauses from Ibexa\Contracts\ActivityLog\Values\ActivityLog\SortClause\ namespace

docs/administration/recent_activity/recent_activity.md

@@ -0,0 +1,68 @@
+---
+description: Log and monitor activity through UI, PHP API and REST API.
+---
+
+# Recent activity
+
+Recent activity log summaries last actions on the repository (whatever their origin, such as Back Office, REST, migration, CLI, or CRON).
+
+To learn more about its Back Office usage and the actions logged by default, see [Recent activity in the User documentation]([[= user_doc =]]/recent_activity/recent_activity/).
+
+## Configuration and cronjob
+
+* The parameter `ibexa.site_access.config.<scope>.activity_log.pagination.activity_logs_limit` set the number of log items shown per page in the Back Office (default: 25 items per page). (A log item is a group of entries, or an entry without group.)
+* The configuration `ibexa.repositories.<repository>.activity_log.truncate_after_days` set the number of days a log entry is kept before being deleted by the `ibexa:activity-log:truncate` command (default: 30 days).
+
+For example, the following set 20 log groups per page for the `admin` SiteAccess, and 15 days of life to the log entries on the `default` repository:
+
+```yaml
+parameters:
+    ibexa.site_access.config.admin.activity_log.pagination.activity_logs_limit: 20
+ibexa:
+    repositories:
+        default:
+            activity_log:
+                truncate_after_days: 15
+```
+
+To automate a regular truncation, the command `ibexa:activity-log:truncate` must be added to a crontab.
+To minimize the number of entries to delete, it's recommended to execute the command more than one time a day.
+
+For every exact hour, the cronjob line is:
+`0 * * * * cd [path-to-ibexa]; php bin/console ibexa:activity-log:truncate --quiet --env=prod`
+
+## Permission and security
+
+The "Activity Log / Read" policy ([`activity_log/read`](policies.md#activity-log)) gives a role the access to
+the "Admin > Activity list", the dashboard's "Recent activity" block, and the user profile's "Recent activity".
+It can be limited to "Only own log".
+
+The "Activity Log / Read" policy should be given to every roles having access to the Back Office,
+at least with the "Only own log" owner limitation,
+to allow them to use the "Recent activity" block in the default dashboard or their custom dashboard.
+This policy is also required by user having a profile to properly view their own.
+
+!!! caution
+
+    Never give `activity_log/read` permission to Anonymous role, even with the owner limitation,
+    as this role is shared among all unauthenticated users.
+
+## PHP API
+
+The ActivityLogService PHP API can be used to browse activity logs and write new entries.
+
+### Searching in the Activity Log entries
+
+TODO: Quick example of …\ActivityLog\Query passed to ActivityLogService(Interface)::find and loop through the returned ActivityList(Interface)
+
+See [Activity Log Search Criteria reference](activity_log_search.md) to discover query possibilities.
+
+### Adding custom Activity Log entries
+
+Your custom features could write into the activity log.
+
+TODO: Illustrate the use of ActivityLogService(Interface)::build & ActivityLogService(Interface)::save
+
+## REST API
+
+REST API can be used to browse activity logs, see in the [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#monitoring-activity).

docs/permissions/limitation_reference.md

@@ -35,6 +35,14 @@ Out of the box FunctionList uses it in the following way:
             - {name: ibexa.permissions.limitation_type, alias: FunctionList}
 ```
 
+## ActivityLogOwner Limitation
+
+The `ActivityLogOwner` Limitation specifies if a user can see only own [recent activity](recent_activity.md) log entries, and not entries from other users. 
+
+| Value | UI value        | Description                                            |
+|-------|-----------------|--------------------------------------------------------|
+| `1`   | "Only own logs" | Current user can only access own activity log entries. |
+
 ## CartOwner Limitation
 
 The `CartOwner` Limitation specifies whether the user can modify a cart.

docs/permissions/policies.md

@@ -24,6 +24,12 @@ which define, which parts of the application or website the user has access to.
 
 ### Administration and user management
 
+#### Activity log
+
+| Module                       | Function           | Effect                  | Possible Limitations                                                    |
+|------------------------------|--------------------|-------------------------|-------------------------------------------------------------------------|
+| <nobr>`activity_log`</nobr> | <nobr>`read`</nobr> | access to activity list | [ActivityLogOwner](limitation_reference.md#activitylogowner-limitation) |
+
 #### Customer groups
 
 | Module                        | Function              | Effect                  | Possible Limitations |

mkdocs.yml

@@ -141,6 +141,9 @@ nav:
             - Multi-file upload: administration/back_office/multifile_upload.md
             - Sub-items list: administration/back_office/subitems_list.md
             - Notifications: administration/back_office/notifications.md
+        - Recent activity:
+            - Recent activity: administration/recent_activity/recent_activity.md
+            - Activity Log search reference: administration/recent_activity/activity_log_search.md
     - Content management:
         - Content management: content_management/content_management.md
         - Content management guide: content_management/content_management_guide.md