Overview
A 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 conventions.
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.
- Name Text. Text used to query for object's name. Can include wild cards ? and *.
- Not Name Text. Text used to exclude objects. Can include wild cards ? and *.
- 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 .png?version=1&modificationDate=1558119661499&cacheVersion=1&api=v2)
to save any changes made to the record collection.
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.
Warning
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.
