- Print
- PDF
Introduction
This module allows you to search and view audit logs for different event types. Use search filters to define the parameters for the audits you want to view.
Warning
It is possible to leave all fields empty to view every audit record in the system; however, this is not recommended because an extremely large number of records will be returned.
With large result sets, we recommend limiting your search to a smaller timeframe.
Audit Filters
You can filter as many or as few parameters as necessary to return relevant results.
Choose from the following options:
Audit events: Click the drop-down menu and select the audit event you want to search. Click the drop-down menu again to select more events. Click the small cross to clear individual events or the larger cross to clear all events from the field.
Note
You can search for multiple events.
Event presets: Select a preset from the drop-down menu. These are groups of audit events – selecting an option will populate the audit events field for you.
Start date: Select a date and time at the start of the period during which you want to search.
End date: Select a date and time at the end of the period during which you want to search.
Document ID: Type a Document ID to filter the results to activity on a particular document.
User: Select a user from the drop-down menu to filter the results by activity performed by that user.
Click the Search Audit Log button to start the search.
Note
The Results Panel will be shown with relevant audit events. The more results that are returned, the longer this will take.
Click the Reset button to clear all search parameters.
Remote Integrations
You can prepopulate audit filter fields by parsing data into the URL. The fields are still editable, and you must click the search button to run the search.
The following fields can be included in the URL:
Audit events
eventTypes=
Start date / End date
start=
end=
Note
The format is YYYY-MM-DDTHH:MM. You can specify seconds if required.
Document ID
documentId=
User
user=
Example
Construct the URL with optional data:
https://yourURL/dm/admin/audit-search?eventTypes=document-access,document-create&start=2023-03-31T16:40&end=2023-03-31T17:40:30&documentId=12345&user=admin
Results Panel
The results are organized into a table with one row for each event.
The same columns are always shown to display the most relevant data, with additional columns shown when relevant data is present.
Note
Columns will be blank if they are not applicable to a particular result.
Page Controls
These buttons facilitate the navigation of results. The current page is shown next to the buttons.
The options are:
First page
Previous page
Next page
Note
Due to the fast-moving nature of audit records, there is no 'Last Page' functionality because many audit records could have been added to the system in the time since the search was run.
Items per page
Select, from the drop-down menu, how many results you want to display on each page.
Export data
Click the Export data button to export the entire search (not just the results shown on the screen).
Note
For extremely large data sets, exporting data might take a few moments.
View Single Entry Data
Some entries contain more complex data, which is too large to display in the table.
Click the Copy button to copy the full data to the clipboard without viewing it.
Click the View button to show the full data in its raw form.
The data will be shown in a dialog from which you can select part of it or copy all of it to the clipboard.