Skip to Content

03h. Quick Start Wizards

Last modified by Ross Beck on 06/11/2025, 14:23
Contents

The Quick Start Wizards have been designed to offer fast access to system-wide configuration options in a single screen.

This includes rapid deployment options where Index components can be built from a single database or from CSV files contained in a single directory, global changes to letter casing and Index naming conventions and a further options to perform global administrative tasks.

Click Setup, Extensions then Quick Start Wizards to access the Quick Start Wizards screen.

Bulk Viewer User Creation

Using this wizard, multiple Report Viewer users can be simultaneously created by uploading an Excel file with the relevant credentials entered. 

Click Download Template to download a local copy of the template that can be used and, one completed, click Upload Excel File to re-upload the completed template. Click Deploy to complete the process.

The users will now be created. The speed of creation depends on the number of users and current system load.

CSV Directory Deployment

The CSV Directory Deployment wizard allows multiple Index structures to be built based on a single directory containing multiple CSV files. This will result in every CSV file in the directory being built as a single Data Source, Data Source Group and Index.

Select the relevant file path by clicking the … icon next to the Directory option. The wizard will also create a new Search Engine named after the directory file path. All Index structures created using the wizard will be added to this Search Engine.

Populating the Prefix textbox will amend the contained text as a prefix onto the Index name.

Use the Collection drop-down list to select a previously created collection that all created Index structures will be added to upon completion.

Enable the As Text option to set all fields to be strings, regardless of whether they have been identified as other field types and enable the First Row is Header option to set the contents of the first row to be used as the column headings in the resulting output.

To create a unique Data Source and Data Source Group for each CSV directory but only create a single Index containing all of the Data Source Groups, enable the Single Index option. By default, the directory path will be used as the Index name.

After creating the Index structures using this wizard, the build status will be set as Waiting. At this stage, the Indexes can be built individually or collectively using the Collections functionality.

Enforce Strict Security

This wizard enables a number of configuration settings to adhere to strict security protocols. The following options are set system-wide once this wizard is run:

Fix Index Field Types

The...

Generate Report Information

Using this wizard, multiple report previews and specifications can be generated simultaneously.

Select between the Reports radio buttons to restrict what will be processed. Home will process the reports for the current user directory, Public will process reports made publicly available and Both will process all available reports.

The Type radio buttons allow the selection of what will be generated. Select Preview to generate report previews, Specification to generate report specifications and save them to disk or Both to generate the two together.

Enabling the Overwrite option will result in any previously generated previews or specifications being overwritten with the latest version.

Click Deploy to complete the process. The speed of creation depends on the number of reports and current system load. The process will run as a background task.

Global Case Change

This wizard allows the name for every Data Source, Data Source Group and Index to be globally updated to a single case.

Select either UPPER CASE, lower case or Title Case from the Case radio buttons and click Deploy to apply the changes. All names are updated immediately.

Global Rename

This wizard allows multiple Indexes with shared prefixes to be renamed.

Enter the prefix that will be changed in the Prefix textbox, and enter a new prefix in the Replacement textbox.

Click Deploy to complete the process.

Indexes from Database Tables

Using this wizard allows multiple Index structures to be built based on unique tables from a single database. This results in each database table within the database having its own Data Source, Data Source Group and Index structure created. A Search Engine is also created with the same name as the source database. All Index structures created using this wizard will be added to this Search Engine.

Use the Database Connection drop-down list to select a previously created database connection that will be used to connect to the source database.

Populating the Prefix textbox will amend the contained text as a prefix onto the Index name.

Use the Collection drop-down list to select a previously created collection that all created Index structures will be added to upon completion.

Select either Table, View or Both from the Table Type drop-down list to restrict what is imported and enable the Ignore Errors option to complete the deployment regardless of any errors that may occur during the retrieval process. If errors are found, it is recommended that the system logs are checked to locate and rectify the issue. Please refer to the Logging section of the Status Monitoring chapter for more detailed information.

The Include and Exclude options are used to enter Regular Expression strings to further specify the data that will be retrieved or omitted.

Click Deploy to build the relevant Index structures. The build status is set as Waiting and the Indexes can then be built individually or collectively using the Collections functionality.

Remove Licence

Use this wizard to remove a PRN from the system. To use this process you have to be logged in as the admin user (not just a user with administrator privileges)

Use the checkbox to select the PRN(s) you wish to remove and click the start button.

You will see a success message once this process has completed.

Tidy Up Missing Report Schedules

The...

Upgrade ETL

CXAIR version 3.0 changes the way ETL indexes can be processed. From version 3.0 stages can be added that use other data source types such as Amalgamated Indexes and Data Marts. This streamlines the process of having multiple separate data source types as part of a work flow.

This Quick Start Wizard is a conversion process to automatically create a new ETL that syncs existing work flows (CXAIR identifies where Indexes are shared by other data source types).

Choose the work flow CXAIR has identified from the Configurations drop list and click the Start button to start the process.

A message will confirm that the process is successful.

The Indexes are created without building so that the converted configuration can be checked prior to a build of the data. The conversion process may not be able to apply all elements of the original work flow. Please contact support@connexica.com if you have any questions or need any assistance with this process.

Waffle Test

The...