The Search Tab

Faceted search provides a static tab named Search.

Note: The Search tab is only visible to an AVEVA AIM user if the Faceted Search feature is enabled in their environment.

To initiate a search request:

1. Specify the search term in the search textbox.

2. To refine your search, you can select a high-level category – Tags, Documents, Events, Tasks, Locations, 3D Models, Physical Equipment, Activity and All – from the dropdown list.

   

   Note: Selecting All means searching all of the listed categories.

3. Select the search icon present on the right of the textbox or press Enter.

   

   

   You can refine your search results based on the available filters, such as:

   • Type of artefacts for example All, Documents, Tags, Events and so on.

   • Applicable Types: Further classification for the type of artefact, if available. Applicable Types are disabled when type All is selected.

     • The Applicable Types dropdown allows you to select up to five sub-types from the available list.

       

     • All the other options in the list are disabled and a message is displayed.

       

     • You may deselect any of the five sub-types and select a new option.

     • The selected Applicable Types are retained when clicking in and out of the Applicable Types dropdown.

     • The selected Applicable Types are reset once Type has been changed.

   • The checkbox Within Document is only enabled when type All or Documents are selected. For other types this checkbox is disabled

     After a search request is issued, the search window is updated.

     The search window is divided into three main sections:

   • Facet pane – displays names of all attributes and their values for the search criteria.

   • Search results pane – displays the results for the search criteria.

   • Attributes pane – displays names of the attributes and their values for a specific object.

     

4. To view the search results beyond the first 50, select Next.

   

Actions menu

You can use the Print and Export actions available in the Faceted Search Actions Menu, when one or more files are selected.

• Selecting Print opens a popup, allowing the option to deselect or reselect selected files for printing.

  

• Selecting OK processes the selected documents for printing.

• Selecting Cancel exits the pop-up.

• Once selections are confirmed, a message appears and a second pop-up displays to adjust print settings, if required.

  

• Selecting Print from this pop-up triggers printing.

• Selecting Cancel exits the pop-up.

  

• Selecting Export from the Actions menu opens a pop-up, allowing chosen files to be deselected or reselected as necessary.

• Within this pop-up you can also choose the data type and location to export.

  

• Click Export queues selected documents for export/download, closing the pop-up and displays a success message.

  

• Selecting Cancel from the Export pop-up exits the pop up.

Wildcard Searches

Wildcard searching enables you to enter a search term that matches any characters.

You can use an asterisk character (*) to specify a wildcard, which will match zero or more characters.

For example, "test*" will match any word that starts with "test", such as "test", "test1", "testable".

However, it is NOT recommended to start a search term with a wildcard, for example "*test", because it may impact the performance of the search operation.

Search for a Phrase

To search for exact phrases present in tag or document data, enclose the search term within double quotes.

As shown in the following screenshot, the "ball valve" search term is enclosed within double quotes so the search results get only those values in which the whole phrase "ball valve" appears:

Note: Currently, it is NOT recommended to use a wildcard character (*) inside a search phrase as it may lead to unpredictable results. Also, currently, when using a search phrase, the ordering based on relevance of individual fields is not supported.

Compound Searches

Compound searches enables you to provide multiple search criteria within a single search term by using the plus character (+) and the vertical bar character (|). A + provides an AND operation. A | provides an OR operation.

Currently, search terms support either + or | but not both at the same time.

For example, consider the case where you need to search for the exact phrase "ball valve" and results must mention the word "pump". The search term would be "ball valve" + pump.

Warning

If a search response has more than 50 records (and the Next button is visible) and you modify the facet filter criteria but do not select Apply, then, a warning message will be displayed and the pagination will not happen:

If you have searched for "pump" in the Tags category and selected Apply, but now you change the search term to "pumps12", without searching or applying, and then try to load more facets or navigate to the next page, then the search text would be modified back to "pump". This is because you did not apply the modified search term "pumps12" and the actions that you are performing now are based on the results that came when you searched for "pump".