Skip to main content

Audit Trail

The Audit Trail module automatically records all actions performed on the system, enabling complete traceability of operations.

Objectives

  • Trace all user actions on the system
  • Secure data with an immutable history
  • Analyze system usage
  • Meet compliance and audit requirements

Access

Menu: Audit

Or via SettingsAudit tab


Overview

Statistics

At the top of the page, cards display statistics by action type:

StatisticDescription
TotalTotal number of records
CreationsNumber of creations
ModificationsNumber of modifications
DeletionsNumber of deletions

Action Types

Each action is categorized and displayed with a colored badge:

ActionBadgeDescription
CreationGreenNew record created
ModificationBlueData updated
DeletionRedRecord deleted
ViewGrayData viewed
LoginPurpleUser login
LogoutPurpleUser logout
ExportYellowData exported
ImportYellowData imported
ValidationEmeraldRecord validated
RejectionOrangeRecord rejected
ExecutionIndigoOperation executed
CancellationGrayAction cancelled

Search and Filters

Search in descriptions and metadata.

Advanced Filters

Click Filters to display options:

FilterDescription
ActionFilter by action type
Entity TypeFilter by data type (Household, Beneficiary, User, etc.)
Start DateActions after this date
End DateActions before this date

Reset Filters

Click Reset filters to clear all criteria.


Audit Table

Displayed Columns

ColumnDescription
DateAction date and time
ActionAction type (colored badge)
EntityEntity type + abbreviated ID
UserUser email
DescriptionAction summary
ActionsView details button

Pagination

  • 20 records per page
  • Navigation with Previous/Next buttons
  • Display of page number and total

Audit Details

Click the View icon (eye) to open the details modal.

Displayed Information

FieldDescription
DatePrecise date and time
ActionAction type
Entity TypeRecord category
Entity IDComplete unique identifier
UserAuthor email
IP AddressConnection IP
DescriptionFull description

Old Values

For modifications, old values are displayed in JSON on a light red background.

New Values

For creations and modifications, new values are displayed in JSON on a light green background.

Metadata

Additional contextual information (browser, system, etc.).


Entity Types

Main tracked entities:

EntityDescription
UserUser accounts
MenageHousehold forms
BeneficiaireBeneficiary forms
CyclePayment cycles
PaiementIndividual payments
PlainteGRM complaints
RegionRegions
SecteurSectors
LocaliteLocalities
EcoleSchools
CentreSanteHealth centers

Use Cases

Investigate a Suspicious Modification

  1. Access the audit trail
  2. Filter by Action = "Modification"
  3. Filter by Entity Type = the concerned entity
  4. Use date filters if needed
  5. Click View to examine details
  6. Compare old and new values

Verify User Activity

  1. Search for the user's email
  2. Review the action list
  3. Analyze types of actions performed
  4. Check times and IP addresses

Audit Logins

  1. Filter by Action = "Login" or "Logout"
  2. Review dates and times
  3. Check IP addresses
  4. Identify abnormal connections

Trace Deletions

  1. Filter by Action = "Deletion"
  2. Identify deleted entities
  3. Note responsible users
  4. Check old values for recovery

Analyze Usage Over a Period

  1. Set the period with date filters
  2. Review statistics by action type
  3. Identify activity peaks
  4. Analyze usage patterns

Best Practices

Regular Review

  • Review the audit trail periodically
  • Monitor unusual actions
  • Check connections from unknown IPs

Archiving

  • Export audit data regularly
  • Keep archives according to retention policies
  • Document identified incidents

Security

  • The audit trail is read-only
  • Records cannot be modified or deleted
  • Access is limited to authorized users

Incident Response

  • Use the audit trail to investigate issues
  • Document corrective actions
  • Identify preventive measures

Permissions

ActionRequired Permission
View audit trailaudit.view
View detailsaudit.view
Note

The audit trail is generally reserved for administrators and supervisors for confidentiality reasons.


Integration with Other Modules

All Entities

Every creation, modification, or deletion in any module is automatically recorded in the audit trail.

Authentication

Logins, logouts, and failed login attempts are tracked.

Import/Export

All data import and export operations are recorded.


Technical Information

Record Structure

{
"id": "uuid",
"action": "update",
"entityType": "Menage",
"entityId": "household-uuid",
"userId": "user-uuid",
"userEmail": "user@example.com",
"description": "Household modification",
"oldValues": { "tailleMenage": 4 },
"newValues": { "tailleMenage": 5 },
"metadata": { "browser": "Chrome", "os": "Windows" },
"ipAddress": "192.168.1.1",
"createdAt": "2024-01-15T10:30:00Z"
}

Data Retention

Audit records are retained according to the retention policy defined by the system administrator.