NiFi Server UI overview

Connect to NiFi Server

After installing the NiFi service, enter the address of the host, on which the NiFi Server component is installed, in the address bar of the browser. As the port number, specify the value of the Nifi UI port parameter from the Main section, defined at the configure stage of the NiFi service when installing the ADS cluster.

Another way to connect to the NiFi Server interface is to follow one of the links indicated on the Info tab of the NiFi service menu.

Go to NiFi Server interface
Go to NiFi Server interface

The NiFi user interface provides mechanisms for creating automated data flows, as well as visualizing, editing, monitoring, and administering these data flows.

Below is an overview of the NiFi UI elements.

Main window

This is the window that the user sees after logging into the NiFi user interface. By default, login to the NiFi Server user interface is available without authentication.

NiFi UI main window
NiFi UI main window
NiFi UI main window
NiFi UI main window

Initially, the NiFi user interface is presented as a blank canvas on which you can create your data flows.

Toolbar

The toolbar is located at the top left of the screen. To create data flows, tool icons can be transferred to the canvas.

Component toolbar
Component toolbar
Component toolbar
Component toolbar

The toolbar contains the following elements (icons):

  • nifi ui proc dark nifi ui proc light — Processor. Responsible for data entry and exit, routing, and manipulation. There are many different types of processors.

  • nifi ui input dark nifi ui input light — Input Port. Provide a mechanism for passing data to a process group.

  • nifi ui output dark nifi ui output light — Output Port. Provides a mechanism for passing data from a process group to destinations outside the process group.

  • nifi ui prgr dark nifi ui prgr light — Process group. Used to logically group a set of components to make the flow of data easier to understand and maintain.

  • nifi ui rmprgr dark nifi ui rmprgr light — Remote Process Group. Used similarly to process groups. However, the remote process group refers to the remote NiFi instance.

  • nifi ui funnel dark nifi ui funnel light — Funnel. Used to combine data from many connections into one connection.

  • nifi ui templ dark nifi ui templ light — Template. Can be created from sections of a flow or imported from other data flows. These templates provide larger building blocks to quickly create a complex flow.

  • nifi ui label dark nifi ui label light — Label. Used to attach records to parts of a data flow.

Status bar

The status bar is below the component toolbar.

Status bar
Status bar

The status bar contains elements (icons) for each parameter and the numerical value of the parameter for this canvas. The status bar displays the following options:

  • Total component counters:

    • nifi ui sost 01 — the number of nodes in the cluster and the number of nodes currently connected;

    • nifi ui sost 02 — the number of threads currently active;

    • nifi ui sost 03 — the amount of data that currently exists in the stream;

    • nifi ui sost 04 1 — the number of remote process groups sending data;

    • nifi ui sost 04 2 — the number of remote process groups not sending data;

    • nifi ui sost 05 1 — the number of active processors;

    • nifi ui sost 05 2 — the number of processors stopped;

    • nifi ui sost 05 3 — the number of invalid processors;

    • nifi ui sost 05 4 — the number of disabled processors.

  • Counters of versioned states of components:

    • nifi ui sost 06 1 — the number of updated process groups;

    • nifi ui sost 06 2 — the number of locally modified process groups;

    • nifi ui sost 06 3 — the number of stale process groups;

    • nifi ui sost 06 4 — the number of locally modified and obsolete process groups;

    • nifi ui sost 06 5 — the number of process groups with synchronization error.

    NOTE

    For more information about versioning in the Apache NiFi user interface, see Versioning a DataFlow.

  • nifi ui sost 07 — the timestamp of last update of all information.

Action palette

The action palette is located on the left side of the screen. The palette consists of icons that are used to control the flow, as well as to control user access and set system properties.

Action palette
Action palette

To work with a flow, you need to click on the desired flow, then the name and designation of the flow are displayed on the operations palette. This thread is available for management.

The action palette contains the following elements (icons):

  • nifi ui oper 01 — view and change the configuration of the created flow;

  • nifi ui oper 02 — enable the flow (commission in the schema);

  • nifi ui oper 03 — disable the thread (out of action in the schema);

  • nifi ui oper 04 — start the flow;

  • nifi ui oper 05 — stop the flow;

  • nifi ui oper 06 — create a template;

  • nifi ui oper 07 — load the created template;

  • nifi ui oper 08 — copy the flow;

  • nifi ui oper 09 — paste the flow (where allowed);

  • nifi ui oper 10 — create a processor group (where allowed);

  • nifi ui oper 11 — change the color of the flow symbol, used to visually highlight different flows;

  • nifi ui oper 12 — delete the flow.

The navigation palette is used to move around the canvas and to zoom in and out.

Navigation palette
Navigation palette

On the right side of the canvas is the search and the global menu.

Search and global menu
Search and global menu

The search bar allows you to:

  • find components by name, type, identifier, configuration properties and their values;

  • refine and narrow your search results based on certain conditions using filters and keywords.

After clicking on the search icon, a line opens to record the search parameter.

Search
Search
Search
Search

Global menu

The global menu contains options that allow you to control existing components on the canvas.

Global menu
Global menu
Global menu
Global menu

The global menu includes the following tabs:

  • Summary — provides a summary of all configured data flows and their elements.

    Summary of all dataflow elements
    Summary of all dataflow elements
    Summary of all dataflow elements
    Summary of all dataflow elements
  • Counters — event counters used for monitoring purposes.

    Counters
    Counters
    Counters
    Counters
  • Bulletin Board — bulletins of events that have occurred. Filtering based on component, message, etc. is available.

    Bulletins of past events
    Bulletins of past events
    Bulletins of past events
    Bulletins of past events
  • Data Provenance — detailed information for each piece of data that NiFi accepts.

    Data Provenance
    Data Provenance
    Data Provenance
    Data Provenance
  • Controller Settings — allows users to view/modify the controller, including management controller services, reporting tasks, registry clients, settings providers, and nodes in the cluster.

    Controller configuration
    Controller configuration
    Controller configuration
    Controller configuration
  • Parameter Contexts — shows parameter contexts globally defined for a NiFi instance.

    Parameter contexts
    Parameter contexts
    Parameter contexts
    Parameter contexts
  • Cluster — shows cluster parameters.

    Cluster settings
    Cluster settings
    Cluster settings
    Cluster settings
  • Flow configuration history — shows the history of configuration changes for all flows.

    Config change history for all threads
    Config change history for all threads
    Config change history for all threads
    Config change history for all threads
  • Nodes Status History — shows the status history of all cluster nodes.

    Status history of all cluster nodes
    Status history of all cluster nodes
    Status history of all cluster nodes
    Status history of all cluster nodes
  • Templates — shows created templates.

    Created NiFi flow templates
    Created NiFi flow templates
    Created NiFi flow templates
    Created NiFi flow templates
  • Help — opens the NiFi documentation.

    Apache NiFi documentation
    Apache NiFi documentation
    Apache NiFi documentation
    Apache NiFi documentation
  • About — shows brief information about Apache NiFi.

    Apache NiFi brief description
    Apache NiFi brief description
    Apache NiFi brief description
    Apache NiFi brief description
NOTE

For more information about the Apache NiFi user interface, please refer to NiFi User Interface.

Found a mistake? Seleсt text and press Ctrl+Enter to report it