Query Builder Screen

Data is captured on the following tabs of the Query Builder screen: Filter Criteria, Fields and Parameters. Below are descriptions for the fields on these tabs.

Filter Criteria

The filter criteria determines what data is displayed in a grid. If no criteria is defined, then no filter will be applied and all records will be returned from the server. There is a limit of 100 000 records that can be retrieved on a grid.

To define what you want to see on the grid, click Add criteria (), then specify the Field, Operator and Value. Filter criteria is applied directly to the records on the grid. You can add one or multiple criteria.

Field

Click on the Field to select a Field or Function to build the query with.

  1. Field: Select the field that you want to apply the filter on.
  2. Function: Look up a function to be included in the query and add the related details.

Operator

An operator is a symbol or character that represents an action or process. Operators are used in filter expressions to determine the range of items that appear in the grid list. Different operators are available in the drop-down list, depending on the Field selection.

Possible operators include:

  • Equal
  • Not Equal
  • Less Than
  • Less Than Or Equal
  • Greater Than
  • Greater Than Or Equal
  • In
  • Not In
  • Contains
  • Not Contains
  • Like
  • Not Like
  • Is Null
  • Is Not Null
  • Starts With
  • Ends With.

Value

Click on the Value to select the Field, Functions or Parameter you want to use to filter the data.

Please note, the Value is case-sensitive.

  1. Field: This corresponds to the Field you've selected to apply the filter on. You can select another field to base your query on.
  2. Functions: Functions further enhance the filtering capabilities within the query. They provide further flexibility in creating complex filtering queries and can be used to return specific values for the relevant resource. You are able to specify a user parameter for the function.
  3. Parameters: Parameters can be defined per filter criteria in your query. Parameters prompt the user to allocate a default value by which the data will be filtered. A parameter is defined in the Value by specifying the following information:
    • Parameter Name: Provide a name for the parameter. This is the name that is displayed to the user. The Parameter Name is the same as the field name. However, you have the ability to customise the parameter's name according to your business requirements.
    • Default Parameter Value: The default value for the specified parameter. This is to specify a value for what you are searching for.

For the advanced user making use of complex queries, the Text View and Clear Query options are accessed by clicking Toggle preview ().

You have the ability to enable and disable filter criteria. To disable a filter criteria, switch the toggle associated with the expression to OFF. When disabled, the filter criteria expression will be greyed-out. To enable the expression again, switch the associated toggle to ON.

Fields

Data Source Fields

There are data source fields listed in the query builder, by default. These are the fields that are available for you to base your query on. The same fields can be accessed on the Available tab in the properties panel, which contains all the columns that you can display on the grid.

Other, related data source fields can be accessed by clicking Add Field (). The fields are displayed in a tree view (an hierarchical view of information that enables you to drill down from the parent field to the child items) on the Choose Fields screen.

When additional fields are added, these are displayed in the data source list, on the Selected tab in the properties panel, as well as on the grid as columns.

Data source fields determine what can be found in the properties panel. The Available tab in the properties panel contains a standard amount of fields that correspond to the default data source fields in the query builder. The Selected tab includes the data source fields that have been added manually from the Choose Fields screen in the query builder.

Records can be cross referenced to a different area/entity in the system to see where it is used. For example, to build the Cost Centre dashboard, a cross reference field can be added for work order codes. Refer to Cross References. for more information.

To remove a data source field from the Fields tab, select the checkbox associated with the data source field, then click Remove Field (). The removed fields will no longer be available for use in a query. Required fields, for example WorkOrder->Code, cannot be removed.

Parameters

This is a view of the active parameters defined in your query. Parameters are added automatically to the Parameters tab when they are used in the filter criteria.