Object Group Filtering

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. The following guide details how filtering is configured, applied and cleared.

Please note that Object Group filtering will only be available if configured correctly. Please see the configuration section at the end of this document for details.

Please also 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.

Screenshots

Android Display

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

 

 

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

 

 

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.

 

 

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.

 

 

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.

 

 

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

 

 

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

 

 

iOS Display

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

 

 

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

 

 

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

 

 

The filter view disappears, and all lines that do not meet our 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 in question.

 

 

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.

 

 

Note that line #2 through line #45 has now been hidden from view.

 

 

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

 

 

Configuration

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.

 

 

 

Comments are closed.

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

X