Object Group Filter

How Can We Help?

< Back

In version 2.2.2 of XMPro Act, we introduced the ability for end-users to automatically filter object group lines based on user-defined criteria, and in 2.2.4 we’ve added additional ways to filter and search. The following guide details how filtering is configured, applied and cleared.

Please note that filter requests will not create or raise a request to the server. All filtering is applied to the form currently locally loaded on-device.

Configuration

6.6.0.2+ APIs

This new feature will require 2.2.4 or later, as well as API 6.6.0.2 or later.

To enable Object Group filtering, a system administrator can go into the properties of the Object Group, and set the Filter Control property (under Behaviour > Options) to True.

Pre – 6.6.0.2 APIs

To enable Object Group filter functionality, a System Administrator will need to add a new Reference Label field on an Activity with name [Object Group Name]_AllowFilter, with a value set to True.

For example, if you would like to enable filtering on an Object Group named TST10Group, an administrator will need to add a new Reference Label named TST10Group_AllowFilter, with a value set to True. This will instruct XMPro Act to enable filter functionality for this Object Group.

It is important to note that this filtering functionality will only be available on Object Groups in which the lines are pre-populated by the XMPro Server. Filter buttons will not be shown in Object Groups which allow the end-user to add or remove lines. This behavior is intentional, to minimize confusion – where newly added lines could be automatically hidden by an active filter.

Screenshots

When opening a configured Activity, a filter icon will be displayed on the Object Group header.

Android

iOS

 

Tapping this filter icon will display a list of all visible fields currently belonging to the Object Group.

 

Android

iOS

 

 

In this example, we want to see only lines with an “Occurrence” of “Ad Hoc”. Type the value, then tap the “Accept” tick box in the top right corner.

 

Android

iOS

 

The filter view disappears, and all lines that do not meet the filter criteria are removed from view. Note below that Line #2 is no longer visible. Also, note that the “Clear Filter” icon is now visible on the Object Group header – this indicates a filter has been applied to the Object Group.

 

Android

iOS

 

The filter can also be applied using multiple criteria. In the screenshot below we have reopened the filter view and decided we want to see only “Ad Hoc” lines with an “Expected Start Day” in 2018.

 

Android

iOS

 

Note that lines #2 through #45 have now been hidden from view.

 

Android

iOS

 

We can also set it to filter for items with either “Ad Hoc” or an Expected Start Day in 2018. You can do this by going into the Filter and changing “Select Condition” from AND to OR.

 

Android

iOS

 

Line #2 appears again, as it has an Expected Start Day in 2018. If you go back into Filters and change the Condition to AND again, Line #2 would disappear.

 

Android

iOS

 

Tap the “Clear Filter” X icon to remove the filter criteria and display all lines again.

 

Android

iOS

 

You can also use the Search Bar to quickly filter for a single item. For example, if we want to only look for items that contain the word “Hedges”, we can enter “Hedges” into the Search bar. The Search Bar is a wildcard search and will look in every field in each line for the text you enter.

 

Android

iOS

 

Just like with the filter, you can tap the X next to it to clear the search.

 

Android

iOS

 

 

Comments are closed.

This is the legacy version of the XMPro Documentation site. For the latest XMPro documentation, please visit documentation.xmpro.com

X