Tracking and Reviewing Audit Logs in ACE

Prev Next

ACE automatically tracks all configuration changes in an audit log. Users with the AUDIT_VIEW permission can access these logs under Utilities → Audit Logs.

Accessing Audit Logs

When accessing the Audit Logs page, users are first presented with a search interface to filter and locate specific logs.

Image Displays Audit Logs Page

Available Filters

Users can refine their search using the following filters:

  • User: Includes both "Override Username" and "Username" fields.

  • Object Type: The type of object that was modified.

  • Operations: The action performed on the object.

  • ObjectIDs: A comma-separated list of object IDs, unique within their object type.

  • Date Range: The timeframe in which changes occurred.

Filters are combined using "AND" logic, meaning only logs that match all selected criteria are shown. Leaving a filter empty includes all values for that field.

Understanding Audit Log Details

The Audit Log table provides detailed information about each recorded change, including:

  • Timestamp: The exact date and time when the change was made.

  • Override Username: The user who initiated the action, particularly useful when logging in using the "as" keyword (e.g., "Sally as admin").

  • Username: The actual user account that performed the action.

  • Operation: The type of action performed on the object (e.g., Create, Update, Delete).

  • Object ID: The unique identifier of the modified object within its respective object type.

  • Object Type: The category of the modified object (e.g., FlowActionProperty, HotkeyMacro)

  • Audit Log ID: The system-generated unique identifier for the audit log entry.

  • Diff Column: Displays the JSON patch representing the change, formatted according to RFC 6902. The patch describes how to revert the object to its previous state.

Image Displays Audit Log Columns and Details

Comparing Audit Logs

Clicking on an audit log entry opens a detailed comparison screen, where changes are highlighted for better visibility.

Fields in the Comparison Page

  • Before Dropdown: Selects an earlier version of the object to compare.

  • After Dropdown: Compares it to the selected or current version.

  • Showing Changes by Users: Lists all users who modified the object within the selected timeframe.

  • Restore Button: Reverts the object to the selected "Before" version.

Change Highlights

  • Green: Newly added or modified values.

  • Red: Removed values.

  • Gray: Unchanged properties (can be hidden using the "Show unchanged values" checkbox).

Example of Changes:

  • The "value" field was updated with a new text description.

  • The "lastUpdate" timestamp changed to reflect the latest modification.

  • Additional attributes like "createdBy", "identifier", and "required" remain unchanged but are displayed in the log.

By using this screen, users can review modifications, track historical changes, and restore previous configurations if needed.

Image Displays Detailed Differences

Logged Object Types

The audit log tracks changes for various object types.

(* Indicates objects that frequently change and may require additional review.)

Accounts & Adjustments

  • account/BankReturnReason

  • account/Bankruptcy

  • account/Bundle

  • account/BundlePreference

  • account/DebtGroup

  • account/DebtGroupConfig

  • account/OwingAdjustmentReason

  • account/ReceivedAdjustmentReason

  • account/UserCommission

  • Accounting & Payments

  • accounting/BankAccount

  • accounting/BankAccountEntry

  • accounting/BankAccountTransDestination

  • accounting/CommissionRate

  • accounting/CommissionRateLogic

  • accounting/Invoice

  • accounting/InvoiceRemit

  • accounting/InvoiceTemplate

  • accounting/RemittanceMethod

  • accounting/TransactionSpreader

  • payment/PaymentDestination

  • payment/PaymentPlan *

  • payment/TransactionBatch

Client & Customer Data

  • client/Client

  • client/ClientLedgerEntry

  • client/ClientSalesman

  • customer/Customer *

Communication & Vendor Configurations

  • email/EmailTemplate

  • els/ElsVendor

  • txtMsg/TxtMsgTemplate

  • txtMsg/TxtMsgVendor

  • dialer/DialerVendor

  • dialer/DialerVendorCode

Forms, Letters, and Reports

  • form/Form

  • form/FormConfig

  • form/FormFieldConfig

  • letter/LetterConfig

  • letter/LetterSeriesConfig

  • letter/LetterSeriesConfigLetter

  • letter/MailReturnReason

  • report/ReportTemplate

Hotkey Actions

  • hotkey/HotkeyMacro

User Roles & Worklists

  • user/Role

  • user/User *

  • user/UserCommissionTier

Worklist

  • worklist/WorklistSortField

Virtual Agent (VA) Preferences

  • va/Preferences