XWiki - Technical Documentation.CXAIR.Administration Guide.Wizards.c\. Aggregation Wizard

The Aggregation Wizard allows the creation of an aggregated version of an existing Index to improve a query performance against Crosstabs or to use as a standalone Index. When completed, a Data Source Group and Index is created.

6

7

To create an Aggregated Index, click **Wizards**, then **Aggregation**.

8

9

Click the **New** button to begin the process.

= Creation Process =

== Details ==

Enter the name that will be given to the associated Data Source, Data Source Group and Index in the **Name** text box.

16

17

Use the **Tags** text box to add associated search terms to the Index structure. This allows the components to be searched using alternative strings when using the search bar.

18

19

To automatically restrict access to the Index once built, enable the **Sensitive** option. Only users with explicit permission will be able to access the Index.

20

21

**Note: **Only a Complete build method can be used for this Data Source type.

22

23

Use the **Index Size** drop-down list to specify the expected number of records the resulting Index will contain. This is an indicative value and does not need to be exact.

24

25

Using this drop-down list allows the system to work out how many folders to split the Index into. The higher the specified Index size, the less folders created. A lower number of folders results in less threads used to query the Index, as a single thread is allocated per folder. This decreases the speed of individual queries, but reduces the performance impact of multiple concurrent users querying the system simultaneously.

26

27

Use the **Add to Search Engine** drop-down list to select the relevant search engine the Index will be added to upon completion and the **Add to Collection** drop-down list to select an existing Collection to which the Index will be added.

28

29

Enable the **Build Now** option to build the Index as soon as the creation process is complete. If disabled, the settings are saved for the Index to be built at a later time.

== Setup ==

Select the required Index from the **Index** dropdown list, and specify the fields to be used in the aggregation using the **Columns** dropdown list. Click **All** to select all entries, or **None** to clear all currently selected entries. Remove individual entries by clicking the relevant **X** icon.

34

35

Specify the total fields to aggregate when the Index is built using the **Aggregations** drop-down list.

36

37

Enable the **Automatically Refresh** option for the aggregated Index to stay up-to-date and rebuild whenever the original Index is rebuilt.

38

39

Enabling the **For Crosstab** option will not result in a separate aggregated Index being created. Instead, every time the [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] functionality is used with the original Index, aggregated values will be used to improve performance. Please note that the aggregated values are ignored if a filter is used in the report. Disable this option to create a separate Index from the original that can be used like any other.

version	line-number	content
1.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
	4
	5	The Aggregation Wizard allows the creation of an aggregated version of an existing Index to improve a query performance against Crosstabs or to use as a standalone Index. When completed, a Data Source Group and Index is created.
	6
	7	To create an Aggregated Index, click Wizards, then Aggregation.
	8
	9	Click the New button to begin the process.
	10
	11	= Creation Process =
	12
	13	== Details ==
	14
	15	Enter the name that will be given to the associated Data Source, Data Source Group and Index in the Name text box.
	16
	17	Use the Tags text box to add associated search terms to the Index structure. This allows the components to be searched using alternative strings when using the search bar.
	18
	19	To automatically restrict access to the Index once built, enable the Sensitive option. Only users with explicit permission will be able to access the Index.
	20
	21	Note: Only a Complete build method can be used for this Data Source type.
	22
	23	Use the Index Size drop-down list to specify the expected number of records the resulting Index will contain. This is an indicative value and does not need to be exact.
	24
	25	Using this drop-down list allows the system to work out how many folders to split the Index into. The higher the specified Index size, the less folders created. A lower number of folders results in less threads used to query the Index, as a single thread is allocated per folder. This decreases the speed of individual queries, but reduces the performance impact of multiple concurrent users querying the system simultaneously.
	26
	27	Use the Add to Search Engine drop-down list to select the relevant search engine the Index will be added to upon completion and the Add to Collection drop-down list to select an existing Collection to which the Index will be added.
	28
	29	Enable the Build Now option to build the Index as soon as the creation process is complete. If disabled, the settings are saved for the Index to be built at a later time.
	30
	31	== Setup ==
	32
	33	Select the required Index from the Index dropdown list, and specify the fields to be used in the aggregation using the Columns dropdown list. Click All to select all entries, or None to clear all currently selected entries. Remove individual entries by clicking the relevant X icon.
	34
	35	Specify the total fields to aggregate when the Index is built using the Aggregations drop-down list.
	36
	37	Enable the Automatically Refresh option for the aggregated Index to stay up-to-date and rebuild whenever the original Index is rebuilt.
	38
	39	Enabling the For Crosstab option will not result in a separate aggregated Index being created. Instead, every time the [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] functionality is used with the original Index, aggregated values will be used to improve performance. Please note that the aggregated values are ignored if a filter is used in the report. Disable this option to create a separate Index from the original that can be used like any other.

Wiki source code of 03c. Aggregation Wizard