Skip to Content

Wiki source code of 05b. System Diagram

Last modified by Tom Jardine on 06/11/2025, 14:23
Hide last authors
Tom Jardine 1.1 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 Using the interactive System Diagram, administrators have access to a visual representation of a system’s underlying Index structure and all associated schedules.
6
7 To access the System Diagram, click **Search Engine** then **System Diagram**.
8
9 Use the drop-down list at the top of the page to restrict the number of Indexes that will be displayed. Selecting **All Indexes** will not apply any restrictions, while the **Last 20 Built** and the **Built This Week** options will limit the displayed Indexes based on a specific time frame.
10
11 The diagram can be further filtered by typing a term the search bar and clicking **Refresh / Filter** or by clicking a letter in the alphabetical list. To access the **Key**, click the **?** icon.
12
13 = Diagrams =
14
15 When viewing a diagram, nodes can be moved anywhere on-screen using drag-and-drop functionality and the entire view can be moved by clicking and dragging the background into the desired position. Zoom in and out of the diagram using the scroll functionality on the connected mouse.
16
17 Use the **Diagram** drop-down list to change between the various available views.
18
19 == Index Overview ==
20
21 The **Index Overview** diagram will detail the Indexes on the system as interactive nodes, denoting links using arrows. Use this view to filter down to specific Index structures.
22
23 Each node displays the number of rows of data it contains along with the last time it was updated, the next scheduled update and how many reports have been built.
24
25 Use the **Search Engine** drop-down list to restrict the view to a specific Search Engine, or select **All** to display results from every Search Engine across the system.
26
27 For systems that contain a large number of Indexes, there are options available to filter the results. The **Index** drop-down list allows a specific Index to be selected or, if no Index is specified, the **Limit Indexes Displayed** option is available. When enabled, the diagram will only display the number of Indexes specified in the **Indexes Per Page** option.
28
29 To select a specific Index, use the **Index** drop-down or double click one of the displayed nodes. Once an individual Index has been specified, a number of options are revealed. The **Degrees of Separation** option allows the specification of how ‘steps’ away from the original Index are displayed and is an especially useful option when there are a large amount of linked nodes on-screen. Click **Select All** to select every displayed node, and clear any selections by clicking **Deselect All**. Click **Build Selected** to refresh every selected item based on the build method specified when created.
30
31 Clicking **Expand All** will reveal all of the associated Data Source Groups and Data Sources. These can be hidden by clicking **Collapse All**. To clear the individual selection from the **Index** drop-down list and display all available Indexes, click **Back**.
32
33 === Node Interaction ===
34
35 Click the arrows at the top-left a node to show or hide the node details, and click the menu icon located at the top-right corner of a node to reveal further options. Click the **Preview** icon to open a preview window, or the **Show/hide** icon to show or hide associated Data Source Groups and Data Sources.
36
37 == Tree ==
38
39 The **Tree** view displays a hierarchical view of each Search Engine, Index, Data Source Group and Data Source. Use this diagram to view an entire system in an ordered and organised structure.
40
41 Use the **Search Engine** drop-down list to restrict the view to an individual Search Engine.
42
43 === Node Interaction ===
44
45 Each Index and Data Source node has an **Edit**, **Copy** and **Delete** icon. When the desired modifications have been made, the solution will be directed back to the System Diagram screen.
46
47 Click the **Edit** icon on a node to edit its underlying details in the relevant functionality area. Click the **Copy** icon to enter the relevant functionality area with the node’s underlying structure copied, allowing changes to be made that do not affect the original source. Click the **Delete** icon to remove it from the system.
48
49 Data Source Groups also contain refresh icons. Click the **Start** icon to rebuild the Data Source Group based on the build method specified when created. When a rebuild is in progress, the process can be stopped by clicking the **Stop** icon, or paused by clicking the **Pause** icon.
50
51 == Network ==
52
53 The **Network** view displays the entire system, or a selected Search Engine, as an interactive network that can be navigated by following the various link types. Use this view to understand how Search Engines are constructed.
54
55 Use the **Search Engine** drop-down list to restrict the view to a specific Search Engine, or select **All** to display results from every Search Engine across the system.
56
57 The available options for each node are the same as those detailed for the **Tree** view Node Interaction settings.
58
59 == Schedules ==
60
61 The **Schedules** view displays every schedule in an interactive Gantt chart.
62
63 Use the **Sort By** drop-down list to change how the schedules are ordered, either by **Build Order** or **Name**, and enable the **Show Disabled** option to display the schedules that have been configured but are currently disabled. This is especially useful when considering the system load at a specific time, as additional schedules may require modification to reduce the number of simultaneous tasks.
64
65 Click a schedule on the chart to modify its settings in the relevant functionality area. Once the changes have been saved or discarded, the solution will redirect back to the **Schedule** diagram view.