...
In Usage Engine, streams are created inside solutions. A stream can comprise various Collector, Forwarder, and Processor Functions each providing specific functionality, that is linked into automated data flows of virtually any complexity.
Adding First Stream to Solution
Once inside a new 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:
Creating a Stream
Click Create Stream and enter the name of the new stream as shown below:
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.
New stream
| 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,000,000 records per execution. If you want to process more than 10,000,000 records, you can configure stream replica(s) to process a large number of records without compromising on the performance of Usage Engine. You can choose the number of replicas you wish to create to effectively process your records with the least impact on performance. However, there are some prerequisites that you need to ensure before configuring replicas. For more information about this, refer to Performance and Scalability. |
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.
...
...
...
Importing an Existing Stream
You can also import an existing stream into your current solution. You can import a stream either by dragging an exported file JSON file onto the upper part of the pop-up or the file contents can alternatively be pasted in the input box. Click on the Import button to confirm and import the stream. The imported stream is displayed in the Stream Editor.
Import stream
| Note | ||
|---|---|---|
| ||
When you export and import a stream, the stream name is also retained. Ensure that you do not already have a stream with the same name in the solution that you import into. |
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 the download the file locally.
Importing an Example Stream
There are example streams curated by the team for you to import and start exploring Usage Engine. Go to any example stream of your choice and click Import Stream to import that example stream.
Once you create your first stream, you will see the following options in the toolbar to alternatively enable you to create or import more streams inside the same solution.
Streams view
| Stream options icon | Description |
|---|---|
| Import example stream |
| Import stream |
| Create new stream |
In this section, the following chapters can provide more insight into the functioning of streams and provide example streams examples for further understanding:
...