Skip to main content

Audit Log

1. View Audit Logs

Scenario: User views Audit Log entries

  • Given the User is on the Audit Log Page
  • Then User can see a table of all system activities with Action, User, Type, and Created At information
  • And User can navigate through multiple pages of audit records

Example: Security administrator Maya opens the Audit Log page to review recent system activities. She can immediately see various actions performed by users, such as "Added inventory" by sujan@brownbrick.io on 04/03/2025 and "Edited customer" actions, providing a complete trail of system changes.

2. Filter Audit Logs

Scenario: User searches audit logs

  • Given the User is on the Audit Log Page
  • When User enters keywords in the search field
  • Then Audit logs are filtered to show only matching records

Example: When investigating a potential issue with customer records, IT manager Carlos types "customer" in the search field. The system immediately filters the audit log to show only customer-related actions such as "Added customer," "Edited customer," "Archived customer," and "Unarchived customer."

Scenario: User filters audit logs by type

  • Given the User is on the Audit Log Page
  • When User clicks on "Select type" dropdown
  • And Selects options like "Login," "Logout," "User Create," etc.
  • Then Audit logs are filtered to show only records of the selected type

Example: During security review, compliance officer Janet needs to check all login activity. She clicks the "Select type" dropdown and chooses "Login" from the list. The system filters the audit log to display only login events, allowing her to review all system access instances.

Scenario: User filters audit logs by module

  • Given the User is on the Audit Log Page
  • When User clicks on "Select module" dropdown
  • And Selects options like "Inventories," "Expenses," "Suppliers," "Invoices," "Transactions," or "Customers"
  • Then Audit logs are filtered to show only records related to the selected module

Example: Financial auditor Robert needs to review all changes related to suppliers. He clicks the "Select module" dropdown and selects "Suppliers." The system then shows only audit records related to supplier operations, such as additions, edits, or removals of supplier information.

3. Select Audit Log Period

Scenario: User selects time period for audit logs

  • Given the User is on the Audit Log Page
  • When User clicks on "Select Period" dropdown
  • Then User can choose from time period options to filter audit records
  • And Audit logs are updated to show only records from the selected time period

Example: During a monthly compliance check, auditor Sarah needs to review all system changes from the previous week. She clicks the "Select Period" dropdown and chooses "Previous Week." The system updates to show only audit logs created during the previous week, streamlining her review process.

4. Paginate Through Audit Results

Scenario: User navigates through multiple pages of audit logs

  • Given the User is on the Audit Log Page with multiple pages of results
  • When User clicks on page number buttons (1, 2, 3, 4, etc.) or navigates using "..."
  • Then User can view different pages of audit log entries
  • And System shows current position (e.g., "Showing 10 of 1623 results")

Example: System administrator Alex is conducting a thorough review of system activities. With 1623 total audit records, he starts on page 1 reviewing the most recent activities. When finished with the first page, he clicks on page number "2" to continue his review with the next set of audit logs, and can see his progress as "Showing 10 of 1623 results."