Query Builder Basics

This feature is available to all users

Selecting Your Entity Type

With the new updates to query builder, it's important to make sure that you select the entity type(s) that you want to search through.  The entity type option is below Assessment on the Query Builder.  Importantly, if you choose more than one entity type, the query builder will search across both types for any other criteria.  For example, if you have both people and contractors selected as entity types and you search for Assessment level 1, the results will return any person OR any contractor assessed at level 1.

The Entity Type can also be used without any other criteria to show a specific entity type or multiples types together on the wall chart. 

Running and Resetting Queries

To run a query, select the criteria you want to use and select Run Query at the top of the Query Builder. If you are successful the Wall Chart will update with only people matching the criteria you selected. You should also see pills at the top of the list summarizing what criteria you selected.

To bring back your full list, select Reset Query. Reset Query will erase your query and go back to the full list immediately.

Optimizing Query Builder

Before using Query Builder, there are two important things to keep in mind:

First, the current version of Query Builder can only run simple queries, which means that everything runs in one step. 

Second, selections within a category use an "OR" operator, whereas selections between categories use an "AND" operator. This is best illustrated with some examples.

For example, selecting Assessment level of 1, 2 and 3 in the Query Builder will return anyone who has an assessment of 1, 2 OR 3. That is because all of your selections are within one category.

Brian, Martha, Michael and Kelsey all have Assessment levels of 1, 2 or 3

However, if you selected Assessment levels 1, 2, and 3 and selecting anyone flagged under "Follow Up", then this will return anyone who has an Assessment of 1, 2, or 3 but only if they are also flagged for Follow Up. That is because your selection now encompasses multiple categories, and so the AND operator applies between categories.

Only Michael has an Assessment level of 1, 2, or 3 and is Flagged for Follow Up

Check out our article on Query Builder Criteria for information on each available field and how it interacts with itself and other criteria.