Keyword Search - Integration - Update 44 - Help - Hexagon

The Schema Editor supports keyword searching of the Name and Description property values using a Web-like syntax.

Simple Keyword Search

1. Click Keyword Search on the Find tab to open a single keyword list box.

2. Type the criteria on which to search or select an existing keyword search from the list.

   

Any keywords entered into this field are used to search the Name and Description property values for all objects of the selected classes for the specified information set or sets. Entering a keyword into this field is the equivalent of entering the same text into the Name and Description fields with the following differences:

• Keyword searches check both the Name and Description property values.

• Wildcard asterisks surrounding the keywords are not required and, in fact, should not be included as they are treated exactly as any other character.

• Multiple keywords can be entered whereas only one keyword could be specified using the UID, Name or Description test fields.

• The ALL, ANY, and NOT operators can be used to qualify the search to be performed.

• Multiple words in sequence can be specified by enclosing those words inside quotation marks.

• Keyword searches are case insensitive.

• Keyword searches check both the Name and Description property values for each object whereas criteria specified using the UID, Name and Description text fields only searches the specified property value.

• When using the keyword search, it is recommended that you do not use wildcards, such as asterisks. Any asterisks included in the keyword search criteria will be treated like any other character. For example, specifying *Piping* as a keyword would only match an object that explicitly contained *Piping* (including the asterisks) in its Name or Description property value.

• You can do a search on multiple keywords. For example, type Piping Component and the search matches objects containing both Piping and Component in their Name or Description property values. By default a match on the keyword criteria will only apply if the Name or Description property values contain all the specified keywords (the criteria uses the AND operator). However, the user can change that behavior by using the ANY and NOT operators.

• Keywords using the ANY operator are treated like criteria using the OR operator. For example, any object that matches any of the keywords after ANY will be considered to satisfy the criteria. Therefore, specifying a keyword criteria of Any Piping Component attempts to match objects containing either Piping or Component in their Name or Description property values.

• Keywords using the NOT operator in the criteria identify keywords that are not to be found in the Name or Description property values. For example, a keyword criteria of Piping Not Component attempts to match objects that contain Piping in their Name or Description values but do not include Component in that property value.

• The ALL operator is also a special keyword. Its use defines that an object must match all of the specified keywords in the criteria. There is an implied ALL at the start of any keyword criteria and, therefore, normally ALL is not specified. For example, the keyword criteria Piping Component and All Piping Component are equivalent.

• ALL, ANY, and NOT operators can all be specified as part of the keyword criteria. For example, the keyword criteria Piping Any Valve Component Not Gate specifies that a matching object must include the Piping keyword, must include either Valve or Component and must not include Gate.

• Since ALL, ANY, and NOT are special keywords, if the keyword criteria should include one of these special keywords, they must be enclosed within quotation marks (“”). The keyword search criteria “All” Piping attempts to match objects that contain both the All and Piping keywords in their Name or Description property values.

• If a search matching multiple words in sequence is desired, then those words should be enclosed inside quotation marks (“”). For example, the keyword search “Piping Component” only matches objects that contain Piping Component in their Name or Description property values.

• Keyword searches, unlike criteria specified using UID, Name, and Description, is case insensitive. Therefore, while a Name criteria of *Piping* only matches an object with a Name value that contains Piping with a capital P, a keyword criteria of Piping will match a Name or Description value that contains a lowercase p (such as piping).

Advanced Keyword Search

Advanced keyword searching is also available using the ALL, ANY, and NOT operators. Click Advanced and separate search boxes appear for these specific search operators, one for specifying the ALL criteria, one for specifying the ANY criteria, and one for specifying the NOT criteria. For example, searching on Piping Any Valve Component Not Gate on the Advanced group would appear as follows.