Global Search Viewer Screen - BCPro - LIT-12011905 - Server - BCPro Data Server - 4.0

BCPro Data Server

Brand
BCPro
Product name
BCPro Data Server
Document type
User Guide
Document number
LIT-12011905
Version
4.0
Revision date
2020-03-27
Language
English

The Global Search Viewer allows you to perform a global search for like objects in your BCPro system. You can access the Global Search Viewer from the Query Menu by selecting Global Search. The Global Search Viewer opens in the Display Frame of the BCPro system Site Management Portal.

You can have multiple Global Search Viewers open, but can only initiate one search at a time within the same UI. If you try to start another search in the same UI, an error message appears stating you must either stop the search in progress, or wait until it completes before initiating another search.

By default, the Global Search feature supports a maximum of 500 items displayed in a Global Search Viewer. If the search results reach the maximum number of items, a message appears stating the current search is too broad and you should change the search criteria to narrow the search and try again.

Figure 1. Global Search Viewer Screen

Table 1. Global Search Viewer Screen Components

Screen Area/Item

Description

Instructions Area

Provides tips to help you perform a search.

Search Locations List Box

Lists the parts of the BCPro system navigation view you selected to search.

When you initially invoke the Global Search feature, any items currently selected in the navigation view appear in the Search Locations list box. If no items are selected in the navigation view, the box appears blank. Make or change selections using the Add and Remove buttons.

Add Button

Opens the Select Item dialog box and allows you to select the parts of the system you want to search. You can select items from the All Items tab.

You can search the entire site, one or more devices, one or more trunks on a device, and so on. Use the Ctrl or Shift keys when clicking to select multiple items. After completing the dialog box, the items you selected appear in the Select Scope box.

Remove Button

Removes selected items from the Search Locations list box.

Object Name Box

Allows you to type the full or partial name of the object you want to find. You can leave it blank for a more expansive search. You also can use one or more wildcards (* or ?) to aid in your search.

Wildcard Examples:
  • LCP-2*
  • ZN-T*
  • OCC-S*

The object name search is not case-sensitive.

The search looks at the Name attribute. For searches against user navigation views, the search also considers the user-defined label assigned to the item within that particular navigation view, and includes the item if its Name attribute or its label matches the search criteria for object name.

Object Type Drop-Down List

Allows you to select a specific type of object to search for or to search for all object types. Options include:
  • All (excluding trend extension)
  • Trend Extensions
  • Schedules
  • Calendars
  • Field Devices
  • Field Points

Include child objects Check Box

Includes all child objects of any items found when searching the Search Locations. That is, it includes the nested child objects.

Include search location objects Check Box

Includes the location items in the search results (if they meet the search criteria), as well as any items found when searching in those locations.

For example, if you initiate a search on a Field Bus named MSTP Trunk 1 to search for all objects named *2*, and you check Include search location objects, the results include the Field Bus in the results. If you do not check the option, the search results only include items under the Field Bus (along with their child objects, if the Include child objects option was checked), and does not include the Field Bus itself.

Search Button

Begins the search.

Stop Search Button

Cancels a search in progress and no more new objects appear in the Search Results table.

Search Results Table

Displays the results of the search.
  • Dynamic data in this table automatically refreshes periodically. The refresh rate depends on the platform to which you are logged in.
  • If you select an item in the Search Results and place your cursor over it within each column, tooltips appear providing more information, if available.
  • Any data that does not fit within the columns is identified by an ellipsis (...). You can resize the column or place your cursor over the table cell to see its tooltip text.
  • If the search finds an object in more than one location (for example, in the All Items navigation view and in a user navigation view), the object is listed twice in the Search Results Table. If the same location is searched a second time, or if search locations overlap, the object is not repeated in the table. Items are only repeated in the table if their location differs.
See the Working with Search Results section for more information on manipulating and using the table data.

Status Icon Column

Displays the icon of the object’s current status as defined by its Status attribute.

Icon Column

Displays the icon of the object as it appears in the navigation tree.

Status Column

Displays the object’s current status as defined by its Status attribute.

Name/Label Column

Displays the object’s name as defined by its Name attribute. The object’s full reference identifier appears in a tooltip when the cursor is placed over the name.

Value Column

Displays the object’s value as defined by its default attribute (generally, the Present Value attribute).

Units/States Column

Displays the Units attribute data for analog objects, Number of States attribute data for multistate objects, and appears blank for all other objects.

Description Column

Displays the data defined in the object’s Description attribute.

Location Column

Displays the object’s context, specifically its location within a particular navigation view.

Type Column

Displays the object’s type.

Category

Displays the object’s category as defined by its Object Category attribute (for example, General).

Signature

Indicates whether a signature is associated with the object.

Annotation

Indicates whether an annotation is associated with the object.

Select All

Selects all rows in the Search Results table.

Clear List

Removes all of the objects from the Search Results table.

Remove From List

Removes selected objects from the Search Results table.

Add New

Allows you to manually add one or more objects to existing search results (where the added objects append to the bottom of the existing Search Results table).

Copy to Clipboard

Copies the selected search results in a tab-delimited format to the Clipboard for pasting into other applications such as Microsoft Excel or Word.

Status Bar

Displays the current location being searched while the search is in progress, the status of the search, and the number of objects found.