Object Search Panel

The Object Search Panel is hidden by default. It becomes visible when the Object Quick Search feature on the model tree panels is used, or when it is explicitly brought into view via the View Menu or the Ctrl+F keyboard shortcut.

Object Search Panel
Figure 1. Object Search Panel

The Object Search panel is divided in two parts, the Available Objects and Bookmarked Objects areas. Elements in the Available Objects area can be used to search for objects, or to refine the search by filtering. Found objects can then be moved to the Bookmarked Objects area, which keeps a list of bookmarked objects independent from the search and allows the user to create new displays from this area.

The Object Search panel is launched as a floatable panel so, to keep it visible, right click its header and change the state from Floating to Dockable, than drag-and-drop the panel to one of the target locations.

Docked Object Search Panel
Figure 2. Docked Object Search Panel

Search Options

To search for an object by name, type a search query into the search field and click enter (or click on the magnifying glass). To view more search options, click on the drop-down arrow next to the search field.

Search Options
Figure 3. Search Options

Check the boxes to search for dynamic objects only or to math the search query against object path as well as object name (the SQL Search option uses the SQL catalog to search and is explained in the section below). The Model Filter drop-down menu allows you to limit your search to a particular model or to search all model types.

The SQL search option allows you to use the SQL catalog to search for items. With this option, objects can be searched for by their property value. The search string is structured like a SQL statement, however, the system database table ‘properties’ is automatically queried and appended to the beginning of the SQL statement. Therefore, the search statement need only include the property code or path and the value for the property.

SQL Search Option in Object Search Panel
Figure 4. SQL Search Option in Object Search Panel

As an example, a search of the ObjectName property can be entered as: code IS 1 AND value IS 'FC4711' Where '1' is the property code for the ObjectName property. The result of the search is shown below:

SQL Search Results
Figure 5. SQL Search Results

The same can be done using the property path as a key, where the SQL query is written: path IS '.ObjectName' AND value IS 'FC4711'

SQL search using 'path' key
Figure 6. SQL search using 'path' key
When using the 'path' for SQL searches, remember to add the "." notation at the front of the property name. This can be conveniently accessed by right-clicking on the property in the Object Properties panel and selecting "Copy property path" from the context menu.

To search for items that are configured to store raw history values (StorageStrategy has property code 154) the following statement can be used: code IS 154 AND value IS 1 The property value for Raw Storage is 1. All objects for which raw history data is archived will be returned.

SQL Search results - Raw History Data Archived
Figure 7. SQL Search results - Raw History Data Archived

The property codes for each object are available on this page.

Available Objects Area

The search query is returned as a table of objects with further information about the objects such as Path and Object Type returned in corresponding columns (the columns visible can be configured by pressing the column selection item in the top right corner of the table). The returned search results can be further refined using the grid-filter options at the top of each column. Every executed search renews the list of available objects, replacing the old search results. However, objects can be moved to the Bookmarked Objects area to preserve them while executing consecutive searches. To do this double click the desired objects in the list, moving them to the bookmarked objects list. Alternatively you can also drag-and-drop from the available objects list or click on the cross icon. To bookmark multiple objects at once, select the objects in the list and click the cross icon in the bottom right of the Available Objects area. To bookmark all search results click the Add List icon just below the cross icon. Delete items from the Available Objects panel by clicking the Trash icon.

Object Search - Bookmarking Objects
Figure 8. Object Search - Bookmarking Objects

Bookmarked Objects

As previously mentioned, objects that have been added to the bookmarked objects list stay there even when a new search is executed. Bookmarked objects can be removed from the list by double clicking the object. This will move the clicked object back to the available objects list. Alternatively you can also drag-and-drop from the bookmarked objects list or use the Remove From Bookmarked button in the bottom-right of the window.

Object Search - Removing items from bookmarked list
Figure 9. Object Search - Removing items from bookmarked list

New displays can be opened from the Bookmarked Objects area by choosing the display type from the drop-down menu and pressing New. This will open the selected display type using the objects in the bookmarked objects area. The display can also be named prior to opening by typing a name into the Display Name field.

Objects can also be added to existing displays from the both the Available Objects and Bookmarked Objects area by selecting, then dragging and dropping into the target display (see example below).

Adding found objects to already open displays
Figure 10. Adding found objects to already open displays