Skip to Content

Wiki source code of 05e. Index Schedules

Last modified by Tom Jardine on 06/11/2025, 14:23
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Index schedules allow administrators to specify a time and frequency for individual Index refreshes. Refreshing an Index will rebuild its content to accommodate for any new data that may have been added or for any data that has been removed. The up-to-date data is then made available to the relevant users when the process has been completed.
6
7 = Creating a New Schedule =
8
9 Click **Search Engine** then **Index Schedules** to access the configuration options.
10
11 Click **New** to create a new schedule. Enter a name in the **Name** textbox and specify the build type using the relevant radio button.
12
13 == Build Types ==
14
15
16 (% border="1" cellspacing="0" class="MsoTableGrid" style="border-collapse:collapse; border:1pt solid windowtext; width:1024px" %)
17 |(% style="background-color:#ed7d31; background:#ed7d31; border-style:solid; border-width:1pt; width:349px" width="282" %)(((
18 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
19 (% style="color:white" %)Build Type
20 )))|(% style="background-color:#ed7d31; background:#ed7d31; border-left-color:initial; border-style:solid; border-width:1pt; width:674px" width="284" %)(((
21 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
22 (% style="color:white" %)Description
23 )))
24 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:349px" width="282" %)(((
25 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
26 Build
27 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:674px" width="284" %)(((
28 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
29 Results in an Index build based on the **Index Method** selected at Index-level.
30
31 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
32
33 )))
34 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:349px" width="282" %)(((
35 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
36 With Dependants
37 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:674px" width="284" %)(((
38 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
39 Builds the Index and any associated Indexes, such as aggregated Indexes.
40
41 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
42
43 )))
44 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:349px" width="282" %)(((
45 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
46 Coalesce
47 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:674px" width="284" %)(((
48 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
49 Used to optimise the Index data structures for all non-complete build types, including incremental, cumulative and timeline indexes. To maintain a high level of performance, a weekly Coalesce build is recommended for each relevant Index.
50
51 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
52
53 )))
54 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:349px" width="282" %)(((
55 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
56 Complete
57 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:674px" width="284" %)(((
58 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
59 Overrides the Index-level Index Method and instead builds a complete Index.
60
61 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
62
63 )))
64 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:349px" width="282" %)(((
65 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
66 Auto Export
67 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:674px" width="284" %)(((
68 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
69 Used when exporting to a remote server. When selected, specify the target server from the resulting **Remote Server** dropdown list. Please refer to the [[Remote Servers>>doc:Technical Documentation.CXAIR.Administration Guide.6\. Advanced Configuration.06h\. Remote Servers.WebHome]] chapter for more information.
70 )))
71
72 == Build Options ==
73
74 Use the **Items** drop-down list to select an associated Data Source Group or Collection, and specify when the schedule will take place using the **Frequency of Execution** drop-down list.
75
76 Selecting **Dependant** as a frequency allows the schedule to be triggered once a specific Index or report schedule is run. Select individual dependencies from the **Dependant Index Schedules** and **Dependant Report Schedules** drop-down lists, or click **All** to add every created schedule. Remove individual selections using the relevant **X** icon, or click **None** to remove all selected schedules.
77
78 Selecting **Monthly Working Days** as a frequency, once the [[Working Days>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Working Days"]] and [[Holidays>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Holidays"]] options have been specified in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]], specifies the working day of the month that the schedule will run. If the specified day falls on a holiday or a non-working day, the schedule will be run the next working day. For example, setting the **Days** option to 1 will trigger the schedule on the first working day of the month. With UK Bank Holidays set as [[Holidays>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Holidays"]] and [[Working Days>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome||anchor="Working Days"]] set as Monday-Friday in the [[System Settings>>doc:Technical Documentation.CXAIR.Administration Guide.Status Monitoring.System Settings.WebHome]], for the month May 2021 the schedule will run on 04/05/2021. This is due to 1st and 2nd May being Saturday and Sunday, and 3rd May being a Bank Holiday. Specify the time the schedule will execute in **Hours** and **Minutes** .
79
80 Specify the **Start Time** and **End Time** options to configure when the schedule will run and activate the schedule with the **Enabled** checkbox.
81
82 Click **Create Schedule** to complete the process of creating a new schedule, or **Modify Schedule** to save any changes made to an existing schedule. Alternatively, click **Cancel** to discard any changes made.
83
84 = Managing Created Schedules =
85
86 Created Index schedules are displayed when the Index Schedules screen is accessed.
87
88 Use the checkboxes in the **Enabled** column to manually disable an Index schedule from executing, or click the top checkbox to disable all Index schedules.
89
90 The **Name** column will display the name given to the schedule when created, and the Data Source Group column will denote the associated **Data Source Group** that the schedule applies to.
91
92 The **Schedule** column displays the time and frequency of execution and the **Action** column denotes the selected **Build Option** for Index schedules or the system process for system schedules.
93
94 The number of failed executions is displayed in the **Schedule Failures** column and the length of time the schedule ran for is displayed in the **Duration column**. The date and time of the previous execution is displayed under the **Last Run** column and the date and time of the next execution is displayed under the **Next Run** column.
95
96 Click the **Run** icon to execute the schedule immediately or the **Edit** icon to modify the Index schedule. Click the **X** icon to remove the schedule. Please note that system schedules cannot be deleted, but they can be disabled.
97
98 = {{id name="System Schedules"/}}System Schedules =
99
100 There are a number of system schedules that are enabled by default that can be modified to optimise their efficiency. When modifying a system schedule, the **Build Type** is automatically assigned.
101
102 Please note that these are not new additions to the solution, rather they have now been made visible. If updating from a previous version, the default behaviour will remain consistent.
103
104 The following system schedules are available:
105
106 (% border="1" cellspacing="0" class="MsoTableGrid" style="border-collapse:collapse; border:1pt solid windowtext; width:1024px" %)
107 |(% style="background-color:#ed7d31; background:#ed7d31; border-style:solid; border-width:1pt; width:348px" width="300" %)(((
108 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
109 (% style="color:white" %)Schedule Name
110 )))|(% style="background-color:#ed7d31; background:#ed7d31; border-bottom-style:solid; border-bottom-width:1pt; border-left:1pt solid; border-right-style:solid; border-right-width:1pt; border-top-style:solid; border-top-width:1pt; width:675px" width="266" %)(((
111 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
112 (% style="color:white" %)Description
113 )))
114 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:348px" width="300" %)(((
115 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
116 CXAIR Configuration
117 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:675px" width="266" %)(((
118 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
119 Integral to the solution is a configuration database that contains information on users, permissions, versioning and system configuration settings. The Index refresh schedule will ensure that the most recent changes are accounted for and Indexed for the most efficient access.
120 )))
121 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:348px" width="300" %)(((
122 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
123 GC
124 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:675px" width="266" %)(((
125 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
126 The Garbage Collection functionality will scan for unreferenced objects, such as unused entries, relating to Indexes and remove them to reclaim the memory they occupy. This deallocation of memory results in more efficient resource allocation across the system.
127 )))
128 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:348px" width="300" %)(((
129 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
130 SCRIPT
131 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:675px" width="266" %)(((
132 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
133 The Backup DB script will automatically create backups of the configuration database at a defined interval. The backup files are stored in the following location:
134
135 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
136 **CXAIR/sys/databasebackup**
137
138 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
139 To restore the database from a backup, stop the CXAIR service and navigate to the following location:
140
141 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
142 **CXAIR_Database/databases/cxair**
143
144 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
145 Rename the **cxair.script** file to **cxair.script.old **and copy a backup file into the folder, renaming it to **cxair.script**. Restart the CXAIR service and the system will run using the previously backed-up database.
146 )))
147 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:348px" width="300" %)(((
148 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
149 TIDYINDEX
150 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:675px" width="266" %)(((
151 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
152 The Tidy Index schedule scans the system [[Crosstab>>doc:Technical Documentation.CXAIR.User Guide.02\. Reporting.2c\. Crosstabs.WebHome]] cache, export cache and Index directories to remove old, unused versions and free disk space.
153 )))
154 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:348px" width="300" %)(((
155 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
156 UPDATE_CURRENCY_RATES
157 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:675px" width="266" %)(((
158 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
159 The currency rates across the system are updated to reflect the latest online exchange rates.
160 )))
161 |(% style="border-style:none solid solid; border-top-color:initial; border-width:1pt; width:348px" width="300" %)(((
162 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
163 UPDATE_GOOGLE_ANALYTICS_METADATA
164 )))|(% style="border-bottom:1pt solid windowtext; border-left:none; border-right:1pt solid windowtext; border-top:none; width:675px" width="266" %)(((
165 (% style="padding:0cm 5.4pt 0cm 5.4pt" %)
166 The Google Analytics metadata across the system is updated to reflect the latest online changes, affecting the available options in the [[Google Analytics Wizard>>doc:Technical Documentation.CXAIR.Administration Guide.Wizards.e\. Google Analytics Wizard.WebHome]].
167 )))
168
169 It is recommended that all system schedules remain enabled and execute using their default values to for the system to remain as optimised as possible. However, as with any other Index task, system resources are consumed when they are running. Therefore, the system tasks should be scheduled for when little or no other activity is expected.