Stream groups
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 pare are some examples of stream group actions.
This page contains the following sections:
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 .
Enter a name for the group in the Stream group name. Drag the stream in the execution order you want it to run.
You can add additional streams into the stream group, by clicking Add streams and selecting the other streams in the solution.
Click Create. A stream group is now created and displayed in the Stream groups tab.
Note!
Streams within a stream group cannot be deleted, scheduled or run independently.
Stream group actions
Once a stream group is created you can use the following options in the More Actions menu:
Action | Description |
---|---|
Start | Select this option to run the stream group immediately. |
Stop | Select this option to stop the stream immediately and 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. |
Resume | Select this option to resume running a stream group from the last stream that stopped or failed. This action is only available when a stream group’s Status is Stopped or Failed. |
Schedule | Select this option to specify the interval for when you want the stream group to run. You can select the following intervals: Minute, Hour, Day, Week, and Month. See Schedule for more information. |
Cancel schedule | Select this option to delete the schedule for the stream group. When you confirm that you want to cancel the schedule, the schedule is deleted. This action cannot be undone. If the schedule has been triggered, all streams will run before the schedule is canceled. This action is only visible when the stream group is scheduled. |
Edit | Select this option to make changes to a stream group. You can change the name of the group and re-order the streams within the group. Note! If a stream group is scheduled, the streams can not be re-ordered. Cancel the schedule to re-order the streams. |
Ungroup | Select this option to move all streams from the stream group and delete the stream group. This action cannot be undone. |
Stream actions
When a stream is a part of a group, you can use the following options in the More Actions menu
Action | Description |
---|---|
View stream | Select this option to view the stream in the stream editor. See Stream Editor for more information. |
Edit | Select this option to make changes to a stream. You can change the name and logic of the stream. You can edit a stream in a group at any time, even when the stream group has a scheduled run. Note! See Stream Editor for more information on stream editing. |
Log | Select this option to open the Logs view for the stream where you can see details of the events generated for every run of the stream. See Logs for more information. |
Audit | Select this option to open the Audit view for the stream where you can see audit data. See Audit Log for more information. |
Set notifications | Select this option to set notifications to inform a pre-defined mailing group about stream events or issues that interrupt the stream group run. See Notification groups for more information. |
Rename | Select this option to rename the stream. |
Export | Select this option to open the Export stream dialog where you can export or copy the content of the given stream. You can either copy the contents by clicking the Copy to clipboard button or export the stream content in a JSON file format by clicking the Export button. |
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, the Start option is replaced by the Stop option..
If you click on the Schedule option, you can set the interval between runs.
See Schedule for more information on the configurations in this dialog box.
Once the interval is chosen, click Save settings to save the settings.
Click Publish in the confirmation dialog to activate the schedule.
If you want to cancel the schedule, click Cancel schedule, and confirm by clicking Ok in the confirmation dialog.
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.