Skip to Content

Wiki source code of 05d. System Settings

Last modified by Kevin Strachan on 06/11/2025, 14:23
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 The System Settings are split into a number of tabs that reflect an area of functionality. Click **Modify** to save changes to the currently selected tab, or **Cancel** to discard changes.
6
7 = Paths =
8
9 Here the file paths for the different [[CXAIR >>doc:Technical Documentation.CXAIR.WebHome]]and [[CXFORMS>>doc:Technical Documentation.CXFORMS.WebHome]] directories can be edited.
10
11 Each System file path is listed next to the relevant file type. To make any changes, edit the path in the relevant textbox.
12
13 Please note that if modifying the paths for **Maps**, **Saved Reports**, **Audit Directory**, **SYS Directory**, **OEM Directory**, **Library Directory** or **Log Directory** [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] will need to be restarted for the changes to take effect.
14
15 = Performance Tuning =
16
17 The **Performance Tuning** tab provides a number of options that adjust operational behaviour to utilise available system resources.
18
19 [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] is optimised to take advantage of multi-threading to maintain a high level of performance when working with large volumes of data. By splitting operations into concurrent processes, numerous tasks can be carried out simultaneously to make optimal use of multiple CPU cores.
20
21 When data is analysed and returned to end users, whether running a query or loading a [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]], this is achieved through a number of data query processes. These processes are completed by splitting the queries into sub-queries that can be analysed using multiple threads to increase performance.
22
23 Changing the number of available threads per process and the number of sub-queries a data query is split into gives system administrators the ability to scale processes to match the projected system load and the available hardware.
24
25 Any changes made to the available options must be made with careful consideration of the target system as performance will not scale linearly with all changes. Doubling the amount of available threads, for example, will not double the processing throughput.
26
27 All recommendations are made under the assumption that the system specifications match the amount of data being processed and the required user output.
28
29 == Reports ==
30
31 **Exporters**
32 //The maximum number of processes used to export charts in parallel for each user.//
33
34 Due to the system-intensive nature of chart generation, limiting the number that can be processed simultaneously can be an effective way of preventing system-wide slowdown.
35
36 Increasing the number will allow more charts to be created at the same time, and should only be increased if there is enough memory and processor overhead to account for the extra load.
37
38 **Maximum Documents per Flow Report Section**
39 //The maximum number of documents that are displayed in a single Flow Report section before the data is truncated with a warning message.//
40
41 If a large number of documents are included in a [[Flow Report>>doc:Technical Documentation.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Reporting.2g\. Flow Reports.WebHome]] section, performance may be impacted when running the report. By setting a limit on the number of documents that can be displayed in a section, potential performance issues can be negated.
42
43 This should be set according to system specification and reporting requirements.
44
45 **Maximum Queued Query Time**
46 //Sets a time limit, in seconds, for data queries.//
47
48 Should a data query reach the specified time limit, the system will attempt to kill the process. This is to ensure that system resources are not drained by extremely large data queries. The instance is written to the system log.
49
50 **Maximum Query Queue Length**
51 //Sets a limit on the maximum amount of simultaneous data queries.//
52
53 As a precautionary measure, applying a value to this setting will limit the amount of simultaneous data queries before the system prevents any more users logging in. Administrators are still allowed access when this occurs.
54
55 This setting should only be used if extreme system slowdown is experienced and data queries have been identified as the cause.
56
57 **Index Upgrade Threads**
58 //The maximum number of threads used across the system when the Index upgrade process is running.//
59 Indexes created in a CXAIR version prior to 2020.2 will be automatically upgraded to the new Apache Lucene structure before they can be used. Increase this number to allocate more system resources to the Index upgrade process.
60
61 == Search ==
62
63 The following options should only be changed under advice from Connexica:
64
65 **Use isCurrent()**
66 //Enables a series of extra validation checks to denote whether the Index has been updated.//
67 This will increase Index build times and should only be enabled when troubleshooting.
68
69 **Enable Order**
70 //When executing a query containing multiple search terms, they will be re-ordered to return the results in the fastest time.//
71
72 This option will add an extra step to the query process where the search terms are re-ordered to execute in the most optimised order.
73
74 This may provide a performance boost to very large queries, but will have a detrimental effect on smaller queries. This is due to the addition of an extra process, and is only recommended if there are significant waiting times when conducting a large query.
75
76 **Index Access**
77 //The configuration of how indexes are read from disk.//
78
79 There are three options for index access, each offering a different approach for reading the files from disk.
80
81 The default option is **File System**, where index files are read directly from the disk with no optimisations. This may prove slower than other options, but is the least resource-intensive method.
82
83 The **New I/O** option optimises file access by making use of additional memory resources. While this may reduce access times, the system will use considerably more memory when multiple users are accessing indexes simultaneously.
84
85 The fastest but most resource-intensive option is **Memory Map**. This will map a selection of data into virtual memory, making the files available to the processor without input from the operating system’s page file to swap the files into memory first. This requires a large amount of memory overhead to ensure there is enough memory available for file allocation and other system processes.
86
87 **Undo Threads**
88 //The number of threads available to the Undo process in the front end.//
89
90 As users navigate the solution, the relevant Undo options are created asynchronously in a separate process. This value should be increased to reflect the number of simultaneous users to ensure that the Undo steps are created as quickly as possible.
91
92 = {{id name="System"/}}System =
93
94 **System Name**
95 //The name that appears in the browser’s URL bar and tabs.//
96
97 By default, the server name is used.
98
99 **{{id name="Webserver Timeout"/}}Webserver Timeout**
100 //The amount of time, in minutes, a session can remain inactive before the user is logged out.//
101
102 **Protocol**
103 //Select whether the CXAIR URL is accessed via HTTP or HTTPS.//
104
105 By default, HTTP is selected. It is recommended that HTTPS is selected during the post-install configuration.
106
107 **External Protocol**
108 //Allows either HTTP or HTTPS to be specified if a different protocol is required for external access.//
109
110 **External Host Name**
111 //The external name used to connect to the solution.//
112
113 This may be different to the internal host name.
114
115 **External Port Number**
116 //The external port number used to connect to the solution.//
117
118 This may be different to the internal port.
119
120 **External SSL Port Number**
121 //The external SSL port number used to connect to the solution.//
122
123 This may be different to the internal SSL port number.
124
125 **Force External Host**
126 //Forces redirects to always use the set external protocol, host and port.//
127 This should only be enabled to ensure compliance with specific security protocols.
128
129 **{{id name="iFrame"/}}Allow to Run in Frame**
130 //Enables the solution to be embedded into an Inline Frame (IFrame).//
131
132 **CXAIR Max Memory**
133 //The maximum amount of system memory, in MB, that the solution can access at any given time.//
134
135 As part of the install process, this value should be increased to match the available system memory. This value should be calculated based on the additional workload of the host - for a server running only CXAIR, a minimum of 4GB should be deducted to ensure the host operating system does not run out of memory.
136
137 **Indexer Max Memory**
138 //The maximum amount of memory, in MB, that the CXAIR Indexer process can access at any given time.//
139
140 This value should be set according to how many concurrent indexes are regularly being built on the system, and is independent of the above option.
141
142 The built-in garbage collection functionality dictates that the indexer process will work most efficiently with less memory, so should only be increased incrementally and tested to ensure performance is not reduced.
143
144 **Disk Space Threshold**
145 //The minimum amount of disk space, in MB, that the system must have available before an Index refresh can be executed.//
146
147 Use this option to ensure the system does not run out of disk space. The default value is 10240, approximately 10GB. If this limit is reached, the failure will be recorded in the system log and any user who attempts to manually refresh an Index will be notified.
148
149 **PD4ML Max Memory**
150 //The maximum amount of memory, in MB, that the PDF exporting process can access.//
151
152 This value should be set according to how many concurrent users will be exporting queries and reports to PDF format. Reducing this value is recommended if the server is impacted by multiple simultaneous exports.
153
154 **Pre-Cache Options**
155 //Forces the relevant area of functionality to be pre-cached when CXAIR is first run by the user. Left unchecked, pre-caching will only occur when the relevant index is searched.//
156
157 The **Display Fields**, **Totals** and **Dynamic Views** options all apply to their specific area of functionality, while **Links** applies to indexes and all linked search engines.
158
159 Pre-caching does not necessarily guarantee increased performance and is very memory intensive. The different options can be independently enabled so that individual areas do not consume memory unnecessarily.
160
161 **Debug**
162 //Enables additional debug features that are used to troubleshoot potential issues.//
163 This option should only be enabled under advice from Connexica.
164
165 **Backup Options**
166 //Specify the frequency that the CXAIR files will be backed-up to the CXAIR backup directory.//
167
168 Use the **Backup Database**, **Backup Export Empty Index Files**, **Backup Export Reports** and **Backup CXFORMS** drop-down lists to specify the required frequency that the internal backup process will run.
169
170 Please note that these options should **not** be used instead of pre-established backup routines and should be used to compliment a robust disaster recovery programme.
171
172 **{{id name="Encryption Key"/}}Encryption Key**
173 //The key that is used to encrypt fields with the relevant Obfuscation option selected//
174 When obfuscating fields at Data Source or Data Source Group level, select **Encryption** from the type menu to encrypt the field using the entered key.
175
176 **{{id name="Log Settings"/}}Log Level**
177 //Modifies the level of information that is recorded, with the choices ordered by most to least granularity.//
178 Do not change the **Log Level** unless advised to do so, as the information is used to diagnose potential issues.
179
180 **Log Pattern**
181 //Allows modification of the system logs format using the Apache Class 'PatternLayout'//
182 Default format: [%d{dd-MM-yy HH:mm:ss}] %-5p %t %c{2} %m%n
183
184 **{{id name="Log Retention"/}}Log Retention**
185 //The number of days that system logs are retained on the system before being deleted.//
186 If left blank, no log files will be deleted on the system.
187
188 **{{id name="Remote Monitoring"/}}Remote Monitoring URL**
189 //The URL of the CXAIR server that will be used to remotely monitor other CXAIR installs.//
190 The URL is entered in the following format: <server name>/cxair/servlet/insecure/remotemonitoring
191
192 **Remote Monitoring Servers**
193 //The IP addresses that will be remotely monitored.//
194 Enter the IP addresses of the CXAIR servers in a comma separated list.
195
196 = User Interface =
197
198 **{{id name="Skinning"/}}Default Skin**
199 //Select the system-wide skin that will be used by default.//
200
201 Please refer to the [[Skinning>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Appearance .WebHome||anchor="Skinning"]] chapter for more information regarding the creation of custom skins.
202
203 **Enable Index Linking**
204 //Toggles the Links Index configuration option.//
205
206 When enabled, the **Links** added in the [[Index configuration>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome||anchor="Links"]] are active for users in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen.
207
208 **{{id name="Import Files"/}}Import Files**
209 //Enables the importing of external files to be used as elements in the Dashboard, Flow Report and Pages functionality.//
210
211 **{{id name="Import File Types"/}}Import File Types**
212 //The supported file types that can be imported into CXAIR and uploaded as attachments in CXFORMS submissions when the above option is enabled.//
213
214 Use the dropdown list to select the required files, or click **All** to enable all options. Click **None** to deselect all options. To remove individual selections, click the **X** icon next to the relevant file type.
215
216 **Check For Missing Report Elements**
217 //Perform additional validation on reporting components within Pages reports in run mode.//
218
219 When enabled, a popup will be displayed to the end-user running the Pages report to inform of any missing elements within any of the reporting components.
220
221 For example, if a saved Query has been added to a Crosstab then removed from the load screen, the report will run but without the required filtering. Enabling this option ensures that the user is notified of this change.
222
223 == Query ==
224
225 **Display Blank Columns**
226 //Display all columns in the query screen, including those that do not contain data.//
227
228 **Sort Enabled**
229 //Provides the sort functionality in the Query screen for users.//
230
231 Enable this option to provide the options to sort columns in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen either **A-Z** or **Z-A**. Sorting large amounts of data is a memory-intensive operation, and should only be enabled if there is a significant overhead to accommodate the load. This can be alleviated with the below option.
232
233 **Maximum Sortable Results**
234 //Allows a limit to be set on the number of sortable results.//
235
236 As detailed above, the sorting option may prove too intensive when sorting large amounts of data. By enabling the above option and setting a limit of results, the functionality remains available when processing a pre-set number of values, but is no longer available for results that may impact system performance.
237
238 The maximum number of results should be set based on system specifications and reporting requirements.
239
240 **Show Indexes Alphabetically**
241 //Orders indexes alphabetically on the home screen and in search engines.//
242
243 When this option is not enabled, Indexes are sorted by the order set in the Search Engine list.
244
245 **Disable Auto Update Filters**
246 //Disables a query being automatically re-run once a filter is updated.//
247
248 With this option disabled, changing a [[filter>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2b\. Filters.WebHome]] value will re-run the current query to reflect the changes. With this option enabled, the query will have to be run manually for the data to match the [[filter>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2b\. Filters.WebHome]] values. This is used to reduce the potential impact of multiple users changing [[filter>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2b\. Filters.WebHome]] values simultaneously.
249
250 **Disable Context Specific Filters**
251 //Disables the use of context specific filters across all indexes.//
252
253 Enabling the **Context Specific** option for a filter adds additional processing to ensure values that have been omitted by a query or another filter are not displayed. Should this impact performance when a large number of concurrent users are accessing the system, this option can be enabled to hide the **Context Specific** option from the filter setup.
254
255 **Maximum Field Values**
256 //The maximum number of entries that can appear when exposing field values.//
257
258 The entered value will act as a hard limit to prevent any further entries items appearing after the specified amount when clicking column headings in the Query screen or the **...** icon for fields when creating Crosstabs. This can be used to negate any potential performance impacts that may occur when too many items are loaded at once.
259
260 **{{id name="Maximum Drop List Items"/}}Maximum Drop List Items**
261 //The maximum number of entries that can appear in a drop list.//
262
263 The entered value will act as a hard limit to prevent any further drop list items appearing after the specified amount. This can be used to negate any potential performance impacts that may occur when too many items are loaded at once.
264
265 **Maximum Checkbox & Radio Items**
266 //The maximum number of entries that can appear in a Checkbox or Radio Button list.//
267
268 The entered value will act as a hard limit to prevent any further items appearing after the specified amount. This can be used to negate any potential performance impacts that may occur when too many items are loaded at once.
269
270 **{{id name="Limit Drop List Items"/}}Limit Drop List Items**
271 //Reduces the number of values displayed in column heading dropdown lists across all indexes.//
272
273 This soft limit can be applied globally using this setting, or for individual indexes where this setting is also available.
274
275 **Force Strict Syntax**
276 //Applies strict syntax rules for every query across the system.//
277
278 By default, the system will use Lazy Syntax for running queries. If a field used within a query no longer exists or the name is incorrect (such as a spelling mistake or the field has changed name), the field is ignored and is not used as part of the query.
279
280 With Strict Syntax applied, data is not displayed when there are incorrect field names in the query syntax and an error message is displayed when viewed in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen.
281
282 Using the **Cog** icon in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen, users can toggle between which syntax is used. This option is Index specific and session-based.
283
284 By enabling this system setting, strict syntax is used system-wide by default.
285
286 Please note that this will have an impact on Pages reports containing tile-specific drill options. When passing the drill context onto a tile containing components from another Index, it will not produce any results if the generated context contains fields that do not exist in the second Index.
287
288 == Export ==
289
290 **Default Export Page Range**
291 //The page range that is pre-populated in the Document Options when in the Export screen.//
292
293 **Max Rows a User Can Export To Excel From Query**
294 //Sets a hard limit on the number of rows that can be exported into the Excel format from a query.//
295
296 **Excel Footer**
297 //Specifies a footer that will be added to the bottom of every Excel export.//
298
299 **Automatically Size Columns in Excel Exports**
300 //Sets the width of the columns in all exported Excel reports based on the amount of contained data.//
301
302 **Rename CSV Headings on Export**
303 //Overwrite the original headings with those specified in CXAIR when exporting.//
304
305 **Limit Group Administrator Export**
306 //Only permit group administrator users to export reports via email to users within their own user group.//
307
308 == Pages ==
309
310 **{{id name="Enable Embedded Content"/}}Enable Embedded Content**
311 //Toggles the availability of the [[Embed>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.WebHome||anchor="Embed"]] reporting component in [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.WebHome]] reports.//
312
313 **{{id name="Enable Source Code in Text Elements"/}}Enable Source Code in Text Elements**
314 //Toggles the availability of the Source Code option when editing a [[text>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.WebHome||anchor="Text"]] reporting component.//
315
316 When editing a [[text component>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.WebHome||anchor="Text"]], clicking **Tools** then **Source Code** allows users to enter additional HTML styling parameters. Disabling this option removes the **Tools** option for all users across the system.
317
318 **Byte Order Mark**
319 //Toggles the Byte Order Mark setting in Report Export options on or off by default.//
320 May be required for certain special characters to render correctly in Windows based applications. For example, Norwegian special characters in Excel on Windows OS.
321
322 == Dashboard ==
323
324 **Maximum Splits per Dashboard Window**
325 //The number of sections an individual Dashboard window can be split into.//
326
327 **Maximum Dashboard Rows & Columns**
328 //The limit of rows and columns that can be added to a dashboard window segment.//
329
330 == Crosstab ==
331
332 **Lowest Number of Values Displayed**
333 //Sets the lowest number of results to display before the number is hidden.//
334
335 This prevents unique records identifying individuals.
336
337 **Number Rounding Method**
338 //Sets how numbers are rounded in Crosstabs.//
339
340 Selecting **Half Up** will result in values being rounded up if containing an integer greater to or equal to .5. For example, 10.5 will be rounded up to 11.
341
342 **Half Down** will round down when this occurs, while .6 and above is rounded up. For example, 10.5 will be rounded down to 10, but 10.6 will be rounded up to 11.
343
344 **Half Even** rounding will round values to the nearest even whole number. For example, 11.5 is rounded up to 12, and 10.5 is rounded to 10.
345
346 Selecting **Up** will result in values being rounded up to the nearest whole number. For example, 10.3 will be rounded up to 11.
347
348 Selecting **Down** will result in values being rounded down to the nearest whole number. For example, 10.8 will be rounded down to 10.
349
350 **Use Rounded Cell Calculation Values**
351 //When enabled, Cell Calculations will be calculated using the displayed values.//
352
353 Disable this option to calculate Cell Calculations from the actual values, rather than the displayed values that may have been formatted for display purposes such as truncating decimal places, for example.
354
355 **Enable Row Total**
356 //Enables the row total functionality in Crosstabs.//
357
358 When enabled, the Row Total option will appear in the **Total Type** drop-down list.
359
360 **Chart Theme**
361 //The default chart theme applied if no theme is specified by the user.//
362
363 **Maximum Intersections**
364 //The maximum number of intersections that a Crosstab or Dashboard can contain before the ‘Large Crosstab’ warning popup box appears.//
365
366 The value entered will act as a hard limit to constrain how many cells with values can be displayed in the [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] and [[Dashboard>>doc:Technical Documentation.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Reporting.2f\. Dashboards.WebHome]] functionality areas.
367
368 Should the limit be reached, users will be presented with the option the run the report as a background task.
369
370 When blank, there will be no limit. It is recommended that this is left unchanged to accommodate reporting requirements, and only changed to prevent excessive resource usage.
371
372 **Maximum Query Time**
373 //The maximum length of time, in seconds, that a Crosstab will generate for before the ‘Large Crosstab’ warning popup box appears.//
374
375 To warn users that a currently generating [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] may need to run in the background, set a time limit that, once exceeded, will result in the option to run it in the background.
376
377 This is useful to warn end-users of a potential error or to allow them to complete other tasks while waiting. Removing the limit is not recommended, as generating an excessively large [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] will consume considerable system resources and users will be unable to complete other tasks.
378
379 **Maximum Number of Hits to Run a Crosstab in Real Time**
380 //The maximum number of records contained in a Crosstab before the ‘Large Crosstab’ warning popup box appears.//
381
382 This setting can be used independently or in conjunction with the above option to ensure that users do not also exceed the number of records in a [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]]. When the limit is reached, the option to run it in the background will appear.
383
384 This is useful to warn end-users of a potential error and to allow them to complete other tasks while waiting. If using this option, it is recommended that it is used to compliment the above option to have an additional threshold in which to identify large [[Crosstabs>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]], rather than using this value independently.
385
386 **Enable Crosstab and Dashboard Caching**
387 //Caches the current Crosstab or Dashboard for increased performance when reloading.//
388
389 Leave this option enabled to increase performance when switching between the Edit and Run modes of the current [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] or [[Dashboard>>doc:Technical Documentation.Legacy Documentation.CXAIR 2017\.2.User Guide (2017\.2).02\. Reporting.2f\. Dashboards.WebHome]].
390
391 This option should only be disabled for debugging purposes.
392
393 **Validate Row Totals**
394 //Validates every included row total when running a Crosstab.//
395
396 Enable this option to validate all row totals before displaying the resulting [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]]. If a calculation has become invalid, it will be highlighted.
397
398 Please note that enabling this option will impact rendering performance.
399
400 **Maximum Crosstab Drop List Items**
401 //The maximum number of entries than can appear in a drop list or Row Total calculation in the Crosstab functionality.//
402
403 The entered value will act as a hard limit to prevent potential system slowdown if a large number of entries are loaded. This option applies to [[Crosstab >>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]]functionality only.
404
405 **Auto Group Crosstab Rows**
406 //Sets the ‘Group Crosstab Rows’ option in Crosstabs to be enabled by default.//
407
408 **{{id name="Locked Headers Enabled"/}}Locked Headers Enabled **
409 //Sets the column headers to stay in place when scrolling down in the query screen.//
410
411 This can also bet set at index level, and will not activate for indexes that have had this option disabled.
412
413 Due to the resource-intensive nature of data retrieval, having this option enabled while running large queries may result in reduced performance.
414
415 **Legacy Chart Rendering**
416 //Draws charts using the legacy charting engine.//
417
418 Enable this option to display charts using the previous version of the built-in charting library.
419
420 **Preview Cells Size**
421 //Specify the maximum number of cells from the Index will be loaded to render the Crosstab preview.//
422
423 **Preview Query Records**
424 //Specify the maximum number of records from the Index will be loaded to render the Crosstab preview for each cell.//
425
426 **Use Raw Numbers**
427 //Forces Crosstabs to use the raw Index data rather than formatted Index data. Default setting is OFF.//
428
429 When enabled, the Crosstab standard calculations (not Cell Calculations) will use the raw data in the Index rather than the values that have been formatted in the Index. So with the setting OFF, if the raw data value is 9.12689 and the Index is formatted to show this as 2 decimal places, the value used will be 9.13. With the setting ON, the formatted value will be used for display but calculations will use 9.12698.
430
431 == Administration Area ==
432
433 **Configuration Area Page Size**
434 //Controls the maximum number of displayed entries per page in the Admin screens.//
435
436 This value applies to the every screen containing paged lists.
437
438 **Admin Search Levenshtein Distance**
439 //Specifies the matching level of the Admin query functions.//
440
441 The value must be between 0-1. The closer to 1, the less fuzzy the search.
442
443 **Active Wizards**
444 //Specifies the wizards available to administrators.//
445
446 Use the dropdown list to select the required wizard, or click **All** to enable all options. Click **None** to deselect all options. To remove individual selections, click the **X** icon next to the relevant wizard.
447
448 **Send Reset Password on User Create**
449 //Automatically send a confirmation email to all new users.//
450
451 **Show Admin Popups**
452 //Displays configuration options in a popup window rather than in a separate screen.//
453
454 Configuration options, such as when the **Edit** icon is clicked in the Indexes screen, will be displayed inside a popup window rather than navigating to a separate page when enabled.
455
456 == Links ==
457
458 **Privacy Policy**
459 //Enter a URL that can be used to access the relevant privacy policy on the login screen.//
460
461 **Cookie Policy**
462 //Enables the Cookie Policy option in the login screen that details the cookies used by CXAIR.//
463
464 **Administration Guide URL**
465 //The URL used to access the online Administration Guide from the CXAIR Admin area.//
466
467 **User Guide URL**
468 // The URL used to access the online User Guide from the CXAIR front-end.//
469
470 **CXFORMS Guide URL**
471 // The URL used to access the online User Guide for CXFORMS.//
472
473 **CXAIR Viewer Guide URL**
474 // The URL used to access the online User Guide for the Report Viewer interface.//
475
476 **Support**
477 // The URL used to access the Support page from the CXAIR front-end and Admin area.//
478
479 **Website**
480 // The URL used to access the company website from the CXAIR front-end and Admin area.//
481
482 = {{id name="CXAIR Viewer"/}}CXAIR Viewer =
483
484 The following options relate to the [[Report Viewer>>doc:Technical Documentation.CXAIR.User Guide.7\. Report Viewer.WebHome]] functionality:
485
486 **Show Search Bar**
487 //Enables the query bar for Report Viewer users to further filter the data when viewing row-level data as the result of a report drill through.//
488
489 **Show Previews**
490 //Display generated previews for reports.//
491
492 **Allow Users to Change Filters**
493 //Provides the option to change and use reporting filters.//
494
495 **Default User Type**
496 //Specifies the default Viewer user type.//
497
498 The default option will be set to **CXAIR Viewer User**, where the user is restricted to the functionality provided by Viewer and cannot use CXAIR to change or modify reports.
499
500 The Static Viewer User option refers to users who cannot filter data while selecting the **Full User** option will create a standard CXAIR user who can log into and access the full [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]] solution, subject to permissions.
501
502 **No Log Out**
503 //Disables the Log Out feature.//
504
505 **Show Navigation**
506 //Toggles the display of the folder navigation options.//
507
508 **Show Hierarchy Popups**
509 //Toggles the activation of popup hierarchy charts in the Report Viewer interface.//
510
511 Hierarchical links are specified at Index level. Please refer to the [[Hierarchy>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome||anchor="Hierarchy"]] section of the [[Creating an Index>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.c\. Creating an Index.WebHome]] chapter for more information.
512
513 **Show Initial Card**
514 //Toggles the default CXAIR card located at the top-left of the Report Viewer home screen.//
515
516 **Show Report Options**
517 //Toggles the availability of the Query screen **Cog** icon when viewing data in the Report Viewer interface.//
518
519 **Landing Page**
520 //Sets the default URL used to access the Viewer functionality.//
521
522 When blank, users can access the Report Viewer interface using the folloiwng URL:
523
524 **<server name or IP address>:<port number>/cxair/ui/reportviewer**
525
526 Enter a value using this textbox to modify the URL. For example, entering **/internal-reporting** would result in the following URL:
527
528 **<server name or IP address>:<port number>/internal-reporting**
529
530 Please note that the entry must start with a forward slash (**/**) and that spaces are not supported.
531
532 = CXFORMS =
533
534 **Online Only**
535 //When enabled, distributed forms can only be completed when connected to the internet.//
536
537 Disabling this option allows users to download forms as HTML files to complete while offline over multiple sessions before submitting when internet connectivity is re-established. Should the end user clear their browser cache, progress will be erased.
538
539 Completing forms online ensures the highest level of compatibility across platforms, and as such this option should only be disabled under advice from Connexica.
540
541 **Clam Anti Virus Command**
542 //The command that is passed to the configured anti virus solution for file uploads.//
543
544 **Clam Anti Virus Enabled**
545 //Enables the configured anti virus solution for file uploads.//
546
547 **Show Print Button**
548 //Enables the PDF printing functionality for CXFORMS.//
549
550 **{{id name="Index CXFORMS on Demand"/}}Index CXFORMS on Demand**
551 //Enable this option to stop CXFORMS Indexes automatically building when a form has been submitted. The required Index can then be refreshed manually.//
552
553 = Locale =
554
555 **Locale**
556 //Sets the required number display formatting for the required country.//
557
558 **Default Language**
559 //Sets the language that the solution will default to.//
560
561 **Time Zone**
562 //Specifies the time zone used by the solution.//
563
564 **Auto Time Zone**
565 //Enables location-based time zone detection.//
566
567 **Format Options**
568 //Specifies the default format set per field type at the time of indexing.//
569
570 The options include **Integer Format**, **Decimal Format**, **Date Format**, **Time Format**, **Date Time Format**, **Month of Fiscal Year** and **First Day of Week**.
571
572 **Month Of Fiscal Year**
573 //Specifies the first month of the fiscal year, referenced when conducting dynamic date queries and calculations.//
574
575 **First Day of Week**
576 //Specifies the starting point when utilising dynamic date syntax.//
577
578 For example, when FIRST_DAY_OF_WEEK is used as part of a calculation or the query bar, it will refer to this value as the start of the week. Please refer to the [[Date Parsing Syntax>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome||anchor="DPS"]] section of the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] chapter for more information regarding the available dynamic syntax.
579
580 **{{id name="Working Days"/}}Working Days**
581 //Specifies the days classed as working days.//
582
583 By setting the working days, additional schedules, calculation functions and query syntax become available. Please refer to the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome||anchor="DPS"]] chapter for more information.
584
585 **{{id name="Holidays"/}}Holidays**
586 //Specify the bank holidays that will be excluded from working day calculations and working day schedules.//
587
588 Dates must be entered in the date format specified in the above **Date Format** option.
589
590 **Decimal Places**
591 //Specify the maximum number of permitted decimal places for a field value.//
592
593 Changing this value requires a restart for the new format to become available.
594
595 = Indexing =
596
597 **Crawler Threads**
598 //The maximum number of threads permitted when building a Data Source Group with multiple Data Sources.//
599 By leaving this value blank, the system will dynamically allocate the maximum number of threads to build the Data Source Group as quickly as possible.
600
601 If, however, there are multiple Data Sources, this may use more resources than desired. This is due to each Data Source requiring its own thread in order to complete tasks in parallel.
602
603 Specifying a value for this option will limit the thread pool used when building Data Source Groups from multiple Data Sources, and should only be used if build processes are identified as the root cause of system slow-down or if system resources need to be managed with a greater level of granularity.
604
605 **Index Threads**
606 //The number of threads available to modify indexes.//
607
608 This value should be set according to how many concurrent indexes are regularly being built on the system, with each index requiring at least one thread. This value must be 1 or more.
609
610 **Aggregation Threads**
611 //The number of threads available to build aggregated indexes.//
612
613 This value should be set according to how many concurrent aggregated indexes are regularly being built on the system. Due to the system-intensive nature of the process, two threads per aggregated index is recommended. This value must be 1 or more.
614
615 **Retrieval Threads**
616 //The number of threads available to retrieve documents from unstructured data file stores.//
617
618 Unstructured data sources, such as PDF files and websites, require an initial retrieval process to track the location of the required data. This information is then passed to the extraction process.
619
620 The threads available to the retrieval process should be based on the maximum number of simultaneous users searching across unstructured documents, with each user given at least one thread.
621
622 **Retrieval Rate**
623 //The number of bytes per second that are processed when retrieving documents from unstructured data file stores.//
624
625 Specifying this option provides greater control over the speed of retrieval, allowing a data transfer cap to be applied to the retrieval process.
626
627 **Extract Threads**
628 //The number of threads available to extract information from retrieved documents.//
629
630 Following retrieval, the extraction process is used to obtain the matched information from unstructured documents. This memory-intensive process benefits from the allocation of additional threads, but may negatively impact other system processes if set too high.
631
632 It is recommended that the number of threads is increased in small increments to monitor any potential performance improvements that can be gained without draining system resources from other tasks.
633
634 **Extract Rate**
635 //The number of bytes per second that are processed when extracting information from retrieved documents.//
636
637 Specifying this option provides greater control over the speed of extraction, allowing a data transfer cap to be applied to the retrieval process.
638
639 **Text Mining Threads**
640 //The number of threads available when performing text mining on Index fields.//
641
642 Due to the resource intensive nature of text mining, providing the maximum number of processing threads possible will dramatically reduce the time taken to scan the required fields.
643
644 Please note that the text mining functionality is not present in the current release and this option has been added for future development purposes.
645
646 **Document Timeout**
647 //The time, in seconds, that will be spent extracting the contents of an unstructured document. Once the time limit has been reached, the extraction process will be terminated.//
648
649 Due to the memory-intensive nature of the extraction process, multiple processes may place too much of a drain on system resources if not managed. By specifying a time limit, documents that take too long to process will not be included in the index.
650
651 It is recommended that a limit is used to ensure unnecessarily large files do not have a negative impact on the rest of the system. The default setting of 180 seconds is sufficient for large files to be processed, but should be adjusted to suit system load and to negate potential performance issues.
652
653 Documents that fail to be processed in the specified time are queued up in the processing pipeline and the instance will be noted in the system log.
654
655 **Processor Sleep**
656 //The time, in milliseconds, that the processor will pause for when re-indexing queued files.//
657
658 Processors have a limited pipeline in which to complete assigned tasks. This is dictated by a number of factors, such as clock-speed, cache size and the number of cores available. Regardless of advertised processing power, every processor will reach a limit of operations that can completed simultaneously without slowdown.
659
660 When multiple processes are queued for completion, such as scheduled indexes, and new processes are being generated, such as queries, the pipeline may fill, leading to a reduction in on-demand performance.
661
662 By specifying a time that the processor will pause for in-between re-indexing queued files, the load can be managed to ensure new tasks are still being completed in a timely manner. This setting is especially useful for systems with limited processing power, as the load can be effectively managed to slow processes that may not have an immediate impact on perceived speed by end-users.
663
664 Increasing the value will greatly reduce the processing throughput when re-indexing. For example, a value of 1 may result in as much as a tenfold reduction in indexing throughput.
665
666 It is recommended that this setting only be used in circumstances where the re-indexing processes are the cause of extreme system slowdown for end-users.
667
668 **Maximum File Size**
669 //The maximum size, in MB, of individual files that can be indexed when building Unstructured Indexes.//
670
671 Setting a maximum file size ensures that system resources are not too heavily impacted when multiple concurrent Unstructured Indexes are built. Increasing the allowed file size will increase the amount of memory used by each indexing process.
672
673 It is recommended that, subject to requirements, a limit is used to reduce the memory load when indexing. The default setting of 10MB may need to be increased or decreased based on the processing requirements and amount of available system memory.
674
675 When building an Unstructured Index from a directory, files that do not adhere to the specified limit are queued up in the processing pipeline and the instance is noted in the system log.
676
677 **Maximum Archive Size**
678 //The maximum size, in MB, of archive files that can be indexed.//
679
680 This setting applies to archive files, such as .zip and .rar files, that are included in an unstructured Index build. Please refer to the above option for more information regarding file size.
681
682 **Message Queue Size**
683 //The number of documents that can be queued between the individual process that constitute the CXAIR Audit index before a warning message is written to the log.//
684
685 When building the [[Audit Index>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.5f\. Audit Index.WebHome]], this value controls the number of documents that can be queued between the individual processes: crawling, extracting and building.
686
687 This value should increase alongside the number of index threads to allow an increased buffer for documents to be queued. If the number of documents exceeds this value, the performance is impacted.
688
689 **Message Queue Size Check Period**
690 //The amount of time, in seconds, between a new warning message being written to the log if the queue size is exceeded.//
691
692 If the above value is exceeded multiple times, multiple instances of the same warning message may be written to the log.
693
694 Setting this value will stop a new message being written for a certain amount of time, giving the process time to work through the queued documents before issuing a new warning message.
695
696 **Message Queue Size Check Period**
697 //The amount of time, in seconds, between a new warning message being written to the log if the queue size is exceeded.//
698
699 If the above value is exceeded multiple times, multiple instances of the same warning message may be written to the log.
700
701 Setting this value will stop a new message being written for a certain amount of time, giving the process time to work through the queued documents before issuing a new warning message.
702
703 **Max Index Log Size **
704
705 This is the maximum size of a log file. If exceeded the system will automatically archive the log file by renaming it and creating a new one.
706
707 **Index Logs**
708 //Toggles the logging of files that contain the progress of index build processes.//
709
710 When enabled, indexes will build at a slower rate with a complete audit trail.
711
712 **Treat Nulls as Zero**
713 //Displays a zero instead of a null value when creating Crosstabs and charts.//
714
715 **Add All Column Types To Free Text**
716 //Adds every column to the Free Text Selected list and removes any entries from the Excluded Selected list when creating a new Database Data Source.//
717
718 Please note that this option should only be enabled if the required fields are not added automatically as this will dramatically increase the size of the Index on disk.
719
720 **Analyser**
721 //The default text analyser used for index fields.//
722
723 The selected analyser is used to detect and convert index fields into the correct function when configuring the **Column Mapping** options.
724
725 **Coalesce after Incremental / Cumulative / Timeline Index Build**
726 //Sets whether to compile all previous builds into a single file following a successful build process.//
727
728 **{{id name="Stop Words"/}}Stop Words**
729 //Words that are excluded from the Word Cloud functionality.//
730
731 **{{id name="Derive Options"/}}Derive Date Field Date / Number / String Values**
732 //Select the field types that are created when deriving new date values when selected in the **Derived Dates** tab.//
733
734 Please note that selecting Fiscal in the [[Derived Dates>>doc:Technical Documentation.CXAIR.Administration Guide.Wizards.Database Data Source Wizard.WebHome||anchor="Derived Dates"]] tab will overwrite these options.
735
736 **Schedule Failures**
737 //The number of times a failed index schedule will retry the build before the process moves on to the next queued item.//
738 Please only change this option under advice from Connexica.
739 When an Index build schedule fails, the default behaviour is to reattempt the build process. Use this option to specify the number of attempts that will be made before rescheduling the next build according to the schedule.
740
741 **Schedule Clear Down**
742 //When enabled, the Index build schedule will be cleared at midnight to ensure schedules start at the correct time the next day.//
743 Please only change this option under advice from Connexica.
744 Should any schedules for the current day not complete by midnight, they are cleared from the queue. This prevents failing schedules from blocking the schedule queue on the following day. Please ensure that schedules can complete within this time frame before enabling this option, as clearing down the queue before they have chance to run will result in Indexes not being updated.
745
746 **Scheduling Enabled**
747 //Permits Index build schedules to run on the system.//
748 Please only change this option under advice from Connexica.
749 Clear this checkbox to disable all scheduled Index builds.
750
751 **Reset All Build Schedules**
752 //Clears the current build queue and resets the scheduling task.//
753 Please only change this option under advice from Connexica.
754
755 = Email =
756
757 Select the type of email service to be used:
758
759 == SMTP ==
760
761 **Server**
762 //The name or IP address of the required mail server.//
763
764 **Port**
765 //The port on which the mail server is running.//
766
767 **Use Authentication**
768 //Enables authentication methods on the mail server.//
769
770 **Use TLS**
771 //Toggles the use of Transport Layer Security for email accounts.//
772
773 **Login**
774 //The login name used to allow access to the mail server.//
775
776 **Password**
777 //The password used to allow access to the mail server.//
778
779 **From Address**
780 //The address that will appear as the ‘From’ address on any emails sent by a user who does not have an email address configured for their CXAIR user account.//
781
782 **Reply-to Address**
783 //The address that will appear as the ‘Reply To’ address on any emails sent by a user who does not have an email address configured for their CXAIR user account.//
784
785 **Retry Failed Timing**
786 //The period of time following a failed email before the next attempt is made.//
787
788 **Connection Timeout**
789 //The time, in seconds, before the connection to the specified email server times out after no response.//
790
791 Should the default value of 30 (seconds) not be sufficient, it is recommended that this value is increased to 60 (seconds).
792
793 **Allow Sending to Non-CXAIR Users**
794 //Toggles the ability for users to export reports to email addresses not stored within CXAIR.//
795 When enabled, manually exporting a saved report to Email will reveal an **Add New Recipient** option where an external email address can be entered. Please note that scheduled reports can only be sent to email addresses associated with active CXAIR users.
796
797 **Mail Receipt Acknowledgement**
798 //Toggles read receipts for emails sent via the configured email server.//
799
800 **Mail Debugging**
801 //Enables additional debug features that are used to troubleshoot potential issues.//
802
803 This should only be enabled under advice from Connexica.
804
805 == Amazon Simple Email Service (SES) ==
806
807 **Region**
808 //The Amazon region managing the SES.//
809
810 **From Address**
811 //The address that will appear as the ‘From’ address on any emails sent by a user who does not have an email address configured for their CXAIR user account.//
812
813 **Reply-to Address**
814 //The address that will appear as the ‘Reply To’ address on any emails sent by a user who does not have an email address configured for their CXAIR user account.//
815
816 **Retry Failed Timing**
817 //The period of time following a failed email before the next attempt is made.//
818
819 **Allow Sending to Non-CXAIR Users**
820 //Toggles the ability for users to export reports to email addresses not stored within CXAIR.//
821 When enabled, manually exporting a saved report to Email will reveal an **Add New Recipient** option where an external email address can be entered. Please note that scheduled reports can only be sent to email addresses associated with active CXAIR users.
822
823 **Mail Receipt Acknowledgement**
824 //Toggles read receipts for emails sent via the configured email server.//
825
826 **Mail Debugging**
827 //Enables additional debug features that are used to troubleshoot potential issues.//
828
829 This should only be enabled under advice from Connexica.
830
831 = {{id name="Third-Party"/}}Third-Party Settings =
832
833 This tab contains the options to specify third-party account access information. Generate the required key string by clicking the relevant **click here** text, or enter it manually if the key is already known.
834
835 The **R Server URL** option allows the required URL to be entered for access within the solution.
836
837 = Third-Party Paths =
838
839 Here the file paths for the different third-party components can be edited. Each system file path is listed next to the relevant file type, and can be changed using the textbox.
840
841 = {{id name="Audit"/}}Audit =
842
843 The [[Audit Index>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.5f\. Audit Index.WebHome]] options allow system administrators to configure the timing and included components of the built-in [[Audit Index>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.5f\. Audit Index.WebHome]].
844
845 Select a time frequency from the **Index Audit Trail Every** dropdown list, and use the **Only Index Audit Trail After** and **Only Index Audit Trail Before** options to specify a window when the indexing process can complete without impacting system resources at a time when they are required.
846
847 The maximum number of queued audit items can be configured using the **Audit Queue Length** option. When this limit is reached, the process will wait for it to empty before queuing further audit components.
848
849 Use the **Audit Types** dropdown list to select the required functionality areas, or click **All** to enable all options. Click **None** to deselect all options. To remove individual selections, click the **X** icon next to the relevant file type.