The main landing page of Rule editor displays the following components:
- Header with Deploy and menu buttons
- Node palette on the left-hand side
- Main workspace on the center
- Sidebar on the right-hand side
The node palette contains default sets of nodes that are also known as core nodes. Nodes are the basic building blocks for creating flows on the workspace. Each node has a well-defined function and contains its own data.
Different Node Types
The nodes on the left-hand side are sorted into various categories, for example common, function etc. Use the drop-down arrow on the header to view different types of nodes under each category.
The most commonly used nodes are explained below:
The inject node is an output node indicated by the connection box on its right. Use the inject node to input data into the flow.
The debug node is an input node indicated by the connection box on its left. Use the debug node to display data, typically on the debug window in the sidebar.
The switch node allows to route an incoming message based on a condition. Use the switch node to filter and route incoming messages.
The change node allows to set, change and delete properties in a message.
The report by exception node, rbe for short, allows to block repeated messages. Use the rbe node to pass a message that is different from a previously received message.
When data is received in bursts or batches as arrays, the split node allows to process that burst of messages as one message at a time. The split node automatically splits an array into individual messages thus simplifying the logic of the data flow.
The activity feed node is an input node. The activity feed node provides a copy of the data that gets saved under Activities inside the Security Manager application.
The incident - in node is an input node. The incident - in node provides a copy of the incident data that are created under Incidents.
The incident - out node is an output node. The incident – out node updates attributes of the received incidents. Updates for the attributes title, description, category and priority are supported.
The text, gauge and chart nodes are samples of the many user interface nodes that are available under the dashboard category in the node palette. Using these nodes, you can build a user-facing dashboard where data gets displayed in a simple text or visualized in graphs and charts.
The link in node is used in conjunction with a link out node for receiving the data sent from its paired counterpart. You can pair one or many link in nodes with one link out node for creating virtual link or wiring.
The link out node is used to create a virtual link or wiring between nodes that can span across flows.
The auto refresh node prevents connection time out to the Customized portals. Use this node to display the Customized portals for an extended period without having the user to log-in every 10 minutes.
The groupby node groups the data displayed in the dashboard table based on the column header.
The advancedfilter node allows filtering of data loaded in the dashboard table.
The reportpdf node enables users to generate pdf reports for data displayed in the dashboard table.
You can create flows on the main workspace by dragging the nodes from the node palette and wiring them together. Use the buttons at the bottom to zoom in or out of the flow view or to reset to the default zoom level.
The sidebar contains panels with following tabs.
- Information : Provides information for the selected node in the main workspace.
- Help : Provides the functionality and usage of the node.
- Debug messages : Displays messages passed to debug nodes.
- Configuration Nodes : Displays configured nodes for all flows.
- Context Data : Provides stored information that can be shared between different nodes.
- Dashboard : Creates a live dashboard.
For more information on the Rule editor user interface refer to: https://nodered.org/docs/user-guide/editor/. Also, refer to the chapter Recommended Online Content for a summary of online video tutorials available for Node-RED.