Skip to Content

Wiki source code of 04c. Creating an Index

Last modified by Jeff Nicholson on 06/11/2025, 14:23
Hide last authors
Jeff Nicholson 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Navigate to the Indexes screen by clicking **Search Engine**, then **Indexes**. All currently loaded Indexes will be displayed, and clicking **New** will allow the creation of a new Index.
6
7 = Details =
8
9 Enter the Index name in the **Name** text box.
10
11 Use the **Tags** textbox to add associated search terms to the Index. This allows the components to be accessed using customised strings when using the search bar.
12
13 The **Description** textbox allows text to be entered that describes the Index. This is displayed in the administration screens and on the Home screen to provide users with additional detail.
14
15 The **Count Description** options allows the customisation of the wording displayed on the Home screen. Left blank, the number of documents will be displayed as ‘Matches’.
16
17 Using the **Default Realm Access** drop-down list, select either **System Default**, **Open** or **Closed**. Please refer to the [[Realms>>doc:Technical Documentation.CXAIR.Administration Guide.Security.Realm-Based Security.WebHome]] chapter for more information.
18
19 If building an Incremental Index, enabling the **Most Recent First** option will order the data chronologically. Enabling this option for Complete Indexes will order the rows as they are retrieved from the source system.
20
21 To set the column headers to stay in place when scrolling down in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen, enable the **Locked Headers Enabled** option. This can be automatically enabled for all new Indexes using the [[Locked Headers Enabled>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Locked Headers Enabled"]] option in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]].
22
23 Enable the **Limit Drop-Down List Items** option to apply a soft limit to the number of values that can be displayed in a drop-down list. When enabled, only the first 1000 values are displayed to reduce system load. This can also be applied globally using [[Limit Drop List Items>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Limit Drop List Items"]] setting in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]].
24
25 Select the Data Source Group(s) from which the Index will be created using the **Groups added to Index** drop-down list.
26
27 = Index Fields =
28
29 The Index Fields options allow the formatting of the Index fields to be specified.
30
31 The **Index Field** column contains the field names and, for number fields, the **Format** column will contain a drop-down list where the number display format can be selected.
32
33 To alter the field name that is displayed to end-users, amend the automatically populated **Display** Field textbox with the desired display name.
34
35 If an Index field contains free text, wrapping the text will visually improve the field when viewed in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen. To wrap the contents of an Index field, use the drop-down list in the **Wrapping** column. Select either **Words** or **Characters** and specify the wrap value in the associated textbox. To further enhance presentation, use the **Colour Palette** drop-down list to apply a previously saved Colour Palette to individual fields.
36
37 To add a value to a field in the Index, click the **…** icon in the **Value** column. Enter a value in the textbox and click **Add**. All added values will appear below. To remove a value, click the **X** icon next to the relevant entry. Click **Close** to add the values and return to the previous screen.
38
39 To add a field based on an original, click the **Add** button next to the relevant field. This will create an exact copy of the field below. This option is especially useful if additional views of the same data are required. For example, adding another date field, formatted as dd/MM/yyyy, and using the **Format** drop-down list to select MM/dd/yyyy would allow two different views of the same field to be added to reports.
40
41 To remove a field, click the **Remove** button. Alternatively, all Index fields can be removed simultaneously by clicking the **Remove All** radio button. To reverse this action, click the **Add All** radio button.
42
43 By clicking the **Remove Redundant** button, unused or empty fields left over from previous builds can be deleted.
44
45 == System Fields ==
46
47 Click the **Show System Fields** button to reveal the system fields generated during the build process. Click **Hide System Fields** to hide the options.
48
49 System fields allow the unique items from the Index make-up to be referenced in reporting. Organise and modify these fields using the same options as detailed above.
50
51 The following System Fields are available:
52
53 (% border="1" cellspacing="0" class="Table" style="border-collapse:collapse; border:1pt solid black; width:1024px" %)
54 |(% style="background-color:#f38337; background:#f38337; border-style:solid; border-width:1pt; width:169px" width="92" %)(((
55 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
56 (% lang="EN-US" style="color:white; line-height:18pt; text-autospace:none" %)**Issue ID**
57 )))|(% style="background-color:#f38337; background:#f38337; border-left-color:initial; border-style:solid; border-width:1pt; width:854px" width="548" %)(((
58 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
59 (% lang="EN-US" style="color:white; line-height:18pt; text-autospace:none" %)**Summary**
60 )))
61 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
62 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
63 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_DataSource
64 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
65 (% style="margin-bottom:.0001pt; padding:0cm 5.4pt 0cm 5.4pt" %)
66 (% style="color:#000000" %)Denotes the Data Source GUID.
67 )))
68 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
69 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
70 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_DataSourceDisplay
71 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
72 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
73 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Denotes the Data Source name.
74 )))
75 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
76 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
77 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_DataSourceGroup
78 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
79 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
80 (% style="color:#000000" %)Denotes the Data Source Group GUID.
81 )))
82 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
83 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
84 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_DataSourceGroupDisplay
85 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
86 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
87 (% style="color:#000000" %)Denotes the Data Source Group name.
88 )))
89 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
90 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
91 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_EffectiveDate
92 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
93 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
94 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Virtual field used for querying purposes. Only available for Timeline Indexes.
95 )))
96 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
97 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
98 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_EffectiveTo
99 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
100 (% style="margin-bottom:.0001pt; padding:0cm 5.4pt 0cm 5.4pt" %)
101 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The current status of the Effective date. Only available for Timeline Indexes.
102 )))
103 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
104 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
105 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_EntryStatus
106 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
107 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
108 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Denotes whether the record is an Addition, Deletion, Modification (where the record has been updated), Replaced (where a new record with a valid effective date range has been added) or is a Re-Addition (there is a gap in the record's timeline). Only available for Timeline Indexes.
109 )))
110 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
111 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
112 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_EntryStatus2
113 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
114 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
115 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The status of record before it was deleted. Only available for Timeline Indexes.
116 )))
117 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
118 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
119 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_Id
120 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
121 (% style="margin-bottom:.0001pt; padding:0cm 5.4pt 0cm 5.4pt" %)
122 (% lang="EN-US" style="color:black; line-height:14pt; text-autospace:none" %)The identifier of the Indexed file. (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Only available for Unstructured Indexes.
123 )))
124 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
125 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
126 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_Indexed
127 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
128 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
129 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Denotes when the records were inserted.
130 )))
131 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
132 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
133 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_MD5
134 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
135 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
136 The MD5 hash used to identify the Indexed file. (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Only available for Unstructured Indexes.
137 )))
138 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
139 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
140 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_Modified
141 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
142 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
143 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The current Effective From date. Only available for Timeline Indexes.
144 )))
145 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
146 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
147 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_Type
148 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
149 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
150 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The file type of the Indexed file. Only available for Unstructured Indexes.
151 )))
152 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
153 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
154 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)_url
155 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
156 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
157 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Used to identify URL values within an Index.
158 )))
159 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
160 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
161 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Directory
162 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
163 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
164 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The original location of the Indexed file. Only available for Unstructured Indexes.
165 )))
166 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
167 (% style="margin-bottom:.0001pt; padding:0cm 5.4pt 0cm 5.4pt" %)
168 (% lang="EN-US" style="color:black; line-height:14pt; text-autospace:none" %)File
169 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
170 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
171 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The original filename of the Indexed file, Only available for Unstructured Indexes.
172 )))
173 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
174 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
175 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Score
176 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
177 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
178 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Virtual field used for ranking query results.
179 )))
180 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:169px" width="92" %)(((
181 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
182 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)Size
183 )))|(% style="border-bottom:1pt solid black; border-left:none; border-right:1pt solid black; border-top:none; width:854px" width="548" %)(((
184 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
185 (% lang="EN-US" style="color:black; line-height:18pt; text-autospace:none" %)The original size on disk of the Indexed file. Only available for Unstructured Indexes.
186 )))
187
188 = Display Fields =
189
190 The Display Fields options are used to set the fields that can be used as totals.
191
192 Use the **Total** drop-down list to individually select the numeric fields that will be available to be used as a **Measure**, or click **All** to add every numerical field. To delete individual fields, click the **X** icon next to the relevant field. Alternatively, click **None** to remove all fields.
193
194 Fields that are selected using the **Excluded** drop-down list cannot be used as **Axes** in [[Crosstabs>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]].
195
196 = Descriptions =
197
198 The Descriptions option allows you to enter a description against each field in the index that can be accessed from the query screen. This can be details from the data dictionary, or an explanation of how the value is calculated. In the query screen you will see an 'i' icon under any fields that have a description set against them and when you click this icon a popup box will appear to show the description.
199
200 = Similar =
201
202 The Similar options provide the configuration of the **Find Similar** feature that allows end-users to search for words similar to those typed.
203
204 Select the required fields from the relevant drop-down list to activate the feature. Click the **All** button add all fields, or **None** to remove all selected fields.
205
206 The **Double Metaphone** option utilises a phonetic encoding algorithm to account for the numerous applications of individual letters, supporting multiple languages.
207
208 Using the **Soundex** option will result in searches based on sound, as pronounced in English. Different words with similar pronunciation will be returned.
209
210 The **Fuzzy Matching** option searches words based on Levenshtein Distance. This measures the difference between words in the minimum number of single-character edits specified.
211
212 = {{id name="Targets"/}}Targeting =
213
214 Select the **Target Index** from the drop-down list to add its configuration settings to the Index.
215
216 For each field, select the relevant Index field from the **Mapping** drop-down list. This allows Targets to be used across multiple Indexes.
217
218 Please refer to the [[Targeting>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Targeting.WebHome]] section of the Extensions chapter for more information.
219
220 = {{id name="Currencies"/}}Currencies =
221
222 Currency conversion can be applied at Index level using the following options once the relevant currencies have been uploaded in the [[Currency Management>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Currency Management.WebHome]] screen.
223
224 Any field selected from the **Total** drop-down list in the **Display Fields** options will appear in the Currencies section in the **Index Field** column.
225
226 In the **Type** column, specify the field that will be converted using the **Currency Index Field** drop-down list and select a predefined currency matching the field from the **Base Currency** drop-down list. The **Display Field** column denotes how the field is displayed in the Index.
227
228 Select a predefined currency from that the field will be converted to from the **To Currency** drop-down list.
229
230 = Filter Values =
231
232 Using the Filter Values option, a list of reference values can be specified that can be used in the filter pane for [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] calculations.
233
234 To create a new value, click the **Add** button and type a name in the **Name** textbox. Use the **Type** drop-down list to specify the data format and the resulting Format drop-down list to further specify the display format for
235
236 In the **Label** textbox, type the name that will appear in drop-down lists for users, and enter the required value in the **Value** textbox. Click **Save** to add the value and reveal a new row. Repeat the process to add multiple values.
237
238 = {{id name="Links"/}}Links =
239
240 Adding links allows the joining of fields from another Index based on a join key.
241
242 To create a link, click the **Add** button and type a name in the **Name** textbox. Use the **Form Field** drop-down list to specify the join key for the currently loaded Index.
243
244 For the Index to be joined, select the required Index from the **Index** drop-down list, and its join key from the **To Field** drop-down list.
245
246 = Display Field Layouts =
247
248 Use this set of options to configure a number of display options for the Index in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen.
249
250 The **Order** drop-down list specifies how the display field layouts will be ordered, with **Alphabetic** and **Creation Date** available as options. Select a field using the **Default** column radio button to apply the specified layout when the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen is first accessed with the Index loaded. Click **Edit** to modify an existing layout, or **Remove** to delete it.
251
252 To create a new layout, click the **Add** button and type a name in the **Name** textbox.
253
254 Use the **Type** drop-down list to specify the display format and reveal the applicable options. The **Table** option provides options to customise the default [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen layout of the Index, while the **JSON** option outputs the data in **JSON** (JavaScript Object Notation) format for each row. Selecting **Editable Table** will activate the [[Editable Data>>doc:Technical Documentation.CXAIR.Administration Guide.Data Warehouse.WebHome||anchor="Editable Data"]] functionality in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen and the **List** and **Fixed List** options will restrict the view to a configurable number of rows for structured and unstructured data, respectively. Select **HTML** to design a layout that will be used for each row, or **Word Cloud** to display an interactive view of the data. The **Clustering** options reveal algorithm selection options to create display fields based on related data, and the [[CXFORMS>>doc:Technical Documentation.CXFORMS.WebHome]] option will read data directly from the [[CXFORMS>>doc:Technical Documentation.CXFORMS.WebHome]] Index.
255
256 Select individual fields from the **Display Fields** drop-down list, or click **All** to add all fields. Delete individual fields by clicking the **X** icon next to the relevant field, or click **None** to delete all fields. Re-order fields by dragging and dropping selections into the required order. Enable the **Automatically add new columns** option to ensure that any new fields that get added to the Index are automatically included in the display field configuration.
257
258 Select fields from the **Constraint Fields** drop-down list to force rows not to display. Use the **Constrain** radio buttons to select how many have to be blank before they are hidden, with **None**, **All**, or **Any** available as options.
259
260 When configuring a **List**, specify between **1** and **2** in the **Columns** drop-down list to specify the number of columns that will display the data. For unstructured data, selecting the **Fixed List** option reveals the **Delimiter** option. Specify what separates the field values in this textbox.
261
262 Selecting the **HTML** option reveals a text editor with a range of functions. Quickly reference a field using the drop-down list above and click **Add Field**. Enter required code manually by clicking Tools, then **<> Source code**. Enter the required code and click **OK** to add the contents, or click **Cancel** to return without applying its contents. Use the **Page Size** option below to specify how many rows of data will be displayed on each page of the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen.
263
264 When **Word Cloud** is selected, a number of display options become available. Please refer to the [[Word Cloud Configuration>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome||anchor="Word Cloud"]] section for more information.
265
266 Selecting the **Clustering** option reveals a number of options to facilitate the grouping of related display fields via the Carrot2 open source clustering engine. Specify the amount of rows that will be scanned before the algorithm moves onto the next field using the **Number of rows to scan** textbox. The more rows that are scanned, the more accurate the grouping output at the expense of increased system load. Select the required algorithm from the **Clustering** drop-down list, with **Bisecting K-Means**, **Lingo** and **Suffix Tree Clustering** available to account for differing data structures. Select a field previously added to the [[Analysed list>>doc:Technical Documentation.CXAIR.Administration Guide.Wizards.Database Data Source Wizard.WebHome||anchor="Analysed"]] when the Index was created from the **Display Field Layout** drop-down list to specify the field that will be used to determine the resulting clusters.
267
268 = Dynamic Views =
269
270 Using Dynamic Views, Distinct Counts can be created for selected fields. Click the arrows in the **Order** column to re-order created dynamic views, click **Edit** to modify an existing dynamic view, or **Remove** to delete it.
271
272 To create a new layout, click the **Add** button and type a name in the **Name** textbox. Enter additional information in the **Description** textbox and select an Index field from the **Display Field** drop-down list to specify the field used to perform the distinct count.
273
274 Use the **Display Field Layout** drop-down list to select the display field layout the dynamic view will use when drilling through to the underlying data and select the required totals from the **Total Fields** drop-down list. Select individual fields from the **Display Fields** drop-down list, or click **All** to add all fields. Delete individual fields by clicking the **X** icon next to the relevant field, or click **None** to delete all fields.
275
276 Click **Save Dynamic View** to add it to the above table, or click **Cancel** to discard any changes.
277
278 = {{id name="Maps"/}}Maps =
279
280 The following options allow configured Maps to be setup for an Index. Once set, the Map option will become available in the [[Pages>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2e\. Pages.WebHome]] functionality.
281
282 To add a new map, click **Add**. Enter a name for the configured map settings and select a map type from the **Map** drop-down list.
283
284 == Fusion Maps ==
285
286 Fusion Maps provide over 1,500 offline maps without the loading limits associated with the Google Maps API, and each entry can be previewed on the [[Fusion Maps website>>https://www.fusioncharts.com/fusionmaps]].
287
288 Maps can either be created separately for each Index, or created in the Fusion Maps screen and then selected from the **Map Type** drop-down list. To create a map that can be applied to multiple Indexes, navigate to the Fusion Maps screen by clicking **Setup**, **Extensions**, then **Fusion Maps**. Complete the following instructions and click **Create Fusion Map** to save the configuration that will then be available from the **Map Type** drop-down list.
289
290 When configuring a map at Index level, select a saved map or region applicable to the Index from the **Map Type** drop-down list and select the field containing the pertinent location information from the **Code** drop-down list.
291
292 To ensure that the selected **Map Type** matches the granularity of the data, it is recommended that this expansive drop-down list is fully explored.
293
294 There are a number of high-level options, such as **Europe**, **Africa** and **North America** and also variations based on a single country of interest. For example, **England** contains entries for every county while **England Region** contains entires for pre-defined regions that could encapsulate multiple fields from the Index.
295
296 With a **Map Type** and **Code** selected, click **Data Mapping** to map the field values from the Index to the relevant area of the selected map. Should any matches be found, they will be mapped automatically.
297
298 With the required fields mapped, click **Save Map** to complete the configuration process, or **Cancel** to discard changes.
299
300 == Google Maps ==
301
302 With the relevant API configured in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Third-Party"]], Google Maps can be used in reporting. Please note that the number of map loads is limited by the Google Account used to make the connection.
303
304 Select the relevant location field from the **Name** drop-down list and specify the two **Latitude** and **Longitude** fields in the Index from the applicable drop-down lists.
305
306 Under the **Layers** heading, select the required fields that will be used to add supplementary information to the map, such as county boundaries.
307
308 With the configuration options set, click **Save Map** to complete the configuration process, or **Cancel** to discard changes.
309
310 == Google Maps Drivetime ==
311
312 The Google Maps Drivetime option is also available using an API and configuring its use in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Third-Party"]]. This functionality can be built into the Index without the use of a third-party API using the [[Distance Extra Fields option>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.b\. Creating a Data Source Group.WebHome||anchor="Distance"]] in the Data Source Groups screen.
313
314 Select the Index fields from the **Venue Name**, **Venue Latitude**, **Venue Longitude**, **Patron Name**, **Patron Latitude**, **Patron Longitude** drop-down lists that specify the points that will be used to calculate the distance.
315
316 Under the **Layers** heading, select the required fields that will be used to add supplementary information to the map, such as county boundaries.
317
318 Click **Save Map** to complete the process, or click **Cancel** to discard any changes.
319
320 = {{id name="Exporters"/}}Exporters =
321
322 Using the following options, the exporting functionality can be limited to a select few file types.
323
324 Use the **Add Exporter** drop-down list to add individual file types, or click **All** to add all available options. Click the **X** icon next to the relevant entry to remove individual file types, or click **None** to remove all selections.
325
326 The specified options will apply to all reports built from the Index.
327
328 == Database ==
329
330 When the **Database** option is added, click the **...** icon to configure the database that the data will be exported to. Please note that a [[Database Connection>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Database Connections.WebHome]] must be configured and saved before the database can be specified at Index level. The database instance must be running on the same server as [[CXAIR>>doc:Technical Documentation.CXAIR.WebHome]].
331
332 Use the **Database Connection** drop-down list to specify the saved [[Database Connection>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.Database Connections.WebHome]] that will be used to connect to the target database, and select the relevant table from the **Table** drop-down list.
333
334 Click **New** next to the **Field Mappings** option to map fields from the Index to those in the database. To create additional field mappings, click **New** to reveal another row of options.
335
336 Enable the **Delete All Rows** option to clear previously exported rows before adding the new entries. If left disabled, the same records will be amended to the database table after every export.
337
338 If operating over a network with a high amount of concurrent traffic, reduce the **Rows per Transaction** value to export the data in smaller packets, ensuring the export process does not impact network performance.
339
340 == Twitter ==
341
342 Before exporting to Twitter, a number of options must be configured. Please refer to the [[Twitter Configuration>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.6e\. Twitter.WebHome]] chapter for more information.
343
344 When the **Twitter** option is added, click the **...** icon to reveal the **Screen Names** drop-down list. Select the Index field containing the screen name to map its value to the export process.
345
346 = External Files =
347
348 These options allow uploaded documents relating to the Index to be accessed from the home screen.
349
350 Click **Add** and then **Select File**. Locate and select the required file to add it to the Index. For added files, click **Edit** to replace the file, or **Remove** to delete it.
351
352 = Languages =
353
354 To translate column names into a different language, click **Choose file** to upload the relevant properties file.
355
356 Once all the options have been completed, click **Create Index** to complete the process. To build the Index and navigate directly to the [[Search Engine>>doc:Technical Documentation.CXAIR.Administration Guide.4\. Manual Index Creation.4d\. Creating a Search Engine.WebHome]] or [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen, click the up arrow next to this text and click **Create Index and View Search Engines** or **Create Index and Search**.
357
358 = {{id name="Hierarchy"/}}Hierarchy =
359
360 Using the Hierarchy options for an Index, fields can be related to enhance the ad hoc functionality in the [[Query>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2a\. Query.WebHome]] screen for end users by presenting pre-defined charts for specific fields.
361
362 To define a hierarchy, click **Add** and enter a label in the **Name** textbox.
363
364 Specify the fields that will be used to drive the resulting chart using the **Set Hierarchy** drop-down list. For example, selecting 'Region', 'Area' then 'Branch' will set the data in the appropriate order to group rows together. Drag the fields into the required order and use the **X** icon to remove any unwanted entries.
365
366 Then select the required chart from the **Set Chart Type** drop-down list and select the theme from the **Colours** drop-down list. Leaving the below radio buttons set to **Default Colours** will display the chart using the predefined colour scheme, or **All Same Colour** can be selected to specify the colour used by entering the corresponding hex code or using the popup colour picker.
367
368 A preview of the resulting chart is drawn from the top ten values and can be used to further configure the styling options. Click an area of the preview and select the area from the subsequent popup to reveal the styling options.
369
370 Click **Save Hierarchy** to save the configuration options, or **Cancel** to discard any changes.
371
372 This functionality must be enabled in the [[User Preferences>>doc:Technical Documentation.CXAIR.User Guide.6\. User Preferences.WebHome||anchor="Query"]] for users to activate this feature.