DocView Capture
The audit log is DocView Capture's full audit trail. It records who did what and when: sign-ins, changes to users and permissions, changes to Batch Setups and settings, and actions on batches. It also records every change to a field value, with the old value, the new value, the user and the time.
Audit entries are append-only. Nobody can edit them from the application. Old entries are removed only by the retention setting (see below).
Go to Administration › Audit log. You need the permission Admin.Audit. The built-in Administrator and Supervisor roles have it.
What each entry shows
| Column | Meaning |
|---|---|
| Time | When it happened, in your local time. |
| User | Who did it. REST API clients show as api: followed by the key name. |
| Action | What happened, for example FieldValueChanged or UserUpdated. |
| Entity | The kind of thing that changed and its identifier. |
| Field | The field name, for field value changes. |
| Old value / New value | The value before and after the change. |
| IP | The address the request came from. |
Secret values are never written to the audit log. When a secret or an internal setting changes, the entry only says that it changed.
Filter the log
The filter bar is at the top of the page.
- Fill in any of these boxes:
- User: part of a user name;
- Action: pick one action from the list, or (all);
- Batch id: the id of a batch, to see everything that happened to it;
- From and To: whole days (the To day is included);
- Text: text in the old value, the new value or the entity id.
- Click Filter.
The Action list only offers actions that exist in your log.
Tip: To see every change made to one batch, copy the batch id from the batch's details in the Batch Manager and paste it into Batch id.
Useful actions
| Action | Recorded when |
|---|---|
SignedIn |
A user signs in (password or Windows). |
UserCreated, UserUpdated |
A user is added or changed, including role changes and password resets. |
RoleCreated, PermissionsChanged |
A role is added or the permission grid is saved. |
GroupMappingAdded, GroupMappingDeleted |
A Windows group mapping changes. |
IpRuleSaved, IpRuleDeleted |
An IP access rule changes. |
SessionEnded, SessionsEnded |
An administrator ends a session, or signs a user out everywhere. |
SettingChanged |
A system setting changes. |
SecretSet, SecretDeleted |
A secret is saved or deleted (never the value). |
ApiKeyCreated, ApiKeyRevoked |
A REST API key is created or revoked. |
BatchClassPublished, BatchClassUpdated, WorkflowChanged |
A Batch Setup is released or changed. |
FieldValueChanged |
A field value is changed and saved. |
DocumentReclassified, DocumentSplit, DocumentsMerged |
Operators change documents. |
PageDeleted, PageRotated, PageMoved |
Operators change pages. |
BatchDeleted |
A batch is deleted. |
WorkerProfileSaved, WorkerProfileDeleted |
A worker profile changes. |
AuditLogExported, TableExported |
Someone downloads the audit log or another list. |
The full list depends on what your users do. Use the Action filter to see every action recorded so far.
Page through long results
The log shows the newest entries first, 100 to a page. Below the table you see which entries are shown out of the total that match the filter (for example "1–100 of 5,340"), the page numbers, and how many entries a page shows (25, 50, 100 or 200). The filter stays as you move between pages. The header row stays at the top of the window while you scroll.
The Filter rows box above the table narrows the rows of the page shown, as you type. To search the whole log, use the filter bar at the top instead.
Export to Excel or CSV
- Set the filter for the entries you need.
- Click Export above the table.
- Choose Excel (.xlsx) or CSV.
The export contains every entry that matches the filter, not just the rows loaded on screen, up to 200,000 entries. It has these columns: Time, User, Action, Entity type, Entity, Batch, Document, Field, Old value, New value and IP address.
Each export is itself recorded in the audit log as AuditLogExported, with the number of entries, the format and the filter used. This shows auditors who took a copy of the log.
Tip: For a monthly compliance report, filter by From and To for the month, export to Excel, and store the file with your records.
How long entries are kept
Entries older than Audit log retention (days) are deleted automatically. The default is 730 days (two years). Set it to 0 to keep everything. The setting is on the Settings page.
Sign-in history and ended sessions on the Security page follow the same period.
Important: Set the retention to match your legal and compliance rules before you go live. On SQL Server Express the database is limited to 10 GB, so export and archive old entries if you must keep them for many years.