You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by jp...@apache.org on 2016/07/12 22:30:27 UTC
svn commit: r1752357 [3/3] - in /nifi/site/trunk/docs/nifi-docs/html: ./
images/
Modified: nifi/site/trunk/docs/nifi-docs/html/user-guide.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/html/user-guide.html?rev=1752357&r1=1752356&r2=1752357&view=diff
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/html/user-guide.html (original)
+++ nifi/site/trunk/docs/nifi-docs/html/user-guide.html Tue Jul 12 22:30:27 2016
@@ -1,20 +1,4 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
- <!DOCTYPE html>
+<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
@@ -837,8 +821,7 @@ location that it was dropped.</p>
<p><strong>Note</strong>: For any component added to the canvas, it is possible to select it with the mouse and move it anywhere on the canvas. Also, it is possible to select multiple items at once by either holding down the Shift key and selecting each item or by holding down the Shift key and dragging a selection box around the desired components.</p>
</div>
<div class="paragraph">
-<p>Once a Processor has been dragged onto the canvas, the user may interact with it by right-clicking on the Processor and selecting an option from
-context menu.</p>
+<p>Once a Processor has been dragged onto the canvas, the user may interact with it by right-clicking on the Processor and selecting an option from the context menu.</p>
</div>
<div class="imageblock">
<div class="content">
@@ -967,7 +950,7 @@ context menu.</p>
references a remote instance of NiFi. When an RPG is dragged onto the canvas, rather than being prompted for a name, the DFM
is prompted for the URL of the remote NiFi instance. If the remote NiFi is a clustered instance, the URL that should be used
is the URL of the remote instance’s NiFi Cluster Manager (NCM). When data is transferred to a clustered instance of NiFi
-via an RPG, the RPG it will first connect to the remote instance’s NCM to determine which nodes are in the cluster and
+via an RPG, the RPG will first connect to the remote instance’s NCM to determine which nodes are in the cluster and
how busy each node is. This information is then used to load balance the data that is pushed to each node. The remote NCM is
then interrogated periodically to determine information about any nodes that are dropped from or added to the cluster and to
recalculate the load balancing based on each node’s load. For more information, see the section on <a href="#site-to-site">Site-to-Site</a>.</p>
@@ -1058,18 +1041,18 @@ icon, indicating that there is more info
<strong>Label</strong>: Labels are used to provide documentation to parts of a dataflow. When a Label is dropped onto the canvas,
it is created with a default size. The Label can then be resized by dragging the handle in the bottom-right corner.
The Label has no text when initially created. The text of the Label can be added by right-clicking on the Label and
-choosing <code>Configure...</code></p>
+choosing <code>Configure</code></p>
</div>
</div>
<div class="sect2">
<h3 id="Configuring_a_Processor"><a class="anchor" href="#Configuring_a_Processor"></a>Configuring a Processor</h3>
<div class="paragraph">
-<p>To configure a processor, right-click on the Processor and select the <code>Configure...</code> option from the context menu. The configuration dialog is opened with four
+<p>To configure a processor, right-click on the Processor and select the <code>Configure</code> option from the context menu. 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
the changes by clicking the <code>Apply</code> button or cancel all changes by clicking the <code>Cancel</code> button.</p>
</div>
<div class="paragraph">
-<p>Note that after a Processor has been started, the context menu shown for the Processor no longer has a <code>Configure...</code>
+<p>Note that after a Processor has been started, the context menu shown for the Processor no longer has a <code>Configure</code>
option but rather has a <code>View Configuration</code> option. Processor configuration cannot be changed while the Processor is
running. You must first stop the Processor and wait for all of its active tasks to complete before configuring
the Processor again.</p>
@@ -1138,7 +1121,7 @@ auto-terminated, the auto-termination st
</div>
</div>
<div class="paragraph">
-<p>The first configuration option is the Scheduling Strategy. There are three options for scheduling components:</p>
+<p>The first configuration option is the Scheduling Strategy. There are three possible options for scheduling components:</p>
</div>
<div class="ulist">
<ul>
@@ -1242,7 +1225,7 @@ must define which Properties make sense
</div>
</div>
<div class="paragraph">
-<p>This Processor, by default, has only a single property: ‘Routing Strategy.’ The default value is ‘Route on Property name.’ Next to
+<p>This Processor, by default, has only a single property: ‘Routing Strategy.’ The default value is ‘Route to Property name.’ Next to
the name of this property is a small question-mark symbol (
<span class="image"><img src="./images/iconInfo.png" alt="Question Mark"></span>
). This help symbol is seen in other places throughout the User Interface, and it indicates that more information is available.
@@ -1270,7 +1253,7 @@ In fact, this Processor will not be vali
<div class="paragraph">
<p>Note that after a User-Defined property has been added, an icon will appear on the right-hand side of that row (
<span class="image"><img src="./images/iconDelete.png" alt="Delete Icon"></span>
-). Clicking this button will remove the User-Defined property from the Processor.</p>
+). Clicking it will remove the User-Defined property from the Processor.</p>
</div>
<div class="paragraph">
<p>Some processors also have an Advanced User Interface (UI) built into them. For example, the UpdateAttribute processor has an Advanced UI. To access the Advanced UI, click the <code>Advanced</code> button that appears at the bottom of the Configure Processor window. Only processors that have an Advanced UI will have this button.</p>
@@ -1474,13 +1457,13 @@ prioritizers’ list to the ‘A
<div class="ulist">
<ul>
<li>
-<p><strong>FirstInFirstOutPrioritizer</strong>: Given two FlowFiles, the on that reached the connection first will be processed first.</p>
+<p><strong>FirstInFirstOutPrioritizer</strong>: Given two FlowFiles, the one that reached the connection first will be processed first.</p>
</li>
<li>
<p><strong>NewestFlowFileFirstPrioritizer</strong>: Given two FlowFiles, the one that is newest in the dataflow will be processed first.</p>
</li>
<li>
-<p><strong>OldestFlowFileFirstPrioritizer</strong>: Given two FlowFiles, the on that is oldest in the dataflow will be processed first. This is the default scheme that is used if no prioritizers are selected.</p>
+<p><strong>OldestFlowFileFirstPrioritizer</strong>: Given two FlowFiles, the one that is oldest in the dataflow will be processed first. This is the default scheme that is used if no prioritizers are selected.</p>
</li>
<li>
<p><strong>PriorityAttributePrioritizer</strong>: Given two FlowFiles that both have a "priority" attribute, the one that has the highest priority value will be processed first. Note that an UpdateAttribute processor should be used to add the "priority" attribute to the FlowFiles before they reach a connection that has this prioritizer set. Values for the "priority" attribute may be alphanumeric, where "a" is a higher priority than "z", and "1" is a higher priority than "9", for example.</p>
@@ -2113,7 +2096,7 @@ the “Configure” menu option.
<li>
<p><strong>Bulletin Indicator</strong>: When a child component of a Process Group emits a bulletin, that bulletin is propagated to
the component’s parent Process Group, as well. When any component has an active Bulletin, this indicator will appear,
-allowing the user to hover over the icon with the mouse to see Bulletin.</p>
+allowing the user to hover over the icon with the mouse to see the Bulletin.</p>
</li>
<li>
<p><strong>Active Tasks</strong>: The number of tasks that are currently executing by the components within this
@@ -2172,7 +2155,7 @@ within the Process Group. The following
<li>
<p><span class="image"><img src="./images/iconOutputPortSmall.png" alt="Output Port"></span>
<strong>Output Ports</strong>: The number of Output Ports that exist directly within this Process Group. This does not include any
- Output Ports that exist within child Process Group as child groups' ports cannot be accessed directly.</p>
+ Output Ports that exist within child Process Groups as child groups' ports cannot be accessed directly.</p>
</li>
<li>
<p><span class="image"><img src="./images/iconTransmissionActive.png" alt="Transmission Active"></span>
@@ -2340,7 +2323,7 @@ on the Remote Process Group and choosing
<div class="sect2">
<h3 id="Queue_Interaction"><a class="anchor" href="#Queue_Interaction"></a>Queue Interaction</h3>
<div class="paragraph">
-<p>The FlowFiles enqueued in a Connection can be viewed when necessary. The Queue listing is opened via a menu item in
+<p>The FlowFiles enqueued in a Connection can be viewed when necessary. The Queue listing is opened via <code>List queue</code> in
a Connection’s context menu. The listing will return the top 100 FlowFiles in the active queue according to the
configured priority. The listing can be performed even if the source and destination are actively running.</p>
</div>
@@ -2354,7 +2337,7 @@ no longer be in the active queue.</p>
</div>
<div class="paragraph">
<p>The FlowFiles enqueued in a Connection can also be deleted when necessary. The removal of the FlowFiles is initiated
-via a menu item in the Connection’s context menu. This action can also be performed if the source and destination
+via <code>Empty queue</code> in the Connection’s context menu. This action can also be performed if the source and destination
are actively running.</p>
</div>
</div>
@@ -2386,10 +2369,10 @@ the different elements within the dialog
</div>
</div>
<div class="paragraph">
-<p>The Summary page consists mostly of a table that provides information about each of the components on the canvas. Above this
+<p>The Summary page is primarily comprised of a table that provides information about each of the components on the canvas. Above this
table is a set of five tabs that can be used to view the different types of components. The information provided in the table
is the same information that is provided for each component on the canvas. Each of the columns in the table may be sorted by
-double-clicking on the heading of the column. For more on the types of information displayed, see the sections
+clicking on the heading of the column. For more on the types of information displayed, see the sections
<a href="#processor_anatomy">Anatomy of a Processor</a>, <a href="#process_group_anatomy">Anatomy of a Process Group</a>, and <a href="#remote_group_anatomy">Anatomy of a Remote Process Group</a> above.</p>
</div>
<div class="paragraph">
@@ -2402,7 +2385,7 @@ double-clicking on the heading of the co
provide information about the Bulletin that was generated, including the message, the severity level, the time at which
the Bulletin was generated, and (in a clustered environment) the node that generated the Bulletin. Like all the columns in the
Summary table, this column where bulletins are shown may be sorted
-by double-clicking on the heading so that all the currently existing bulletins are shown at the top of the list.</p>
+by clicking on the heading so that all the currently existing bulletins are shown at the top of the list.</p>
</li>
<li>
<p><strong>Details</strong>: Clicking the Details icon will provide the user with the details of the component. This dialog is the same as the
@@ -2426,7 +2409,7 @@ on the page is not automatically refresh
<p><strong>Filter</strong>: The Filter element allows users to filter the contents of the Summary table by typing in all or part of some criteria,
such as a Processor Type or Processor Name. The types of filters available differ according to the selected tab. For instance,
if viewing the Processor tab, the user is able to filter by name or by type. When viewing the Connections tab, the user
-is able to filter by source name, destination name, or Connection name. The filter is automatically applied when the contents
+is able to filter by source, by name, or by destination name. The filter is automatically applied when the contents
of the text box are changed. Below the text box is an indicator of how many entries in the table match the filter and how many
entries exist in the table.</p>
</li>
@@ -2502,7 +2485,7 @@ Hovering the mouse over the Cluster or o
The top graph is larger so as to provide an easier-to-read rendering of the information. In the bottom-right corner of
this graph is a small handle (
<span class="image"><img src="./images/iconResize.png" alt="Resize"></span>
-) that can be dragged to resize the graph. The blank area of the dialog above this graph can also be dragged around
+) that can be dragged to resize the graph. The blank areas of the dialog can also be dragged around
to move the entire dialog.</p>
</div>
<div class="paragraph">
@@ -2510,7 +2493,7 @@ to move the entire dialog.</p>
cause the top graph to show only the time range selected, but in a more detailed manner. Additionally, this will cause the
Min/Max/Mean values on the left-hand side to be recalculated. Once a selection has been created by dragging a
rectangle over the graph, double-clicking on the selected portion will cause the selection to fully expand in the
-vertical direction. I.e., it will select all values in this time range. Clicking on the bottom graph without dragging
+vertical direction (i.e., it will select all values in this time range). Clicking on the bottom graph without dragging
will remove the selection.</p>
</div>
</div>
@@ -2573,7 +2556,7 @@ instantiated, or added to the canvas. Th
</div>
<div class="paragraph">
<p>This will present a dialog to choose which Template to add to the canvas. After choosing the Template to add, simply
-click the “Add” button. The Template will be added to the canvas with the upper-right-hand side of the Template
+click the “Add” button. The Template will be added to the canvas with the upper-left-hand side of the Template
being placed wherever the user dropped the Template icon.</p>
</div>
<div class="paragraph">
@@ -2678,7 +2661,7 @@ image could be performed:</p>
<div class="sect2">
<h3 id="event_details"><a class="anchor" href="#event_details"></a>Details of an Event</h3>
<div class="paragraph">
-<p>In the far-left column of the Data Provenance page, there is a View Details icon for each event ( <span class="image"><img src="./images/iconViewDetails.png" alt="View Details" width="32"></span> ).
+<p>In the far-left column of the Data Provenance page, there is a View Details icon for each event (<span class="image"><img src="./images/iconDetails.png" alt="Details"></span>).
Clicking this button opens a dialog window with three tabs: Details, Attributes, and Content.</p>
</div>
<div class="paragraph">
@@ -2703,7 +2686,7 @@ a result of the processing event, the us
<div class="paragraph">
<p>A DFM may need to inspect a FlowFile’s content at some point in the dataflow to ensure that it is being processed as expected. And if it
is not being processed properly, the DFM may need to make adjustments to the dataflow and replay the FlowFile again. The Content tab of the View Details dialog window is where the DFM can do these things. The Content tab shows information about the FlowFile’s content, such as its location in the Content Repository
-and its size. In addition, it is here that the user may click the <code>Download</code> button in order to download a copy of the FlowFile’s content as it existed
+and its size. In addition, it is here that the user may click the <code>Download</code> button to download a copy of the FlowFile’s content as it existed
at this point in the flow. The user may also click the <code>Submit</code> button to replay the FlowFile at this point in the flow. Upon clicking <code>Submit</code>,
the FlowFile is sent to the connection feeding the component that produced this processing event.</p>
</div>
@@ -2715,7 +2698,7 @@ the FlowFile is sent to the connection f
<h3 id="viewing-flowfile-lineage"><a class="anchor" href="#viewing-flowfile-lineage"></a>Viewing FlowFile Lineage</h3>
<div class="paragraph">
<p>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 ( <span class="image"><img src="./images/iconLineage.png" alt="Show Lineage" width="28"></span> ) in the far-right column
-of the Data Provenance table. This opens a graph displaying the FlowFile ( <span class="image"><img src="./images/lineage-flowfile.png" alt="FlowFile" width="32"></span> ) and the various processing events that have occurred. The selected event will be highlighted in yellow. It is possible to right-click on any event to see that event’s details (See <a href="#event_details">Details of an Event</a>)
+of the Data Provenance table. This opens a graph displaying the FlowFile ( <span class="image"><img src="./images/lineage-flowfile.png" alt="FlowFile" width="32"></span> ) and the various processing events that have occurred. The selected event will be highlighted in yellow. It is possible to right-click on any event to see that event’s details (See <a href="#event_details">Details of an Event</a>).
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.</p>
</div>
<div class="paragraph">
@@ -2763,14 +2746,14 @@ lineage graph and select "Find parents"
<p>In addition to the Summary Page, Data Provenance Page, Template Management Page, and Bulletin Board Page, there are other tools in the Management Toolbar (See <a href="#User_Interface">NiFi User Interface</a>) that are useful to the DFM. The Flow Configuration History, which is available by clicking on the clock icon ( <span class="image"><img src="./images/iconFlowHistory.png" alt="Flow History" width="28"></span> ) in the Management Toolbar, shows all the changes that have been made to the dataflow. The history can aid in troubleshooting, such as if a recent change to the dataflow has caused a problem and needs to be fixed. The DFM can see what changes have been made and adjust the flow as needed to fix the problem. While NiFi does not have an "undo" feature, the DFM can make new changes to the dataflow that will fix the problem.</p>
</div>
<div class="paragraph">
-<p>Two other tools in the Management Toolbar are the Controller Settings page ( <span class="image"><img src="./images/iconSettings.png" alt="Settings" width="28"></span> ) and the Users page ( <span class="image"><img src="./images/iconUsers.png" alt="Users" width="28"></span> ). The Controller Settings page provides the ability to change the name of the NiFi instance, add comments describing the NiFi instance, set the maximum number of threads that are available to the application, and create a back-up copy of the dataflow(s) currently on the canvas. It also provides tabs where DFMs may add and configure Controller Services and Reporting Tasks (see <a href="#Controller_Services_and_Reporting_Tasks">Controller Services and Reporting Tasks</a>). The Users page is used to manage user access, which is described in the Admin Guide.</p>
+<p>Two other tools in the Management Toolbar are the Controller Settings page ( <span class="image"><img src="./images/iconSettings.png" alt="Settings" width="28"></span> ) and the Users page ( <span class="image"><img src="./images/iconUsers.png" alt="Users" width="28"></span> ). The Controller Settings page provides the ability to change the name of the NiFi instance, add comments describing the NiFi instance, set the maximum number of threads that are available to the application, and create a back-up copy of the dataflow(s) currently on the canvas. It also provides tabs where DFMs may add and configure Controller Services and Reporting Tasks (see <a href="#Controller_Services_and_Reporting_Tasks">Controller Services and Reporting Tasks</a>). The Users page is used to manage user access, which is described in the <a href="administration-guide.html">Admin Guide</a>.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2016-04-12 21:55:56 -04:00
+Last updated 2016-07-09 13:42:05 -04:00
</div>
</div>
</body>