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.
Creating A Publish Filter
A Publish Filter can be created using any one of several methods. See Creating Objects.
Configuration
General Tab
This tab is common to all objects in ACM. See General Configuration.
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, it acts as an OR. 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.
- 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.
Example 1: Publish data for every device that is named NGCTT Protocol1 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 and not named like '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.