Skip to main content
Version: 3.2

Audit

docuteam box records an audit trail of relevant user actions performed on repository objects. The trail is available to administrators and to users with the new @audit role for their namespace.

Access

The audit trail is reachable from the Admin dropdown, under the Audit entry. The entry is shown to:

  • administrators, who see audit events across all namespaces;
  • users with the role <namespace>@audit, who see only the events that belong to their namespace(s).

A user without either of these roles does not see the menu entry and cannot access the page.

Recorded events

For each tracked action, a record is stored with the following information:

FieldDescription
DateTimestamp at which the event was recorded.
User IDIdentifier of the user in Keycloak (preferred_username's underlying subject ID).
UsernameUsername of the user as displayed in the UI.
Event TypeType of action that was performed (see below).
NamespaceSubmission Agreement prefix the object belongs to. Used to scope visibility per @audit role.
PIDPID of the affected record resource. Links to the detail view of the record.
URIFedora resource URI of the affected object.

The following event types are recorded:

EventTriggered by
View recordOpening the detail view of a record resource.
Edit metadataSaving changes to a record resource's metadata.
Replace objectSuccessful execution of the replace file action for an instantiation.
Fixity checkSuccessful execution of a fixity check task on an object.
File downloadDownloading the original file, a DIP, EAD, PREMIS or related artefact for a record resource.

Background actions (replace file, fixity check, file download) write their audit entry only when the underlying task succeeds for the given object.

Filtering

The audit page provides a filter form to narrow down the list:

  • by User ID, Username, Event Type, Namespace, URI, PID;
  • by date range (From / To).

Multiple filters can be combined. The result is paginated; the page size can be changed at the bottom of the table.