Model Trees - General Usage

This section applies to all model panels that contain a model tree. The Object Search panel works differently and is covered later in this chapter. Model trees show objects of the particular model in a strictly hierarchical way. When DataStudio starts the communication with a Core on login, the top level elements of each model will be fetched. This could be multiple elements or none depending on what is already configured on the server side.

When DataStudio is started, the model panel will show the highest object in the model. To access objects further down the tree structure, use the Expand icon (triangle) to the left of the element to fetch the children of the object. No Expand icon will be visible if the object has no children.

Expanded Model Tree in I/O Model Panel
Figure 1. Expanded Model Tree in I/O Model Panel

If the expanded model tree extends past the panel size, the scroll bars on the side and bottom of the panel can be used to navigate through the tree, or click the Expand icon to collapse the tree. The model tree can also be navigated using the arrow keys. Expanding and collapsing the object’s children is achieved by using the right and left arrow keys respectively. Using the star key on the keypad will expand an entire object’s children, including any expandable branches further down the tree. To select an object either click on it or navigate to it using the arrow keys and press Enter, the selected object will automatically appear in the Object Properties panel. Multiple objects can be selected using Shift+Click or Ctrl+Click.

Refreshing

Model trees can be completely refreshed using the Refresh icon in the top right of the panel or using the shortcut key Alt+F5 (see below). Refreshing or reloading can also be achieved through the Tree Menu on the main menu bar.

Refreshing Entire Model Tree
Figure 2. Refreshing Entire Model Tree

To only refresh the children of a particular object, right-click on the object and select Refresh Children, or select the object and press F5. It should be noted that the Refresh action instructs DataStudio to purge the known model tree objects and re-fetch them from the Core server

DataStudio is part of the real time communication of inmation and therefore, gets updates of all relevant tree objects in real time. For this reason refreshing is not required in normal operation mode.

Each model tree panel contains the search text field and search button elements at the top.

Search Elements
Figure 3. Search Elements

To search for objects in the model scope of the active panel, enter a part of the object’s name in the edit box and click the Search button. The result will be shown in the Object Search panel (see later section for more details).

Object Quick Search only searches for the object names. Use the Object Search panel for advanced searching and filtering capabilities.

Context Menu

Objects in model trees share the same context menu. Depending on the object type and the access rights of the logged in user, some context menu options may be disabled.

Object Context Menu

The object context menu contains Refresh and Expand/Collapse items which perform the same functions as described earlier. The other menu items are discussed in the following sections.

Admin Menu

The Admin menu contains all available menu items for administrative users, and includes various options for changing/creating/deleting the selected item and/or its children.

Menu Item Action

New  [Object Type]

Creates a new object of the selected type as a child of the currently selected model tree object. Only the supported child object types are available

Enable  Object

Enables the currently selected model tree object and all its children

Enable  Children

Enables all children of the currently selected model tree object and all its path ancestors

Disable  Object

Disables the currently selected model tree object and all its children

Disable  Children

Disables all children of the currently selected model tree object

Delete  Object

Deletes the currently selected model tree object and all its children

Delete  Children

Deletes all children of the currently selected model tree object

Rename

Rename the currently selected model tree object

MassConfig Sheet

Opens a new MassConfig display and adds the currently selected model tree object to it

Advanced Functions  Functions

Executes the advanced function of the currently selected model tree object. Different object types supply different functions

Assign Location

Assign object location on a GeoMap display. Only available when a GeoMap display is active

Show Security

Opens a new SecurityChart display and adds the item to it

Open Log  [Time Span]

Opens a new SystemLog display, sets the object filter to the currently selected model tree object and the time span to the selected time span

Add Item to the Menu

This menu option allow the currently selected object to be added to a DataStudio display. All the DataStudio displays possible for that object type will be displayed.

Menu Item Action

Active Display

Adds the currently selected model tree object to the active display

Dashboard

Opens a new Dashboard display and adds the currently selected model tree object

Realtime Grid

Opens a new RealTimeGrid display and adds the currently selected model tree object

Realtime Trend

Opens a new RealTimeTrend display, and adds the currently selected model tree object

HistoryTrend  [Time Span]

Opens a new HistoryTrend display, adds the currently selected model tree object and sets time span to the selected time span

HistoryGrid  [Time Span]

Opens a new HistoryGrid display, adds the currently selected model tree object and sets time span to the selected time span

Data Ticker

Opens a new DataTicker display and adds the currently selected model tree object

GeoMap

Opens a new GeoMap display and adds the currently selected model tree object

Add Children to the Menu

This menu works exactly the same as the Add item to… menu described above, except it adds all of the object’s direct children to the relevant display.

Cut, Copy and Paste

Objects in any of the model panels can be cut and pasted using the context menu or the standard shortcuts for those actions: Cut (Ctrl+X) and Paste (Ctrl+V). When an object is cut and pasted to another part of a model tree all reference paths are automatically updated to the new path (this does not include paths in embedded Lua scripts however, these must be updated manually). The entire history of the item is also copied and can be accessed in the normal way once the object has been pasted to the new location. Objects can also be moved using drag and drop (see below).

Cutting and pasting objects will only work within the same model panel. The parent object for the pasting action must also be appropriate for the cut object otherwise the option to paste will not be available in the context menu.