Stream Editor
You build a stream in the Stream Editor, which consists of a canvas, a Function library presented in a panel to the left, and a toolbar to aid you. In addition, there are 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. You 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.
How to Build a Stream
Each stream must include a collector and a forwarder Function. Your stream consists of the Functions that you require to process your data, which you link according to how the data will 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. It is recommended that after configuring each Function, you link it to the next one in your stream.
For an introduction to how to create a stream, 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. When selecting multiple Functions, they do not need to be adjacent to each other.
Note!
When copying multiple functions, the connecting lines between them are not included.
The following keyboard shortcuts are available:
Action | Shortcut |
|---|---|
Copy | Ctrl/command+C |
Paste | Ctrl/command+V |
Cut | Ctrl/command+X |
Undo | Ctrl/command+Z |
Delete | Delete/Backspace arrow |
Note!
The usage of Ctrl or Command keys varies according to the operating system you use. For Windows OS users, the Ctrl key is used and for Mac OS users, the command key is applicable.
Stream Toolbar
The toolbar includes several items to assist you in building a stream.
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. |
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. After pressing Layout: |
Zoom | Zooming to increase or decrease the size of the Function icons on the canvas can be done in three ways:
|
Notifications
As you add Functions to a stream and configure each one if there is a configuration error in one of them, 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 displays in which Function(s) there is an error. Click Configure to open the respective Function configuration, where you can investigate what the issue is 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.
Starting a Stream
When you have created a complete stream, that does not have any errors, as described in the Notifications above, click Start to run the stream. While you are building a stream, or while there are still errors in your stream, the Start button is disabled.
When the stream started to run, the Start button becomes a Stop button. You can stop a running stream at any time. When a stream has been run to completion, the Start button is enabled once again.
Stream Status
In the upper right part of the stream editor, a status field shows the progress of the stream when it is run.
The status shown is one of the following:
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 Streams View.