Search Tips for CxEngage Documentation

Within the CxEngage's online help, you can search all documentation pages for a specific topic or search within a page to find the content you need.

To expand the text below, click the drop-down text header. To open and close all of the drop-down text, click the Expand All or Collapse All icon () in the top right corner of this topic.

Global Search

The global search allows you to search anywhere within the specific documentation site you are using. There are currently two CxEngage documentation sites: online help and the API documentation site. Searching within one documentation site only returns search results for that site.

All CxEngage documentation sites include a search bar at the top of the page where you can enter search terms to find content in that help site.

To search the documentation site using the global search:

  1. Enter one or more search terms in the search bar.

    Search terms are not case sensitive.

    Global search for Online Help

    Global search for REST API documentation

  2. Click the magnifying glass or press Enter.

Using the global search, you can search for an exact phrase by surrounding your query with quotation marks. For example, entering "custom realtime dashboards" returns topics that contain the exact phrase "custom realtime dashboards" with terms in the order that they are entered.

Use boolean searches to narrow or expand your search results when you are using the global search:

Operator Description Examples
AND

The AND operator narrows the search so that only topics that contain all the search terms are returned. Use the AND operator when you are searching for two or more terms.

The following are interpreted as an AND operator:

  • AND
  • Search terms separated by a blank space
  • + (plus sign)
  • & (ampersand)

These search queries return topics that contain both the term "toolbar" and the term "ready".

  • toolbar AND ready
  • toolbar ready
  • toolbar + ready
  • toolbar & ready
OR

The OR operator broadens the search so that any topics that contain at least one of the search terms are returned. Use the OR operator when you are searching for two or more terms.

The following are interpreted as an OR operator:

  • OR
  • | (pipe)

These search queries return topics that contain any of the included terms: "skills", "groups" or both.

  • skills OR groups
  • skills | groups
NOT

The NOT operator returns search results that contain one search term but not the other. Enter NOT before the term you want excluded in your search results.

The following are interpreted as a NOT operator:

  • NOT
  • ! (exclamation mark)
  • ^ (caret)
 If you are searching for topics about Do Not Contact lists, surround the search term with quotation marks to create an exact search. For example, enter "Do Not Contact lists". Otherwise, searching Do Not Contact lists without quotation marks is treated as a boolean search and the topics won't be returned in the search results.

These search queries return topics that contains "toolbar" and not "reporting":

  • toolbar NOT reporting
  • toolbar ! reporting
  • toolbar ^ reporting
() Using parentheses ( ), you can combine boolean searches. Surround each boolean search within the query with parentheses.

This search query returns any topic that contains the search term "reporting" and either "realtime" or "historical":

  • reporting AND (realtime OR historical)

Searching Within a Specific Page

At times, you may need to search within a documentation page to find what you're looking for, especially with longer reference documentation such as Flow Designer Reference or Data Dictionary.

Press CTRL+F (Windows) or Command +F (Mac) to search for a specific term on the page. Enter the term in the search bar that opens and any terms that match are highlighted.

Any drop-down text that is collapsed won't be searched. To include the additional content in your search, expand the drop-downs.

There are two ways to expand and collapse drop-down text:

Click the drop-down text header to expand the text. In this example, clicking Flow Control expands the drop-down:

Clicking Flow Control again collapses the drop-down:

Click the Expand All or Collapse All icon in the top right corner of the topic to open and close all drop-down content on the page.