View and Export the Entity Audit Trail

Sway
Sway
  • Updated

The Entity Audit Trail records activity within a specific entity. It helps users monitor changes, troubleshoot issues, and maintain transparency.

Overview

The audit trail shows what actions were taken in an entity, who performed them, and when. Entries are automatically recorded, and eligible users can also add them manually.

All users can view this tab, except Summary-Only users. Read-Only users can view entries but cannot add new ones.

Use the Entity Audit Trail to:

  • Monitor changes made to records in the entity

  • Troubleshoot by reviewing a timeline of actions

  • Maintain accurate records for compliance

Access the audit trail from the Audit Trail tab in the General section of the desired entity.

Availability: All customers.


Access the Audit Trail

  1. Open the desired entity and go to the General > Audit Trail tab

  2. The audit trail columns display the following information:

    • Changed on: date and time when the event was logged
    • Effective Date: date when the event took effect
    • Changed by: name and email of the user who made the change
    • Type: specific category of the event associated with the change
    • Record: entity, people, or classes impacted by the change
    • Details: detailed information on the event and changes made
    • Tags: automatically or manually added tags (Individual audit trails have been upgraded to meet the same “format” we use in the global audit trail
      • Note: Manual vs system tags are colored differently:
        • Manually added tags are grey 
        • System added tags are blue
  3. Click on an entry to open the Audit details in a pop-up modal

  4. At the bottom right corner, choose Items per page (5, 10, 20, or 100) to see more entries on the same page and click the arrow to navigate the following pages


Add a Manual Audit Log

To add a manual audit trail event:

  1. Open the desired entity and go to the General > Audit Trail tab

  2. Click the + New button in the top-right corner

  3. In the New Event modal:

    • Select the Event Type from the Type dropdown

      • If selecting Custom, type the Event Name

    • Choose an Effective Date
    • Enter Tags (optional)

      • Note: Manually added tags are coloured in grey

    • Enter a description in the Details textbox

  4. Click Add to save the entry

The event will appear in the audit history for that entity.


Filter the Audit Trail

  1. Click the Filter dropdown button on the left side of the search bar
  2. Set Filters as Desired:
    • Changed On: Select a start date and an end date in YYYY-MM-DD format
    • Effective Date: Choose a start date and an end date in YYYY-MM-DD format
    • Changed By: Type the name of the user who made the change
    • Type: Select one or multiple types from the dropdown list
    • Record: Type the name of the record you wish to search for
    • Tags: Choose one or more tags from the dropdown list
  3. Click Apply
  4. To save the filter, click on + Save filter
  5. Click on Clear all filters or the X icon to remove the filters and view the results without any filters

Search the Audit Trail

  1. Enter keywords in the top right search bar to find matching audit trail events
  2. Combine filters and searches for more accurate and precise results

Export the Audit Trail

To export the audit trail:

  1. Go to the General > Audit Trail tab within the entity

  2. Click the Export button in the top-right corner

An .xlsx file of the audit data will be downloaded to your local device for your review or recordkeeping.


Video Instructions