05a. System Overview
The System Overview displays all created Data Sources, Data Source Groups and Indexes, organised by their designated Search Engines along with a Last Updated column denoting when the latest build process took place.
To access the System Overview, Click Search Engine then System Overview.
Navigation
Use the search bar at the top of the screen to quickly filter the results by typing a search term and click Refresh / Filter.
Each Search Engine is displayed as a tab on the left side of the screen. Any Indexes not in a Search Engine will be grouped in the No Search Engine tab.
Options
To perform an action against one or more components, click the relevant checkbox(es). This will reveal a set of context specific options below the search bar. Following the selection of an option, confirm the selection in the subsequent popup.
Build
The Build options will rebuild the selected entries based on their current status.
Select Empty to build an entry containing zero documents, Failed to build an entry with the Failed status, Now to immediately build all selected entries and With Dependants to build a Data Source Group along with any dependent Data Sources or Indexes.
Data Source Group
The Data Source Group options allow multiple Data Source Groups to be modified simultaneously.
Select Change Build Method and use the Method drop-down list to change the selected Data Source Groups to either a Complete, Incremental, Timeline or Cumulative build method. Please refer to the Index Methods section of the Manual Index Creation chapter for more information regarding build types.
Select Change Build Size and use the Index Size drop-down list to alter the projected number of records. Click Change to apply changes, or Close to discard changes.
To alter a pre-existing schedule for the selected entries, select Change Schedule. Select a timeframe from the available radio buttons and use the subsequent drop-down lists to specify when the schedule will now take place. Click Change to apply changes, or Close to discard changes.
The Coalesce option will compact Indexes stored over a large amount of separate folders into a smaller amount of larger sections to negate potential performance impacts. It is recommended that this process is performed regularly for large incremental and snapshot Indexes. Confirm this action by clicking OK, or click Cancel return without making any changes.
Data Source
The Data Source options allow multiple Data Sources to be modified simultaneously.
Selecting the Change Maximum Rows option will show a pop up message box. Specify the maximum number of rows that an Index can receive before completing in the Maximum Rows text box. To disable this option, enter zero.
Click Change and then Confirm for any subsequent message boxes.
Tags
The Tags options allow tags to be added to multiple entries simultaneously.
To add tags, click Add then type the desired tag in the resulting Tags textbox. Click Add Tags to apply changes, or Close to discard changes.
To remove tags, click Remove and select the relevant tag from the Tags drop-down list. Click Remove Tag to apply changes, or Close to discard changes.
Collections
Collections enable the grouping of Indexes, allowing multiple Indexes to be configured simultaneously.
To create a Collection, select the required Indexes and click Collections, then Save. Type a name in the Collection Name textbox and click Save to apply changes, or Close to discard changes.
Created Collections are located in the Collections Panel. Click the >> icon above the System Overview text to open the panel and reveal all currently configured Collections. Click the Filter icon to display only Indexes contained in the Collection in the System Overview.
To add or remote Indexes from a collection, click the Edit icon. This will result in all Indexes currently part of the Collection to be selected in the System Overview. Select and deselect Indexes as required and click Collections, then Save. Click Overwrite to save changes to the original Collection, or New Name to create a new Collection. Confirm the name by clicking Save or click Close to discard changes.
Export
Using the Export options, data can be downloaded to the local machine in a format suitable for importing back into the solution.
Select Data to export the entire Index with all data included or Data With Schedules to export the entire Index with all data and schedules included. The Export Reports option will only export the associated reports. Alternatively, select Without Data to export only the Index configuration settings or Without Data and Schedules to export the Index configuration settings along with saved schedule settings. To export the entire Index with all data included to a previously configured remote server select To Remote Server and select the required destination from the Remote Server drop-down list. Click Export to complete the process, or Cancel to discard changes.
Importing Exported Data
To import data that has been exported from CXAIR, navigate to the Import screen by clicking Search Engine, then Import.
Click the Choose File button to select the relevant file, and enable the Overwrite Reports in Original Folder option to replace the original reports on the system with those in the imported file, if required. Click Import to initiate the import process.
If importing a report saved in a user's home directory who does not exist on the target system, enable the Import Reports Into User's Folder If The User Does Not Exist option to import the report into the current user's home folder.
If importing a set of reports that are built from an Index that does not exist on the target system, these reports can still be loaded against Indexes that contain the same field names. Please note that every field used in the report must match.
In the next screen, use the relevant textboxes to rename the Index components, associated schedules and Display Field Layouts before enabling the Import checkbox for the required components.
Use the Key at the top of the screen to determine how the imported data will interact with the system’s pre-existing structures. Each component textbox is annotated with a colour and position depending on whether the imported data will be imported with or without overwriting existing information, or imported in addition to the original data. To stop a component being overwritten, rename the component using the relevant textbox. Once changes have been made click the Check button to refresh the colour coding based on the options modified.
Enable the Overwrite checkbox to replace any existing data with the version included in the import, and amend the location for the Index and Data Source Group files on disk using the Directory textbox.
When the desired options have been set, click Import to complete the process.
Delete
Use the Delete options to remove multiple entries simultaneously.
Click Delete All Documents to delete all associated records but maintain the Index structure and configuration, or instead select Delete All Documents And Fields to also remove associated Index fields. Click Remove to delete all records and the Index structures, or Remove Failed Indexes to only remove Indexes with the Failed status.