This page is for application designers who need to apply a background filter to the data that is displayed from stream.

The following layout components display data from a stream:

a stream view
a card container.

In some cases, you may need to apply a filter on the stream data that is displayed in the stream view or card container. This is called a background filter. The layout properties enable to you select several filter rules that combine to form a background filter. This page explains how to set up a filter rule.

This properties tab is not available from the repository. It opens from the layout properties → Background Filter Rules section.

For information about the properties toolbar, and about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. We recommend you always add a Description that explains the purpose of the item you are creating.

For a full list of all the PhixFlow property tabs and windows, see Properties, Windows, Menus and Toolbars.

Basic settings

Field	Description
Rule Expression	Enter an expression. If the expression is empty or evaluates to true, PhixFlow applies the selected Filter. To prevent the filter from being applied in specific conditions, enter an expression that evaluates to false. The values that represent `true` are: any number other than 0 for a list: all items in the list are true the following case-insensitive strings `true` `t` `yes` `y` The values that represent `false` are: 0 (zero) any string not listed as true above including `false`
Filter	To select a filter: either select a filter that already exists in the backing stream for this layout component or click Filter to look for a filter in the repository. or click Add New to create a new filter; see Filter.
Order	Specify the order in which this filter rule is listed in the layout properties → Background Filter Rules grid. PhixFlow evaluates the filter rules in order and applies those that evaluate to true in order.
Enabled	Error rendering macro 'excerpt-include' : No link could be created for '_check_box_ticked'. to indicate the filter can be used.
Stop if True	Error rendering macro 'excerpt-include' : No link could be created for '_check_box_ticked'. to stop PhixFlow evaluating any following filter rules when the Rule Expression evaluates to true.