tpalfy 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_r400929270
########## 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 + +NiFi UI's search functionality supports a number of "keywords". These are literals used to execute search based on non-textual information. A keyword is used only in case of the search term consists of a section of the keyword or matches with it. In case the keyword is only the subset of the search term, the keyword is not picked for usage. The keywords are case-insensitive. The supported keywords are the following: + +*back pressure*: Adds the Connections to the result list which are applying back pressure in the time of search. + +*disabled*: Adds disabled Ports and Processors to the result list. + +*expiration*: Adds the Connections to the result list in which there are expired Flow Files. + +*expires*: See "expiration". + +*event*: Adds every Processor 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 which are not transmitting data at the time of searching. + +*pressure*: See "back pressure". + +*primary:* Adds Processors into the result list which are set to running on the primary node only. (Regardless 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 every Processor to the result list where the Scheduling Strategy is "Event Timer". + +*transmitting*: Adds Remote Process Groups to the result list which are transmitting data at the time of searching. Review comment: ```suggestion *transmitting*: Adds Remote Process Groups to the result list that are transmitting data at the time. ``` ---------------------------------------------------------------- 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
