Filtering enables to you to select specific submissions from your dataset that match one or more criteria that you specify. By default, no filters are applied and all submissions are returned. Any filters you choose to specify apply across the Overview, Grid, Export, Map and Chart outputs displayed below the filter bar. You can also save filters by creating a published report.
These are the several types of filters available:
- Date range: filter submissions received or captured between specific dates
- Fieldworker: filter submissions captured by particular fieldworkers
- Language: filter submissions captured in a particular language
- Field responses: filter submissions where fields match the criteria you specify
Date range filter
- When filtering by date, you have the option to filter either on the dates that submissions were received by the console, or on the dates that the submissions were captured by the fieldworker.
- The captured date is the start date of the submission as recorded by the handset. This is dependent on the date and time of the handset and will be inaccurate if the date and time on the handset is inaccurate.
- The date that you select will be displayed in YYYY/MM/DD format (year/month/day).
- To see all submissions, leave the 'From' and 'To' dates blank.
You can choose whether you would like to see submissions from all your fieldworkers or from specific fieldworkers only. By default, submissions from all fieldworkers are shown. To change this, click 'Change selection'.
From the 'Fieldworker selector' pop-up, you can deselect the fieldworkers whose submissions you do not want to see. When you are satisfied with your selection, click 'Submit'.
If your form has been set up in multiple languages and submissions were received in some or all of these, you will be able to filter by one or more of the languages. By default, submissions received in all languages will be displayed. You can simply click on the check box next to a language if you do not want to see submissions in that language.
Field response filter
If you wish to select submissions based on data captured by fieldworkers, you can configure field response filters. These filters use a common syntax called Lucene.
For example, if your form contained a multiple choice field type called "Household Characteristics" with option labels "Wood", "Brick", "Mud", "Iron", "Other" and "None of the above" (option values 1 through 6), and a numeric field "Year Moved In", you could filter for submissions with wooden houses (option value 1) where residents took occupancy in 2010 by creating a filter:
Note that you must replace spaces contained in field names with underscores. Also note that for integer fields, you must add "mobint_" to the field name so that the system knows not to do a text-based match (see additional tips for filtering). This becomes really useful when you want to do numeric filtering. For example, if you want to find wooden houses where residents took occupancy between 1999 and 2011, you can use the following filter:
For most filters, you don't need to remember the correct syntax, exact field names or option values. You can click the "modify filters" link to access the filter builder.
Here, you can select the fields and values you want to filter on. By default, the query will be constructed using "AND". This means that only submissions matching all the filters will be returned. You can change this behaviour by replacing "AND" with "OR", which will return submissions matching any of the applied filters. You can also use parentheses to group filters as you need them. Once you've applied the filters, the matching submissions will be displayed below the filter bar.
If you would like to search for submissions that do not match your search criteria, you would need to put a minus before the field name. For example, if you wanted to see the number of submissions where the gender selected was not male, you would see all the submissions where male was not selected, including submissions where the field was skipped.
For more advanced Lucene filtering, you can read through the "View tips and examples" link available in the filter builder.
Note: When filtering for a date response, you need to use the YYYY-MM-DD format, and not DD-MM-YYYY as it appears on the submissions.
A note on repeating sections
When filtering based on fields taken from repeating sections, it's important to remember that filters are applied to the entire submission. This means that the entire submission (including all other iterations - which may or may not match the selected filter) will be returned if any of the iterations match the filter. Filters apply to submissions as a whole - not to individual sections.
For example, assume you have a form which enumerates household members in a repeating section. Setting up a filter to return males will return submissions (households) where males were enumerated or where males and females were enumerated because the filter is applied to the submission as a whole - and the submission does match the filter.
Also see: Additional tips for submission filtering and Advanced submission filtering.