Visual Elements

11min
QuickQuery User Interface Overview
QuickQuery User Interface Overview



Status Icon

The status icon is located on the left of the query field, and indicates if QuickQuery is enabled and if hints are being displayed.

Document image


QuickQuery is disabled

QuickQuery is enabled and hinting is enabled

QuickQuery is enabled and hinting is disabled



Query Field

Document image


To search using QuickQuery, write your query inside the Query Field. It will automatically get color-highlighted to easily distinguish each part of the query - field types, operations, logical operators, and so on. Additionally, if hinting is enabled, a list of hints will get displayed as you type.

If your query contains an error, the corresponding part of the query will get underlined and an error message will get displayed. These are fairly understandable when a simple error is involved (e.g. an invalid field name or operation is used), but can get fairly cryptic when you make a mistake that QuickQuery can't recognize. However, in those situations, highlighting stops working at the point the error occurred, so it's usually obvious what the mistake is.



A simple error message
A simple error message

A cryptic error message caused by an obvious mistake
A cryptic error message caused by an obvious mistake






Hint List

Document image


As you type your query inside the Query Field, QuickQuery will hint possible completions by searching all permissible inputs and showing the ones that contain the characters you wrote. For example, in the picture above, all permissible inputs containing the characters "age" are shown.

You can use the arrow keys [↑] / [↓] and [↵ Enter] or the mouse 🖱️ to select a particular hint and have it inputed into the Query Field.

Each row contains the following information about the item in question, from left to right:

  • (Left) Badge indicating type of item - field, module or logical operation
  • (Left) Label of item, if it exists, or system name
  • (Left) System name of item in parentheses, if aforementioned label exists
  • (Right) Badge indicating type of field, if applicable
The selected item represents a temporal field with no label
The selected item represents a temporal field with no label

The selected item represents a link to the Accounts module
The selected item represents a link to the Accounts module

The selected item represents the AND logical operator
The selected item represents the AND logical operator



Buttons

The Search, Documentation, and Clear Results Buttons
The Search, Documentation, and Clear Results Buttons


Search Button

The Search Button is red when a query is incomplete or contains an error, and green when a query is valid and can be used to search.

The button is disabled if no change has been made to the query since the last search. If you need to execute the search again anyway (e.g. to refresh results), use [⇧Shift] + [↵ Enter] while the cursor is inside the Query Field.

Documentation Button

The Documentation Button ? leads to these webpages.

Clear Results Button

The Clear Results Button x is only enabled when a search has been executed, and cancels the query that is currently active.