Stream Editor

You build a stream in the Stream Editor, which consists of a canvas, a function library (in the panel on the left), and a toolbar along the top of the canvas. There are also two elements above the toolbar to the right. The notification icon indicates if there are any errors in your function configurations while you are building your stream. Click Start when you have completed a stream and want to run it.

To navigate back to the Streams view, click the arrow next to the stream name.

For information on the Functions library, see Functions.

Stream Editor showing the canvas, Function library, and the toolbar

How to Build a Stream

Each stream must include a collector and a forwarder Function. Your stream will consist of the functions you require to process your data. You will link these functions according to how the data should flow in the stream.

Select a function that you require from the library and drag and drop it onto the canvas of the stream editor. After configuring each function, you must link it to the next one in your stream.

For more information on creating streams, see My First Stream.

Keyboard Shortcuts

Once you have configured functions in one or more streams, it can be convenient to re-use them. For this purpose some keyboard shortcuts are available.

You click on a function to select it and shift-click to select several functions. The functions don’t need to be adjacent when selecting multiple.

Note!

When copying multiple functions, the connecting lines between them are not included.

The following keyboard shortcuts are available:

Action	Shortcut

Action	Shortcut
Copy	Ctrl/command+C
Paste	Ctrl/command+V
Cut	Ctrl/command+X
Undo	Ctrl/command+Z
Delete	Delete/Backspace arrow

Note!

The Ctrl and Command key shortcuts apply to different operating systems. Use the Ctrl key for Windows OS and the command key for Mac OS.

Stream Toolbar

The toolbar includes several items to assist you in building a stream.

Item	Description

Item	Description
Export	Use Export to export a stream, for example, to a different solution. When you click Export, a dialog appears with the code for the stream you have created. Click Copy to Clipboard. You can then navigate to the solution that you want to add the stream to and insert it by clicking Import Stream. In the dialog that appears, paste the code for the stream and click Import. You can also download the stream in JSON format using the Download option.
Audit	Use Audit to view the flow of information for the stream.
Logs	Use Logs to view the events during the stream execution.
Undo	Use Undo to undo your last action.
Redo	Use Redo to redo the action that you have undone.
Layout	Use Layout to re-arrange and straighten out a stream layout. Before pressing Layout: After pressing Layout:
Zoom	Zooming to increase or decrease the size of the Function icons on the canvas can be done in three ways: Using the zoom slider Clicking on the + or - Pinch using a trackpad

Notifications

As you add Functions to a stream and configure each one, the stream will be validated. If there is a configuration error in one of the Functions or the stream itself, a red indicator on the notification icon is displayed, showing the number of errors in your stream.

Click the notification icon to display the list of errors. The list will show which function(s) contain error(s). Click Configure to open the respective Function configuration. Here you can investigate the issue and correct it. When you have corrected the error, it is removed from the error list.

You cannot run a stream until you have corrected all of the errors listed.

Validation

A Stream is considered invalid if:

it does not have a collector
it does not begin with a collector
it does not contain processors
it contains a processor with one or more unlinked outputs.
it does not end with a forwarder
it is cyclic
there are multiple streams in a single stream configuration (multiple collectors connected to different processors and different forwarders)

Note!

All outputs of a function need to be connected to another function. If the data for an unlinked function is not needed, then the ‘no operation’ function can be used to close the link.

Starting a Stream

When you have created a complete stream with no errors, click Start to run it. The Start button is disabled while you are building a stream, or if there are errors in your stream.

When the stream starts to run, the Start button becomes a Stop button. You can stop a running stream at any time. When a stream has completed running the Start button is re-enabled.

Stream Status

In the upper right part of the stream editor, a status field shows the status of the stream once it has been run.

The status shown is one of the following:

Status	Description

Status	Description
Pending	The stream is preparing to run
Running	The stream is running
Complete	The stream run has ended successfully
Failed	The stream run was terminated due to a problem

Stopping a Stream

You can stop a stream from the Stream Editor or in the Streams view. For further information, see https://infozone.atlassian.net/wiki/x/eOF3.