The Group Filter Plugin filters which CO Groups are passed through to the connected context. Rules are processed for each CO Group passed to the Group Filter Plugin.
This is a non-core plugin, see Installing and Enabling Registry Plugins for more information.
- After instantiating the plugin as a Data Filter, proceed to the plugin's Configuration page.
- From this page, click Attach Group Data Filter Rules.
This Rule Processing configuration is experimental, and may change across minor releases.
Group Data Filter Rules are processed in the order configured, where rules with lower Order values are processed first. If two rules have the same Order, it is not specified which will be processed first.
Each Rules contains a Name Pattern, which is a full regular expression, including the slash (
/) delimiters. For example, the Pattern
/^Foo/ matches all strings beginning with the text
Each Rule also has a Required value, which may be Required, Optional, or Not Permitted. Rules are processed accordingly:
- If a Name Pattern is Required, the CO Group Name must match the specified Name Pattern, otherwise the CO Group is filtered (not passed to the connected context) and processing for the CO Group stops.
- If a Name Pattern is Optional, if the CO Group Name matches the specified Name Pattern, the CO Group is passed to the connected context and processing stops.
- If a Name Pattern is Not Permitted, if the CO Group Name matches the specified Name Pattern, the CO Group is filtered and processing stops.
- If processing has not been stopped, the next rule as sorted by Order will be processed.
While the Group Filter Plugin only operates on the CO Group Name, but running a CO Group Name Filter beforehand can be used to replace the CO Group Name with an Identifier attached to the Group, allowing filtering by Identifier as well.