Data Stream

A Data Stream is a visual representation of the flow of data. It enables you to integrate and connect to multiple different systems or Data Sources in order to view your data. This can include real-time data from machines, websites, or other streaming data, or contextual data such as the make or model of a certain item. 
The Data Stream Designer will allow you to see all of the connected data in one place and allow you to manipulate the data in different ways such as aggregating, filtering, displaying, or re-saving the data into another database. It will allow you to monitor the data to identify any critical events such as machine failures, without having to know how to code. 
The Data Stream's flow of data is depicted by the use of Agents that are connected by arrows, allowing data to flow from one agent to the next and be processed upon reaching each agent, according to the function of that particular agent. This allows you to view data from multiple data sources in one place, and complete certain actions on the data.
It is recommended that you read this documentation along with the article listed below to improve your understanding of data streams.
​Agent​
Finding Data Streams
The search bar can be used to find any specific Data Streams that you may be looking for. There is a dropdown option where you can specify to search through everything in Data Stream Designer, or only for Data Streams.
Data Stream Type
The Type selected in the Properties affects your choice of how often and when polling-based Agents run.
Streaming (Default): This allows you to specify a Polling Interval in seconds on polling-based Agents in the Stream Object configuration. Polling starts immediately and continues indefinitely.
Recurring: This allows you to specify granular options to schedule polling-based Agents in the Stream Object configuration. Options allow you to control the start time, repetition interval, and end time or number of repetitions. There is also the option to repeat indefinitely.
Buffer Size
An advanced option that allows the Data Stream to compensate for large event sizes, a high number of events, or increased stream complexity by allocating more memory to the Data Stream. The default buffer size is 128kb. 
The Canvas
Data streams are built in an interactive canvas environment that allows you to drag agents from the toolbox to a drawing area. Each agent’s user settings can then be configured in the same environment as where the stream was built. This page also allows for you to perform various tasks related to each data stream, including managing versions, defining business cases, etc. Stream Objects that are on the canvas can also be duplicated or deleted. 
The Toolbox
The toolbox is a component in the Data Stream Designer that allows you to choose an Agent from a library of Agents that have been uploaded to the system and drag the agent from the toolbox to the Canvas when building a stream. All agents in the toolbox will always be the latest version and will all be available for all users, regardless of their role, unless a user does not have permission to view any of the Agents.
Agents are grouped by category in the toolbox. To expand a category, click on the arrow next to the category name. Please note that if no agents in a particular category are uploaded, the entire category will be hidden. Thus, if you are missing some of the categories in the toolbox, it is likely that there aren’t any Agents uploaded belonging to that category. 
Building a stream
See the Manage Data Streams article for detailed instructions and an example of how to build your first stream.
Actions on the Data Stream
Action
Description
Save
Saves any changes made to the Data Stream up to this point.
Discard
Discards any changes made to the Data Stream up to this point.
Properties
Opens the properties for the Data Stream. Also allows you to Delete the Data Stream.
​Business Case​
Opens the Business Case for the Data Stream.
​Notes​
Opens the Notes, which allows you to add notes about the Application for collaboration and future-proofing.
​Versions​
Versioning for the Recommendation.
​Timeline​
Opens the Timeline, which shows a timeline of the history of the Data Stream.
​Manage Access​
Allows you to manage which users are allowed to view or modify this Data Stream.
​Integrity Check​
Verifies if the agents in your stream are configured correctly.
Logs
Allows you to check for log messages for the Stream Host being used to run the Data Stream.
Error Flow
Toggles between being able to view and configure the default error Agent for the Stream, which collects all the errors from all agents with an Error endpoint.
​Publish/Unpublish​
Publishes or unpublishes the Recommendation, which makes it start listening for data from the Data Stream.
Configure (Agent)
Opens the configuration page for the selected Stream Object.
Upgrade (Agent)
Upgrades the selected Stream Object to the latest Agent Version. Only available if the selected Stream Object's Agent is not the latest version.
Delete (Agent)
Deletes the selected Stream Object from the canvas and Data Stream.
Help (Agent)
Opens the help page for the selected Stream Object's Agent.
Delete
Deletes the Data Stream.
​Export​
Export the Data Stream as an encrypted file.
​Clone​
Clones the Data Stream as a new Data Stream.
Further Reading
​How to Create and Manage Data Streams​
​How to Manage Recurrent Data Streams​
​How to Troubleshoot a Data Stream​

General

Stream Object Configuration

Last modified 8mo ago

Action	Description
Save	Saves any changes made to the Data Stream up to this point.
Discard	Discards any changes made to the Data Stream up to this point.
Properties	Opens the properties for the Data Stream. Also allows you to Delete the Data Stream.
Business Case	Opens the Business Case for the Data Stream.
Notes	Opens the Notes, which allows you to add notes about the Application for collaboration and future-proofing.
Versions	Versioning for the Recommendation.
Timeline	Opens the Timeline, which shows a timeline of the history of the Data Stream.
Manage Access	Allows you to manage which users are allowed to view or modify this Data Stream.
Integrity Check	Verifies if the agents in your stream are configured correctly.
Logs	Allows you to check for log messages for the Stream Host being used to run the Data Stream.
Error Flow	Toggles between being able to view and configure the default error Agent for the Stream, which collects all the errors from all agents with an Error endpoint.
Publish/Unpublish	Publishes or unpublishes the Recommendation, which makes it start listening for data from the Data Stream.
Configure (Agent)	Opens the configuration page for the selected Stream Object.
Upgrade (Agent)	Upgrades the selected Stream Object to the latest Agent Version. Only available if the selected Stream Object's Agent is not the latest version.
Delete (Agent)	Deletes the selected Stream Object from the canvas and Data Stream.
Help (Agent)	Opens the help page for the selected Stream Object's Agent.
Delete	Deletes the Data Stream.
Export	Export the Data Stream as an encrypted file.
Clone	Clones the Data Stream as a new Data Stream.