Edge Documentation

The "Apply a Server Side Filter to a Data Collection" Action will apply a server-side filter to a Data Collection when a User clicks to invoke the Action in a Widget. This Action is provided to empower Users to control the data that they are viewing to meet their current needs. The Data Collection that is filtered does not need to be the Data Collection that is driving the selected Widget. Thus, it is possible to click in one Widget and have this Action filter the presentation of other Widgets.

For more information on the concepts of applying Server-side filters to Data Collections in AppBoard, see AppBoard Server-side Queries.

How To Add Actions To A Widget

For instructions on adding an Action to a Widget, see the general instructions in How To Create an Action in a Widget.

How To Configure the Apply a Server Side Filter to a Data Collection Action

Perform the following steps to configure an "Apply a Server Side Filter to a Data Collection" Action:

1. Follow the instructions above to create the basic "Apply a Server Side Filter to a Data Collection" Action.
2. Enter the following information on the Actions configuration panel in the Widget Wizard:
3. Name: The label for this Action. For convenience, a default label is provided.
4. On selection of:
   1. Select "any" or "specific" for the type of data selection by the User that will trigger the Action. If you select "specific", you must do the following:
      1. Click the Filter button. The Filter Editor is displayed.
      2. Click Add Rule to create one or more rules that indicate what data should trigger the Action, when selected.
      3. Click Finish to save the Filter settings.
   2. Select the Data Collection name. When the Widget is run, selection of data in this Data Collection will trigger the Action.
5. Filter data collection: Select the name of the data collection to be filtered.
6. Click Add Rule to add one or more filters. For each filter, select Simple Property Comparison or Widget Interaction Comparison from the drop-down list of filter types.
7. Checking the Show Clear Filter Button on Widget box will provide a button on the Widget that the User can click, after the filter is invoked, to stop the filter from being applied and show the original full Data Collection.
   • From the drop-down list, select the name of the Widget on which you want to display the Clear Filter button.
   • Clear Label Button Field indicates what value should be used for the label that will be shown on the clear button.
8. Click Finish, go to the Builder, and select an item that will initiate the filter to validate the "Apply a Server Side Filter to a Data Collection" Action.

Sample Use Case

Suppose that a particular User will only be concerned with data from a specific location that they select on a map. When the User clicks the location on the map, you can apply a Server-side Filter Action to only return data from that location. Applying the filter on the server side will reduce the amount of data that needs to be passed between the server and client.