Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Words and Phrases
| Search for | Example | Results |
|---|---|---|
| A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
|
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Using Boolean Operators
| Search for | Operator | Example |
|---|---|---|
|
Two or more words in the same topic |
|
|
| Either word in a topic |
|
|
| Topics that do not contain a specific word or phrase |
|
|
| Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
| A combination of search types | ( ) parentheses |
|
Hyperlink
The Hyperlink property enables you to link a widget to another dashboard or to a URL. When a user then clicks the widget, the linked dashboard or URL opens and replaces the current dashboard in the browser.
You can add variables from dashboard templates to the URL. Variables will be replaced by their assigned value when an instance is viewed. Add variables to the URL in the format ${variable}.
For example, a company uses a URL in a dashboard template to show the floor plan of their company location. They use different instances for each location and want to show the floor plan specific to each location.
The following URL replaces the query value with the value of the variable location that is assigned to the instance:
https://example.com/office-locations/floor-plans?site=${location}
When viewing the instance with the assigned value Atlanta, the floor plan for the company location in Atlanta is shown. The location variable is replaced with Atlanta in the URL: https://example.com/office-locations/floor-plans?site=Atlanta
If the variable is not defined or the template is converted back into a dashboard, the variable expression in the URL is not resolved.
For more information on templates and variables, see Template Manager.
