The Dialogue Filter builder enables you to provide report writers with a reproducible representation of a dialogue filter.
There are two methods for creating dialogue filters, Create a New Filter or Choose from pre-existing dialogue filters. To create your own dialogue filters, an understanding of the terminology used in the builder is required, the terminology will be explored further in this article.
Note: There is a limit of six dialogue filters per report request. If more filters are required feel free to specify what those are in the Report Description section on the following page or discuss this with your report writer during your request.
What is a Dialog Filter?
Dialogue filters are options that are provided at the time a report is run in order to better shape the generated data. For example, selecting a date range for a report will ensure that the retrieved information is only relevant to that period.
Choose from Pre-Existing Dialogue Filters
We have provided some pre-existing filters so you can quickly set up a dialog page. These filters are broken down into specific filter types including Single Select, Multi Select and Date Range. These are based on common standard filters that should satisfy most use cases.
To add a pre-existing dialogue filter to your request, navigate to the right-hand pane and select the filters you want to include. Once a pre-existing dialogue filter is added it is displayed in the main dialogue filter pane where you can also make any changes to the selected filters here.
Note: If you are unsure what these filter types mean hover over the help icon to view an example of how these filters may work in your report.
Create your Own Dialog Filter
If you have a dialogue filter in mind that isn’t in the list of pre-existing dialogue filters, then you can create your custom filter. To create your own filter, press the green Create a New Filter button to generate a new custom dialogue filter.
The following points describe what kind of information is required to produce a dialogue filter:
- Filter On: The Filter on field provides the report writer with the type of entity the filter will be filtering against. For example, if you want to filter reports by the status of an enrolment, you’d be filtering on the Status Type.
- Filter Type: Dialogue filters come in many variants; however, they can be broadly split into four types:
- Single Select is a dialogue filter, where only one value can be selected to filter the report e.g. I must be able to select one enrolment to run our enrolment form against.
- Multi Select is a dialogue filter, where multiple values can be selected to filter the report against e.g. I must be able to select many qualifications to run our Occurrence Progress report against.
- Date Range is a dialogue filter, which enables you to filter a record by a date between a date range e.g. I must be able to display a report for each Enrolment which ends between the given date range.
- Date is a dialogue filter, like the Date Range filter, but retrieves records by date where the records date is equal to that of the date entered in the dialogue filter e.g. I must be able to display a Class Timetable report for a given date.
- Mandatory: If Mandatory is checked, then the filter must be given a value for the report to run.
- Description: Use this box to describe specifically which field this field in VETtrak this filter applies to and unique behaviours for the custom filter. For example, if you wish to filter on employer you may want to specify that you want to filter on the employer selected in the Client Wizard (as an employer can be selected in many wizards in VETtrak). If you are basing it on an already existing filter it would be useful to mention the existing report with this filter option here.
Note: If you are unsure of what fields are available to query within VETtrak a helpful resource is our online Data Dictionary.
Here is an example of a filter to filter on the employer in the enrolment wizard by selecting one or many employers.
At least one filter must be added in order to finish the Report Request Form where you’ll be given an opportunity to review your requested filters on the last page. If you’d like to make further changes after reviewing your selection you can navigate back to the Dialogue Form builder to do so.