Audit Trail
This page documents the SureDrive Audit Trail — the searchable activity log that records all user actions across a SureDrive project. It covers the Angular route and controller, available filter parameters, CSV export, the signing audit trail sub-view, and the backend activity service.
Overview
The Audit Trail is accessed via the Project Dashboard overflow menu → Audit Trail. It presents a chronological log of all activities in the SureDrive: document uploads, downloads, metadata edits, workflow initiations, signing events, access changes, and administrative actions.
Each record shows:
- Username — links to the user's profile
- Activity description — links to a detailed view including related entities
- Action type — categorised event type
- Date / time
- Client application — web, desktop, or mobile
- IP address
Key owning modules:
- UI:
suredms-web-client—network/network-audit-trail.jsandadministration/audit/signing-audit-trail.js - Backend:
suredms-web-service—NetworkActivityRepositoryandNetworkActivityService
Angular Route
File: SC/suredms-web-client/src/main/webapp/app/js/state/app-states-network.js
State: app.network.audit-trail
Controller
File: SC/suredms-web-client/src/main/webapp/app/js/network/network-audit-trail.js
Controller: NetworkAuditTrailController
Loads the audit trail for the current network/project context. Owns the filter state, pagination, and export actions. Filter parameters are passed via $stateParams in the URL, allowing deep-linked filtered views.
Filter Parameters
The audit trail supports the following filters, passed as $stateParams:
| Parameter | Type | Description |
|---|---|---|
userId | string | Filter by a specific user's username |
eventType | string | Filter by action type (e.g., upload, sign, delete) |
from | date | Start of the date range |
to | date | End of the date range |
| User type | enum | Internal user / external user |
| Group | string | Filter by user group membership |
| Document | string | Filter by document name or ID |
| IP address | string | Filter by originating IP |
Multiple filters can be applied simultaneously. Active filters are reflected in the URL for shareability.
CSV Export
The Audit Trail supports exporting a filtered or full record set to CSV:
- Partial export — exports the current filtered view.
- Full export — exports all records regardless of active filters.
Export triggers a backend request to an endpoint in suredms-web-service. The resulting CSV includes all visible columns: username, activity description, action type, date/time, client, and IP address.
Signing Audit Trail Sub-View
File: SC/suredms-web-client/src/main/webapp/app/js/administration/audit/signing-audit-trail.js
Controller: AdministrationSigningAuditTrailController
Accessible from within the Audit Trail view via the Signing Audit Trail action. This sub-view filters audit records to signing-specific events: signature applied, signature rejected, eSign workflow initiated, certificate used. It uses the same filter parameter model as the full audit trail but scoped to signing action types.
The signing audit trail is the primary compliance reference for CFR Part 11 / eSign attestation audits.
Backend Services
Activity data is retrieved via:
| Service | Purpose |
|---|---|
NetworkActivityRepository | Fetches paginated audit records from the backend with filter parameters |
NetworkActivityService | Higher-level service that wraps the repository; manages filter state and export requests |
Backend endpoints reside in the suredms-web-service module. Export requests return a streamed CSV response.
Report Generation from Audit Trail
The Audit Trail view includes a Generate Report action that launches the Report Wizard (see Reports) pre-filtered to the Signing Audit Trail report type. The SIGNING_AUDIT_TRAIL report type in ReportType.java is the corresponding backend report definition.
Help Reference
| Topic | File |
|---|---|
| Viewing the SureDrive Audit Trail | Help/contents/Content_Repo/Viewing_the_SureDrive_Audit_Trail.htm |
Key Source Files Reference
| File | Purpose |
|---|---|
| SC/suredms-web-client/src/main/webapp/app/js/state/app-states-network.js | Route definition for app.network.audit-trail |
| SC/suredms-web-client/src/main/webapp/app/js/network/network-audit-trail.js | NetworkAuditTrailController — filter, pagination, export |
| SC/suredms-web-client/src/main/webapp/app/js/administration/audit/signing-audit-trail.js | AdministrationSigningAuditTrailController — signing-specific audit sub-view |