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.

Paths

Here the file paths for the different CXAIR and CXFORMS directories can be edited.

Each System file path is listed next to the relevant file type. To make any changes, edit the path in the relevant textbox.

Please note that if modifying the paths for Maps, Saved Reports, Audit Directory, SYS Directory, OEM Directory, Library Directory or Log Directory CXAIR will need to be restarted for the changes to take effect.

Performance Tuning

The Performance Tuning tab provides a number of options that adjust operational behaviour to utilise available system resources.

CXAIR 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.

When data is analysed and returned to end users, whether running a query or loading a Crosstab, 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.

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.

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.

All recommendations are made under the assumption that the system specifications match the amount of data being processed and the required user output.

Reports

Exporters
The maximum number of processes used to export charts in parallel for each user.

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.

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.

Maximum Documents per Flow Report Section
The maximum number of documents that are displayed in a single Flow Report section before the data is truncated with a warning message.

If a large number of documents are included in a Flow Report 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.

This should be set according to system specification and reporting requirements.

Maximum Queued Query Time
Sets a time limit, in seconds, for data queries.

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.

Maximum Query Queue Length
Sets a limit on the maximum amount of simultaneous data queries.

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. 

This setting should only be used if extreme system slowdown is experienced and data queries have been identified as the cause.

Index Upgrade Threads
The maximum number of threads used across the system when the Index upgrade process is running.
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.

Search

The following options should only be changed under advice from Connexica:

Use isCurrent()
Enables a series of extra validation checks to denote whether the Index has been updated.
This will increase Index build times and should only be enabled when troubleshooting.

Enable Order
When executing a query containing multiple search terms, they will be re-ordered to return the results in the fastest time.

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.

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.

Index Access
The configuration of how indexes are read from disk.

There are three options for index access, each offering a different approach for reading the files from disk.

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.

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.

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.

Undo Threads
The number of threads available to the Undo process in the front end.

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.

System

System Name
The name that appears in the browser’s URL bar and tabs.

By default, the server name is used.

Webserver Timeout
The amount of time, in minutes, a session can remain inactive before the user is logged out.

Protocol
Select whether the CXAIR URL is accessed via HTTP or HTTPS.

By default, HTTP is selected. It is recommended that HTTPS is selected during the post-install configuration.

External Protocol
Allows either HTTP or HTTPS to be specified if a different protocol is required for external access.

External Host Name
The external name used to connect to the solution.

This may be different to the internal host name.

External Port Number
The external port number used to connect to the solution.

This may be different to the internal port.

External SSL Port Number
The external SSL port number used to connect to the solution.

This may be different to the internal SSL port number.

Force External Host
Forces redirects to always use the set external protocol, host and port.
This should only be enabled to ensure compliance with specific security protocols.

Allow to Run in Frame
Enables the solution to be embedded into an Inline Frame (IFrame).

CXAIR Max Memory
The maximum amount of system memory, in MB, that the solution can access at any given time.

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. 

Indexer Max Memory
The maximum amount of memory, in MB, that the CXAIR Indexer process can access at any given time.

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.

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.

Disk Space Threshold
The minimum amount of disk space, in MB, that the system must have available before an Index refresh can be executed.

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.

PD4ML Max Memory
The maximum amount of memory, in MB, that the PDF exporting process can access.

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.

Pre-Cache Options
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.

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.

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.

Debug
Enables additional debug features that are used to troubleshoot potential issues.
This option should only be enabled under advice from Connexica.

Backup Options
Specify the frequency that the CXAIR files will be backed-up to the CXAIR backup directory.

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.

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.

Encryption Key
The key that is used to encrypt fields with the relevant Obfuscation option selected
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.

Log Level
Modifies the level of information that is recorded, with the choices ordered by most to least granularity.
Do not change the Log Level unless advised to do so, as the information is used to diagnose potential issues.

Log Pattern
Allows modification of the system logs format using the Apache Class 'PatternLayout'
Default format: [%d{dd-MM-yy HH:mm:ss}] %-5p %t %c{2} %m%n

Log Retention
The number of days that system logs are retained on the system before being deleted.
If left blank, no log files will be deleted on the system.

Remote Monitoring URL
The URL of the CXAIR server that will be used to remotely monitor other CXAIR installs.
The URL is entered in the following format: <server name>/cxair/servlet/insecure/remotemonitoring

Remote Monitoring Servers
The IP addresses that will be remotely monitored.
Enter the IP addresses of the CXAIR servers in a comma separated list.

User Interface

Default Skin
Select the system-wide skin that will be used by default.

Please refer to the Skinning chapter for more information regarding the creation of custom skins.

Enable Index Linking
Toggles the Links Index configuration option.

When enabled, the Links added in the Index configuration are active for users in the Query screen.

Import Files
Enables the importing of external files to be used as elements in the Dashboard, Flow Report and Pages functionality.

Import File Types
The supported file types that can be imported into CXAIR and uploaded as attachments in CXFORMS submissions when the above option is enabled.

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.

Check For Missing Report Elements
Perform additional validation on reporting components within Pages reports in run mode.

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.

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.

Query

Display Blank Columns
Display all columns in the query screen, including those that do not contain data.

Sort Enabled
Provides the sort functionality in the Query screen for users.

Enable this option to provide the options to sort columns in the Query 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.

Maximum Sortable Results
Allows a limit to be set on the number of sortable results.

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.

The maximum number of results should be set based on system specifications and reporting requirements.

Show Indexes Alphabetically
Orders indexes alphabetically on the home screen and in search engines.

When this option is not enabled, Indexes are sorted by the order set in the Search Engine list.

Disable Auto Update Filters
Disables a query being automatically re-run once a filter is updated.

With this option disabled, changing a filter 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 values. This is used to reduce the potential impact of multiple users changing filter values simultaneously.

Disable Context Specific Filters
Disables the use of context specific filters across all indexes.

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.

Maximum Field Values
The maximum number of entries that can appear when exposing field values.

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.

Maximum Drop List Items
The maximum number of entries that can appear in a drop list.

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.

Maximum Checkbox & Radio Items
The maximum number of entries that can appear in a Checkbox or Radio Button list.

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.

Limit Drop List Items
Reduces the number of values displayed in column heading dropdown lists across all indexes.

This soft limit can be applied globally using this setting, or for individual indexes where this setting is also available.

Force Strict Syntax
Applies strict syntax rules for every query across the system.

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.

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 screen.

Using the Cog icon in the Query screen, users can toggle between which syntax is used. This option is Index specific and session-based.

By enabling this system setting, strict syntax is used system-wide by default.

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.

Export

Default Export Page Range
The page range that is pre-populated in the Document Options when in the Export screen.

Max Rows a User Can Export To Excel From Query
Sets a hard limit on the number of rows that can be exported into the Excel format from a query.

Excel Footer
Specifies a footer that will be added to the bottom of every Excel export.

Automatically Size Columns in Excel Exports
Sets the width of the columns in all exported Excel reports based on the amount of contained data.

Rename CSV Headings on Export
Overwrite the original headings with those specified in CXAIR when exporting.

Limit Group Administrator Export
Only permit group administrator users to export reports via email to users within their own user group.

Pages

Enable Embedded Content
Toggles the availability of the Embed reporting component in Pages reports.

Enable Source Code in Text Elements
Toggles the availability of the Source Code option when editing a text reporting component.

When editing a text component, 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. 

Byte Order Mark
Toggles the Byte Order Mark setting in Report Export options on or off by default.
May be required for certain special characters to render correctly in Windows based applications. For example, Norwegian special characters in Excel on Windows OS.

Dashboard

Maximum Splits per Dashboard Window
The number of sections an individual Dashboard window can be split into.

Maximum Dashboard Rows & Columns
The limit of rows and columns that can be added to a dashboard window segment.

Crosstab

Lowest Number of Values Displayed
Sets the lowest number of results to display before the number is hidden.

This prevents unique records identifying individuals.

Number Rounding Method
Sets how numbers are rounded in Crosstabs.

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.

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.

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.

Selecting Up will result in values being rounded up to the nearest whole number. For example, 10.3 will be rounded up to 11.

Selecting Down will result in values being rounded down to the nearest whole number. For example, 10.8 will be rounded down to 10.

Use Rounded Cell Calculation Values
When enabled, Cell Calculations will be calculated using the displayed values.

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.

Enable Row Total
Enables the row total functionality in Crosstabs.

When enabled, the Row Total option will appear in the Total Type drop-down list.

Chart Theme
The default chart theme applied if no theme is specified by the user.

Maximum Intersections
The maximum number of intersections that a Crosstab or Dashboard can contain before the ‘Large Crosstab’ warning popup box appears.

The value entered will act as a hard limit to constrain how many cells with values can be displayed in the Crosstab and Dashboard functionality areas.

Should the limit be reached, users will be presented with the option the run the report as a background task.

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.

Maximum Query Time
The maximum length of time, in seconds, that a Crosstab will generate for before the ‘Large Crosstab’ warning popup box appears.

To warn users that a currently generating Crosstab 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.

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 will consume considerable system resources and users will be unable to complete other tasks.

Maximum Number of Hits to Run a Crosstab in Real Time
The maximum number of records contained in a Crosstab before the ‘Large Crosstab’ warning popup box appears.

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. When the limit is reached, the option to run it in the background will appear.

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, rather than using this value independently.

Enable Crosstab and Dashboard Caching
Caches the current Crosstab or Dashboard for increased performance when reloading.

Leave this option enabled to increase performance when switching between the Edit and Run modes of the current Crosstab or Dashboard.

This option should only be disabled for debugging purposes.

Validate Row Totals
Validates every included row total when running a Crosstab.

Enable this option to validate all row totals before displaying the resulting Crosstab. If a calculation has become invalid, it will be highlighted.

Please note that enabling this option will impact rendering performance.

Maximum Crosstab Drop List Items
The maximum number of entries than can appear in a drop list or Row Total calculation in the Crosstab functionality.

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 functionality only.

Auto Group Crosstab Rows
Sets the ‘Group Crosstab Rows’ option in Crosstabs to be enabled by default.

Locked Headers Enabled 
Sets the column headers to stay in place when scrolling down in the query screen.

This can also bet set at index level, and will not activate for indexes that have had this option disabled.

Due to the resource-intensive nature of data retrieval, having this option enabled while running large queries may result in reduced performance.

Legacy Chart Rendering
Draws charts using the legacy charting engine.

Enable this option to display charts using the previous version of the built-in charting library.

Preview Cells Size
Specify the maximum number of cells from the Index will be loaded to render the Crosstab preview.

Preview Query Records
Specify the maximum number of records from the Index will be loaded to render the Crosstab preview for each cell.

Use Raw Numbers
Forces Crosstabs to use the raw Index data rather than formatted Index data. Default setting is OFF.

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.

Administration Area

Configuration Area Page Size
Controls the maximum number of displayed entries per page in the Admin screens.

This value applies to the every screen containing paged lists.

Admin Search Levenshtein Distance
Specifies the matching level of the Admin query functions.

The value must be between 0-1. The closer to 1, the less fuzzy the search.

Active Wizards
Specifies the wizards available to administrators.

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.

Send Reset Password on User Create
Automatically send a confirmation email to all new users.

Show Admin Popups
Displays configuration options in a popup window rather than in a separate screen.

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.

Links

Privacy Policy
Enter a URL that can be used to access the relevant privacy policy on the login screen.

Cookie Policy
Enables the Cookie Policy option in the login screen that details the cookies used by CXAIR.

Administration Guide URL
The URL used to access the online Administration Guide from the CXAIR Admin area.

User Guide URL
 The URL used to access the online User Guide from the CXAIR front-end.

CXFORMS Guide URL
 The URL used to access the online User Guide for CXFORMS.

CXAIR Viewer Guide URL
 The URL used to access the online User Guide for the Report Viewer interface.

Support
 The URL used to access the Support page from the CXAIR front-end and Admin area.

Website
 The URL used to access the company website from the CXAIR front-end and Admin area.

CXAIR Viewer

The following options relate to the Report Viewer functionality:

Show Search Bar
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.

Show Previews
Display generated previews for reports.

Allow Users to Change Filters
Provides the option to change and use reporting filters.

Default User Type
Specifies the default Viewer user type.

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.

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 solution, subject to permissions.

No Log Out
Disables the Log Out feature.

Show Navigation
Toggles the display of the folder navigation options.

Show Hierarchy Popups
Toggles the activation of popup hierarchy charts in the Report Viewer interface.

Hierarchical links are specified at Index level. Please refer to the Hierarchy section of the Creating an Index chapter for more information.

Show Initial Card
Toggles the default CXAIR card located at the top-left of the Report Viewer home screen.

Show Report Options
Toggles the availability of the Query screen Cog icon when viewing data in the Report Viewer interface.

Landing Page
Sets the default URL used to access the Viewer functionality.

When blank, users can access the Report Viewer interface using the folloiwng URL:

<server name or IP address>:<port number>/cxair/ui/reportviewer

Enter a value using this textbox to modify the URL. For example, entering /internal-reporting would result in the following URL:

<server name or IP address>:<port number>/internal-reporting

Please note that the entry must start with a forward slash (/) and that spaces are not supported.

CXFORMS

Online Only
When enabled, distributed forms can only be completed when connected to the internet.

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.

Completing forms online ensures the highest level of compatibility across platforms, and as such this option should only be disabled under advice from Connexica.

Clam Anti Virus Command
The command that is passed to the configured anti virus solution for file uploads.

Clam Anti Virus Enabled
Enables the configured anti virus solution for file uploads.

Show Print Button
Enables the PDF printing functionality for CXFORMS.

Index CXFORMS on Demand
Enable this option to stop CXFORMS Indexes automatically building when a form has been submitted. The required Index can then be refreshed manually.

Locale

Locale
Sets the required number display formatting for the required country.

Default Language
Sets the language that the solution will default to.

Time Zone
Specifies the time zone used by the solution.

Auto Time Zone
Enables location-based time zone detection.

Format Options
Specifies the default format set per field type at the time of indexing.

The options include Integer Format, Decimal Format, Date Format, Time Format, Date Time Format, Month of Fiscal Year and First Day of Week.

Month Of Fiscal Year
Specifies the first month of the fiscal year, referenced when conducting dynamic date queries and calculations.

First Day of Week
Specifies the starting point when utilising dynamic date syntax.

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 section of the Query chapter for more information regarding the available dynamic syntax.

Working Days
Specifies the days classed as working days.

By setting the working days, additional schedules, calculation functions and query syntax become available. Please refer to the Query chapter for more information.

Holidays
Specify the bank holidays that will be excluded from working day calculations and working day schedules.

Dates must be entered in the date format specified in the above Date Format option.

Decimal Places
Specify the maximum number of permitted decimal places for a field value.

Changing this value requires a restart for the new format to become available.

Indexing

Crawler Threads
The maximum number of threads permitted when building a Data Source Group with multiple Data Sources.
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.

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.

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.

Index Threads
The number of threads available to modify indexes.

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.

Aggregation Threads
The number of threads available to build aggregated indexes.

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.

Retrieval Threads
The number of threads available to retrieve documents from unstructured data file stores.

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.

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.

Retrieval Rate
The number of bytes per second that are processed when retrieving documents from unstructured data file stores.

Specifying this option provides greater control over the speed of retrieval, allowing a data transfer cap to be applied to the retrieval process.

Extract Threads
The number of threads available to extract information from retrieved documents.

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.

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.

Extract Rate
The number of bytes per second that are processed when extracting information from retrieved documents.

Specifying this option provides greater control over the speed of extraction, allowing a data transfer cap to be applied to the retrieval process.

Text Mining Threads
The number of threads available when performing text mining on Index fields.

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.

Please note that the text mining functionality is not present in the current release and this option has been added for future development purposes.

Document Timeout
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.

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.

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.

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.

Processor Sleep
The time, in milliseconds, that the processor will pause for when re-indexing queued files.

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.

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.

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.

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.

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.

Maximum File Size
The maximum size, in MB, of individual files that can be indexed when building Unstructured Indexes.

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.

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.

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.

Maximum Archive Size
The maximum size, in MB, of archive files that can be indexed.

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.

Message Queue Size
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.

When building the Audit Index, this value controls the number of documents that can be queued between the individual processes: crawling, extracting and building.

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. 

Message Queue Size Check Period
The amount of time, in seconds, between a new warning message being written to the log if the queue size is exceeded.

If the above value is exceeded multiple times, multiple instances of the same warning message may be written to the log.

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.

Message Queue Size Check Period
The amount of time, in seconds, between a new warning message being written to the log if the queue size is exceeded.

If the above value is exceeded multiple times, multiple instances of the same warning message may be written to the log.

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.

Max Index Log Size 

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. 

Index Logs
Toggles the logging of files that contain the progress of index build processes.

When enabled, indexes will build at a slower rate with a complete audit trail.

Treat Nulls as Zero
Displays a zero instead of a null value when creating Crosstabs and charts.

Add All Column Types To Free Text
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.

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.

Analyser
The default text analyser used for index fields.

The selected analyser is used to detect and convert index fields into the correct function when configuring the Column Mapping options.

Coalesce after Incremental / Cumulative / Timeline Index Build
Sets whether to compile all previous builds into a single file following a successful build process.

Stop Words
Words that are excluded from the Word Cloud functionality.

Derive Date Field Date / Number / String Values
Select the field types that are created when deriving new date values when selected in the Derived Dates tab.

Please note that selecting Fiscal in the Derived Dates tab will overwrite these options.

Schedule Failures
The number of times a failed index schedule will retry the build before the process moves on to the next queued item.
Please only change this option under advice from Connexica.
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.

Schedule Clear Down
When enabled, the Index build schedule will be cleared at midnight to ensure schedules start at the correct time the next day.
Please only change this option under advice from Connexica.
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.

Scheduling Enabled
Permits Index build schedules to run on the system.
Please only change this option under advice from Connexica.
Clear this checkbox to disable all scheduled Index builds.

Reset All Build Schedules
Clears the current build queue and resets the scheduling task.
Please only change this option under advice from Connexica.

Email

Select the type of email service to be used:

SMTP

Server
The name or IP address of the required mail server.

Port
The port on which the mail server is running.

Use Authentication
Enables authentication methods on the mail server.

Use TLS
Toggles the use of Transport Layer Security for email accounts.

Login
The login name used to allow access to the mail server.

Password
The password used to allow access to the mail server.

From Address
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.

Reply-to Address
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.

Retry Failed Timing
The period of time following a failed email before the next attempt is made.

Connection Timeout
The time, in seconds, before the connection to the specified email server times out after no response.

Should the default value of 30 (seconds) not be sufficient, it is recommended that this value is increased to 60 (seconds).

Allow Sending to Non-CXAIR Users
Toggles the ability for users to export reports to email addresses not stored within CXAIR.
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.

Mail Receipt Acknowledgement
Toggles read receipts for emails sent via the configured email server.

Mail Debugging
Enables additional debug features that are used to troubleshoot potential issues.

This should only be enabled under advice from Connexica.

Amazon Simple Email Service (SES)

Region
The Amazon region managing the SES.

From Address
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.

Reply-to Address
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.

Retry Failed Timing
The period of time following a failed email before the next attempt is made.

Allow Sending to Non-CXAIR Users
Toggles the ability for users to export reports to email addresses not stored within CXAIR.
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.

Mail Receipt Acknowledgement
Toggles read receipts for emails sent via the configured email server.

Mail Debugging
Enables additional debug features that are used to troubleshoot potential issues.

This should only be enabled under advice from Connexica.

Third-Party Settings

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.

The R Server URL option allows the required URL to be entered for access within the solution.

Third-Party Paths

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.

Audit

The Audit Index options allow system administrators to configure the timing and included components of the built-in Audit Index.

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.

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.

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.