Report Filters
Filters define the data that is displayed on report pages and visuals. You can filter the full list of events to include or exclude specific event types, users, doors, locations, time periods and so on. Filters are based on the data fields which are available for displaying events, such as the text of the event, the time it occurred and the controller it is associated with.
When an operator creates a report, they can apply default filters which cannot be edited and select which filter cards will be available to anyone viewing the report later. Operators who are viewing reports can temporarily filter the data using the available filter cards.
-
For filtering instructions and examples, see Using Report Filters.
-
For instructions on creating a report with custom filters, see Report Programming Examples.
Several sections are available in the Filters pane:
- Search: Search for an available filter by entering all or part of its description.
- Filters on this visual: Lists the filters available for the selected visual only. These filters are only applied to data on that visual.
- Filters on this page: Lists the filters available for the selected report page only. These filters are applied to data on all visuals on the page.
- Filters on all pages: Lists the filters available for all configured report pages. These filters are applied to data on all report pages.
Each field and filter on a report represents a data property which can be added and configured in the report. This page describes the different data properties that are available in Protege X reports.
During report customization the data fields can be renamed, so fields and filters on your report may be labeled differently to the data field name.
ControllerID Filter
The ControllerID filter allows you to use the controller database ID to select which controller(s) to display events for. When this filter is applied only events associated with the selected controller(s) will be included. All others will be filtered out.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in numerical order, the database ID of each controller that has events recorded within the defined parameters. Selecting any controller ID(s) will filter the view to display only events for the selected controller(s).
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
The Advanced filtering option provides additional selections for filtering event records by controller ID only.
Typically controller selections will be performed using basic filtering.
The Show items when the value selections allow you to customize your values and the way you want to use them to identify controllers to display events for. The following options allow you to display events where the controller ID:
- is less than
- is less than or equal to
- is greater than
- is greater than or equal to
- is
- is not
- is blank
- is not blank
ControllerName Filter
The ControllerName filter allows you to use the description in the controller's Name field to select which controller(s) to display events for. When this filter is applied only events associated with the selected controller(s) will be included. All others will be filtered out.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in controller name order, each controller which has events recorded within the defined parameters. Selecting any controller(s) will filter the view to display each event associated with the selected controller(s) which occurred within the defined parameters.
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
The Advanced filtering option provides additional selections for filtering event records by controller names only.
Typically controller selections will be performed using basic filtering.
The Show items when the value selections allow you to customize your search values to identify controllers to show events for. The following options allow you to display events where the controller name:
- contains
- does not contain
- starts with
- does not start with
- is
- is not
- is blank
- is not blank
- is empty
- is not empty
Additionally, the And / Or selection allows you to couple your search value with another value to find events which do or do not include the second value. The second value also offers the same options listed above.
Remember that any advanced filtering selections you make will be applied on top of any existing filters, such as basic description filtering selections.
ControllerName2 Filter
The ControllerName2 filter allows you to use the description in the controller's Name (Second Language) field to select which controller(s) to display events for. When this filter is applied only events associated with the selected controller(s) will be included. All others will be filtered out.
The ControllerName2 filter has the same basic and advanced filtering selection options as the ControllerName filter (see above).
DeviceID Filter
The DeviceID filter allows you to use the controller serial number to select which controller(s) to display events for. When this filter is applied only events associated with the selected controller(s) will be included. All others will be filtered out.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in serial number order, each controller which has events recorded within the defined parameters. Selecting any controller(s) will filter the view to display each event associated with the selected controller(s) which occurred within the defined parameters.
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
The Advanced filtering option provides additional selections for filtering event records by controller serial numbers only.
Typically controller selections will be performed using basic filtering.
The Show items when the value selections allow you to customize your search values to identify controllers to show events for. The following options allow you to display events where the controller serial number:
- contains
- does not contain
- starts with
- does not start with
- is
- is not
- is blank
- is not blank
- is empty
- is not empty
EventCode Filter
The EventCode filter allows you to use the ID of each event type to filter the report to display specific events. For example, you might want to see all armed or disarmed events regardless of the area, or all access denied events.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in numerical order, each unique event code that has been recorded within the defined parameters, along with the number of times each event has been recorded. Selecting any event code(s) will filter the view to display each instance of when the selected event(s) occurred.
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
Select the Advanced filtering option to define more specific event code criteria. This can be used to search for a unique event code or a range of event codes.
The Show items when the value selections allow you to customize your values and the way you want to use them to identify events. The following options allow you to display events where the event code:
- is less than
- is less than or equal to
- is greater than
- is greater than or equal to
- is
- is not
- is blank
- is not blank
EventData Filters
The EventData filters (EventData0 to EventData7) each represent a specific piece of data in the event. Depending on the event type and the EventData filter, this may represent the field for users, areas, locations, or any other field of variable information available in the events. For example, EventData4 in one event may be a user ID, while in another it may be a location ID. Additionally, not all events will populate all of the EventData fields.
For each EventData filter you can specify the relevant value(s) in order to select which records to display events for, based on their associated value in the event. When this filter is applied only events associated with the selected field values will be included. All others will be filtered out.
The Show items when the value selections allow you to customize your search values to identify the specific EventData field values to show events for. The following options allow you to display events where the data value:
- is less than
- is less than or equal to
- is greater than
- is greater than or equal to
- is
- is not
- is blank
- is not blank
Additionally, the And / Or selection allows you to couple your search value with another data value to find events which do or do not include the second value. The second value also offers the same options listed above.
EventDescription Filter
The EventDescription filter is a powerful tool which allows you to search using full or partial event descriptions to identify specific events, record types, locations and other descriptive groupings, as well as reporting on events for a particular user.
To reduce delays in loading events, it is recommended to apply a FieldTime filter before making a description search.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in alphabetical order, each unique event that has been recorded within the defined parameters, along with the number of times each event has been recorded. Selecting any event(s) will filter the view to display each instance of when the selected event(s) occurred.
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
Select the Advanced filtering option to define more specific description criteria. This can be used to search for a unique event description, a more general description for a record type, such as 'door', or a description combination such as 'door' and 'user'. Any words which appear in events can be searched in isolation or in combination. Any number of words can be included in the search description string as long as they exist in the same sequence in the event, such as 'Door Not Allowed', and partial words can be searched, such as 'arm', to cover multiple event types. You can also user this filter to display events which do not contain a particular description.
Description searches are not case sensitive, but words in the string must be spaced correctly.
The Show items when the value selections allow you to completely customize your description values and the way you want to use them to identify events. The following options allow you to display events where the event description:
- contains
- does not contain
- starts with
- does not start with
- is
- is not
- is blank
- is not blank
- is empty
- is not empty
Additionally, the And / Or selection allows you to couple your search value with another description to find events which do or do not include the second value. The second value also offers the same options listed above.
Remember that any advanced filtering selections you make will be applied on top of any existing filters, such as basic description filtering selections.
FieldTime Filter
The FieldTime filter is used to define the timeframe for events that will be included in the report. It can be used on its own to display all events that occurred within the timeframe, or in conjunction with other filters.
Note that the report time and time filters are relative - i.e. they display the time that events occurred, relative to your browser time setting. They do not use the controller's field time.
When viewing and filtering events you will need to factor any time difference between your local time and the controller's time zone setting. You may also want to use the serial number or controller name filters to separate reporting into time zones to more easily identify and compare field times of events.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Relative Date to filter for recent date ranges.
- Select Relative Time to filter for recent time ranges.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in chronological order, each unique date/time that has any event(s) recorded within the defined parameters, along with the number of events recorded at that time. Selecting any time(s) will filter the view to display each event that occurred within the defined parameters. This is a quick and easy way to view a series of events that occurred at a specific time.
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
Select the Advanced filtering option to define specific time criteria. This can be used to search for events that occurred at a specific date/time or within a broader range.
The Show items when the value selections allow you to include events which occurred when the entered time value:
- is
- is not
- is after
- is on or after
- is before
- is on or before
- is blank
- is not blank
Additionally, the And / Or selection allows you to define another time value to find events which do or do not fall within the combined time configuration. The second time value also offers the same options listed above.
The advanced filtering option provides the greatest freedom and flexibility in making time selections, however it can be difficult to use as it requires specific times or timeframes to be defined. The relative date and relative time filter selections are generally more useful in daily operation.
The Relative date filtering option offers a more convenient and operationally practical date selection filter with structured date range selections.
The Show items when the value selections allow you to include any event with a recorded date which:
- is in the last
- is in this
- is in the next
The available associated selections are dependent on which option is selected.
Current Period
To filter events for a fixed current period, select is in this
- day
- week
- month
- year
Date Range
To filter events by defining a date range which is x number of periods, select is in the last / is in the next
- days
- weeks
- calendar weeks (Sun-Sat)
- months
- calendar months
- years
- calendar years
The Include today option is enabled by default.
The Relative time filtering option offers a convenient time selection filter which would typically be used to quickly find recent events.
The Show items when the value selections allow you to include any event with a recorded time which:
- is in the last
- is in this
- is in the next
The available associated selections are dependent on which option is selected.
Current Time
To filter events for a fixed current time period, select is in this
- minute
- hour
Time Range
To filter events by defining a time range which is x number of time periods, select is in the last / is in the next
- minutes
- hours
ID Filter
The ID filter allows you to use the database ID of each specific event to filter the report to display selected events.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in numerical order, each unique event that has been recorded within the defined parameters. Selecting any event ID(s) will filter the view to display only the selected event(s).
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
Select the Advanced filtering option to define more specific event ID criteria. This can be used to search for a unique event or a range of events.
The Show items when the value selections allow you to customize your values and the way you want to use them to identify events. The following options allow you to display events where the event ID:
- is less than
- is less than or equal to
- is greater than
- is greater than or equal to
- is
- is not
- is blank
- is not blank
LocationID Filter
The LocationID filter allows you to use the location database ID to select which location(s) to display events for. When this filter is applied only events associated with the selected location(s) will be included. All others will be filtered out.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in numerical order, the ID of each location that has been recorded within the defined parameters. Selecting any location ID(s) will filter the view to display only events for the selected location(s).
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
Select the Advanced filtering option to define more specific location ID criteria.
The Show items when the value selections allow you to customize your values and the way you want to use them to identify locations. The following options allow you to display events where the location ID:
- is less than
- is less than or equal to
- is greater than
- is greater than or equal to
- is
- is not
- is blank
- is not blank
LocationName Filter
The LocationName filter allows you to use the description in the location's Name field to select which location(s) to display events for. When this filter is applied only events associated with the selected location(s) will be included. All others will be filtered out.
The LocationName fields were added to the reporting functionality in Protege X version 1.0.18. Events from before that release do not contain these fields and therefore cannot display this information. For events generated before late June 2023 the location name fields will be blank.
-
Filter type: Determines the level of filtering options.
- Select Basic filtering for simple selections.
- Select Advanced filtering for more complex event filtering.
- Select Top N to select the top or bottom results for a specific data type and sorting method. For more information, see Using Top N Filtering below.
The Basic filtering option displays, in location name order, each location which has events recorded within the defined parameters. Selecting any location(s) will filter the view to display each event associated with the selected location(s) which occurred within the defined parameters.
-
Require single selection: When customizing a report, enable this setting to require viewers to pick only one option out of the basic filter list. Other filter options will not be available.
The Advanced filtering option provides additional selections for filtering event records by controller names only.
Typically location selections will be performed using basic filtering.
The Show items when the value selections allow you to customize your search values to identify locations to show events for. The following options allow you to display events where the location name:
- contains
- does not contain
- starts with
- does not start with
- is
- is not
- is blank
- is not blank
- is empty
- is not empty
Additionally, the And / Or selection allows you to couple your search value with another value to find events which do or do not include the second value. The second value also offers the same options listed above.
Remember that any advanced filtering selections you make will be applied on top of any existing filters, such as basic description filtering selections.
LocationName2 Filter
The LocationName2 filter allows you to use the description in the location's Name (Second Language) field to select which location(s) to display events for. When this filter is applied only events associated with the selected location(s) will be included. All others will be filtered out.
The LocationName2 filter has the same basic and advanced filtering selection options as the LocationName filter (see above).
Using Top N Filtering
The Top N option enables you to filter for the highest or lowest values based on a particular sorting method. For example, you may wish to display the 100 most recent events.
Top N filters can only be applied to specific visuals and only one can be used per visual. They can only be customized by operators with edit access to reports.
To use a Top N filter:
-
Click on the visual you wish to filter.
-
Select a filter card, or click and drag a new one from the Data pane into the Filters on this visual section. This is the filtering data type.
Top N filtering works best when used with unique data types such as Id. Filtering by non-unique data types such as EventDescription may return more results than expected due to duplicate values.
-
Set the Filter type to Top N.
-
Set Show items to Top or Bottom.
-
Enter the number of results to display.
-
Select an item from the Data pane and click and drag it into the By value field. This is the sorting data type, which will be used to sort the list before filtering the top or bottom values.
If the data type used for sorting is not unique, the filter may return more results than expected due to duplicate values.
-
Click on the arrow next to the sorting value to choose how the data will be sorted. The relevant settings are different depending on the data type:
-
For numerical values (e.g. Id), the default is Count. To sort by the actual value, select Maximum or Minimum.
-
For textual values (e.g. EventDescription), you can sort by First (reverse alphabetical) or Last (alphabetical).
-
For time/date values (e.g. FieldTime), the Earliest and Latest settings have no effect. Use Top to select latest values and Bottom to select earliest values.
-
-
Click Apply filter.
-
Click Save.
One common use of this filter is to display the most recent events. For example, to display the most recent 200 events, add an Id filter card to Filters on this visual. Enter the following settings:
-
Filter type: Top N
-
Show items: Bottom 200
-
By value: Earliest FieldTime
This report would typically show slightly more than 200 events, because multiple events can occur at the same second. To return exactly 200 events, use Maximum Id as the sorting data type.