Color Filter

< appboard | 2.4 | builder

In certain parts of AppBoard, such as within the Advanced Status List Widget, it is possible to define what colors are used based on a specified set of rules. These sets of rules are known as Color Filters. As with the other types of filters in AppBoard, Color Filters allow users to give more meaning to data. By applying Color Filters to data collections, users can convey information about the data, such as the severity of an incident, the current status of a node in a topology, or perhaps whether a given measurement is within a certain threshold.

1. How To Create a Color Filter

To add a Color Filter click the Add button and a new window will appear where you can create the filter rules. To modify an existing Color Filter, click the Edit button and perform the same steps to make any changes to the filter.

2. How To Configure a Color Filter

Create a new filter, as described above, to open the Color Filter Rules editor. Perform the following steps to configure Color Filter Rules:

  1. Name: Provide a unique name for the set of rules so that it can be differentiated from other existing Color Filter Rules. This is important since rule sets are saved and listed as Color Filter options wherever the filters are applicable.
  2. Add: The Add button adds a new rule for the user to configure. Unless the Show Advanced Filter Options check box is selected, these rules will be configured in a Simple Property Comparison format.
  3. Remove Rule: In the far right side of the row of each rule is a red "X" button that can be used to remove a rule from the filter list.
  4. Property: In the first pull-down of the comparison, select the field that will be the subject of this rule. Note that if the chosen field changes due to a change in the widget's Data Collection, Property will have to be set to the new field.
  5. Comparator: In the next pull-down, select an operator to define the comparison.
  6. Value: In the text box, enter in the value that the data will be filtered by.
  7. Show Advanced Filter Options: When the box is checked, the comparison pull-down selectors will be replaced by an Advanced button. Click the button to enter advanced configuration.
    • Note: Once Advanced filter rules have been created, they cannot be retained when unchecking the box to return to the basic mode. You will be prompted to delete any Advanced filter rules first before you can uncheck the box.

3. Advanced Configuration of a Color Filter

There are some key advantages that come with using the Advanced option. In addition to the Simple Property Comparison, the Advanced Filter provides to the user the Match Regular Expression comparison type. Advanced Filters also allow the user to add multiple comparisons to define one rule.

Once the Advanced box has been checked and the Advanced Filter button is clicked in the Color Filter window, a new Filter Editor window will appear. Perform the following steps to configure an Advanced Filter in the Filter Editor:

  1. Add Rule: Choose either Simple Property Comparison (the basic comparison used in the previous window) or Match Regular Expression. A new row will appear with fields that match the selected comparison. See the linked pages for options specific to each comparison.
  2. Conjunction Type: Allows the user to restrict or expand the items that make it through the filter.
  3. Remove Rule: In the far right side of the row of each rule is a red "X" button that can be used to remove a rule from the filter list.
  4. Close: Once all comparisons have been added, click Finish to return to the Color Filter page.