Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Next »

CE.png

Use stream groups to run, or schedule, two or more streams in sequence. 

Streams may be grouped if there are dependencies between the streams. A typical example is when one of the streams in a given group must run successfully before subsequent streams can be executed. The stream group feature handles such situations by stopping the run if any stream fails.

Note!

It is recommended to use Notification groups to receive information about failing streams in groups.

Streams must be created, and belong to the same solution before they can be grouped. For information on how to create streams, see Streams. At the end of this documentation, you find screenshot-based examples of stream group actions. 

Create a stream group

Once you have created a solution with the streams needed, you can group the streams in that solution. To create a stream group, select the streams you want to group and click Create group Create group.png .

Create stream group selected.png
  1. Enter a name for the group in the Stream group name. Drag the stream in the execution order you want it to run.

    Create stream group.png

  2. You can add additional streams into the stream group, by clicking Add streams and selecting the other streams in the solution.

    Add stream in Create stream group.png

  3. Click Create. A stream group is now created and ready for any of the stream group actions.

    Stream groups view.png

Note!

Streams within a stream group can run independently, but not deleted or scheduled. 

Stream Group Actions

Once a stream group is created, the following actions can be taken:

Action

Description

Start

Select start to run the stream group immediately.

Stop

Select stop to immediately halt a running stream group. 

If the stream group is scheduled, it will run at the next specified interval. To permanently stop a scheduled stream, the schedule must be canceled.

This action is only visible when a stream group is running.

Schedule

Select the schedule to specify the interval for when you want the stream group to run. 

The intervals are selectable on the following basis: Minute, Hour, Day, Week, and Month.

Cancel schedule

Select Cancel schedule to delete the schedule for the stream group. When you confirm to cancel the schedule, the schedule is deleted. This action cannot be undone.

If the schedule has started, all streams run before the schedule is canceled.

This action is only visible when the stream group is scheduled.

Edit

Select edit to make changes to a stream group. You can change the name of the group and re-order the streams.

Note!

If a stream group is scheduled, the streams can not be re-ordered. Cancel the schedule to re-order the streams.

Ungroup

Select ungroup to move all streams from the stream group, return the individual stream to the Streams View, and delete the stream group. This action cannot be undone.

Stream Actions

When a stream is a part of a group, the following actions can be taken:

Action

Description

View stream

View the stream in the stream editor. See Stream Editor for more information.

Edit

Select edit to make changes to a stream. You can change the name and logic, that is the desired result, of the stream.

You can edit a stream in a group at any time, even when the stream group has a scheduled run.

Note!
If the stream is a part of a scheduled stream group. The schedule must be canceled and restarted for the edits to take effect.

See Stream Editor for more information on stream editing.

Log

Select view log to get details of the events generated for every run of the stream. 

See Logs for more information about view logs. 

Audit

Select to view the audit data.

See Audit Log for more information. 

Data correction

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

Set notifications

Select set notifications to inform a pre-defined mailing group about stream events or issues that interrupt the stream group run.

For more information about notifications, see Notification groups

Rename

Rename the stream.

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.

Examples

When a stream group is created, the initial actions are the following: Start, Schedule, Edit, and Ungroup. Once a group is scheduled and started, three more actions are available: Stop, View schedule, and Cancel schedule.

Stream groups example scheduled and started .png

When the Schedule option is selected, you can choose the interval between runs.

Schedule settings frequency.png

Once the interval is chosen, click Save settings to save the settings.

Click Publish in the confirmation dialog to activate the schedule.

Schedule assigned.png

If you want to cancel the schedule, click Cancel schedule, and confirm by clicking Ok in the confirmation dialog. 

Cancel schedule.png

You can stop the stream group run by selecting Stop.

Note!

If the stopped stream group is scheduled, it resumes the run at the start of the next scheduled interval. To completely stop a scheduled stream group, use Cancel schedule

  • No labels