...
In Usage Engine, streams are created inside solutions. Once inside A stream is made up of Collector, Forwarder, and Processor Functions that provide specific functionality and are linked to automated data flows of varying complexity.
Adding Your First Stream to a Solution
Inside a solution, you can create a new stream . However, you can also import a stream using the JSON schema or simply drag and drop your JSON file. There are example streams curated by the team for you to import and start exploring Usage Engine. In the following image, each row depicts a stream.
You can also click on Import Stream to open the stream import dialog box. Here, streams can be imported either by dragging a JSON file onto the upper part of the modal. The stream export file contents can alternatively be pasted in the input box. Click on the Import button to confirm the stream entry and add the stream. 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.
...
Once you have created or imported a stream you will see a list of your streams in your Solution Overview.
...
Tools in the Solution Overview toolbar
You can use the tools in the Solution Overview toolbar to help you create a stream or import an existing or example stream.
...
Stream options icon | Description |
|---|---|
 | Import example stream |
 | Import stream |
 | Create new 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 the name of the new stream and click Create Stream
...
Clicking Create Stream takes you to the Stream Editor where you can create the stream of your choice using the Functions that are part of your subscription package.
...
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
...
All streams you create in that solution are listed in a table. If you have several streams in the solution, you can search for streams, and by selecting the streams in the table, you can manage them using actions and create Stream Groups.
Action Toolbar
Selecting a single stream enables the following actions for that stream. You can access the same options using the More menu that is available under the Actions column.
The following actions are available for a stream:
...
...
...
Shows the Schedule Settings dialog box.
Different scheduling options are available from this dialog box. Using one of the buttons the users can designate the desired frequency: Minute, Hour, Day, Week, and Month.
For each option, different scheduling rules can be selected:
- Minute – Run every 15, 20, or 30 minutes.
- Hour – Run every 1 hour, 2 hours, 3 hours, 4 hours, 6 hours, or 12 hours.
- Day – This option works by designating both a Start Time and defining the Timezone. Additional schedule rules can be added by clicking on the Add time button.
- Week – The scheduling rules are defined by choosing the selected days of the week, the start time, and the timezone. Additional times can be entered by clicking on the Add time button.
- Month – This is the most complex scheduling option. The scheduling rules allow for select days of the month to be entered in the designated field, the associated start time is entered below it, and the associated timezone is to be selected on the right.
...
...
...
...
This opens the notifications screen. From here email notification options can be designated for each Notification Group. The following options can be toggled as needed:
- Send an email when no file is found
- Send an email when the stream fails
- Send an email when a stream executes successfully
- Send an email when there is a new error in Data Correction.
Click on the Apply button to confirm the notifications setup and close the window.
...
This will open up the Export Stream modal used to copy down the content of the given stream.
You can either copy the contents using the Copy to Clipboard button or download the stream content in a JSON file format.
...
...
...
Selecting two or more streams removes the actions mentioned above and gives you the choice to delete the streams together or create a stream group.
...
Importing an Existing Stream
You can 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.
Importing an Example Stream
The example streams have been created for you to import so that you can explore Usage Engine. Once you have created your first stream, you will see the following options in the toolbar. The first icon, Import example stream, will return you to the landing page with the example streams.
...
Choose an example you want to import and click Import stream
...
Subsections
This section has the following subsections:
| Child pages (Children Display) |
|---|