Skip to Content

Wiki source code of 03h. Quick Start Wizards

Last modified by Ross Beck on 06/11/2025, 14:23
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 The Quick Start Wizards have been designed to offer fast access to system-wide configuration options in a single screen.
6
7 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.
8
9 Click **Setup**, **Extensions** then **Quick Start Wizards** to access the Quick Start Wizards screen.
10
11 = Bulk Viewer User Creation =
12
13 Using this wizard, multiple [[Report Viewer>>doc:Technical Documentation.CXAIR.User Guide.7\. Report Viewer.WebHome]] users can be simultaneously created by uploading an Excel file with the relevant credentials entered.
14
15 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.
16
17 The users will now be created. The speed of creation depends on the number of users and current system load.
18
19 = CSV Directory Deployment =
20
21 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.
22
23 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.
24
25 Populating the **Prefix** textbox will amend the contained text as a prefix onto the Index name.
26
27 Use the **Collection** drop-down list to select a previously created collection that all created Index structures will be added to upon completion.
28
29 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.
30
31 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.
32
33 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.
34
35 = Enforce Strict Security =
36
37 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:
38
39 * Disable the [[Allow to Run in Frame>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="iFrame"]] System Setting.
40 * Disable the [[Import Files>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Import Files"]] System Setting.
41 * Removes any selections from [[Import File Types>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Import File Types"]] System Setting.
42 * Disabled the [[Enable Embedded Content>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Enable Embedded Content"]] System Setting.
43 * Disable the [[Enable Source Code in Text Elements>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Enable Source Code in Text Elements"]] System Setting.
44 * Set [[Webserver Timeout>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Webserver Timeout"]] System Setting to less than 10.
45 * Set [[Failed Attempt Lock Out Period>>doc:Technical Documentation.CXAIR.Administration Guide.Security.User Management.WebHome||anchor="J2EE"]] to 5 minutes for J2EE users.
46 * Set [[Number of Failed Login Attempts Allowed>>doc:Technical Documentation.CXAIR.Administration Guide.Security.User Management.WebHome||anchor="J2EE"]] to 3 for J2EE users.
47 * Set [[Reset Password Expire>>doc:Technical Documentation.CXAIR.Administration Guide.Security.User Management.WebHome||anchor="J2EE"]] to 5 minutes.
48 * Set [[Password History Length>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] to 24.
49 * Set [[Minimum Password Length>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] to 16 characters.
50 * Set the [[Maximum Password Life>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] to 30 days.
51 * Disable [[Password Never Expires>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] option.
52 * Enable the [[Mixed Case Password>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] option.
53 * Enable the [[Mixed Alphanumeric>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] and Non-Alphanumeric Password option.
54 * Enable the [[Password Must Contain Special Characters>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] option.
55 * Enable the [[Password Must Not Contain Username>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] option.
56 * Enable the [[Password Must Not Contain Car Registration>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] option.
57 * Enable the [[Password Must Not Contain Month or Day>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Password Policies.WebHome]] option.
58
59 = Fix Index Field Types =
60
61 The...
62
63 = Generate Report Information =
64
65 Using this wizard, multiple report previews and specifications can be generated simultaneously.
66
67 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.
68
69 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.
70
71 Enabling the **Overwrite** option will result in any previously generated previews or specifications being overwritten with the latest version.
72
73 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.
74
75 = Global Case Change =
76
77 This wizard allows the name for every Data Source, Data Source Group and Index to be globally updated to a single case.
78
79 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.
80
81 = Global Rename =
82
83 This wizard allows multiple Indexes with shared prefixes to be renamed.
84
85 Enter the prefix that will be changed in the **Prefix** textbox, and enter a new prefix in the **Replacement** textbox.
86
87 Click **Deploy** to complete the process.
88
89 = Indexes from Database Tables =
90
91 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.
92
93 Use the **Database Connection** drop-down list to select a previously created database connection that will be used to connect to the source database.
94
95 Populating the **Prefix** textbox will amend the contained text as a prefix onto the Index name.
96
97 Use the **Collection** drop-down list to select a previously created collection that all created Index structures will be added to upon completion.
98
99 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>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.Status Monitoring.WebHome||anchor="Logging"]] section of the [[Status Monitoring>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.Status Monitoring.WebHome]] chapter for more detailed information.
100
101 The **Include** and **Exclude** options are used to enter Regular Expression strings to further specify the data that will be retrieved or omitted.
102
103 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.
104
105 = Remove Licence =
106
107 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)
108
109 Use the checkbox to select the PRN(s) you wish to remove and click the start button.
110
111 You will see a success message once this process has completed.
112
113 = Tidy Up Missing Report Schedules =
114
115 The...
116
117 = Upgrade ETL =
118
119 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.
120
121 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).
122
123 Choose the work flow CXAIR has identified from the Configurations drop list and click the Start button to start the process.
124
125 A message will confirm that the process is successful.
126
127 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>>path:mailto:support@connexica.com]] if you have any questions or need any assistance with this process.
128
129 = Waffle Test =
130
131 The...