turcsanyip commented on a change in pull request #4123: NIFI-7188: Adding filter capabilities into search & prerequisite refactors URL: https://github.com/apache/nifi/pull/4123#discussion_r401210406
########## File path: nifi-docs/src/main/asciidoc/user-guide.adoc ########## @@ -167,6 +167,74 @@ contains options that allow you to manipulate existing components on the canvas: image::global-menu.png[NiFi Global Menu] +=== Keywords in searching + +Users can use pre-defined (case-insensitive) keywords in the search box that will check certain conditions (instead of trying to match labels and values etc.). Keywords can be used with filters (see below) but not with other search terms (otherwise they won't be treated as keywords) and only one keyword can be used at a time. Note however that keywords will also be treated as general search terms at the same time. The supported keywords are the following: + +*back pressure*: Adds Connections to the result list that are applying back pressure at the time. + +*disabled*: Adds disabled Ports and Processors to the result list. + +*expiration*: Adds Connections to the result list that contain expired Flow Files. + +*expires*: See "expiration". + +*event*: Adds Processors to the result list where the Scheduling Strategy is "Event Driven". + +*invalid*: Adds Ports and Processors to the result list where the component is invalid. + +*not transmitting*: Adds Remote Process Groups to the result list that are not transmitting data at the time. + +*pressure*: See "back pressure". + +*primary:* Adds Processors to the result list that are set to run on the primary node only (whether if the Processor is currently running or not). + +*running*: Adds running Ports and Processors to the result list. + +*stopped*: Adds stopped Ports and Processors to the result list. + +*timer*: Adds Processors to the result list where the Scheduling Strategy is "Event Timer". + +*transmitting*: Adds Remote Process Groups to the result list that are transmitting data at the time. + +*transmission disabled*: See "not transmitting". + +*transmitting enabled*: See "transmitting". + +*validating*: Adds Processors to the result list that are validating at the time. + +=== Filters + +Filters can be added to the search box as key-value pairs where the keys are predefined and check certain conditions based on the given value. The syntax is "key:value". Filters can be used together with other search terms and multiple filters can be used. The only constraint is that the search must start with the filters. Unknown filters or known filters with unknown values are ignored. If the same filter key appears multiple times, the first will be used. The order of different filters has no effect on the result. + +*scope*: This filter narrows the scope of the search based on the user's currently active Process Group. The only valid value is "here". The usage of this filter looks like "scope:here". Any other value is considered as invalid, thus the filter will be ignored during search. + +*group*: This filter narrows the scope of the search based on the provided Process Group name or id. Search will be restricted to groups (and their components - including subgroups and their components) the names or ids of which match the filter value. If no group matches the filter the result list will be empty. Review comment: Minor: missing comma in the last sentence: "If no group matches the filter, the result list..." ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
