Best Practices for Searching the Broadcom Support Site for CA Products

book

Article ID: 144893

calendar_today

Updated On:

Products

Support Portal

Issue/Introduction

The Broadcom Support Website uses the Elastic Search tool for searching support related content.
This article shares the best practices and operators that can be used for searching against CA products on the Broadcom Support Website.

Cause

This article explains how to search, search best practices and what are the search operators.

Environment

These search best practices are intended for those searching in the Mainframe, Enterprise  Software and the Symantec Security Divisions within Broadcom.

Resolution

The basics on how Search works:

  • AND is the default phrase search

  • We ignore common words (i.e. they won't be highlighted in the search results)

  • Use operators not WORDS  (use +, - , | .... not AND, NOT, OR)

  • You can search up to 250 characters

  • When you search on a word or phrase, Elastic Search returns filters based on where it found the search term. You can narrow the result set using the filters.  To search for product specific, incorporate the product name into your search term.

  • Search will capture multiple forms of same word like when user is searching for base form “work”. It also match “works” “worked”

  • Special characters that come at the end of the word will be ignored – in example: searching for these both will return the same results:

    • outofMemory

    • outofMemory,

    • outofMemory[

  • Search Results for Knowledge Articles show the ~160 characters of the context matched up to 2 occurrences found anywhere in the KB.

Limitations:

  • Not able to do partial searches of a word.  If you aren't sure, use a wildcard at the end. For example: let's say you need to search for all pages that contains all APM properties that start with introscope.enterprisemanager.metrics in that case use query string =  introscope.enterprisemanager.metrics*

  • When performing phrases searches, please note that common words are treated as a wildcard. For example, “no route to host” “APM issues” may yield results that do NOT contain all those words as common words (i.e. no and to)  will act as a wildcard in its place.


Search Query Examples-
To use one of these characters literally, escape it with a preceding backslash (\).  However phrases in double quotes by default will not need to be escaped.

Simple Query String Syntax

Example/Search Text

Explanation

Multiple terms with no operator

 

performance installation errors

is interpreted as performance AND installation AND errors

  • All the words are searched separately, not case sensitive
  • The higher the number of words that match, the higher ranking the document in the results

+ signifies AND operation

Jack +jill

  • Returns documents that contain both jack and jill.

| signifies OR operation

 

Jack | Jill

  • Returns documents that contain Jack or Jill or both.
  • As this is the default behavior you may use this in complex queries with multiple operators.

- negates a single token

 

Jack -Jill

  • Anything following the minus sign (-) will NOT be returned
  • Returns documents that contain Jack but not Jill

“ wraps a number of tokens to signify a phrase for search

“The fox jumped over the lazy dog”

  • Returns ONLY documents containing the exact string in the double quotes

* at the end of a term signifies a prefix query

Jump*

  • Returns documents containing words beginning with jump completed by any number of characters in place of the * character such as, Jump, jumped, jumping

( and ) signify precedence

 

Jack + (fox OR lazy) - Jill

  • Returns documents that contain Jack but NOT Jill and either fox or lazy

~N Fuzzy searching

John~2

  • Uses the Damerau-Levenshtein distance to match terms that are similar in spelling.  This is great when your data set has misspelled words.  Use the tilde (~) along with a number to specify how big the distance can be.  John~2 will match words such as: Jean, Johns, horn

Additional Information

Click here to watch a short video on how to best search: https://youtu.be/JaPYl5AvtNw

Attachments

1592850061803__ElasticSearch Quick Reference Guide.docx get_app