Versions Compared

Key

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

After you have created at least one stream in a solution, you can view and manage streams from the Streams view.

In this view, your streams for the solution are listed. 

Stream Buttons

To create a new stream, click Create Stream.

If you have exported a stream, for example from another solution, click Import Stream to import the stream into the current solution. In the dialog that appears, paste the code for the stream that you exported and click Import. The imported stream is displayed in the Stream Editor.

Note
titleNote!

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. Then navigate to the solution that you want to add the stream to, and insert it by clicking Import Stream. In the dialog that appears, paste the code for the stream and click Import.

Click Import Example Stream to look at and import the example streams. Example streams provide a list of some commonly used examples and use cases that can help you in creating and understanding a stream. Refer to Example Streams to know more.

...

Prerequisites

Readers should be familiar with:

All streams you create in a solution are listed in a table where each row depicts a stream. If you have several streams in the solution, you can search for streams. 

The default order is from newest to oldest stream, but you can sort the list alphabetically using the sorting arrows by Name. You can also sort the list from oldest to newest using the sorting arrows by Modified.

...

The list provides you with details at a glance of when a stream was last started, and finished, as well as its current status. The  The status displayed can be one of the following:

Status

Description

-

This indicates that the stream has not been run.

Complete

The stream ran to completion when it was last run.

Failed

The stream failed when it was last run.

Pending

The stream is in transition between two statuses, for example between Running and Complete.

Running

The stream is currently running.

Scheduled

The stream is scheduled to run according to its specific schedule.

Stopped

The stream was either stopped when it was last run, or the stream was scheduled and the schedule was aborted. See Abort Schedule below.

The Scheduled column indicates if the stream has been set to run at specific intervals, or at a specific point in time, or if no schedule has been set. For more information on Scheduling, see Schedule.

Managing Streams

From the Streams stream view, there are several actions that you can take . To select an action for a stream, click the Action dialog box for the relevant stream and select the action you want to take from the drop-down list. Alternatively, if you select a stream, the actions are displayed in a toolbar directly above the streams list.

...

Select when you want to make changes to the stream. The Stream Editor with your stream is displayed, where you can make your changes.

For more information, see Stream Editor.

...

Select if you want to schedule when you want the stream to run. Schedule Settings is displayed.

For more information, see Schedule.

...

Select if you do not want to use the schedule that you have set. When you confirm to abort the schedule, the schedule is deleted. This action cannot be undone.

...

Select when you want to view the events generated when the stream was last run. The Log is displayed.

This action is only available after you have run a stream at least once.

For more information, see Logs.

...

Select to monitor a stream for specific events or issues. An email is sent to the Notification Group when the event or issue occurs.

For more information, see Notification Groups.

...

on the streams. You can access the same options using the More menu that is available under the Actions column.

...

If you select a single stream, an action toolbar will be shown. The table below provides an explanation of the tools in this toolbar. If you select multiple streams, you will only have the option to delete the streams or create a stream group.

...

The following actions are available for a stream: 

Action

Icon

Description

Create group

Create group.pngImage Added

Create a stream group from the selected streams. This button is only available when multiple streams are selected in the stream view. See Stream groups for more information.

Start

Image Added

Starts the selected stream.

Schedule

Image Added

Shows the Schedule settings dialog box.

Schedule settings.pngImage Added

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 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. 

Audit

Image Added

This opens the Audit Dashboard

Log

Image Added

This opens the Logs

Data Correction

Data Correction button.pngImage Added

This opens the Data Correction tab showing errors for the current stream.

Set Notifications

Image Added

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 Apply to confirm the notifications setup and close the window. 

Export

Image Added

This will open up the Export Stream modal used to copy down the content of the given stream. 

Image Added

You can either copy the contents using the Copy to Clipboard button or download the stream content in a JSON file format.

Duplicate

Image Added

This creates a copy of the selected stream. The duplicate will have "Copy" in its title to differentiate it from the original.

Delete

New Delete button.pngImage Added

This will delete the selected stream.