Skip to content

QueryDash Usage Guide

The QueryDash page is a utility for performing elasticsearch queries on the underlying database. Results are displayed in a table, with a named link to each document in the first column.

It should be noted that the QueryDash is not a formal page for use by customers. Instead, a customised listing template (eg using sc-datatables) for customer oriented listing pages is recommended.

QueryDash Screenshot

Creating a query and running

To create and run a query,

  • Open the QueryDash template in your Formbird application
    (documentId = c6097e00-ce29-11e5-bce0-c145a769f5e9 )
  • Write the query within the "Query" field.
  • A sample query is supplied on a new instance of QueryDash.
  • Use double quotes (") to surround key terms and values, not single quotes ('). See below about toggling quotes if copying from another source.

  • To run the query, click the button "Run".

  • The results will display above the "Query" field.

Saving a QueryDash

The QueryDash page can be saved, like any other template. It requires a Name to be defined before saving (for reference).

Results will not be saved with the page. The query itself will be saved, and rerun when the QueryDash document is opened again, or reloaded.

Showing Other Fields

By default, the query will result in a listing of documents, showing primarily the systemHeader.summaryName of the documents (headed by "Name"). Also by default is a column for the "query" field, which in most cases will be undefined.

The systemHeader.summaryName will always show as the first column.

To show other fields in the list, add a comma separated list of field names in the "Fields to show" field, eg

email,firstName,surname

There is currently no setting of width for these columns; widths will generally be made wide enough to see all columns on the page.

Showing Array Fields

Specific array field values can also be shown, using field.numeral.property type notation, eg

menu.0.description

Showing Date Fields

Date fields may also be shown, eg

systemHeader.createdDate

However, these will be represented in a raw ISO format, ala "2016-03-22T05:37:29.773Z" for "22 Mar 2016, 3:37:29pm"

Showing a listing of QueryDashes

The default query on a new QueryDash page is defined to display a list of existing QueryDashes. Simply open a new QueryDash and click "Run".

Limitations

The QueryDash will only show fifty (50) results of any query. However, it will display the total count of matches at the top of the query results.

If a particular set of documents that don't appear in the first fifty results is required,

  • Change the query to narrow down the search.
  • {"wildcard": {"field-name" : "D*" }} added to the filter array will return those results whose field-name starts with "D".
  • Add a "from" argument to the search query
  • "from":50 will fetch the second bloc of fifty, "from":100 will fetch the third bloc, etc
  • Add a "sort" argument to the search query, to favour the particular set required.

The QueryDash is also limited by the user's granted access to documents. This will not display those documents that are locked by security keys that the user does not have.

Additional Features

Toggle Quotes

This button changes all quotation marks in the query pane from double to single quotes & vice-versa.

Only double-quotes around terms and values are recognised in running a query on this page.

If your query contains both kinds of quote marks, say for one that is enclosed within another, do not use this button. It will change all quotes to one or the other, but will not maintain the mixed states.

Useful for copying and pasting queries from ruleset script or other query utilities.