Overview
A The Publish Filter is used by a Publisher object to curate the output from the collected records table as a whole. An example would be to only publish records to the output that follow some specific naming conventionsprovides 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
...
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.
| Info | ||
|---|---|---|
| ||
When record editing is complete, Click Close to return to the owning object type. Click the Save button |
.png?version=1&modificationDate=1558119661499&cacheVersion=1&api=v2)
Examples
Example 1
In this example, the goal is to publish devices from a specific parent folder called Fields while also excluding devices that start with the letter D or G. The aggregate option selected is And next filter. This concatenates the first requirement with the second.
This screen capture shows the Tabular Display editing option. The excluded devices are highlighted in the object tree.
| Info | ||
|---|---|---|
| ||
Leaving the Aggregate field blank or changing it to "OR next filter" will return unexpected results, with it returning all devices in all folders that do not begin with the letter D. This is because the two statements now operate independently from one another and the second statement will include the "G" devices that were excluded in the first statement. |
Example 2
In this example, the goal is to publish devices that start with R7 or B in the Fields Folder. The aggregate option selected is Or next filter.
This screen capture shows the Tabular Display editing option. The included devices are highlighted in the object tree.
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.
| Info |
|---|
| 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 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.