Administrator Guide > Criteria Builder Help |
Criteria builder uses the field list, operators and values to assist administrators in defining searches when archiving data, building a View, building an Export and so on.
Prior to building criteria, determine what fields must be used to meet the objective. For example, if the objective is to search for all delinquent loans between 30 and 45 days, determine that the following attributes must be used to achieve the expected results.
By breaking down what is trying to be built, it is easier to identify the pieces of criteria that are needed.
The following sections define the components of the criteria builder.
The field list is a feature used throughout the Framework to define the fields to display on reports, views and exports. It is also used in criteria building for searches. Every field in an institution's Framework system can be found in the field list, including custom fields.
By default, the field selector opens in a tree format with expandable folders and sub-folders. Click the arrow next to the folder name to expand or collapse. The Persons folder and the Primary, Addresses and All Addresses sub-folders have been expanded below.
Expand the folders until the desired field has been found, or search for the field by entering any search text into the search text box and hitting Enter on the keyboard. Once the desired field has been found, click on the field to highlight it blue. Click Add Field or double-click the field to add it to the list of selected fields.
A field can also be selected in a search grid format. To change the view of the field selector from a tree to a search grid format, click the View drop-down and select Search Grid.
Locate the desired field by entering any search text into the text box and hit Enter on the keyboard. A list of results display including the field name and location. Click on the desired field to highlight it blue. Click Add Field or double-click the field to add it to the list of selected fields.
Once the field has been identified using the field list, choose the appropriate operator using the buttons in the middle of the Criteria Builder.
Below provides a summary of all of the operators within the Criteria Builder:
Operator | Description |
Equal to | Only the value entered is returned. |
Not Equal to | All other values are returned except the value entered. |
Less Than or Equal to | Used in conjunction with a numerical value. Returns values beginning with value entered and all lesser values. |
Greater Than or Equal to | Used in conjunction with a numerical value. Returns values beginning with value entered and all greater values. |
Less Than | Returns all values less than, but not including, the specified value. |
Greater Than | Returns all values greater than, but not including, the specified value. |
Is Blank | Returns values where the selected field is blank or null. Common examples include date fields, flags, and text fields. |
Not Blank | Returns values where the selected field is not blank or null. |
Is Like | Returns values where a segment of the value corresponds with the value entered. For example, entering ‘K59’ returns a value of ‘123.' |
Not Like | Returns values where a segment of the value does not correspond with the value entered. Choose a value that is ‘not like’ the value being searched for. |
Range | Sets a scope or limits for the criteria. Use a range when looking for a specific group or time frame. |
![]() |
The Not Equal to and Not Like operators individually include null records. |
Once a field and operator has been chosen, the value section of the Criteria Builder becomes available. The field and operator drive the value that can be added to the criteria. For example, if using a date field, a calendar displays in the value section to select a specific date, or range of dates. If using a flag field, a check box displays in the value section as shown below.
After a value has been chosen, click Update to add the criteria to the list.
Repeat for as many lines of criteria as desired.
How do I edit or make a change to an existing piece of criteria?
To edit or make a change to an existing piece of criteria, click on the piece of criteria that is to be updated. The line of criteria is shaded grey. Make any changes necessary and click Update.
How do I delete a line of criteria?
To delete a line of criteria, hover the mouse over the piece of criteria that is to be deleted. To the far right, appears. Click the icon to delete the criteria.
If the line of criteria is clicked accidentally and it populates in the criteria builder to be edited, clicking Cancel cancels the selection from the criteria builder without erasing the criteria.
As pieces of criteria are added, they are associated through the use of ‘and’ statements. When reading through the criteria, it states "Deceased Flag equal to True AND Employee Flag equal to True.”
In some situations, users might not want the criteria to read that way. It may be required to build criteria that shows anything with a Deceased Flag OR an Employee Flag. In this situation, switch the ‘AND’ to an ‘OR.’
Switch the statement to ‘OR’ by clicking on the 'AND' in the small box to the left of the criteria. Now the criteria reads as desired.
Grouping or Bundling Lines of Criteria Together
For more advanced criteria building, more than one line of criteria can be grouped or bundled together. This further refines and narrows the criteria results.
For example, to run a search that shows account holders residing in Pennsylvania or Delaware with birthdays on October 1st, it is necessary to have two lines of criteria to state these scenarios. Because one account holder cannot reside in both states, the states must be grouped together so the intended results are returned.
Looking at the criteria above, the desire is to have two state lines to be grouped or bundled. Hover over the line of criteria. appears on the far left.
Click the icon. A prompt appears instructing to select another line of criteria to group with the selected line.
Click the desired line of criteria to group with the selected line. After the lines are grouped together, they appear as one single line of criteria.
With the lines grouped together, click the 'AND' within the grouped state criteria lines to make it 'OR.'