Skip to Content

Wiki source code of CXAIR 2019.1

Last modified by Tom Jardine on 06/11/2025, 14:22
Hide last authors
Tom Jardine 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 The CXAIR 2019.1 release builds on the usability enhancements present in the previous release by further promoting well-used reporting options and adding features that assist in report creation and administration.
6
7 = Installation Prerequisites =
8
9 **Default Ports required**: 6453/6454
10 //Please note that these can be configured to any ports required after installation//
11
12 **Prerequisite software required**: Java Development Kit 12 or above
13
14 //Please note that due to Oracle licencing changes, an Oracle licence must be purchased to continue to use Oracle JDK in a commercial environment. More information can be found on the Oracle website: [[https:~~/~~/www.oracle.com/technetwork/java/javase/overview/faqs-jsp-136696.html>>url:https://www.oracle.com/technetwork/java/javase/overview/faqs-jsp-136696.html]]//
15
16 A recommended alternative to Oracle's JDK is to use the 'Open Java Development Kit' General-Availability Release 12 or above, which is available from https://openjdk.java.net. This is fully compatible with CXAIR.
17
18 When changing Java versions, there are necessary CXAIR configuration files that must be updated. Please refer to the [[Upgrade Procedure>>doc:Technical Documentation.CXAIR.Administration Guide.Installation.1a\. Upgrade Procedure.WebHome]] chapter for more information.
19
20 Please ensure that any custom **External Host Name**, **External Port Number** and **External SSL Port Number** [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]] values are backed-up prior to the upgrade, as they may need to be re-entered following an upgrade under certain circumstances.
21
22 = Enhancements & New Features =
23
24 == Query ==
25
26 **Report Searching**
27
28 It is now possible to load reports directly from the Query bar. Simply start typing the name of the report and click the desired report from the results that appear.
29
30 Activate the **Enable Report Searching** option from the [[Query section>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome||anchor="Query"]] of the [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome]] to activate this feature.
31
32 [[image:1.png||queryString="width=735&height=83" height="83" width="735"]]
33
34 **Voice Searching**
35 Voice control can now be used to load reports and add search terms to a query when using the Google Chrome web browser.
36
37 Activate the **Enable Voice Searching** option from the [[Query section>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome||anchor="Query"]] of the [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome]] to enable this feature.
38
39 [[image:2.png||queryString="width=283&height=67" height="67" width="283"]]
40
41 Click the microphone icon in the Query bar and enable the relevant browser permissions to get started. Use the ‘Load <report name>’ and ‘Search <search term>’ syntax to perform the relevant action.
42
43 **Column Headings**
44 Extra calculations can now be displayed for numeric values in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Query.WebHome]] screen when a column heading is clicked.
45
46 Activate the **Show Extra Calculations On Headers** option from the [[Query section>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome]] of the [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome]] to enable this feature.
47
48 [[image:3.png||queryString="width=287&height=255" height="255" width="287"]]
49
50 Additional calculations are now displayed when clicking the column heading for a numeric field, including minimum, maximum, average and sum.
51
52 **Hierarchical Charting Popups**
53 Using the [[Hierarchy options>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome||anchor="Hierarchy"]] for an Index, fields can be related to enhance the ad hoc functionality in the [[Query screen>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Query.WebHome]] for end-users by presenting pre-defined charts for specific fields.
54
55 This functionality is set at Index level under the [[Hierarchy>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome||anchor="Hierarchy"]] heading, where the **Set Hierarchy** drop-down list is used to specify the field order and the chart type can be selected:
56
57 [[image:4.png]]
58
59 Once configured and enabled in the [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome]], hovering the cursor over a specified field in the [[Query screen>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Query.WebHome]] will draw the selected chart in a popup window:
60
61 [[image:5.png]]
62
63 == Crosstabs ==
64
65 [[Crosstabs>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] have been a key [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] reporting component since the product was first launched and as the product has matured, many new features have been added that extend this reporting capability.
66
67 **Layout Enhancements**
68 In this release the layout has been enhanced to better integrate key features used regularly in reporting, resulting in changes that help expedite the creation process.
69
70 [[image:6.png||queryString="width=489&height=258" height="258" width="489"]]
71
72 Levels now can be hidden directly from the **Axes** tab for each specified row or column using the **Display** icon, and headers can also be renamed for each field by clicking the … icon and using the **Label** option.
73
74 Clicking the Cog icon for rows and columns will present the following consolidated options:
75
76 [[image:Screenshot 2019-03-21 at 15.20.20.png||queryString="width=374&height=304" height="304" width="374"]]
77
78 The **Do Not Indent Row Headings** option has also been added to alter the display of the reporting output.
79
80 **Enhanced Report Preview**
81 The report preview that is rendered at the bottom of the screen has also been enhanced. Rather than displaying an approximation of the report based on layout alone, the preview will now render the report based using values in the Index.
82
83 This new preview can also be used to style [[Crosstabs>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Crosstabs.WebHome]] and charts by clicking the desired area and selecting from the pop-up options.
84
85 [[image:7.png||queryString="width=367&height=140" height="140" width="367"]] [[image:8.png||queryString="width=370&height=140" height="140" width="370"]]
86
87 **Enhanced PDF Exporting**
88 When exporting a [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] to PDF format, the new **Fit to Page** option ensures that the output is split correctly over multiple pages. Use in conjunction with the **Page Size** option in the Layout tab to achieve a greater level of control over the row count.
89
90 Furthermore, enabling the new **Page on Inner Row** option will calculate the number of pages based on the inner values rather than on the outer values to ensure that sizing remains consistent when the report is filtered or page breaks are used in a [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] report.
91
92 Please note that the print functionality has now been deprecated. The scaling algorithms provided during a PDF export provide a far more robust output that can then be printed from a PDF reader of choice.
93
94 **Filter Totals**
95 Used in conjunction with the **Filter** tab for a total, it is now possible to display the grand total of only the filtered values. Enable the option in the **Table** section of the **Layout** tab once a total has been filtered.
96
97 **Chart Themes**
98 A number of new chart themes have been added to enhance presentation in reporting, available from the **Colours** drop-down list.
99
100 [[image:Screenshot 2019-03-21 at 15.40.53.png]]
101
102 New themes include Gammel, Candy and Fusion and can be used for all chart types.
103
104 **New Mathematical Functions**
105 The mathematical functions available in the [[calculation builder>>doc:Technical Documentation.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Reporting.2c\. Crosstabs.2ci\. Calculation Builder.WebHome]] have been expanded to now include Fact, Greatest Common Denominator (GCD), Lowest Common Multiple (LCM), Log, Mod, Power, Quotient and Sign for greater flexibility when performing calculations.
106
107 **Report Rendering Optimisation**
108 Designed to be used in conjunction with the **Do Not Indent Row Headings** option, the new **Do Not Aggregate Records** option reduces the render time by not aggregating values in the output.
109
110 This new option in located the **Table** section of the **Layout** tab and is especially useful when using the Crosstab functionality to output grouped and nested row headings rather than values.
111
112 **Conditional Formatting**
113 The conditional formatting functionality has now been extended to support chart values. Simply select Chart from the **Scope** drop-down list to apply this new feature:
114
115 [[image:9.png||queryString="width=311&height=102" height="102" width="311"]]
116
117 == Pages ==
118
119 When [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] was first introduced, it represented a radically different way of creating reports without the restrictions of ‘traditional’ analytics tools. In the [[2017.2 release>>doc:Release Notes.2017\.2.WebHome]], the interface was overhauled to utilise the higher resolutions that had become available along with streamlining the entire report creation process.
120
121 In this release, the interface has again been enhanced and features added to hone the usability and add to the power of the tool.
122
123 **Layout Enhancements**
124 A single **Report Style** option consolidates frequently used options and adds new features:
125
126 [[image:10.png||queryString="width=243&height=400" height="400" width="243"]]
127
128 **Header and Footer Options**
129 It is now possible to add traditional headers and footers to reports, such as a company logo or strap-line, that will repeat for every page.
130
131 Click **Report Style** in edit mode and enable the **Show Header & Footer** option to activate this feature. Then, simply add the desired information to the header and footer components that will automatically be added to each page.
132
133 **Auto Refresh**
134 Pages reports can now be set to automatically refresh to account for new data when in Run mode. Simply click the page in the structure panel and click **Page Style** to reveal the **Auto Refresh** option. Enter the required refresh rate, in seconds, and click **Apply** to save.
135
136 **Containers**
137 A new [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] reporting component has been added. **Containers** allow multiple report components to be added to a single Tile, controlled via a single transition:
138
139 [[image:11.png||queryString="width=65&height=63" height="63" width="65"]]
140
141 **Load All Pages**
142 When scrolling through a complex [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] report, there may be a slight pause while the system loads the reporting components for each page.
143
144 A new feature has been added to combat this delay and can be enabled for any [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] report. Click **Report Style** in edit mode and enable the **Load All Pages** option to activate this feature.
145
146 [[image:12.png||queryString="width=299&height=180" height="180" width="299"]]
147
148 Now when the report is run, all reporting components are loaded rather than the system waiting for navigation to a certain page. Please note this may incur a small loading time to initially display the report.
149
150 **New Gauges**
151 The gauge selection has been updated to include a number of new additions to provide end-users with eye-catching totals in a report:
152
153 [[image:13.png]]
154
155 **Fill Page**
156 A new layout option has been added that automatically sizes a reporting component to fill the entire page. Simply click the added component and click the **Fill Page** option from the floating toolbox.
157
158 [[image:14.png||queryString="width=413&height=134" height="134" width="413"]]
159
160 This is especially useful when adding a background image to a report and can also be used for any reporting component.
161
162 **Zoom Slider**
163 When in Run mode, a zoom slider has been added to the bottom of the screen to control the report zoom, previously only available in edit mode. The setting is saved for each user per report, resulting in reports that always fill the required screen size and resolution.
164
165 **Exporting Individual Components**
166 Within a [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] report, it is now possible for end users to export individual components of interest. Within the **Layout** tab of an added gauge, chart or Crosstab, the new **Export** option can be added to either the **Header** or **Footer** of the component:
167
168 [[image:15.png]]
169
170 When the [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] report is run, users can then export a component of interest by clicking the associated export icon:
171
172 [[image:16.png]]
173
174 **Updated Third-Party Text Editor**
175 The third-party text editor has been upgraded, providing greater stability and adding a range of new features, such as in-built image editing tools:
176
177 [[image:17.png||queryString="width=683&height=354" height="354" width="683"]]
178
179 Other features include the ability to add text tables and extended functionality for adding fields, filters and totals from an Index.
180
181 **HTML Component Management**
182 Using the **Text** component, adding custom HTML elements using the **<Source Code>** option is an excellent way to enrich reports with component backgrounds and navigation buttons.
183
184 These custom text components can now be saved and imported into other reports. Click the added HTML element and click **Save** in the toolbox before selecting the desired folder where the component will be saved.
185
186 The **Custom** component can now be added to a report:
187
188 [[image:18.png||queryString="width=63&height=74" height="74" width="63"]]
189
190 Adding this component will present a load popup where saved HTML elements can be loaded, proving access to a library of shared HTML components to enrich reports with this extra level of detail.
191
192 **Component Toolbox View**
193 The component toolbox can now be displayed as a single horizontal row to make better use of screen real-estate while creating a report. Simply click the collapse icon at the top-left of the toolbox to toggle this feature.
194
195 [[image:19.png]]
196
197 **Legacy Report Conversion**
198 An option to convert legacy Flow Reports to [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] has been added that will convert the entire report to the newer platform.
199
200 Simply click the cog icon for any Flow Report in the load screen and select **Convert to Pages** to open the report in [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.Pages.WebHome]] edit mode, complete with all previously configured reporting components.
201
202 [[image:20.png||queryString="width=597&height=300" height="300" width="597"]]
203
204 Within the **Report Style** options, the newly added **Ticker** entries permit compatibility with Flow Reports that used this feature previously.
205
206 [[image:21.png]]
207
208 == Load Screen ==
209
210 **Improved Load Screen Searching**
211 When searching for a report, the load screen will now display the option to conduct the search across a different Search Engine if no results are found.
212
213 [[image:22.png]]
214
215 == Report Viewer ==
216
217 **Query Bar**
218 Administrators can now enable query bar functionality for other users when viewing row-level data, allowing report viewers to further filter down the data. The original syntax used to derive the rows is also displayed below:
219
220 [[image:23.png]]
221
222 Enable the **Show Search Bar** option in the [[CXAIR Viewer section>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome||anchor="CXAIR Viewer"]] of the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome]] to turn on this feature.
223
224 **User Preferences**
225 [[Report Viewer>>doc:Technical Documentation.CXAIR.User Guide.7\. Report Viewer.WebHome]] users now manage their own [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.7\. Report Viewer.WebHome||anchor="Preferences"]] to update their **Real Name**, **Email** and **Password**. This is accessed using the new [[Preferences>>doc:Technical Documentation.CXAIR.User Guide.7\. Report Viewer.WebHome||anchor="Preferences"]] icon in all areas of [[Report viewer>>doc:Technical Documentation.CXAIR.User Guide.7\. Report Viewer.WebHome]].
226
227 == Administration ==
228
229 **Amalgamated Wizard Enhancements**
230 The [[Amalgamated Index Wizard>>doc:Technical Documentation.CXAIR.Administration Guide.Wizards.b\. Amalgamated Data Source Wizard.WebHome]] screen has been refreshed to enhance usability and to better represent the process on-screen.
231
232 [[image:24.png]]
233
234 Field selection has been improved to improve speed of selection and visibility, while the **View Preview** button can be used to display a breakdown of the current configuration. Click the filter icon for each Index to add saved Queries.
235
236 **Copying Schedules**
237 [[Index Schedules>>doc:Technical Documentation.CXAIR.Administration Guide.Index Schedules.WebHome]] can now be copied to quickly queue builds with similar configurations. Click the **Copy** icon for the required entry in the Index Schedules screen to use this feature.
238
239 **Auto Refresh**
240 The **Refresh / Filter** button functionality has now been extended to automatically refresh the screen when the **Auto Refresh** checkbox is enabled. This is especially useful when monitoring Index builds and negates the previous requirement to manually refresh the screen.
241
242 **Audit Index Enhancements**
243 A number of enhancements have been made to the contents of the CXAIR Audit Index to improve usability and make report creation a more straightforward process.
244
245 These changes are supplemented with a new [[Audit Reporting Guide>>doc:Technical Documentation.CXAIR.Reporting Guides.Audit Reporting Guide.WebHome]] that has been written to detail the key steps needed to create a number of reports using the newly organised fields.
246
247 **Crosstab Index Creation**
248 [[Crosstab Indexes>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.a\. Creating a Data Source.WebHome||anchor="Crosstab"]] have become an integral part of reporting in instances where aggregated values must be referenced and in the latest release and the steps needed to create this output have now been simplified into a single screen.
249
250 Simply select **Crosstab** from the **Type** drop-down list in the [[Data Sources >>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.a\. Creating a Data Source.WebHome]]screen and load the required [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] to configure the source values.
251
252 **Index Optimisation**
253 When Indexes are created on the system, the process used to determine the number of fields that are added to the Display Fields **Excluded** list has been optimised to facilitate higher-specification servers. This results in less fields automatically added to the list unnecessarily.
254
255 **Fusion Maps**
256 Changes to the Google Maps API mean that there is now a stricter limit on the number of map loads across an organisation. More information is available on the Google developer website: [[https:~~/~~/developers.google.com/maps/documentation/>>url:https://developers.google.com/maps/documentation/]]
257
258 Due to these changes, over 1,500 Fusion Maps have now been fully implemented into the latest [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] release. These offline maps provide unlimited map loading and, in many cases, an improved visual output.
259
260 [[image:25.png||queryString="width=534&height=378" height="378" width="534"]]
261
262 Configuration is handled at [[Index level>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome]] and can be added by opening the [[Maps>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome||anchor="Maps"]] section. Select **Fusion Maps** from the **Map** drop-down list and select the required region from the **Map Type** drop-down list. Select the required field from the **Code** drop-down list and click **Data Mapping** to open the configuration options.
263
264 Values from the Index must then be mapped to the matching location. Use the **Value** drop-down list to select the value that matches the entry in the corresponding **Map Area** and click **Save Map** to save the configuration.
265
266 [[image:26.png||queryString="width=346&height=285" height="285" width="346"]]
267
268 **Point-to-point Distance Calculation**
269 The load restrictions also apply to the Google Drivetime API. A new **Distance** option is now available in the [[Extra Fields>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.b\. Creating a Data Source Group.WebHome||anchor="Extra Fields"]] Data Source Group options to replicate this functionality and build the required values into the Index.
270
271 [[image:27.png||queryString="width=312&height=274" height="274" width="312"]]
272
273 Select **Distance** from the **Additional Index Fields** section and specify the two **Longitude** and **Latitude** values. Select the distance unit from the **Radius** radio buttons and click **Save** to complete the process. Once rebuilt, an extra column denoting the distance from the specified fields will be available.
274
275 **Extended Back-up Options**
276 Within the [[System>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome||anchor="System"]] tab of the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome]] screen, new options have been added to extend the automated back-up functionality to also include empty Index structures and reports.
277
278 [[image:28.png||queryString="width=587&height=248" height="248" width="587"]]
279
280 Select a time period from the relevant area to schedule the back-up procedure, which will execute automatically.
281
282 **Log Retention**
283 It is now possible to specify, in days, the length of time that the system log files will be retained using the [[Log Retention>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome||anchor="Log Retention"]] option in the [[System>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome||anchor="System"]] tab of the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome]].
284
285 **CXForms Indexes**
286 A new option has been added to stop [[CXForms>>doc:Technical Documentation.CXAIR.User Guide.CXFORMS.WebHome]] Indexes building automatically with every new submission. Disable the [[Index CXFORMS on Demand>>doc:Technical Documentation.CXAIR.Administration Guide.System Settings.WebHome]] option to apply this setting.
287
288 == Documentation ==
289
290 Following the move to online documentation in the [[2017.2 release>>doc:Release Notes.2017\.2.WebHome]], the CXWiki platform has been expanded to include a number of additional guides to assist with report creation.
291
292 The [[Reporting Guides>>doc:Technical Documentation.CXAIR.Reporting Guides.WebHome]] chapter has been written to include step-by-step report creation guides that utilise the latest reporting features for the 2019.1 release.
293