Publish Filter

Overview

The Publish Filter provides the ability to narrow the list of devices and meters that a given publisher will use. This is helpful if you want a certain publisher to only publish a specific type of device, or only those in a specific folder.

See the General Object Configuration guide for assistance configuring the General tab.

Group Tab

Click the Edit Group button to configure the Publish Filter Record Collection of rules to apply to the filter.

Records

Records can be added or removed using the Add, Remove and Copy buttons on the lower left. Each record uses the following fields:

Aggregate. Aggregate option to combine current filter with next filter that is added. When the aggregate is blank and the following row also has a blank aggregate, it acts as an OR next filter. The Example section of this document explains the results of each. The available options are:
- AND all previous filters
- AND next filter
- OR all previous filters
- OR next filter.
Name Text. Text used to query for object's name. Can include wild cards ? (to represent a single character) and * (to represent any number of characters).
Not Name Text. Text used to exclude objects. Can include wild cards ? (to represent a single character) and * (to represent any number of characters).
Parent Folder. The folder containing objects to publish. Child folders are included. Note: the use of "Unassigned" tells ACM to look in every folder.
RecordId. Display Name of Record.

Saving Record Collection Changes

When record editing is complete, Click Close to return to the owning object type. Click the Save button to save any changes made to the record collection.

Examples

All examples will use the tree below and displayed in the "Tabular Display" view. These examples show the solution requiring the least number of aggregates.

One of the common challenges in building filters is how we think about what we want published and our use of the "AND" and "OR" words. For instance: "I want every device in Device Set A and Device Set B" entered as a filter would actually be processed as "I want every device that exists in both Device Set A and Device Set B". Instead we need to think of it as "I want every device that exists in Device Set A OR exists in Device Set B."

Example 1: Publish data for every device that starts with 'NGCTT' in Device Set D or is in Device Set A.

What works:

Using the "OR next filter" aggregate so ACM knows to look in both folders, and a '*' after NGCTT so it searches for anything that starts with NGCTT, regardless the number of characters afterwards.

Example 2: Publish data for every device that is either in Device Set D that does not start with 'NGCTT' or exists in Device Set A.

What works:

In this case, the filter is the same as example one except the NGCTT* has moved into the "Not Name Text" field so that ACM rules it out.

Example 3: Publish data for all devices except for those in Device Set C.

In ACM, it is not possible to rule out an entire folder. Instead, we need to rule in all acceptable folders.

Example 4: Publish data for all devices that have both an "m" and a "y" OR are in Device Set A

Here we used "AND next filter" on the first row to find devices containing both an "m" and a "y". On the third row, we use the "OR all previous filters" to mean that all of the previous filters must be considered as one.

Example 5: Publish data for all devices that have both an "m" and a "y" but do NOT have a "p"

Here we needed to "AND next filter" all three. Had we used "OR next filter before the record with the "P", it would have returned devices containing an "m" and a "y" and ALSO all devices that do not contain a "p" (whether or not they contain an "m" and a "y")