05f. Audit Index

Last modified by Tom Jardine on 06/11/2025, 14:23

The solution includes a comprehensive auditing feature through the use of an Audit Index, where usage data for a number of key functionality areas is automatically recorded.

For more information regarding the reports that be created, please refer to the Audit Reporting Guide.

To modify what is captured and when, navigate to the Audit tab in the System Settings.

To view the contents of the Audit Index, ensure it is added to a Search Engine and then navigate to the Query screen. Select the relevant Search Engine using the Search within: drop-down list, and select CXAIR AUDIT from the list of Indexes.

Select an area of the Audit Index to display the different processes that were executed as a result a specific action. The Record Type column displays the type of data recorded, with the other columns providing further details.

The following Audit components can be selected:

Configuration

Displays any changes made to the CXAIR configuration database, including deletions.

Crosstab

Displays the recorded usage statistics for the Crosstab functionality.

Dashboard

Displays the recorded usage statistics for the Dashboard functionality.

Flow Reports

Displays the recorded usage statistics for the Flow Reports functionality.

Index Maintenance

Displays entries concerning the System Schedules, such as the Garbage Collection and Tidy Index, if enabled.

Job Schedule

Displays the scheduled Index builds along with the associated Data Source Group and timestamps.

Load and Save

Displays the recorded usage statistics for the loading and saving of reports.

Logins

Details all successful logins, successful logouts and failed logins.

Memory Free/Total/Max

Displays an audit on the available system memory. The Metric, Metric 2 and Metric 3 columns detail the available, total amount the amount made available to the solution, respectively.

Model

Displays the recorded usage statistics for the Model functionality.

Pages

Displays the recorded usage statistics for the Pages functionality.

Query

Displays the recorded usage statistics for the Query functionality.

Report Schedules

Creates an entry when the details of a report schedules are changed, along with the user who performed the modifications.

Schedule Execution

Details schedule information at runtime.

Security Violation

Creates an entry when a user attempts to load a report without the correct permissions.

Storage Total/Unallocated/Usable

Displays an audit on the available disk space. The Drive column denotes the disk being monitored, while the Metric, Metric 2 and Metric 3 columns detail the total size, the free space and space available to the solution, respectively.

Sub Crosstab

Displays information concerning every record added to a Crosstab. Leaving this audit option enabled is not recommended due to the large amount of information that is recorded and the potential impact on system performance.

Sub Queries

Displays information concerning every record for every Query. Leaving this audit option enabled is not recommended due to the large amount of information that is recorded and the potential impact on system performance.

Sub Venn

Displays information concerning every record added to a Venn set. Leaving this audit option enabled is not recommended due to the large amount of information that is recorded and the potential impact on system performance.

System

Combines the results of the Memory Free/Total/Max and Utilisation Process/System/Average audit entries.

System Alert

Displays any alerts generated by the system in the Message column that pinpoints a an issue that may require attention. For example, a 'Message Queue Size needs increasing' message can be quickly identified and remedied by increasing the Message Queue Size value in the System Settings.

System Startup

Displays a timestamp for each time the system service was started and stopped.

Unique Values

Creates an entry for every popup that is opened containing unique values. For example, clicking a column heading in the Query screen.

User

Displays every change made to every user, including deletions.

User Lockout

Provides information regarding users that have been refused access to the solution, such as when an incorrect password has been entered.

Utilisation Process/System/Average

Displays an audit on the CPU usage, along with a timestamp. The Metric and Metric 2 columns detail the current and average usage at that point in time, respectively.

Venn

Displays the recorded usage statistics for the Venn functionality.