Searching the XML Tree

You can search your configuration workspace for occurrences of a term, to aid you in determining where to make configuration changes. The layout and operation of the XML Tree Search is very similar to the familiar online help search.

One or more search terms can be entered into the search field (both space and comma delimiters can be used). Hyphen is also treated as a word separator. Search is NOT case sensitive. Criteria options are 'all words', 'any words', and 'exact phrase'.

Using a hyphenated word in the search term will result in multiple search terms unless exact phrase is used: for example, the search term "user-id" will match occurrences of "user" and occurrences of "id".

A Search tab appears on every appearance of an XML tree:

Workspace

Snippet

State machine

Workspace command wizard

Node command wizard

Diag command wizard.

To perform a search, select the scope within the tree for the search:

selected structure (default if a tree node is selected), or

entire tree.

With this option, you can focus your search in a subset of the configuration and limit the matches to area in which you are interested. If more than one node type appears in the tree and entire tree is selected, results from every node (and the subscriber database in every node) will be returned. If, for example, a subscriber database node or PCC profile is selected, only that node and its descendants will be searched.

Check boxes allow you to define which aspects will be searched:

Search Documentation - searches all annotations except usage (display name, description, spec reference, explanation, default)

Search Usage - searches for interface application names and the description of the use within an application

Search Element Names - searches for XML tag names only

The Search button will become enabled when a search term is presented.

The display names of the tree nodes returned by the search are presented in a list that supports F1 (Help) and F3 (Navigate) features. Select an item in the list and press F1 to see the help or F3 to find that node in the tree. When searching a structure the results are sorted alphabetically; when searching the entire tree results are in schema order. List contents will remain until another search is performed. Note that using F3 will cause a tree node to be selected and that will cause selected structure to be set to that node for the next search.

Only the current contents of the tree are searched. You will not see any results for a search if you're looking for something that only appears in a particular node and that node has not been turned on.

All descendants of a structure are searched whether they appear in the tree or not. When a choice node is encountered all choices are searched. If results are returned from a choice other than the selected choice (or if no choice was selected) the choice node itself is returned. Likewise, the entire structure of a snippet will be searched but since only the snippet node is present in the tree only the snippet node is returned.