Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-4347 - Extend documentation with double-click shortcuts info. This closes #2126

This commit is contained in:
yuri1969 2017-09-03 14:25:39 +02:00 committed by Matt Gilman
parent 5957f6ee95
commit cb7bc93e28
No known key found for this signature in database
GPG Key ID: DF61EC19432AEE37
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
nifi-docs/src/main/asciidoc/user-guide.adoc
View File

@ -297,6 +297,9 @@ image::nifi-processor-menu.png["Processor Menu"]
While the options available from the context menu vary, the following options are typically available when you have full privileges to work with a Processor: While the options available from the context menu vary, the following options are typically available when you have full privileges to work with a Processor:
- *Configure*: This option allows the user to establish or change the configuration of the Processor (see <<Configuring_a_Processor>>). - *Configure*: This option allows the user to establish or change the configuration of the Processor (see <<Configuring_a_Processor>>).
NOTE: For Processors, Ports, Remote Process Groups, Connections and Labels, it is possible to open the configuration dialog by double-clicking on desired component.
- *Start* or *Stop*: This option allows the user to start or stop a Processor; the option will be either Start or Stop, depending on the current state of the Processor. - *Start* or *Stop*: This option allows the user to start or stop a Processor; the option will be either Start or Stop, depending on the current state of the Processor.
- *Enable* or *Disable*: This option allows the user to enable or enable a Processor; the option will be either Enable or Disable, depending on the current state of the Processor. - *Enable* or *Disable*: This option allows the user to enable or enable a Processor; the option will be either Enable or Disable, depending on the current state of the Processor.
- *Status History*: This option opens a graphical representation of the Processor's statistical information over time. - *Status History*: This option opens a graphical representation of the Processor's statistical information over time.
@ -353,7 +356,10 @@ image::nifi-process-group-menu.png["Process Group Menu"]
While the options available from the context menu vary, the following options are typically available when you have full privileges to work with the Process Group: While the options available from the context menu vary, the following options are typically available when you have full privileges to work with the Process Group:
- *Configure*: This option allows the user to establish or change the configuration of the Process Group. - *Configure*: This option allows the user to establish or change the configuration of the Process Group.
- *Enter group*: This option allows the user to enter the Process Group. It is also possible to double-click on the Process Group to enter it. - *Enter group*: This option allows the user to enter the Process Group.
NOTE: It is also possible to double-click on the Process Group to enter it.
- *Start*: This option allows the user to start a Process Group. - *Start*: This option allows the user to start a Process Group.
- *Stop*: This option allows the user to stop a Process Group. - *Stop*: This option allows the user to stop a Process Group.
- *Group*: This option allows the user to create a new Process Group that contains the selected Process Group and any other components selected on the canvas. - *Group*: This option allows the user to create a new Process Group that contains the selected Process Group and any other components selected on the canvas.
@ -497,7 +503,7 @@ image::processor-cs-version-mismatch-config.png["Processor and Controller Servic
[[Configuring_a_Processor]] [[Configuring_a_Processor]]
=== Configuring a Processor === Configuring a Processor
To configure a processor, right-click on the Processor and select the `Configure` option from the context menu. The configuration dialog is opened with four To configure a processor, right-click on the Processor and select the `Configure` option from the context menu. Alternatively, just double-click on the Processor. The configuration dialog is opened with four
different tabs, each of which is discussed below. Once you have finished configuring the Processor, you can apply different tabs, each of which is discussed below. Once you have finished configuring the Processor, you can apply
the changes by clicking the `Apply` button or cancel all changes by clicking the `Cancel` button. the changes by clicking the `Apply` button or cancel all changes by clicking the `Cancel` button.
@ -1868,7 +1874,7 @@ image:event-content.png["Event Content", width=700]
It is often useful to see a graphical representation of the lineage or path a FlowFile took within the dataflow. To see a FlowFile's lineage, It is often useful to see a graphical representation of the lineage or path a FlowFile took within the dataflow. To see a FlowFile's lineage,
click on the "Show Lineage" icon ( image:iconLineage.png["Show Lineage", width=28] ) in the far-right column click on the "Show Lineage" icon ( image:iconLineage.png["Show Lineage", width=28] ) in the far-right column
of the Data Provenance table. This opens a graph displaying the FlowFile ( image:lineage-flowfile.png["FlowFile", width=32] ) and the of the Data Provenance table. This opens a graph displaying the FlowFile ( image:lineage-flowfile.png["FlowFile", width=32] ) and the
various processing events that have occurred. The selected event will be highlighted in red. It is possible to right-click on any various processing events that have occurred. The selected event will be highlighted in red. It is possible to right-click or double-click on any
event to see that event's details (see <<event_details>>). event to see that event's details (see <<event_details>>).
To see how the lineage evolved over time, click the slider at the bottom-left of the window and move it to the left to see the state of the lineage at earlier stages in the dataflow. To see how the lineage evolved over time, click the slider at the bottom-left of the window and move it to the left to see the state of the lineage at earlier stages in the dataflow.