IntegrationsInstallationAdministration
Contact Support

Manage Data Streams

A Data Stream is a visual representation of a flow of data, which is depicted by the use of Agents that are connected by arrows that allow data to flow from one Agent to the next. Data streams are built in an interactive canvas environment that allows you to drag Agents from the toolbox to a drawing area. These Agents allow you to complete certain actions on the data. This includes aggregating, filtering, displaying, or re-saving the data into another database.

It is recommended that you read the article listed below to improve your understanding of Data Streams.

Creating a Data Stream

To create a Data Stream, follow the steps below:

  1. Open the New Data Streams page from the left-hand menu.

  2. Give the Data Stream a name.

  3. Enter a description.

  4. Enter the type (streaming or recurring).

  5. Enter the category under which the Data Stream is found in the Data Stream list.

  6. Give the Data Stream an icon. Sample icons can be found in the Icon Library.

  7. Enter the Collection the Data Stream will have.

  8. Click Save.

Fig 1: Creating a Data Stream
Fig 2: A newly created Data Stream

Opening a Data Stream

Data Streams can be opened via the Data Streams Page on the left-hand menu, or via the main page that contains the list of Categories.

To open Data Streams from the left-hand menu:

  1. Open the Data Streams page from the left-hand menu.

  2. Select the Data Stream you want to open.

To open Data Streams from the list of categories:

  1. Click the Logo to open the landing page.

  2. Click the Category of the Data Stream.

Fig 4: Finding a Data Stream from the landing page of categories

3. Click the Data Stream you want to open.

Fig 5: Opening a Data Stream from a category

Adding an Agent to the Canvas

To add Agents to the canvas, drag and drop Agents from the left-hand toolbox to make up the data flow for your Data Stream. An Agent that has been added to the canvas is called a Stream Object. See the Agents article for more information on Agents.

  1. Enter part of the Agent name to filter the toolbox (or expand a category to view the list of Agents).

  2. Click and drag an agent onto the Canvas.

  3. Click the output endpoint and drag it to an input endpoint to connect two Stream Objects.

Fig 6: Adding an Agent to the Canvas
Fig 7: Connecting two Agents

Copying and Pasting Stream Objects

Stream Objects that are in the Data Stream can be copied and pasted using keyboard shortcuts. To copy a Stream object:

  1. Select a Stream Object to highlight it.

  2. To highlight multiple Stream Objects, hold the ctrl key while you are selecting them.

  3. Once the Stream Object(s) are highlighted in yellow, press and hold ctrl + C.

  4. To paste the Stream Object that was just copied, press and hold ctrl + P.

You can also copy a Stream Object from one Data Stream and paste it into a different Data Stream.

Fig 8: Copying a Stream Object

Deleting a Stream Object

To delete a Stream Object on the canvas, follow the steps below:

  1. Click a Stream Object to select it.

  2. Click Delete.

Fig 9: Deleting a Stream Object using the Delete Button

You can also delete Stream Objects that are on the Data Stream canvas by using the 'delete' keyboard shortcut.

  1. Select an Agent to highlight it.

  2. To highlight multiple Agents, hold the ctrl key while you are selecting them.

  3. Once the Stream Object/s are highlighted in yellow, click on the delete key on the keyboard.

Fig 10: Deleting a Stream Object using the keyboard

Deleting a Data Stream

To delete a Data Stream, follow the steps below:

  1. Click Properties.

  2. Click Delete.

Fig 11: Deleting a Data Stream

Sharing Access to a Data Stream

Data Streams can be shared between users with differing permisson. See the Manage Access article to read more about managing access to users. To share a Data Stream, follow the steps below:

  1. Click Manage Access.

  2. Click Add.

  3. Enter the user to which you want to grant access.

  4. Choose between read, write, or co-owner permissions.

  5. Click Ok.

Fig 12: Sharing Access to a Data Stream

Changing Access to a Data Stream

To change permissions of existing users, follow the steps below:

  1. Click on Manage Access.

  2. Select the user.

Fig 13: Changing Access to a Data Stream

3. Change their permissions. 4. Or, delete permissions for the user.

Fig 14: Changing or deleting permission to a Data Stream

Removing Access to a Data Stream

To remove the permissions for multiple users, follow the steps below:

  1. Click Manage Access.

  2. Click Select.

  3. Select multiple users.

  4. Click Delete.

Fig 15: Removing Access to a Data Stream for multiple users

Cloning a Data Stream

To clone a Data Stream, follow the steps below:

  1. From within the Data Stream canvas, click Properties.

  2. Click Clone. This button may not initially be visible on the Properties page but can be found in the menu that appears if you hover with your mouse cursor over the “More” button.

  3. Specify the name for the cloned Data Stream.

  4. Choose a category to copy the Data Steam to. Please note that this should not be the same as the category of the original Data Stream.

  5. Click Save.

Fig 16: Closing a Data Stream
Fig 17: The cloned Data Stream

Further Reading

PreviousData StreamsNextManage Collections

Last updated