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=1771892&r1=1771891&r2=1771892&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/html/user-guide.html (original) +++ nifi/site/trunk/docs/nifi-docs/html/user-guide.html Tue Nov 29 12:03:34 2016 @@ -455,73 +455,73 @@ body.book #toc,body.book #preamble,body. <div id="toc" class="toc"> <div id="toctitle">Table of Contents</div> <ul class="sectlevel1"> -<li><a href="user-guide.html#introduction">Introduction</a></li> -<li><a href="user-guide.html#browser-support">Browser Support</a> +<li><a href="#introduction">Introduction</a></li> +<li><a href="#browser-support">Browser Support</a> <ul class="sectlevel2"> -<li><a href="user-guide.html#unsupported-browsers">Unsupported Browsers</a></li> -<li><a href="user-guide.html#viewing-the-ui-in-variably-sized-browsers">Viewing the UI in Variably Sized Browsers</a></li> +<li><a href="#unsupported-browsers">Unsupported Browsers</a></li> +<li><a href="#viewing-the-ui-in-variably-sized-browsers">Viewing the UI in Variably Sized Browsers</a></li> </ul> </li> -<li><a href="user-guide.html#terminology">Terminology</a></li> -<li><a href="user-guide.html#User_Interface">NiFi User Interface</a></li> -<li><a href="user-guide.html#UI-with-multi-tenant-authorization">Accessing the UI with Multi-Tenant Authorization</a></li> -<li><a href="user-guide.html#logging-in">Logging In</a></li> -<li><a href="user-guide.html#building-dataflow">Building a DataFlow</a> +<li><a href="#terminology">Terminology</a></li> +<li><a href="#User_Interface">NiFi User Interface</a></li> +<li><a href="#UI-with-multi-tenant-authorization">Accessing the UI with Multi-Tenant Authorization</a></li> +<li><a href="#logging-in">Logging In</a></li> +<li><a href="#building-dataflow">Building a DataFlow</a> <ul class="sectlevel2"> -<li><a href="user-guide.html#adding-components-to-the-canvas">Adding Components to the Canvas</a></li> -<li><a href="user-guide.html#Configuring_a_Processor">Configuring a Processor</a></li> -<li><a href="user-guide.html#additional-help">Additional Help</a></li> -<li><a href="user-guide.html#Using_Custom_Properties">Using Custom Properties with Expression Language</a></li> -<li><a href="user-guide.html#Controller_Services">Controller Services</a></li> -<li><a href="user-guide.html#Reporting_Tasks">Reporting Tasks</a></li> -<li><a href="user-guide.html#Connecting_Components">Connecting Components</a></li> -<li><a href="user-guide.html#processor-validation">Processor Validation</a></li> -<li><a href="user-guide.html#site-to-site">Site-to-Site</a></li> -<li><a href="user-guide.html#example-dataflow">Example Dataflow</a></li> +<li><a href="#adding-components-to-the-canvas">Adding Components to the Canvas</a></li> +<li><a href="#Configuring_a_Processor">Configuring a Processor</a></li> +<li><a href="#additional-help">Additional Help</a></li> +<li><a href="#Using_Custom_Properties">Using Custom Properties with Expression Language</a></li> +<li><a href="#Controller_Services">Controller Services</a></li> +<li><a href="#Reporting_Tasks">Reporting Tasks</a></li> +<li><a href="#Connecting_Components">Connecting Components</a></li> +<li><a href="#processor-validation">Processor Validation</a></li> +<li><a href="#site-to-site">Site-to-Site</a></li> +<li><a href="#example-dataflow">Example Dataflow</a></li> </ul> </li> -<li><a href="user-guide.html#command-and-control-of-the-dataflow">Command and Control of the DataFlow</a> +<li><a href="#command-and-control-of-the-dataflow">Command and Control of the DataFlow</a> <ul class="sectlevel2"> -<li><a href="user-guide.html#starting-a-component">Starting a Component</a></li> -<li><a href="user-guide.html#stopping-a-component">Stopping a Component</a></li> -<li><a href="user-guide.html#enabling-disabling-a-component">Enabling/Disabling a Component</a></li> -<li><a href="user-guide.html#Remote_Group_Transmission">Remote Process Group Transmission</a></li> +<li><a href="#starting-a-component">Starting a Component</a></li> +<li><a href="#stopping-a-component">Stopping a Component</a></li> +<li><a href="#enabling-disabling-a-component">Enabling/Disabling a Component</a></li> +<li><a href="#Remote_Group_Transmission">Remote Process Group Transmission</a></li> </ul> </li> -<li><a href="user-guide.html#navigating">Navigating within a DataFlow</a></li> -<li><a href="user-guide.html#monitoring">Monitoring of DataFlow</a> +<li><a href="#navigating">Navigating within a DataFlow</a></li> +<li><a href="#monitoring">Monitoring of DataFlow</a> <ul class="sectlevel2"> -<li><a href="user-guide.html#processor_anatomy">Anatomy of a Processor</a></li> -<li><a href="user-guide.html#process_group_anatomy">Anatomy of a Process Group</a></li> -<li><a href="user-guide.html#remote_group_anatomy">Anatomy of a Remote Process Group</a></li> -<li><a href="user-guide.html#Queue_Interaction">Queue Interaction</a></li> -<li><a href="user-guide.html#Summary_Page">Summary Page</a></li> -<li><a href="user-guide.html#Stats_History">Historical Statistics of a Component</a></li> +<li><a href="#processor_anatomy">Anatomy of a Processor</a></li> +<li><a href="#process_group_anatomy">Anatomy of a Process Group</a></li> +<li><a href="#remote_group_anatomy">Anatomy of a Remote Process Group</a></li> +<li><a href="#Queue_Interaction">Queue Interaction</a></li> +<li><a href="#Summary_Page">Summary Page</a></li> +<li><a href="#Stats_History">Historical Statistics of a Component</a></li> </ul> </li> -<li><a href="user-guide.html#templates">Templates</a> +<li><a href="#templates">Templates</a> <ul class="sectlevel2"> -<li><a href="user-guide.html#Create_Template">Creating a Template</a></li> -<li><a href="user-guide.html#Import_Template">Importing a Template</a></li> -<li><a href="user-guide.html#instantiating-a-template">Instantiating a Template</a></li> -<li><a href="user-guide.html#Manage_Templates">Managing Templates</a></li> +<li><a href="#Create_Template">Creating a Template</a></li> +<li><a href="#Import_Template">Importing a Template</a></li> +<li><a href="#instantiating-a-template">Instantiating a Template</a></li> +<li><a href="#Manage_Templates">Managing Templates</a></li> </ul> </li> -<li><a href="user-guide.html#data-provenance">Data Provenance</a> +<li><a href="#data-provenance">Data Provenance</a> <ul class="sectlevel2"> -<li><a href="user-guide.html#searching-for-events">Searching for Events</a></li> -<li><a href="user-guide.html#event_details">Details of an Event</a></li> -<li><a href="user-guide.html#replaying-a-flowfile">Replaying a FlowFile</a></li> -<li><a href="user-guide.html#viewing-flowfile-lineage">Viewing FlowFile Lineage</a></li> +<li><a href="#searching-for-events">Searching for Events</a></li> +<li><a href="#event_details">Details of an Event</a></li> +<li><a href="#replaying-a-flowfile">Replaying a FlowFile</a></li> +<li><a href="#viewing-flowfile-lineage">Viewing FlowFile Lineage</a></li> </ul> </li> -<li><a href="user-guide.html#other_management_features">Other Management Features</a></li> +<li><a href="#other_management_features">Other Management Features</a></li> </ul> </div> </div> <div id="content"> <div class="sect1"> -<h2 id="introduction"><a class="anchor" href="user-guide.html#introduction"></a>Introduction</h2> +<h2 id="introduction"><a class="anchor" href="#introduction"></a>Introduction</h2> <div class="sectionbody"> <div class="paragraph"> <p>Apache NiFi is a dataflow system based on the concepts of flow-based programming. It supports @@ -538,7 +538,7 @@ use a supported web browser to view the </div> </div> <div class="sect1"> -<h2 id="browser-support"><a class="anchor" href="user-guide.html#browser-support"></a>Browser Support</h2> +<h2 id="browser-support"><a class="anchor" href="#browser-support"></a>Browser Support</h2> <div class="sectionbody"> <table class="tableblock frame-all grid-all spread"> <colgroup> @@ -562,7 +562,7 @@ use a supported web browser to view the </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Edge</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Current</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Current and Current - 1</p></td> </tr> <tr> <td class="tableblock halign-left valign-top"><p class="tableblock">Safari</p></td> @@ -575,21 +575,18 @@ use a supported web browser to view the the current stable release is 45.X then the officially supported versions will be 45.X and 44.X.</p> </div> <div class="paragraph"> -<p>Current indicates that the UI is supported in the current stable release of that browser.</p> -</div> -<div class="paragraph"> <p>The supported browser versions are driven by the capabilities the UI employs and the dependencies it uses. UI features will be developed and tested against the supported browsers. Any problem using a supported browser should be reported to Apache NiFi.</p> </div> <div class="sect2"> -<h3 id="unsupported-browsers"><a class="anchor" href="user-guide.html#unsupported-browsers"></a>Unsupported Browsers</h3> +<h3 id="unsupported-browsers"><a class="anchor" href="#unsupported-browsers"></a>Unsupported Browsers</h3> <div class="paragraph"> <p>While the UI may run successfully in unsupported browsers, it is not actively tested against them. Additionally, the UI is designed as a desktop experience and is not currently supported in mobile browsers.</p> </div> </div> <div class="sect2"> -<h3 id="viewing-the-ui-in-variably-sized-browsers"><a class="anchor" href="user-guide.html#viewing-the-ui-in-variably-sized-browsers"></a>Viewing the UI in Variably Sized Browsers</h3> +<h3 id="viewing-the-ui-in-variably-sized-browsers"><a class="anchor" href="#viewing-the-ui-in-variably-sized-browsers"></a>Viewing the UI in Variably Sized Browsers</h3> <div class="paragraph"> <p>In most environments, all of the UI is visible in your browser. However, the UI has a responsive design that allows you to scroll through screens as needed, in smaller sized browsers or tablet environments.</p> @@ -602,7 +599,7 @@ UI may become unavailable.</p> </div> </div> <div class="sect1"> -<h2 id="terminology"><a class="anchor" href="user-guide.html#terminology"></a>Terminology</h2> +<h2 id="terminology"><a class="anchor" href="#terminology"></a>Terminology</h2> <div class="sectionbody"> <div class="paragraph"> <p><strong>DataFlow Manager</strong>: A DataFlow Manager (DFM) is a NiFi user who has permissions to add, remove, and modify components of a NiFi dataflow.</p> @@ -694,7 +691,7 @@ UI may become unavailable.</p> </div> </div> <div class="sect1"> -<h2 id="User_Interface"><a class="anchor" href="user-guide.html#User_Interface"></a>NiFi User Interface</h2> +<h2 id="User_Interface"><a class="anchor" href="#User_Interface"></a>NiFi User Interface</h2> <div class="sectionbody"> <div class="paragraph"> <p>The NiFi UI provides mechanisms for creating automated dataflows, as well as visualizing, @@ -713,12 +710,12 @@ able to view and modify the dataflow. Fo </div> <div class="imageblock"> <div class="content"> -<img src="images/nifi-toolbar-components.png" alt="NiFi Components Toolbar"> +<img src="./images/nifi-toolbar-components.png" alt="NiFi Components Toolbar"> </div> </div> <div class="paragraph"> <p>The Components Toolbar runs across the top left portion of your screen. It consists of the components you can drag onto the -canvas to build your dataflow. Each component is described in more detail in <a href="http://localhost:8080/nifi-docs/html/building-dataflow.html";>Building a Dataflow</a>.</p> +canvas to build your dataflow. Each component is described in more detail in <a href="building-dataflow.html">Building a Dataflow</a>.</p> </div> <div class="paragraph"> <p>The Status Bar is under the Components Toolbar. The Status bar provides information about how many Processors exist on the canvas in @@ -739,7 +736,7 @@ contain options that allow you to manipu </div> <div class="imageblock"> <div class="content"> -<img src="images/global-menu.png" alt="NiFi Global Menu"> +<img src="./images/global-menu.png" alt="NiFi Global Menu"> </div> </div> <div class="paragraph"> @@ -752,13 +749,13 @@ breadcrumbs is a link that will take you </div> <div class="imageblock"> <div class="content"> -<img src="images/nifi-navigation.png" alt="NiFi Navigation"> +<img src="./images/nifi-navigation.png" alt="NiFi Navigation"> </div> </div> </div> </div> <div class="sect1"> -<h2 id="UI-with-multi-tenant-authorization"><a class="anchor" href="user-guide.html#UI-with-multi-tenant-authorization"></a>Accessing the UI with Multi-Tenant Authorization</h2> +<h2 id="UI-with-multi-tenant-authorization"><a class="anchor" href="#UI-with-multi-tenant-authorization"></a>Accessing the UI with Multi-Tenant Authorization</h2> <div class="sectionbody"> <div class="paragraph"> <p>Multi-tenant authorization enables multiple groups of users (tenants) to command, control, and observe different parts of the dataflow, @@ -795,6 +792,10 @@ is visible and available to you, dependi <td class="tableblock halign-left valign-top"><p class="tableblock">Allows users to submit a provenance search and request even lineage</p></td> </tr> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">access restricted components</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Allows users to create/modify restricted components assuming otherwise sufficient permissions</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">access all policies</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Allows users to view and modify the policies for all components</p></td> </tr> @@ -876,7 +877,7 @@ is visible and available to you, dependi </div> </div> <div class="sect1"> -<h2 id="logging-in"><a class="anchor" href="user-guide.html#logging-in"></a>Logging In</h2> +<h2 id="logging-in"><a class="anchor" href="#logging-in"></a>Logging In</h2> <div class="sectionbody"> <div class="paragraph"> <p>If NiFi is configured to run securely, users will be able to request access to the DataFlow. For information on configuring NiFi to run @@ -890,13 +891,13 @@ be immediately sent to the login form by </div> <div class="imageblock"> <div class="content"> -<img src="images/login.png" alt="Log In"> +<img src="./images/login.png" alt="Log In"> </div> </div> </div> </div> <div class="sect1"> -<h2 id="building-dataflow"><a class="anchor" href="user-guide.html#building-dataflow"></a>Building a DataFlow</h2> +<h2 id="building-dataflow"><a class="anchor" href="#building-dataflow"></a>Building a DataFlow</h2> <div class="sectionbody"> <div class="paragraph"> <p>A DFM is able to build an automated dataflow using the NiFi UI. Simply drag components from the toolbar to the canvas, @@ -904,18 +905,18 @@ configure the components to meet specifi the components together.</p> </div> <div class="sect2"> -<h3 id="adding-components-to-the-canvas"><a class="anchor" href="user-guide.html#adding-components-to-the-canvas"></a>Adding Components to the Canvas</h3> +<h3 id="adding-components-to-the-canvas"><a class="anchor" href="#adding-components-to-the-canvas"></a>Adding Components to the Canvas</h3> <div class="paragraph"> <p>The User Interface section above outlined the different segments of the UI and pointed out a Components Toolbar. This section looks at each of the Components in that toolbar:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/components.png" alt="Components"> +<img src="./images/components.png" alt="Components"> </div> </div> <div id="processor" class="paragraph"> -<p><span class="image"><img src="images/iconProcessor.png" alt="Processor" width="32"></span> +<p><span class="image"><img src="./images/iconProcessor.png" alt="Processor" width="32"></span> <strong>Processor</strong>: The Processor is the most commonly used component, as it is responsible for data ingress, egress, routing, and manipulating. There are many different types of Processors. In fact, this is a very common Extension Point in NiFi, meaning that many vendors may implement their own Processors to perform whatever functions are necessary for their use case. @@ -923,7 +924,7 @@ This section looks at each of the Compon </div> <div class="imageblock"> <div class="content"> -<img src="images/add-processor.png" alt="Add Processor Dialog"> +<img src="./images/add-processor.png" alt="Add Processor Dialog"> </div> </div> <div class="paragraph"> @@ -936,17 +937,39 @@ Processors that allow us to ingest data </div> <div class="imageblock"> <div class="content"> -<img src="images/add-processor-with-tag-cloud.png" alt="Add Processor with Tag Cloud"> +<img src="./images/add-processor-with-tag-cloud.png" alt="Add Processor with Tag Cloud"> +</div> </div> +<div class="paragraph"> +<p>Restricted components will be marked with a +<span class="image"><img src="./images/restricted.png" alt="Restricted"></span> +icon next to their name. These are components that can be used to execute arbitrary unsanitized code provided by the operator +through the NiFi REST API/UI or can be used to obtain or alter data on the NiFi host system using the NiFi OS credentials. +These components could be used by an otherwise authorized NiFi user to go beyond the intended use of the application, escalate +privilege, or could expose data about the internals of the NiFi process or the host system. All of these capabilities should +be considered privileged, and admins should be aware of these capabilities and explicitly enable them for a subset of trusted users.</p> +</div> +<div class="paragraph"> +<p>Before a user is allowed to create and modify restricted components they must be granted access to restricted components. Refer to +<a href="#UI-with-multi-tenant-authorization">multi-tenant</a> documentation.</p> </div> <div class="paragraph"> <p>Clicking the <code>Add</code> button or double-clicking on a Processor Type will add the selected Processor to the canvas at the location that it was dropped.</p> </div> -<div class="paragraph"> -<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. +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +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> +down the Shift key and dragging a selection box around the desired components. +</td> +</tr> +</table> </div> <div class="paragraph"> <p>Once you have dragged a Processor onto the canvas, you can interact with it by right-clicking on the Processor and @@ -954,7 +977,7 @@ selecting an option from the context men </div> <div class="imageblock"> <div class="content"> -<img src="images/nifi-processor-menu.png" alt="Processor Menu"> +<img src="./images/nifi-processor-menu.png" alt="Processor Menu"> </div> </div> <div class="paragraph"> @@ -963,7 +986,7 @@ selecting an option from the context men <div class="ulist"> <ul> <li> -<p><strong>Configure</strong>: This option allows the user to establish or change the configuration of the Processor. (See <a href="user-guide.html#Configuring_a_Processor">Configuring a Processor</a>.)</p> +<p><strong>Configure</strong>: This option allows the user to establish or change the configuration of the Processor. (See <a href="#Configuring_a_Processor">Configuring a Processor</a>.)</p> </li> <li> <p><strong>Start</strong> or <strong>Stop</strong>: 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.</p> @@ -992,34 +1015,34 @@ selecting an option from the context men </ul> </div> <div id="input_port" class="paragraph"> -<p><span class="image"><img src="images/iconInputPort.png" alt="Input Port" width="32"></span> +<p><span class="image"><img src="./images/iconInputPort.png" alt="Input Port" width="32"></span> <strong>Input Port</strong>: Input Ports provide a mechanism for transferring data into a Process Group. When an Input Port is dragged onto the canvas, the DFM is prompted to name the Port. All Ports within a Process Group must have unique names.</p> </div> <div class="paragraph"> <p>All components exist only within a Process Group. When a user initially navigates to the NiFi page, the user is placed in the Root Process Group. If the Input Port is dragged onto the Root Process Group, the Input Port provides a mechanism -to receive data from remote instances of NiFi via <a href="user-guide.html#site-to-site">Site-to-Site</a>. In this case, the Input Port can be configured +to receive data from remote instances of NiFi via <a href="#site-to-site">Site-to-Site</a>. In this case, the Input Port can be configured to restrict access to appropriate users, if NiFi is configured to run securely. For information on configuring NiFi to run securely, see the <a href="administration-guide.html">System Administratorâs Guide</a>.</p> </div> <div id="output_port" class="paragraph"> -<p><span class="image"><img src="images/iconOutputPort.png" alt="Output Port" width="32"></span> +<p><span class="image"><img src="./images/iconOutputPort.png" alt="Output Port" width="32"></span> <strong>Output Port</strong>: Output Ports provide a mechanism for transferring data from a Process Group to destinations outside of the Process Group. When an Output Port is dragged onto the canvas, the DFM is prompted to name the Port. All Ports within a Process Group must have unique names.</p> </div> <div class="paragraph"> <p>If the Output Port is dragged onto the Root Process Group, the Output Port provides a mechanism for sending data to -remote instances of NiFi via <a href="user-guide.html#site-to-site">Site-to-Site</a>. In this case, the Port acts as a queue. As remote instances +remote instances of NiFi via <a href="#site-to-site">Site-to-Site</a>. In this case, the Port acts as a queue. As remote instances of NiFi pull data from the port, that data is removed from the queues of the incoming Connections. If NiFi is configured to run securely, the Output Port can be configured to restrict access to appropriate users. For information on configuring NiFi to run securely, see the <a href="administration-guide.html">System Administratorâs Guide</a>.</p> </div> <div id="process_group" class="paragraph"> -<p><span class="image"><img src="images/iconProcessGroup.png" alt="Process Group" width="32"></span> +<p><span class="image"><img src="./images/iconProcessGroup.png" alt="Process Group" width="32"></span> <strong>Process Group</strong>: Process Groups can be used to logically group a set of components so that the dataflow is easier to understand and maintain. When a Process Group is dragged onto the canvas, the DFM is prompted to name the Process Group. All Process Groups within the same parent group must have unique names. The Process Group will then be nested within that parent group.</p> @@ -1030,7 +1053,7 @@ context menu.The options available to yo </div> <div class="imageblock"> <div class="content"> -<img src="images/nifi-process-group-menu.png" alt="Process Group Menu"> +<img src="./images/nifi-process-group-menu.png" alt="Process Group Menu"> </div> </div> <div class="paragraph"> @@ -1065,7 +1088,7 @@ context menu.The options available to yo </ul> </div> <div id="remote_process_group" class="paragraph"> -<p><span class="image"><img src="images/iconRemoteProcessGroup.png" alt="Remote Process Group" width="32"></span> +<p><span class="image"><img src="./images/iconRemoteProcessGroup.png" alt="Remote Process Group" width="32"></span> <strong>Remote Process Group</strong>: Remote Process Groups appear and behave similar to Process Groups. However, the Remote Process Group (RPG) 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 @@ -1073,7 +1096,7 @@ is the URL of the remote instance’ 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="user-guide.html#site-to-site">Site-to-Site</a>.</p> +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> </div> <div class="paragraph"> <p>Once a Remote Process Group has been dragged onto the canvas, the user may interact with it by right-clicking on the Remote Process Group and selecting an option from @@ -1081,7 +1104,7 @@ context menu. The options available to y </div> <div class="imageblock"> <div class="content"> -<img src="images/nifi-rpg-menu.png" alt="Remote Process Group Menu"> +<img src="./images/nifi-rpg-menu.png" alt="Remote Process Group Menu"> </div> </div> <div class="paragraph"> @@ -1096,7 +1119,7 @@ context menu. The options available to y <p><strong>Remote Ports</strong>: This option allows the user to see input ports and/or output ports that exist on the remote instance of NiFi that the Remote Process Group is connected to. Note that if the Site-to-Site configuration is secure, only the ports that the connecting NiFi has been given accessed to will be visible.</p> </li> <li> -<p><strong>Enable transmission</strong>: Makes the transmission of data between NiFi instances active. (See <a href="user-guide.html#Remote_Group_Transmission">Remote Process Group Transmission</a> )</p> +<p><strong>Enable transmission</strong>: Makes the transmission of data between NiFi instances active. (See <a href="#Remote_Group_Transmission">Remote Process Group Transmission</a> )</p> </li> <li> <p><strong>Disable transmission</strong>: Disables the transmission of data between NiFi instances.</p> @@ -1128,7 +1151,7 @@ context menu. The options available to y </ul> </div> <div id="funnel" class="paragraph"> -<p><span class="image"><img src="images/iconFunnel.png" alt="Funnel"></span> +<p><span class="image"><img src="./images/iconFunnel.png" alt="Funnel"></span> <strong>Funnel</strong>: Funnels are used to combine the data from many Connections into a single Connection. This has two advantages. First, if many Connections are created with the same destination, the canvas can become cluttered if those Connections have to span a large space. By funneling these Connections into a single Connection, that single Connection can then be @@ -1137,14 +1160,14 @@ several Connections can be funneled into one Connection, rather than prioritizing the data on each Connection independently.</p> </div> <div id="template" class="paragraph"> -<p><span class="image"><img src="images/iconTemplate.png" alt="Template"></span> +<p><span class="image"><img src="./images/iconTemplate.png" alt="Template"></span> <strong>Template</strong>: Templates can be created by DFMs from sections of the flow, or they can be imported from other dataflows. These Templates provide larger building blocks for creating a complex flow quickly. When the Template is dragged onto the canvas, the DFM is provided a dialog to choose which Template to add to the canvas:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/instantiate-template.png" alt="Instantiate Template Dialog"> +<img src="./images/instantiate-template.png" alt="Instantiate Template Dialog"> </div> </div> <div class="paragraph"> @@ -1153,11 +1176,11 @@ icon, indicating that there is more info </div> <div class="imageblock"> <div class="content"> -<img src="images/instantiate-template-description.png" alt="Instantiate Template Dialog"> +<img src="./images/instantiate-template-description.png" alt="Instantiate Template Dialog"> </div> </div> <div id="label" class="paragraph"> -<p><span class="image"><img src="images/iconLabel.png" alt="Label"></span> +<p><span class="image"><img src="./images/iconLabel.png" alt="Label"></span> <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 @@ -1165,7 +1188,7 @@ choosing <code>Configure</code></p> </div> </div> <div class="sect2"> -<h3 id="Configuring_a_Processor"><a class="anchor" href="user-guide.html#Configuring_a_Processor"></a>Configuring a Processor</h3> +<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 different tabs, each of which is discussed below. Once you have finished configuring the Processor, you can apply @@ -1178,13 +1201,13 @@ running. You must first stop the Process the Processor again.</p> </div> <div class="sect3"> -<h4 id="settings-tab"><a class="anchor" href="user-guide.html#settings-tab"></a>Settings Tab</h4> +<h4 id="settings-tab"><a class="anchor" href="#settings-tab"></a>Settings Tab</h4> <div class="paragraph"> <p>The first tab in the Processor Configuration dialog is the Settings tab:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/settings-tab.png" alt="Settings Tab"> +<img src="./images/settings-tab.png" alt="Settings Tab"> </div> </div> <div class="paragraph"> @@ -1231,13 +1254,13 @@ auto-terminated, the auto-termination st </div> </div> <div class="sect3"> -<h4 id="scheduling-tab"><a class="anchor" href="user-guide.html#scheduling-tab"></a>Scheduling Tab</h4> +<h4 id="scheduling-tab"><a class="anchor" href="#scheduling-tab"></a>Scheduling Tab</h4> <div class="paragraph"> <p>The second tab in the Processor Configuration dialog is the Scheduling Tab:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/scheduling-tab.png" alt="Scheduling Tab"> +<img src="./images/scheduling-tab.png" alt="Scheduling Tab"> </div> </div> <div class="paragraph"> @@ -1323,6 +1346,11 @@ for any time duration of 0, regardless o applicable for the CRON driven Scheduling Strategy, see the description of the CRON driven Scheduling Strategy itself.</p> </div> <div class="paragraph"> +<p>When configured for clustering, an Execution setting will be available. This setting is used to determine which node(s) the Processor will be +scheduled to execute. Selecting <em>All Nodes</em> will result in this Processor being scheduled on every node in the cluster. Selecting +<em>Primary Node</em> will result in this Processor being scheduled on the Primary Node only.</p> +</div> +<div class="paragraph"> <p>The right-hand side of the tab contains a slider for choosing the ‘Run duration.’ This controls how long the Processor should be scheduled to run each time that it is triggered. On the left-hand side of the slider, it is marked ‘Lower latency’ while the right-hand side is marked ‘Higher throughput.’ When a Processor finishes running, it must update the repository in order to transfer the FlowFiles to @@ -1334,20 +1362,20 @@ Lower Latency or Higher Throughput.</p> </div> </div> <div class="sect3"> -<h4 id="properties-tab"><a class="anchor" href="user-guide.html#properties-tab"></a>Properties Tab</h4> +<h4 id="properties-tab"><a class="anchor" href="#properties-tab"></a>Properties Tab</h4> <div class="paragraph"> <p>The Properties Tab provides a mechanism to configure Processor-specific behavior. There are no default properties. Each type of Processor must define which Properties make sense for its use case. Below, we see the Properties Tab for a RouteOnAttribute Processor:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/properties-tab.png" alt="Properties Tab"> +<img src="./images/properties-tab.png" alt="Properties Tab"> </div> </div> <div class="paragraph"> <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> +<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. Hovering over this symbol with the mouse will provide additional details about the property and the default value, as well as historical values that have been set for the Property.</p> @@ -1358,7 +1386,7 @@ the user is either provided a drop-down </div> <div class="imageblock"> <div class="content"> -<img src="images/edit-property-dropdown.png" alt="Edit Property with Dropdown"> +<img src="./images/edit-property-dropdown.png" alt="Edit Property with Dropdown"> </div> </div> <div class="paragraph"> @@ -1368,38 +1396,38 @@ the Processor becomes invalid when User- In fact, this Processor will not be valid until the user has added a property.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/edit-property-textarea.png" alt="Edit Property with Text Area"></span></p> +<p><span class="image"><img src="./images/edit-property-textarea.png" alt="Edit Property with Text Area"></span></p> </div> <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> +<span class="image"><img src="./images/iconDelete.png" alt="Delete Icon"></span> ). 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> </div> <div class="paragraph"> -<p>Some processors have properties that refer to other components, such as Controller Services, which also need to be configured. For example, the GetHTTP processor has an SSLContextService property, which refers to the StandardSSLContextService controller service. When DFMs want to configure this property but have not yet created and configured the controller service, they have the option to create the service on the spot, as depicted in the image below. For more information about configuring Controller Services, see the <a href="user-guide.html#Controller_Services_and_Reporting_Tasks">[Controller_Services_and_Reporting_Tasks]</a> section.</p> +<p>Some processors have properties that refer to other components, such as Controller Services, which also need to be configured. For example, the GetHTTP processor has an SSLContextService property, which refers to the StandardSSLContextService controller service. When DFMs want to configure this property but have not yet created and configured the controller service, they have the option to create the service on the spot, as depicted in the image below. For more information about configuring Controller Services, see the <a href="#Controller_Services_and_Reporting_Tasks">[Controller_Services_and_Reporting_Tasks]</a> section.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/create-service-ssl-context.png" alt="Create Service" width="700"></span></p> +<p><span class="image"><img src="./images/create-service-ssl-context.png" alt="Create Service" width="700"></span></p> </div> </div> <div class="sect3"> -<h4 id="comments-tab"><a class="anchor" href="user-guide.html#comments-tab"></a>Comments Tab</h4> +<h4 id="comments-tab"><a class="anchor" href="#comments-tab"></a>Comments Tab</h4> <div class="paragraph"> <p>The last tab in the Processor configuration dialog is the Comments tab. This tab simply provides an area for users to include whatever comments are appropriate for this component. Use of the Comments tab is optional:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/comments-tab.png" alt="Comments Tab"> +<img src="./images/comments-tab.png" alt="Comments Tab"> </div> </div> </div> </div> <div class="sect2"> -<h3 id="additional-help"><a class="anchor" href="user-guide.html#additional-help"></a>Additional Help</h3> +<h3 id="additional-help"><a class="anchor" href="#additional-help"></a>Additional Help</h3> <div class="paragraph"> <p>You can access additional documentation about each Processor’s usage by right-clicking on the Processor and selecting ‘Usage’ from the context menu. Alternatively, select Help from the Global Menu in the top-right @@ -1408,7 +1436,7 @@ for all the Processors that are availabl </div> </div> <div class="sect2"> -<h3 id="Using_Custom_Properties"><a class="anchor" href="user-guide.html#Using_Custom_Properties"></a>Using Custom Properties with Expression Language</h3> +<h3 id="Using_Custom_Properties"><a class="anchor" href="#Using_Custom_Properties"></a>Using Custom Properties with Expression Language</h3> <div class="paragraph"> <p>You can use NiFi Expression Language to reference FlowFile attributes, compare them to other values, and manipulate their values when you are creating and configuring dataflows.</p> @@ -1467,7 +1495,7 @@ For information on how to define custom </div> </div> <div class="sect2"> -<h3 id="Controller_Services"><a class="anchor" href="user-guide.html#Controller_Services"></a>Controller Services</h3> +<h3 id="Controller_Services"><a class="anchor" href="#Controller_Services"></a>Controller Services</h3> <div class="paragraph"> <p>Controller Services are available for reporting tasks, processors, and other services to utilize for configuration or task execution. You can use the NiFi UI to add Controller Services for either reporting @@ -1483,7 +1511,7 @@ privileges can be assigned on a global o Services whether you are adding it for a reporting task or a dataflow.</p> </div> <div class="sect3"> -<h4 id="Controller_Services_for_Reporting_Tasks"><a class="anchor" href="user-guide.html#Controller_Services_for_Reporting_Tasks"></a>Adding Controller Settings for Reporting Tasks</h4> +<h4 id="Controller_Services_for_Reporting_Tasks"><a class="anchor" href="#Controller_Services_for_Reporting_Tasks"></a>Adding Controller Settings for Reporting Tasks</h4> <div class="paragraph"> <p>To add a Controller Service for a reporting task, select Controller Settings from the Global Menu. This displays the NiFi Settings window.</p> @@ -1498,14 +1526,14 @@ that connects remotely to this instance <p>The General tab also provides settings for the overall maximum thread counts of the instance.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/settings-general-tab.png" alt="Controller Settings General Tab"></span></p> +<p><span class="image"><img src="./images/settings-general-tab.png" alt="Controller Settings General Tab"></span></p> </div> <div class="paragraph"> <p>To the right of the General tab is the Controller Services tab. From this tab, the DFM may click the "+" button in the upper-right corner to create a new Controller Service.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/controller-services-tab.png" alt="Controller Services Tab"></span></p> +<p><span class="image"><img src="./images/controller-services-tab.png" alt="Controller Services Tab"></span></p> </div> <div class="paragraph"> <p>The Add Controller Service window opens. This window is similar to the Add Processor window. It provides a list of the @@ -1517,20 +1545,20 @@ the the service below. Select the desire to add it.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/add-controller-service-window.png" alt="Add Controller Service Window"></span></p> +<p><span class="image"><img src="./images/add-controller-service-window.png" alt="Add Controller Service Window"></span></p> </div> <div class="paragraph"> <p>Once you have added a Controller Service, you can configure it by clicking the Edit button in the far-right column. Other buttons in this column include Remove and Access Policies.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/controller-services-edit-buttons.png" alt="Controller Services Buttons"></span></p> +<p><span class="image"><img src="./images/controller-services-edit-buttons.png" alt="Controller Services Buttons"></span></p> </div> <div class="paragraph"> <p>You can obtain information about Controller Services by clicking the Details, Usage, and Alerts buttons in the left-hand column.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/controller-services-information-buttons.png" alt="Controller Services Information Buttons"></span></p> +<p><span class="image"><img src="./images/controller-services-information-buttons.png" alt="Controller Services Information Buttons"></span></p> </div> <div class="paragraph"> <p>When the DFM clicks the Edit button, a Configure Controller Service window opens. It has three tabs: Settings, Properties, @@ -1539,14 +1567,14 @@ to give the Controller Service a unique of other components (processors or other controller services) that reference the service.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/configure-controller-service-settings.png" alt="Configure Controller Service Settings"></span></p> +<p><span class="image"><img src="./images/configure-controller-service-settings.png" alt="Configure Controller Service Settings"></span></p> </div> <div class="paragraph"> <p>The Properties tab lists the various properties that apply to the particular controller service. As with configuring processors, the DFM may hover the over the question mark icons to see more information about each property.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/configure-controller-service-properties.png" alt="Configure Controller Service Properties"></span></p> +<p><span class="image"><img src="./images/configure-controller-service-properties.png" alt="Configure Controller Service Properties"></span></p> </div> <div class="paragraph"> <p>The Comments tab is just an open-text field, where the DFM may include comments about the service. After configuring @@ -1560,7 +1588,7 @@ in order to modify an existing/running c </div> </div> <div class="sect3"> -<h4 id="Controller_Services_for_Dataflows"><a class="anchor" href="user-guide.html#Controller_Services_for_Dataflows"></a>Adding Controller Services for Dataflows</h4> +<h4 id="Controller_Services_for_Dataflows"><a class="anchor" href="#Controller_Services_for_Dataflows"></a>Adding Controller Services for Dataflows</h4> <div class="paragraph"> <p>To add a Controller Service for a dataflow, you can either right click a Process Group and select Configure, or click Configure from the Operate Palette. When you click Configure from the Operate Palette with nothing selected on your @@ -1588,7 +1616,7 @@ Process Group.</p> </li> <li> <p>Perform any necessary Controller Service configuration tasks by clicking the View Details icon ( -<span class="image"><img src="images/iconViewDetails.png" alt="View Details"></span> +<span class="image"><img src="./images/iconDetails.png" alt="View Details"></span> ) in the left-hand column.</p> </li> </ol> @@ -1596,30 +1624,30 @@ Process Group.</p> </div> </div> <div class="sect2"> -<h3 id="Reporting_Tasks"><a class="anchor" href="user-guide.html#Reporting_Tasks"></a>Reporting Tasks</h3> +<h3 id="Reporting_Tasks"><a class="anchor" href="#Reporting_Tasks"></a>Reporting Tasks</h3> <div class="paragraph"> <p>The Reporting Tasks tab behaves similarly to the Controller Services tab. The DFM has the option to add Reporting Tasks and configure them in the same way as Controller Services.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/reporting-tasks-tab.png" alt="Reporting Tasks Tab"></span></p> +<p><span class="image"><img src="./images/reporting-tasks-tab.png" alt="Reporting Tasks Tab"></span></p> </div> <div class="paragraph"> <p>Once a Reporting Task has been added, the DFM may configure it by clicking the Edit (pencil icon) in the far-right column. Other buttons in this column include the Start button, Remove button, and Usage button, which links to the documentation for the particular Reporting Task.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/reporting-tasks-edit-buttons2.png" alt="Reporting Tasks Buttons"></span></p> +<p><span class="image"><img src="./images/reporting-tasks-edit-buttons2.png" alt="Reporting Tasks Buttons"></span></p> </div> <div class="paragraph"> <p>When the DFM clicks the Edit button, a Configure Reporting Task window opens. It has three tabs: Settings, Properties, and Comments. This window is also similar to the Configure Processor window. The Settings tab provides a place for the DFM to give the Reporting Task a unique name (if desired). It also lists a UUID for the Reporting Task and provides settings for the task’s Scheduling Strategy and Run Schedule (similar to the same settings in a processor). The DFM may hover the mouse over the question mark icons to see more information about each setting.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/configure-reporting-task-settings.png" alt="Configure Reporting Task Settings"></span></p> +<p><span class="image"><img src="./images/configure-reporting-task-settings.png" alt="Configure Reporting Task Settings"></span></p> </div> <div class="paragraph"> <p>The Properties tab for a Reporting Task lists the properties that may be configured for the task. The DFM may hover the mouse over the question mark icons to see more information about each property.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/configure-reporting-task-properties.png" alt="Configure Reporting Task Properties"></span></p> +<p><span class="image"><img src="./images/configure-reporting-task-properties.png" alt="Configure Reporting Task Properties"></span></p> </div> <div class="paragraph"> <p>The Comments tab is just an open-text field, where the DFM may include comments about the task. After configuring the Reporting Task, click the Apply button to apply the configuration and close the window, or click Cancel to cancel the changes and close the window.</p> @@ -1629,53 +1657,62 @@ Process Group.</p> </div> </div> <div class="sect2"> -<h3 id="Connecting_Components"><a class="anchor" href="user-guide.html#Connecting_Components"></a>Connecting Components</h3> +<h3 id="Connecting_Components"><a class="anchor" href="#Connecting_Components"></a>Connecting Components</h3> <div class="paragraph"> <p>Once processors and other components have been added to the canvas and configured, the next step is to connect them to one another so that NiFi knows what to do with each FlowFile after it has been processed. This is accomplished by creating a Connection between each component. When the user hovers the mouse over the center of a component, a new Connection icon ( -<span class="image"><img src="images/addConnect.png" alt="Connection Bubble"></span> +<span class="image"><img src="./images/addConnect.png" alt="Connection Bubble"></span> ) appears:</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/processor-connection-bubble.png" alt="Processor with Connection Bubble"></span></p> +<p><span class="image"><img src="./images/processor-connection-bubble.png" alt="Processor with Connection Bubble"></span></p> </div> <div class="paragraph"> <p>The user drags the Connection bubble from one component to another until the second component is highlighted. When the user -releases the mouse, a ‘Create Connection’ dialog appears. This dialog consists of two tabs: ‘Details’ and ‘Settings’. They are +releases the mouse, a <em>Create Connection</em> dialog appears. This dialog consists of two tabs: ‘Details’ and ‘Settings’. They are discussed in detail below. Note that it is possible to draw a connection so that it loops back on the same processor. This can be useful if the DFM wants the processor to try to re-process FlowFiles if they go down a failure Relationship. To create this type of looping connection, simply drag the connection bubble away and then back to the same processor until it is highlighted. Then release the mouse and the same <em>Create Connection</em> dialog appears.</p> </div> <div class="sect3"> -<h4 id="details-tab"><a class="anchor" href="user-guide.html#details-tab"></a>Details Tab</h4> +<h4 id="details-tab"><a class="anchor" href="#details-tab"></a>Details Tab</h4> <div class="paragraph"> <p>The Details Tab of the <em>Create Connection</em> dialog provides information about the source and destination components, including the component name, the component type, and the Process Group in which the component lives:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/create-connection.png" alt="Create Connection"> +<img src="./images/create-connection.png" alt="Create Connection"> </div> </div> <div class="paragraph"> <p>Additionally, this tab provides the ability to choose which Relationships should be included in this Connection. At least one Relationship must be selected. If only one Relationship is available, it is automatically selected.</p> </div> -<div class="paragraph"> -<p><strong>Note</strong>: If multiple Connections are added with the same Relationship, any FlowFile that is routed to that Relationship will -automatically be ‘cloned’, and a copy will be sent to each of those Connections.</p> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +If multiple Connections are added with the same Relationship, any FlowFile that is routed to that Relationship will +automatically be ‘cloned’, and a copy will be sent to each of those Connections. +</td> +</tr> +</table> </div> </div> <div class="sect3"> -<h4 id="settings"><a class="anchor" href="user-guide.html#settings"></a>Settings</h4> +<h4 id="settings"><a class="anchor" href="#settings"></a>Settings</h4> <div class="paragraph"> <p>The Settings Tab provides the ability to configure the Connection’s name, FlowFile expiration, Back Pressure thresholds, and Prioritization:</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/connection-settings.png" alt="Connection Settings"></span></p> +<p><span class="image"><img src="./images/connection-settings.png" alt="Connection Settings"></span></p> </div> <div class="paragraph"> <p>The Connection name is optional. If not specified, the name shown for the Connection will be names of the Relationships @@ -1689,14 +1726,31 @@ processed first and then anything that c value of <code>0 sec</code> indicates that the data will never expire. When a file expiration other than <em>0 sec</em> is set, a small clock icon appears on the connection label, so the DFM can see it at-a-glance when looking at a flow on the canvas.</p> </div> <div class="paragraph"> +<p><span class="image"><img src="./images/file_expiration_clock.png" alt="File Expiration Indicator"></span></p> +</div> +<div class="paragraph"> <p>NiFi provides two configuration elements for Back Pressure. These thresholds indicate how much data should be allowed to exist in the queue before the component that is the source of the Connection is no longer scheduled to run. This allows the system to avoid being overrun with data. The first option provided is the “Back pressure object threshold.” This is the number of FlowFiles that can be in the queue before back pressure is applied. The second configuration option -is the “Back pressure data size threshold.” -This specifies the maximum amount of data (in size) that should be queued up before +is the “Back pressure data size threshold.” This specifies the maximum amount of data (in size) that should be queued up before applying back pressure. This value is configured by entering a number followed by a data size (<code>B</code> for bytes, <code>KB</code> for -kilobytes, <code>MB</code> for megabytes, <code>GB</code> for gigabytes, or <code>TB</code> for terabytes).</p> +kilobytes, <code>MB</code> for megabytes, <code>GB</code> for gigabytes, or <code>TB</code> for terabytes). When back pressure is enabled, small progress bars appear on the connection label, so the DFM can see it at-a-glance when looking at a flow on the canvas. The progress bars change color based on the queue percentage: Green (0-60%), Yellow (61-85%) and Red (86-100%).</p> +</div> +<div class="paragraph"> +<p><span class="image"><img src="./images/back_pressure_indicators.png" alt="Back Pressure Indicator Bars"></span></p> +</div> +<div class="paragraph"> +<p>Hovering your mouse over a bar displays the exact percentage.</p> +</div> +<div class="paragraph"> +<p><span class="image"><img src="./images/back_pressure_indicator_hover.png" alt="Back Pressure Indicator Hover Text"></span></p> +</div> +<div class="paragraph"> +<p>When the queue is completely full, the Connection is highlighted in red.</p> +</div> +<div class="paragraph"> +<p><span class="image"><img src="./images/back_pressure_full.png" alt="Back Pressure Queue Full"></span></p> </div> <div class="paragraph"> <p>The right-hand side of the tab provides the ability to prioritize the data in the queue so that higher priority data is @@ -1718,7 +1772,7 @@ prioritizers’ list to the ‘A <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 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> +<p><strong>OldestFlowFileFirstPrioritizer</strong>: Given two FlowFiles, the one that is oldest in the dataflow will be processed first. <em>This is the default scheme that is used if no prioritizers are selected.</em></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> @@ -1726,16 +1780,16 @@ prioritizers’ list to the ‘A </ul> </div> <div class="paragraph"> -<p><strong>Note</strong>: After a connection has been drawn between two components, the connection’s configuration may be changed, and the connection may be moved to a new destination; however, the processors on either side of the connection must be stopped before a configuration or destination change may be made.</p> +<p>After a connection has been drawn between two components, the connection’s configuration may be changed, and the connection may be moved to a new destination; however, the processors on either side of the connection must be stopped before a configuration or destination change may be made.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/nifi-connection.png" alt="Connection"></span></p> +<p><span class="image"><img src="./images/nifi-connection.png" alt="Connection"></span></p> </div> <div class="paragraph"> <p>To change a connection’s configuration or interact with the connection in other ways, right-click on the connection to open the connection context menu.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/nifi-connection-menu.png" alt="Connection Menu"></span></p> +<p><span class="image"><img src="./images/nifi-connection-menu.png" alt="Connection Menu"></span></p> </div> <div class="paragraph"> <p>The following options are available:</p> @@ -1746,7 +1800,7 @@ prioritizers’ list to the ‘A <p><strong>Configure</strong>: This option allows the user to change the configuration of the connection.</p> </li> <li> -<p><strong>Stats</strong>: This option opens a graphical representation of the connection’s statistical information over time.</p> +<p><strong>Status History</strong>: This option opens a graphical representation of the connection’s statistical information over time.</p> </li> <li> <p><strong>Bring to front</strong>: This option brings the connection to the front of the canvas if something else (such as another connection) is overlapping it.</p> @@ -1758,6 +1812,9 @@ prioritizers’ list to the ‘A <p><strong>Go to destination</strong>: Similar to the "Go to source" option, this option changes the view to the destination component on the canvas and can be useful if there is a long distance between two connected components.</p> </li> <li> +<p><strong>List queue</strong>: This option lists the queue of FlowFiles that may be waiting to be processed.</p> +</li> +<li> <p><strong>Empty queue</strong>: This option allows the DFM to clear the queue of FlowFiles that may be waiting to be processed. This option can be especially useful during testing, when the DFM is not concerned about deleting data from the queue. When this option is selected, users must confirm that they want to delete the data in the queue.</p> </li> <li> @@ -1767,19 +1824,17 @@ prioritizers’ list to the ‘A </div> </div> <div class="sect3"> -<h4 id="bending-connections"><a class="anchor" href="user-guide.html#bending-connections"></a>Bending Connections</h4> +<h4 id="bending-connections"><a class="anchor" href="#bending-connections"></a>Bending Connections</h4> <div class="paragraph"> -<p>To add a bend point (or elbow) to an existing connection, simply double-click on the connection in the spot where you want the bend point to be. Then, you can use the mouse to grab -the bend point and drag it so that the connection is bent in the desired way. You can add as many bend points as you want. You can also use the mouse to drag and move the label on the connection to any existing -bend point. To remove a bend point, simply double-click it again.</p> +<p>To add a bend point (or elbow) to an existing connection, simply double-click on the connection in the spot where you want the bend point to be. Then, you can use the mouse to grab the bend point and drag it so that the connection is bent in the desired way. You can add as many bend points as you want. You can also use the mouse to drag and move the label on the connection to any existing bend point. To remove a bend point, simply double-click it again.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/nifi-connection-bend-points.png" alt="Connection Bend Points"></span></p> +<p><span class="image"><img src="./images/nifi-connection-bend-points.png" alt="Connection Bend Points"></span></p> </div> </div> </div> <div class="sect2"> -<h3 id="processor-validation"><a class="anchor" href="user-guide.html#processor-validation"></a>Processor Validation</h3> +<h3 id="processor-validation"><a class="anchor" href="#processor-validation"></a>Processor Validation</h3> <div class="paragraph"> <p>Before trying to start a Processor, it’s important to make sure that the Processor’s configuration is valid. A status indicator is shown in the top-left of the Processor. If the Processor is invalid, the indicator @@ -1787,7 +1842,7 @@ will show a red Warning indicator with a </div> <div class="imageblock"> <div class="content"> -<img src="images/invalid-processor.png" alt="Invalid Processor"> +<img src="./images/invalid-processor.png" alt="Invalid Processor"> </div> </div> <div class="paragraph"> @@ -1797,12 +1852,12 @@ to a Stop icon, indicating that the Proc </div> <div class="imageblock"> <div class="content"> -<img src="images/valid-processor.png" alt="Valid Processor"> +<img src="./images/valid-processor.png" alt="Valid Processor"> </div> </div> </div> <div class="sect2"> -<h3 id="site-to-site"><a class="anchor" href="user-guide.html#site-to-site"></a>Site-to-Site</h3> +<h3 id="site-to-site"><a class="anchor" href="#site-to-site"></a>Site-to-Site</h3> <div class="paragraph"> <p>When sending data from one instance of NiFi to another, there are many different protocols that can be used. The preferred protocol, though, is the NiFi Site-to-Site Protocol. Site-to-Site makes it easy to securely and efficiently transfer data to/from nodes in @@ -1928,11 +1983,11 @@ or deficiency is ever discovered in a pr </ul> </div> <div class="sect3"> -<h4 id="configure-site-to-site-client-nifi-instance"><a class="anchor" href="user-guide.html#configure-site-to-site-client-nifi-instance"></a>Configure Site-to-Site client NiFi instance</h4> +<h4 id="configure-site-to-site-client-nifi-instance"><a class="anchor" href="#configure-site-to-site-client-nifi-instance"></a>Configure Site-to-Site client NiFi instance</h4> <div id="Site-to-Site_Remote_Process_Group" class="paragraph"> -<p><strong>Remote Process Group</strong>: In order to communicate with a remote NiFi instance via Site-to-Site, simply drag a <a href="user-guide.html#remote_process_group">Remote Process Group</a> onto the canvas +<p><strong>Remote Process Group</strong>: In order to communicate with a remote NiFi instance via Site-to-Site, simply drag a <a href="#remote_process_group">Remote Process Group</a> onto the canvas and enter the URL of the remote NiFi instance (for more information on the components of a Remote Process Group, see -<a href="user-guide.html#Remote_Group_Transmission">Remote Process Group Transmission</a> section of this guide.) The URL is the same +<a href="#Remote_Group_Transmission">Remote Process Group Transmission</a> section of this guide.) The URL is the same URL you would use to go to that instance’s User Interface. At that point, you can drag a connection to or from the Remote Process Group in the same way you would drag a connection to or from a Processor or a local Process Group. When you drag the connection, you will have a chance to choose which Port to connect to. Note that it may take up to one minute for the Remote Process Group to determine @@ -1943,25 +1998,34 @@ which ports are available.</p> as this indicates that you will be pulling data from the remote instance. If the connection instead ends on the Remote Process Group, the ports shown will be the Input Ports of the remote group, as this implies that you will be pushing data to the remote instance.</p> </div> -<div class="paragraph"> -<p><strong>Note</strong>: if the remote instance is configured to use secure data transmission, you will see only ports that you are authorized to +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +If the remote instance is configured to use secure data transmission, you will see only ports that you are authorized to communicate with. For information on configuring NiFi to run securely, see the -<a href="administration-guide.html">System Administratorâs Guide</a>.</p> +<a href="administration-guide.html">System Administratorâs Guide</a>. +</td> +</tr> +</table> </div> <div id="Site-to-Site_Transport_Protocol" class="paragraph"> <p><strong>Transport Protocol</strong>: On a Remote Process Group creation or configuration dialog, you can choose Transport Protocol to use for Site-to-Site communication as shown in the following image:</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/configure-remote-process-group.png" alt="Configure Remote Process Group"></span></p> +<p><span class="image"><img src="./images/configure-remote-process-group.png" alt="Configure Remote Process Group"></span></p> </div> <div class="paragraph"> <p>By default, it is set to <em>RAW</em> which uses raw socket communication using a dedicated port. <em>HTTP</em> transport protocol is especially useful if the remote NiFi instance is in a restricted network that only allow access through HTTP(S) protocol or only accessible from a specific HTTP Proxy server. For accessing through a HTTP Proxy Server, BASIC and DIGEST authentication are supported.</p> </div> </div> <div class="sect3"> -<h4 id="configure-site-to-site-server-nifi-instance"><a class="anchor" href="user-guide.html#configure-site-to-site-server-nifi-instance"></a>Configure Site-to-Site server NiFi instance</h4> +<h4 id="configure-site-to-site-server-nifi-instance"><a class="anchor" href="#configure-site-to-site-server-nifi-instance"></a>Configure Site-to-Site server NiFi instance</h4> <div id="Site-to-Site_Input_Port" class="paragraph"> -<p><strong>Input Port</strong>: In order to allow another NiFi instance to push data to your local instance, you can simply drag an <a href="user-guide.html#input_port">Input Port</a> onto the Root Process Group +<p><strong>Input Port</strong>: In order to allow another NiFi instance to push data to your local instance, you can simply drag an <a href="#input_port">Input Port</a> onto the Root Process Group of your canvas. After entering a name for the port, it will be added to your flow. You can now right-click on the Input Port and choose Configure in order to adjust the name and the number of concurrent tasks that are used for the port. If Site-to-Site is configured to run securely, you will also be given the ability to adjust who has access to the port. If secure, only those who have been granted access to communicate with the port will be able to see @@ -1972,7 +2036,7 @@ that the port exists.</p> Process Group and choose to "Refresh" the flow.</p> </div> <div id="Site-to-Site_Output_Port" class="paragraph"> -<p><strong>Output Port</strong>: Similar to an Input Port, a DataFlow Manager may choose to add an <a href="user-guide.html#output_port">Output Port</a> to the Root Process Group. The Output Port allows an +<p><strong>Output Port</strong>: Similar to an Input Port, a DataFlow Manager may choose to add an <a href="#output_port">Output Port</a> to the Root Process Group. The Output Port allows an authorized NiFi instance to remotely connect to your instance and pull data from the Output Port. Configuring the Output Port will again allow the DFM to control how many concurrent tasks are allowed, as well as which NiFi instances are authorized to pull data from the instance being configured.</p> </div> @@ -1995,7 +2059,7 @@ section of the <a href="administration-g </div> </div> <div class="sect2"> -<h3 id="example-dataflow"><a class="anchor" href="user-guide.html#example-dataflow"></a>Example Dataflow</h3> +<h3 id="example-dataflow"><a class="anchor" href="#example-dataflow"></a>Example Dataflow</h3> <div class="paragraph"> <p>This section has described the steps required to build a dataflow. Now, to put it all together. The following example dataflow consists of just two processors: GenerateFlowFile and LogAttribute. These processors are normally used for testing, but they can also be used @@ -2027,7 +2091,7 @@ to build a quick flow for demonstration <p>On the Settings tab, under Auto-terminate relationships, select the checkbox next to Success. This will terminate FlowFiles after this processor has successfully processed them.</p> </li> <li> -<p>Also on the Settings tab, set the Bulletin level to Info. This way, when the dataflow is running, this processor will display the bulletin icon (see <a href="user-guide.html#processor_anatomy">Anatomy of a Processor</a>), and the user may hover over it with the mouse to see the attributes that the processor is logging.</p> +<p>Also on the Settings tab, set the Bulletin level to Info. This way, when the dataflow is running, this processor will display the bulletin icon (see <a href="#processor_anatomy">Anatomy of a Processor</a>), and the user may hover over it with the mouse to see the attributes that the processor is logging.</p> </li> </ul> </div> @@ -2039,17 +2103,17 @@ to build a quick flow for demonstration </div> <div class="imageblock"> <div class="content"> -<img src="images/simple-flow.png" alt="Simple Flow"> +<img src="./images/simple-flow.png" alt="Simple Flow"> </div> </div> <div class="paragraph"> -<p>Now see the following section on how to start and stop the dataflow. When the dataflow is running, be sure to note the statistical information that is displayed on the face of each processor (see <a href="user-guide.html#processor_anatomy">Anatomy of a Processor</a>).</p> +<p>Now see the following section on how to start and stop the dataflow. When the dataflow is running, be sure to note the statistical information that is displayed on the face of each processor (see <a href="#processor_anatomy">Anatomy of a Processor</a>).</p> </div> </div> </div> </div> <div class="sect1"> -<h2 id="command-and-control-of-the-dataflow"><a class="anchor" href="user-guide.html#command-and-control-of-the-dataflow"></a>Command and Control of the DataFlow</h2> +<h2 id="command-and-control-of-the-dataflow"><a class="anchor" href="#command-and-control-of-the-dataflow"></a>Command and Control of the DataFlow</h2> <div class="sectionbody"> <div class="paragraph"> <p>When a component is added to the NiFi canvas, it is in the Stopped state. In order to cause the component to @@ -2057,7 +2121,7 @@ be triggered, the component must be star Stopped state, the component can be configured, started, or disabled.</p> </div> <div class="sect2"> -<h3 id="starting-a-component"><a class="anchor" href="user-guide.html#starting-a-component"></a>Starting a Component</h3> +<h3 id="starting-a-component"><a class="anchor" href="#starting-a-component"></a>Starting a Component</h3> <div class="paragraph"> <p>In order to start a component, the following conditions must be met:</p> </div> @@ -2077,13 +2141,13 @@ Stopped state, the component can be conf </li> <li> <p>The component must have no active tasks. For more information about active tasks, see the “Anatomy of …​” -sections under <a href="user-guide.html#monitoring">Monitoring of DataFlow</a> (<a href="user-guide.html#processor_anatomy">Anatomy of a Processor</a>, <a href="user-guide.html#process_group_anatomy">Anatomy of a Process Group</a>, <a href="user-guide.html#remote_group_anatomy">Anatomy of a Remote Process Group</a>).</p> +sections under <a href="#monitoring">Monitoring of DataFlow</a> (<a href="#processor_anatomy">Anatomy of a Processor</a>, <a href="#process_group_anatomy">Anatomy of a Process Group</a>, <a href="#remote_group_anatomy">Anatomy of a Remote Process Group</a>).</p> </li> </ul> </div> <div class="paragraph"> <p>Components can be started by selecting all of the components to start and then clicking the Start icon ( -<span class="image"><img src="images/iconRun.png" alt="Start"></span> +<span class="image"><img src="./images/iconRun.png" alt="Start"></span> ) in the Actions Toolbar or by right-clicking a single component and choosing Start from the context menu.</p> </div> @@ -2093,16 +2157,16 @@ be started, with the exception of those </div> <div class="paragraph"> <p>Once started, the status indicator of a Processor will change to a Play symbol ( -<span class="image"><img src="images/iconRun.png" alt="Run"></span> +<span class="image"><img src="./images/iconRun.png" alt="Run"></span> ).</p> </div> </div> <div class="sect2"> -<h3 id="stopping-a-component"><a class="anchor" href="user-guide.html#stopping-a-component"></a>Stopping a Component</h3> +<h3 id="stopping-a-component"><a class="anchor" href="#stopping-a-component"></a>Stopping a Component</h3> <div class="paragraph"> <p>A component can be stopped any time that it is running. A component is stopped by right-clicking on the component and clicking Stop from the context menu, or by selecting the component and clicking the Stop icon ( -<span class="image"><img src="images/iconStop.png" alt="Stop"></span> +<span class="image"><img src="./images/iconStop.png" alt="Stop"></span> ) in the Actions Toolbar.</p> </div> <div class="paragraph"> @@ -2111,17 +2175,17 @@ will be stopped.</p> </div> <div class="paragraph"> <p>Once stopped, the status indicator of a component will change to the Stop symbol ( -<span class="image"><img src="images/iconStop.png" alt="Stop"></span> +<span class="image"><img src="./images/iconStop.png" alt="Stop"></span> ).</p> </div> <div class="paragraph"> <p>Stopping a component does not interrupt its currently running tasks. Rather, it stops scheduling new tasks to -be performed. The number of active tasks is shown in the top-right corner of the Processor (see <a href="user-guide.html#processor_anatomy">Anatomy of a Processor</a> +be performed. The number of active tasks is shown in the top-right corner of the Processor (see <a href="#processor_anatomy">Anatomy of a Processor</a> for more information).</p> </div> </div> <div class="sect2"> -<h3 id="enabling-disabling-a-component"><a class="anchor" href="user-guide.html#enabling-disabling-a-component"></a>Enabling/Disabling a Component</h3> +<h3 id="enabling-disabling-a-component"><a class="anchor" href="#enabling-disabling-a-component"></a>Enabling/Disabling a Component</h3> <div class="paragraph"> <p>When a component is enabled, it is able to be started. Users may choose to disable components when they are part of a dataflow that is still being assembled, for example. Typically, if a component is not intended to be run, the component @@ -2132,21 +2196,21 @@ configuration) and inadvertently were ne <div class="paragraph"> <p>When it is desirable to re-enable a component, it can be enabled by selecting the component and clicking the Enable icon ( -<span class="image"><img src="images/iconEnable.png" alt="Enable"></span> +<span class="image"><img src="./images/iconEnable.png" alt="Enable"></span> ) in the Actions Toolbar. This is available only when the selected component or components are disabled. Alternatively, a component can be enabled by checking the checkbox next to the “Enabled” option in the Settings tab of the Processor configuration dialog or the configuration dialog for a Port.</p> </div> <div class="paragraph"> <p>Once enabled, the component’s status indicator will change to either Invalid ( -<span class="image"><img src="images/iconAlert.png" alt="Invalid"></span> +<span class="image"><img src="./images/iconAlert.png" alt="Invalid"></span> ) or Stopped ( -<span class="image"><img src="images/iconStop.png" alt="Stopped"></span> +<span class="image"><img src="./images/iconStop.png" alt="Stopped"></span> ), depending on whether or not the component is valid.</p> </div> <div class="paragraph"> <p>A component is then disabled by selecting the component and clicking the Disable icon ( -<span class="image"><img src="images/iconDisable.png" alt="Disable"></span> +<span class="image"><img src="./images/iconDisable.png" alt="Disable"></span> ) in the Actions Toolbar, or by clearing the checkbox next to the “Enabled” option in the Settings tab of the Processor configuration dialog or the configuration dialog for a Port.</p> </div> @@ -2155,26 +2219,26 @@ of the Processor configuration dialog or </div> </div> <div class="sect2"> -<h3 id="Remote_Group_Transmission"><a class="anchor" href="user-guide.html#Remote_Group_Transmission"></a>Remote Process Group Transmission</h3> +<h3 id="Remote_Group_Transmission"><a class="anchor" href="#Remote_Group_Transmission"></a>Remote Process Group Transmission</h3> <div class="paragraph"> <p>Remote Process Groups provide a mechanism for sending data to or retrieving data from a remote instance of NiFi. When a Remote Process Group (RPG) is added to the canvas, it is added with the Transmission Disabled, as indicated by the icon ( -<span class="image"><img src="images/iconTransmissionInactive.png" alt="Transmission Disabled"></span> +<span class="image"><img src="./images/iconTransmissionInactive.png" alt="Transmission Disabled"></span> ) in the top-left corner. When Transmission is Disabled, it can be enabled by right-clicking on the RPG and clicking the “Enable Transmission” menu item. This will cause all ports for which there is a Connection to begin transmitting data. This will cause the status indicator to then change to the Transmission Enabled icon ( -<span class="image"><img src="images/iconTransmissionActive.png" alt="Transmission Enabled"></span> +<span class="image"><img src="./images/iconTransmissionActive.png" alt="Transmission Enabled"></span> ).</p> </div> <div class="paragraph"> <p>If there are problems communicating with the Remote Process Group, a Warning indicator ( -<span class="image"><img src="images/iconAlert.png" alt="Warning"></span> +<span class="image"><img src="./images/iconAlert.png" alt="Warning"></span> ) may instead be present in the top-left corner. Hovering over this Warning indicator with the mouse will provide more information about the problem.</p> </div> <div class="sect3"> -<h4 id="Remote_Port_Configuration"><a class="anchor" href="user-guide.html#Remote_Port_Configuration"></a>Individual Port Transmission</h4> +<h4 id="Remote_Port_Configuration"><a class="anchor" href="#Remote_Port_Configuration"></a>Individual Port Transmission</h4> <div class="paragraph"> <p>There are times when the DFM may want to either enable or disable transmission for only a specific Port within the Remote Process Group. This can be accomplished by right-clicking on the Remote Process Group @@ -2183,7 +2247,7 @@ configured:</p> </div> <div class="imageblock"> <div class="content"> -<img src="images/remote-group-ports-dialog.png" alt="Remote Process Groups"> +<img src="./images/remote-group-ports-dialog.png" alt="Remote Process Groups"> </div> </div> <div class="paragraph"> @@ -2193,12 +2257,21 @@ If the remote instance is using secure c rather than <code>http://</code>), any Ports that the remote instance has not made available to this instance will not be shown.</p> </div> -<div class="paragraph"> -<p><strong>Note</strong>: If a Port that is expected to be shown is not shown in this dialog, ensure that the instance has proper +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +If a Port that is expected to be shown is not shown in this dialog, ensure that the instance has proper permissions and that the Remote Process Group’s flow is current. This can be checked by closing the Port Configuration Dialog and looking at the bottom-right corner of the Remote Process Group. The date at which the flow was last refreshed is shown. If the flow appears to be outdated, it can be updated by right-clicking -on the Remote Process Group and selecting “Refresh flow.” (See <a href="user-guide.html#remote_group_anatomy">Anatomy of a Remote Process Group</a> for more information).</p> +on the Remote Process Group and selecting “Refresh flow.” (See <a href="#remote_group_anatomy">Anatomy of a Remote Process Group</a> for more information). +</td> +</tr> +</table> </div> <div class="paragraph"> <p>Each Port is shown with the Port name, followed by its description, currently configured number of Concurrent @@ -2207,14 +2280,14 @@ to turn the Port on or off. Those Ports </div> <div class="imageblock"> <div class="content"> -<img src="images/remote-port-connection-status.png" alt="Remote Port Statuses"> +<img src="./images/remote-port-connection-status.png" alt="Remote Port Statuses"> </div> </div> <div class="paragraph"> <p>The on/off switch provides a mechanism to enable and disable transmission for each Port in the Remote Process Group independently. Those Ports that are connected but are not currently transmitting can be configured by clicking the pencil icon ( -<span class="image"><img src="images/iconEdit.png" alt="Edit"></span> +<span class="image"><img src="./images/iconEdit.png" alt="Edit"></span> ) below the on/off switch. Clicking this icon will allow the DFM to change the number of Concurrent tasks and whether or not compression should be used when transmitting data to or from this Port.</p> </div> @@ -2223,21 +2296,21 @@ or not compression should be used when t </div> </div> <div class="sect1"> -<h2 id="navigating"><a class="anchor" href="user-guide.html#navigating"></a>Navigating within a DataFlow</h2> +<h2 id="navigating"><a class="anchor" href="#navigating"></a>Navigating within a DataFlow</h2> <div class="sectionbody"> <div class="paragraph"> -<p>NiFi provides various mechanisms for getting around a dataflow. The <a href="user-guide.html#User_Interface">NiFi User Interface</a> section discussed various ways to navigate around -the NiFi canvas; however, once a flow exists on the canvas, there are additional ways to get from one component to another. The <a href="user-guide.html#User Interface">[User Interface]</a> section showed that when multiple Process Groups exist in a flow, breadcrumbs appear under the toolbar, providing a way to navigate between them. In addition, to enter a Process Group that is currently visible on the canvas, simply double-click it, thereby "drilling down" into it. Connections also provide a way to jump from one location to another within the flow. Right-click on a connection and select "Go to source" or "Go to destination" in order to jump to one end of the connection or another. This can be very useful in large, complex dataflows, where the connection lines may be long and span large areas of the canvas. Finally, all components provide the ability to jump forward or backward within the flow. Right-click any component (e.g., a processor, process group, port, etc.) and select eith er "Upstream connections" or "Downstream connections". A dialog window will open, showing the available upstream or downstream connections that the user may jump to. This can be especially useful when trying to follow a dataflow in a backward direction. It is typically easy to follow the path of a dataflow from start to finish, drilling down into nested process groups; however, it can be more difficult to follow the dataflow in the other direction.</p> +<p>NiFi provides various mechanisms for getting around a dataflow. The <a href="#User_Interface">NiFi User Interface</a> section discussed various ways to navigate around +the NiFi canvas; however, once a flow exists on the canvas, there are additional ways to get from one component to another. The <a href="#User Interface">[User Interface]</a> section showed that when multiple Process Groups exist in a flow, breadcrumbs appear under the toolbar, providing a way to navigate between them. In addition, to enter a Process Group that is currently visible on the canvas, simply double-click it, thereby "drilling down" into it. Connections also provide a way to jump from one location to another within the flow. Right-click on a connection and select "Go to source" or "Go to destination" in order to jump to one end of the connection or another. This can be very useful in large, complex dataflows, where the connection lines may be long and span large areas of the canvas. Finally, all components provide the ability to jump forward or backward within the flow. Right-click any component (e.g., a processor, process group, port, etc.) and select either "Upstream co nnections" or "Downstream connections". A dialog window will open, showing the available upstream or downstream connections that the user may jump to. This can be especially useful when trying to follow a dataflow in a backward direction. It is typically easy to follow the path of a dataflow from start to finish, drilling down into nested process groups; however, it can be more difficult to follow the dataflow in the other direction.</p> </div> </div> </div> <div class="sect1"> -<h2 id="monitoring"><a class="anchor" href="user-guide.html#monitoring"></a>Monitoring of DataFlow</h2> +<h2 id="monitoring"><a class="anchor" href="#monitoring"></a>Monitoring of DataFlow</h2> <div class="sectionbody"> <div class="paragraph"> <p>NiFi provides a great deal of information about the status of the DataFlow in order to monitor the health and status. The Status bar provides information about the overall system health -(See <a href="user-guide.html#status_bar">[status_bar]</a> above for more information). Processors, Process Groups, and Remote Process Groups +(See <a href="#status_bar">[status_bar]</a> above for more information). Processors, Process Groups, and Remote Process Groups provide fine-grained details about their operations. Connections and Process Groups provide information about the amount of data in their queues. The Summary Page provides information about all of the components on the canvas in a tabular format and also provides System Diagnostics information that includes disk usage, @@ -2246,13 +2319,13 @@ information is available per-node or as monitoring artifacts below.</p> </div> <div class="sect2"> -<h3 id="processor_anatomy"><a class="anchor" href="user-guide.html#processor_anatomy"></a>Anatomy of a Processor</h3> +<h3 id="processor_anatomy"><a class="anchor" href="#processor_anatomy"></a>Anatomy of a Processor</h3> <div class="paragraph"> <p>NiFi provides a significant amount of information about each Processor on the canvas. The following diagram shows the anatomy of a Processor:</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/processor-anatomy.png" alt="Anatomy of a Processor"></span></p> +<p><span class="image"><img src="./images/processor-anatomy.png" alt="Anatomy of a Processor"></span></p> </div> <div class="paragraph"> <p>The image outlines the following elements:</p> @@ -2280,20 +2353,20 @@ it will also show the Node that emitted <div class="ulist"> <ul> <li> -<p><span class="image"><img src="images/iconRun.png" alt="Running"></span> +<p><span class="image"><img src="./images/iconRun.png" alt="Running"></span> <strong>Running</strong>: The Processor is currently running.</p> </li> <li> -<p><span class="image"><img src="images/iconStop.png" alt="Stopped"></span> +<p><span class="image"><img src="./images/iconStop.png" alt="Stopped"></span> <strong>Stopped</strong>: The Processor is valid and enabled but is not running.</p> </li> <li> -<p><span class="image"><img src="images/iconAlert.png" alt="Invalid"></span> +<p><span class="image"><img src="./images/iconAlert.png" alt="Invalid"></span> <strong>Invalid</strong>: The Processor is enabled but is not currently valid and cannot be started. Hovering over this icon will provide a tooltip indicating why the Processor is not valid.</p> </li> <li> -<p><span class="image"><img src="images/iconDisable.png" alt="Disabled"></span> +<p><span class="image"><img src="./images/iconDisable.png" alt="Disabled"></span> <strong>Disabled</strong>: The Processor is not running and cannot be started until it has been enabled. This status does not indicate whether or not the Processor is valid.</p> </li> @@ -2361,7 +2434,7 @@ time it would have taken to perform the </div> </div> <div class="sect2"> -<h3 id="process_group_anatomy"><a class="anchor" href="user-guide.html#process_group_anatomy"></a>Anatomy of a Process Group</h3> +<h3 id="process_group_anatomy"><a class="anchor" href="#process_group_anatomy"></a>Anatomy of a Process Group</h3> <div class="paragraph"> <p>The Process Group provides a mechanism for grouping components together into a logical construct in order to organize the DataFlow in a way that makes it more understandable from a higher level. @@ -2369,7 +2442,7 @@ The following image highlights the diffe </div> <div class="imageblock"> <div class="content"> -<img src="images/process-group-anatomy.png" alt="Anatomy of a Process Group"> +<img src="./images/process-group-anatomy.png" alt="Anatomy of a Process Group"> </div> </div> <div class="paragraph">
[... 480 lines stripped ...]
