Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In Usage Engine, streams are created inside solutions. A stream consists of collector, processor, and forwarder functions that provide specific functionality and are linked to automated data flows of varying complexity. 

...

Sections in this page:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

Adding a stream to a solution

Inside When you have created a solution and opened it, you can create a new stream streams or import an existing one. The following section provides the different options available to create a stream. When you first create a solution you will be directed to a landing page where you can choose to create or import your own stream, or import an example stream.

...

When you have created or imported a stream, you will see a list of your streams in the Streams tab in your Solution page.

...

Tools in the Solution page toolbar

You can use the tools in the Solution page toolbar to help you create a stream or import an existing or example stream.

...

Creating a stream

In your Solutions Overview click on the solution where you want to add a stream. Click on the 'plus' + icon in the toolbar, enter streams. When the solution does not contain any streams, you will see the Import example streams page, where you can read about and select to import an example stream or use the Create stream and Import stream buttons for creating or importing an existing stream.

firststream.pngImage Added

Creating a stream

To create a stream:

  1. In the Solution page, click on the Create stream button.
    The New stream dialog opens.

    New stream.pngImage Added
  2. Enter the name of the new stream in the New stream name field and click on the Create

...

  1. Stream button.

...

Clicking Create stream takes you to the The Stream editor will open in Edit mode where you can create the stream of your choice using the functions that are part of your subscription package. 

...

design your stream using the Functions in the Function library, see Stream editor for more information.

...

Note!

When creating streams, depending on your subscription package, you will be presented with an option to configure your stream according to the number of records it needs to process. This is to support the concept of Performance and Scalability when handling streams in Usage Engine.

After clicking Create Stream, you must select the number of records to be processed per stream execution or stream run. Each stream is configured to process a maximum of 10 million records per execution. If you want to process more than 10 million records you can configure one or more stream replicas. This will enable you to process a larger number of records without compromising on the performance of Usage Engine. You can choose the number of replicas you wish to create.

There are some prerequisites that you need to ensure before configuring replicas. For more information about this see Performance and scalability.

Importing an existing stream

You can The streams are stored in *.json format and you can either download the *.json file or copy the content and import into another solution or into the same solution.

To import an existing stream into your solution in a JSON file format. Click the top part of the box to select from your saved files, or drag and drop the file into this top section. You can also paste the file directly into the box below. The imported stream is displayed in the Stream editor.

...

Note!

When importing a stream its name is retained. Please ensure that you import streams into your solution with unique names.

When you click Export, a dialog appears with the code for the stream you have created. Click Copy to Clipboard to copy the contents or click Download to download the file locally:

  1. Download or copy the contents of the *.json file for the stream you want to import into another solution by clicking on the Export button in the Stream editor and either click on the Download button or the Copy to clipboard button.

Tip

Hint!

You can also export the stream from the Solution page by right-clicking on the More button and selecting the Export option.

  1. Open the solution into which you want to import the stream.

  2. Click on the Import stream button.
    The Import stream dialog opens.

    Import stream.pngImage Added
  3. If you downloaded the *.json file, drag 'n' drop it in the Click or drag JSON file here to import area.

Tip

Hint!

You can also click the Click or drag JSON file here to import area, select the downloaded file, and click Upload.

  1. If you copied the content of the *.json file, paste it into the Or paste JSON section.

  2. Click on the Import button.

The stream will be imported and listed in the Solution page.

Note!

If a stream with the same name already exists in the solution, the name of the imported stream will be appended with “(Copy)”.

Importing an example stream

The example streams have been created for you to import so that you can explore how to use Usage Engine. Once you have created your first stream, the Import example stream button in the toolbarreturns you to the landing page with the example streams.

Choose an example you want to import and click Import stream.

...

You will see the Import example streams page when you create a new solution, or if you open a solution and click on the Import example stream button.

...

To import an example stream, click on the Import stream button for the example you want to import. The stream will be imported and and opened in Edit mode in the Stream editor.

Viewing streams in a solution

When you open a solution that contains streams, you will see a list of all the streams in the solution.

...

Toolbar

In the toolbar in the Solution page you have a search field that you can use to search for a specific stream based on its name, and you have four buttons for importing an example stream, importing an existing stream, setting display options, and creating a stream.

...

This section has the following subsections:

...