In Usage Engine, streams are created inside solutions. Once 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 which you can import that have been curated by the team for you to play around import and explore start exploring Usage Engine. In the following image, each row depicts a 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 in order 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 scalabilityScalability. |
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 on the table enables the following actions for that stream:
...
This will open up the Export Stream modal used to copy down the content of the given stream.
The following information is listed in the dialog box:
- Stream name – Shows the name of the selected stream.
- Stream Content
A Copy to Clipboard button is available allowing the users to copy the stream content to their computer's clipboard. The Export file will save the stream content to a JSON file that will be downloaded to the users' computer.
...
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.
The Actions menu available for each stream lists the following options:
...
. 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:
Action | Action Toolbar Icon | Description |
---|---|---|
Start | Starts the selected stream. | |
Schedule | 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:
| ||
Audit | This opens the Audit Dashboard. | |
Log | This opens the Logs screen. | |
Data Correction | — | This opens the Data Correction tab showing errors for the current stream. |
Set Notifications | 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:
Click on the Apply button to confirm the notifications setup and close the window. | ||
Export | 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. | ||
Duplicate | This creates a copy of the selected stream. The duplicate will have "Copy" in its title to differentiate it from the original. | |
Delete | This will delete the selected stream. |
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.
In this section, the following chapters can provide more insight on into the functioning of streams and provide example streams for further understanding:
...