Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DEV-4318 Updated Ignore case explanation

...

Overview

Use filters to display a sub-set of data in a chart. When you create or edit a filter, PhixFlow displays a window where you can specify a set of clauses. Each clause contains a number of conditions.

Image Added

You can name and save filters for future use, or use them temporarily

For information about other settings, see Form Descriptions.

Buttons:

...

Image Removed

...

Filter Window

Toolbar

  • Insert excerpt
    _filter_apply
    _filter_apply
    nopaneltrue
     Apply the filter without saving it.

...

Image Removed

...

  • Insert excerpt
    _save
    _save
    nopaneltrue
     Save without closing.

...

Image Removed

...

  • Insert excerpt
    _finish
    _finish
    nopaneltrue
     Save and close.

Filter tab

If you want to save this To save a filter for future use, enter details and save.after entering the details remember to save the filter.

Filter Tab

FieldDescription
NameThe name of the Filterfilter.
Stream NameThe name of the Stream stream to which the Filter filter applies.
PrivateThis field will only be visible

Available to users with the

'

Create Public Filters

'

privilege.

Tick this field if this Filter should only be available

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to make the filter available only to the user who created it. If this field is not visible

then

to you, the filter

will be

is automatically private.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
to make the filter available to other PhixFlow users.

Protect during importTick this field to prevent this Filter being

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to prevent the filter being updated or deleted during import.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to allow the filter to be updated or deleted during import.

Access Permissions
This section will only be visible Available to users with the 'the Create Public Filters' privilege privilege, when the Private check box is not ticked.
All Users Can View Filter

This field is only visible if Private is not ticked.

Tick this field if

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
 to make the filter visible to all users with permission to view filters

should be able to view

.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to specify User Groups that can use this filter.

User GroupsIf '

Available when  All Users Can View

Filter'

Filter is not ticked

, select

.

Select the user groups who will be able to view this filter.


Build a filter by adding conditions and clauses.

...

Display the Filter Picker
FieldDescription

Insert excerpt
_add
_add
nopaneltrue

Add a clause to the filter. Hover over the editor to the right of a condition to see this button.

Image Removed
Insert excerpt
_delete
_delete
nopaneltrue

Delete the selected clause or condition from the filter. Hover over the editor to the right of a condition or clause to see this button.

The Indicates the value entered is a literal value. Click this icon to change this, if you want to use switch the value as an expression.

The Indicates the value entered is an expression. Click this icon to change this, if you want to enter a literal value.

Image Removed

switch the value to a literal value.

Ignore Case

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
so that, for PhixFlow instances running on Oracle or MariaDB (MySQL), the condition only matches strings that have the same capitalisation (case-sensitive).

Insert excerpt
_check_box_ticked
_check_box_ticked
nopaneltrue
  so that the condition matches strings that have any capitalisation (case-insensitive). For example "abc" matches "abc", "Abc", "ABC", etc. For case-insensitive filters, there is no difference if the attribute is also indexed. 

Whether or not the check box is ticked by default depends on the underlying stream attribute property tab → Advanced section → Filter conditions are case-independent by default.

Note
This option affects the behaviour of filters for PhixFlow instances running on Oracle or MariaDB (MySQL) databases.
For PhixFlow instances running on a SQLServer database, filters are always case-independent.


Insert excerpt
_filter_picker
_filter_picker
nopaneltrue

Display the filter picker. Click this icon to display a list of possible values to filter by. See Below for more informationSee 1261699659, below.

Description Tab

Optionally, enter a description to explain the purpose of this filter.

Some Filter Examples

Create prompt filter

You can create a filter that will prompt users to enter a value, and filter based on that. For example, if you have data which contains people's names, you could create a filter like:

Name contains _prompt.EnterName fx

Filter on Current User

If your data contains details of the user, you may be able to filter based on the currently logged in user. For example, to set a filter where the owner equals the current logged in user, add a condition to the filter:

Owner equals _user.name fx

Enter a list of values for an "Is In" or "Is Not In" filter

If you want to select a set of records which have a field set to one of a range of possible values you can do this by selecting the "Is in" or "Is not in" comparator from the drop down list and then simply typing the list of values into the edit box to the right of the comparator as a comma separated list like this:

Country Is in England, France, Germany ABC

Alternatively, you can enter the comparison value as expression:

Country Is in ["England","France","Germany"] fx

Using Filter

...

Pickers

If the stream view that you are filtering on has the "allow filter picker" enabled, then you will see Allow Filter Picker selected, then PhixFlow displays the  icon after the value field. Clicking on it will To use a filter picker:

  1. Click on the filter picker icon Image Added to display a list of the possible values to filter on for that field

...

  1. .
  2. Click to select one value, or Shift+click or Ctrl+click to select multiple values to use in the filter
  3. Click on the tick in the bottom right to finish.
    Alternatively double-click on a row to add that row to your selection and close.

To clear the currently selected values, click on the cross in the bottom left.

When you are constructing a quick filter then , the values displayed will be in the filter picker list have already been filtered by any stream view:

  • background filters

...

  • stream view filters

...

  • any other filter conditions

...

  • .

When you select:

  • one value

...

  • from the list, the filter condition

...

  • changes to:
    • either Equals
    • or not Equals, when the selected condition is not Equals
  • multiple values from the list, the value field is automatically changed to an expression,

...

  • and the

...

Description tab

...

See Also

  • Formsfilter condition changes to:
    • either Is in
    • or Is not inwhen the selected condition iis set to Is not in.
Tip

There are some scenarios where  PhixFlow cannot generate the list of values for a filter picker list.

  • pivot views
  • where the underlying stream data is aggregated.

In these cases, PhixFlow automatically hides the icon 

Insert excerpt
_filter_picker
_filter_picker
nopaneltrue
.