Skip to Content

Wiki source code of 05f. Audit Index

Last modified by Tom Jardine on 06/11/2025, 14:23
Hide last authors
Tom Jardine 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 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.
6
7 For more information regarding the reports that be created, please refer to the [[Audit Reporting Guide>>doc:Technical Documentation.CXAIR.Reporting Guides.Audit Reporting Guide.WebHome]].
8
9 To modify what is captured and when, navigate to the [[Audit>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Audit"]] tab in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]].
10
11 To view the contents of the Audit Index, ensure it is added to a Search Engine and then navigate to the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen. Select the relevant Search Engine using the [[Search within:>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome||anchor="Interface"]] drop-down list, and select **CXAIR AUDIT** from the list of Indexes.
12
13 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.
14
15 The following Audit components can be selected:
16
17 = Configuration =
18
19 Displays any changes made to the [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] configuration database, including deletions.
20
21 = Crosstab =
22
23 Displays the recorded usage statistics for the [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] functionality.
24
25 = Dashboard =
26
27 Displays the recorded usage statistics for the [[Dashboard>>doc:Technical Documentation.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Reporting.2f\. Dashboards.WebHome]] functionality.
28
29 = Flow Reports =
30
31 Displays the recorded usage statistics for the [[Flow Reports>>doc:Technical Documentation.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Reporting.2g\. Flow Reports.WebHome]] functionality.
32
33 = Index Maintenance =
34
35 Displays entries concerning the [[System Schedules>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.e\. Index Schedules.WebHome||anchor="System Schedules"]], such as the Garbage Collection and Tidy Index, if enabled.
36
37 = Job Schedule =
38
39 Displays the scheduled Index builds along with the associated Data Source Group and timestamps.
40
41 = Load and Save =
42
43 Displays the recorded usage statistics for the loading and saving of reports.
44
45 = Logins =
46
47 Details all successful logins, successful logouts and failed logins.
48
49 = Memory Free/Total/Max =
50
51 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.
52
53 = Model =
54
55 Displays the recorded usage statistics for the [[Model>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2i\. Modelling.WebHome]] functionality.
56
57 = Pages =
58
59 Displays the recorded usage statistics for the [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.WebHome]] functionality.
60
61 = Query =
62
63 Displays the recorded usage statistics for the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] functionality.
64
65 = Report Schedules =
66
67 Creates an entry when the details of a report schedules are changed, along with the user who performed the modifications.
68
69 = Schedule Execution =
70
71 Details schedule information at runtime.
72
73 = Security Violation =
74
75 Creates an entry when a user attempts to load a report without the correct permissions.
76
77 = Storage Total/Unallocated/Usable =
78
79 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.
80
81 = Sub Crosstab =
82
83 Displays information concerning every record added to a [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]]. 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.
84
85 = Sub Queries =
86
87 Displays information concerning every record for every [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]]. 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.
88
89 = Sub Venn =
90
91 Displays information concerning every record added to a [[Venn>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2d\. Venn Diagrams.WebHome]] 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.
92
93 = System =
94
95 Combines the results of the **Memory Free/Total/Max** and **Utilisation Process/System/Average** audit entries.
96
97 = System Alert =
98
99 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>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Message Queue Size"]] value in the [[System Settings>>System Settings]].
100
101 = System Startup =
102
103 Displays a timestamp for each time the system service was started and stopped.
104
105 = Unique Values =
106
107 Creates an entry for every popup that is opened containing unique values. For example, clicking a column heading in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen.
108
109 = User =
110
111 Displays every change made to every user, including deletions.
112
113 = User Lockout =
114
115 Provides information regarding users that have been refused access to the solution, such as when an incorrect password has been entered.
116
117 = Utilisation Process/System/Average =
118
119 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.
120
121 = Venn =
122
123 Displays the recorded usage statistics for the [[Venn>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2d\. Venn Diagrams.WebHome]] functionality.