Manage Processors and Analytics Flows

4min

You can manage Analytics processors and flows on the Analytics canvas by navigating to Analytics > Instances. 
Analytics Canvas Management Options
Refer to the management options below on the Analytics canvas. 
Analytics canvas management options
﻿
Action
Details
[1] Search for processor instance
Use the drop-down list to highlight selected processors on the canvas. Click X in the Search for processor instance field to clear the search. 
[2] Canvas menu
Opens canvas menu options. 
﻿Add Processors and Processor Connections﻿ 
Add flow: See Create Flow Groups﻿. 
Paste flow: After you copy a flow, this option becomes available. 
Clear group: Deletes all flows, processors, and the flow group. 
Remove all processors: Deletes all flows and processors in the flow group. 
[3] Show debug window
Displays the debug panel. Click the View processor output icon for an input or function processor to view its output. The debug panel cannot display output from output processors. These processors are used to publish data to a tag, database, or StdOut immediately upon receipt. Once published, the data is no longer available for display in the UI.
[4] Import/Export menu
You can import analytics flows as JSON files and export flows. When exporting flows, you have the option of selecting individual flow groups or all groups. 
[5] Save
Saves the flow group. 
[6] Refresh
Refreshes all analytics flows in the selected group. It provides a quicker version of your browser refresh function. 
[7] Re-arrange processors
Adjust the layout and position of processors on canvas.
[8] Canvas zoom in and out
Change the zoom level for better visibility of flows.
[9] Canvas view
You have two canvas view options. 
Standard: Allows you to view each processor in the flow at full size.
Compact: Collapses the processors in the view. Icons for each processor appear in green, yellow, or red to indicate the status. You can hover over processor to access functionality.
Processor and Flow Management Options
Refer to the management options below for processors and flows. 
Management options for processors and flows
﻿
Action
Details
[1] Status Icon
Hover over to view status and ID of processor. 
[2] Enable/disable processor
Activates or deactivates the selected processor's functionality.
[3] View processor output
To view output, you must first display the debug window. The debug panel cannot display output from output processors. These processors are used to publish data to a tag, database, or StdOut immediately upon receipt. Once published, the data is no longer available for display in the UI.
[4] Processor menu
The options available depend on the specific processor. 
Toggle passthrough: Normally, a function processor passes to the output processor only the result of the function while dropping the data it had received from the input processor (such as Device ID and Timestamp). When you enable Toggle passthrough, this passes through the input data, along with the function result. 
Copy topic: You can copy the output topic from an output processor. Use the copied topic to view messages in the Flows Manager module by adding it to the DataHub Subscribe or Access Subscribe node.
Edit: Update the details for the processor. 
Copy Flow: After you copy a flow, you can paste it from the canvas menu. 
Remove processor
Remove flow
Invoke processor: Allows you to schedule a Database Batch processor to start and stop providing input at a specified date and time. 
Reset processor
Instance Identifier: Allows you to copy the Instance ID and Flow IDs. 
[5] Removing a release cannot be undone
Click a connection between two processers to edit the connection name or click Break Link to remove the linkage. 
View the Canvas Legend 
You can open the canvas legend to display color-coded information about processor and connection types that can be included in an analytics flow.  
Open canvas legend drawer
﻿
﻿

Action	Details
[1] Search for processor instance	Use the drop-down list to highlight selected processors on the canvas. Click X in the Search for processor instance field to clear the search.
[2] Canvas menu	Opens canvas menu options. Add Processors and Processor Connections Add flow: See Create Flow Groups. Paste flow: After you copy a flow, this option becomes available. Clear group: Deletes all flows, processors, and the flow group. Remove all processors: Deletes all flows and processors in the flow group.
[3] Show debug window	Displays the debug panel. Click the View processor output icon for an input or function processor to view its output. The debug panel cannot display output from output processors. These processors are used to publish data to a tag, database, or StdOut immediately upon receipt. Once published, the data is no longer available for display in the UI.
[4] Import/Export menu	You can import analytics flows as JSON files and export flows. When exporting flows, you have the option of selecting individual flow groups or all groups.
[5] Save	Saves the flow group.
[6] Refresh	Refreshes all analytics flows in the selected group. It provides a quicker version of your browser refresh function.
[7] Re-arrange processors	Adjust the layout and position of processors on canvas.
[8] Canvas zoom in and out	Change the zoom level for better visibility of flows.
[9] Canvas view	You have two canvas view options. Standard: Allows you to view each processor in the flow at full size. Compact: Collapses the processors in the view. Icons for each processor appear in green, yellow, or red to indicate the status. You can hover over processor to access functionality.

Action	Details
[1] Status Icon	Hover over to view status and ID of processor.
[2] Enable/disable processor	Activates or deactivates the selected processor's functionality.
[3] View processor output	To view output, you must first display the debug window. The debug panel cannot display output from output processors. These processors are used to publish data to a tag, database, or StdOut immediately upon receipt. Once published, the data is no longer available for display in the UI.
[4] Processor menu	The options available depend on the specific processor. Toggle passthrough: Normally, a function processor passes to the output processor only the result of the function while dropping the data it had received from the input processor (such as Device ID and Timestamp). When you enable Toggle passthrough, this passes through the input data, along with the function result. Copy topic: You can copy the output topic from an output processor. Use the copied topic to view messages in the Flows Manager module by adding it to the DataHub Subscribe or Access Subscribe node. Edit: Update the details for the processor. Copy Flow: After you copy a flow, you can paste it from the canvas menu. Remove processor Remove flow Invoke processor: Allows you to schedule a Database Batch processor to start and stop providing input at a specified date and time. Reset processor Instance Identifier: Allows you to copy the Instance ID and Flow IDs.
[5] Removing a release cannot be undone	Click a connection between two processers to edit the connection name or click Break Link to remove the linkage.

Updated 03 Jan 2025

Add Processors and Processor Connections

Analytics Flow Groups