Management

The Routes web interface provides comprehensive management for data flow orchestration through two distinct approaches: Quick Routes for simple configurations and Advanced Routes for complex routing logic.

Access

Navigate to Home > Routes, or use the hamburger menu and select Routes.

Overview

The Routes interface is where you orchestrate data flow from devices through pipelines to targets. Routes act as traffic controllers, determining what data goes through which processing pipelines and reaches which destinations.

DataStream provides two route types:

Aspect	Quick Routes	Advanced Routes
Interface	Visual drag-and-drop	Multi-step wizard
Complexity	Simple device-to-target	Complex filtering, conditional logic
Directors	All Directors	Selectable Directors
Scheduling	Continuous only	Cron or interval scheduling
Best for	Straightforward data flows	Enterprise routing scenarios

Quick Routes

Quick Routes provides a visual interface for creating simple data flows with drag-and-drop functionality.

Interface

The Quick Routes page displays an interactive flow canvas showing connections between devices and targets. Devices render as nodes on the left side, targets on the right, with connection nodes between them — either direct or pipeline-mediated.

When no devices or targets have been added yet, a panel offers Select device and Select target buttons to start building the flow.

Creating

Add Device to Flow:

1. Click Select device
2. A two-step drawer opens: Choose Device Type (tile selection), then Select Device (pick devices from a table)
3. The selected device appears as a node on the canvas

Add Target to Flow:

1. Click Select target
2. A drawer opens for target type and target selection
3. The selected target appears as a node on the canvas

Connect Device to Target:

Draw a connection by dragging from the device node's handle to the target node's handle on the canvas. The connection appears as a route node between the two.

Add Pipeline to Connection:

1. Click the connection node between device and target
2. The Insert from available pipelines modal appears
3. Choose a pipeline from the list
4. Click Select pipeline to add it to the connection
5. The pipeline name appears on the connection node
6. Data flows through: Device → Pipeline → Target

Managing

View Route Details:

• Click a connection node on the canvas (labeled Direct route or with the pipeline name) to open a configuration popup with route details and options

Remove Pipeline from Route:

1. Open the connection node's popup
2. Remove the pipeline; the connection reverts to direct device-to-target flow

Delete Route:

1. Open the connection node's popup and choose to remove the route
2. The Remove Route modal appears
3. Click Remove route to confirm
4. The connection disappears from the canvas

Remove Device:

1. Select the device node on the canvas and choose removal
2. The Remove device from routes modal appears
3. Click Remove device to confirm
4. All routes using this device are deleted

Remove Target:

1. Select the target node on the canvas and choose removal
2. The Remove target from routes modal appears
3. Click Remove target to confirm
4. All routes using this target are deleted

Advanced Routes

Advanced Routes provides a wizard-based interface for creating complex routing configurations with filtering, director selection, and scheduling.

List

The Advanced Routes page displays a table of all configured advanced routes.

The table displays Name, Description, Pipeline, Config, Director(s), Status (Enabled/Disabled), and an Actions menu (⋮) for each route.

Filter routes using Search advanced routes (by name) and Status dropdown (All, Enabled, Disabled). The Refresh button reloads table data. Click Add new route to launch the creation wizard.

Actions

Each route row provides an Actions menu (⋮) with the following operations:

View and Edit:

• Manage route - Navigate to the route detail view
• Clone route - Open the creation wizard pre-filled with a copy of the route (name prefixed "Copy of")
• See route details - Shown instead of the management actions for users with read-only access

Status Management:

• Enable route / Disable route - Toggle route status (shown according to current status)

Deletion:

• Delete route - Remove route from platform

Create Advanced Route Wizard

The advanced route creation process uses a multi-step wizard with comprehensive configuration.

Details

Configure basic route information and connections.

Route Information (fields in form order):

Route name:

• Unique route identifier
• Minimum 3 characters
• Maximum 64 characters

Route description:

• Optional route explanation
• Describes route purpose

Filter (Optional):

• Optional filter expression with an information tooltip
• Determines which events match this route
• Uses expression syntax for conditional matching
• Example: event.type == "security" && event.severity > 3

Select director (Optional):

• MultiSelect of available Directors
• If none are selected, the route runs on all Directors; selecting Directors restricts execution to them

Default target:

• Fallback destination for events that don't match specific targets
• Dropdown showing all configured targets

Select pipeline:

• Required processing pipeline selection
• Searchable dropdown showing all available pipelines
• Route processes all events through this pipeline

Route Status:

• Toggle controlling whether the route processes events
• Enabled: Route processes events
• Disabled: Route is configured but not processing

Route Configuration

The second step presents a plain text area where you enter or paste the route's YAML configuration — the in-app hint reads "You can enter or paste your configuration here." This is where device-to-target mappings and conditional routing logic are defined in YAML form (see Routes overview for the configuration schema).

Execution Settings

Configure route scheduling and execution behavior.

Scheduling:

Enable scheduling to run the route at specific times rather than continuous processing.

Scheduling Toggle:

• Enable Scheduling - Activate scheduled execution
• When disabled, route processes data continuously as it arrives
• When enabled, route accumulates data and processes on schedule

Scheduling Method Selection:

Choose between two scheduling approaches using radio tiles:

info

For Cron-Based scheduling, see this chapter, for Interval-based scheduling, see this chapter.

Navigation

The wizard runs in three steps: Route Details, Route Configuration, and Execution Settings.

Progress Indicator:

• Visual step progress at top of wizard
• Click steps to navigate (after validation)
• Current step highlighted
• Completed steps marked with checkmark

Navigation Buttons:

• Cancel - Exit wizard without creating route (first step; on later steps the left button is Back)
• Next step - Advance to next step with validation
• Add route - Finalize route creation (final step); a success notification confirms creation and you are returned to the Advanced Routes list

Unsaved Changes:

Cancelling the wizard with entered data opens an Unsaved changes modal warning that progress will be lost, with Continue adding (stay in the wizard) and Discard (exit) buttons.

Detail View

Clicking a route from the list opens the detailed management interface.

Tabs

The detail view has four tabs: Route Details, Route Configuration, Execution Settings, and Live Data.

Route Details Tab:

Displays and allows editing of route configuration from Step 1:

• Route name - Editable route name
• Route description - Editable route description
• Filter (Optional) - Event filtering logic
• Director(s) - Selected Directors (MultiSelect)
• Default target - Fallback destination
• Select pipeline - Processing pipeline
• Route Status - Enabled/Disabled toggle

Click Manage route details to enter edit mode.

Route Configuration Tab:

Displays the route's raw YAML configuration under the Advanced Route Configuration panel. Click Manage route configuration to enter edit mode and modify the configuration text.

Execution Settings Tab:

Displays and allows editing of scheduling configuration from Step 3:

Scheduling Section:

• Current scheduling status (Enabled/Disabled)
• Scheduling method (Cron or Interval)
• Current schedule pattern or interval
• Edit mode allows modification of all scheduling settings

Live Data Tab:

Captures data flowing through this route in real time, before or after route processing — see Live Data.

Operations

Enable / Disable

To change route status:

1. Navigate to route detail view or use the Actions menu from list
2. Click Actions menu
3. Select Enable route or Disable route
4. Success notification confirms the status change

Enabled routes process events based on configuration. Disabled routes preserve configuration but stop all processing.

Delete

Delete Route Process:

Remove a route from the platform:

1. Navigate to route detail view or use Actions menu from list
2. Click Actions menu
3. Select Delete route
4. A confirmation modal appears showing the route name
5. Click Delete to proceed
6. Success notification confirms deletion
7. Redirect to routes list

Note: Route deletion does not delete the devices, pipelines, or targets used by the route. Only the routing configuration is removed.

Edit Mode Workflow

Route detail tabs support inline editing with unsaved changes protection:

Enter Edit Mode:

1. Navigate to editable tab
2. Click the tab's manage button (for example, Manage route details)
3. Form fields become editable
4. Save changes and Cancel buttons appear

Make Changes:

• Modify editable fields
• Update Director selections
• Change scheduling settings
• Changes are not saved automatically

Save Changes:

1. Click Save changes
2. System validates changes
3. Success notification displays confirmation
4. Edit mode exits
5. Tab displays updated values

Cancel Changes:

Clicking Cancel with unsaved modifications opens an Unsaved changes modal with Continue editing (return to the form) and Discard (revert and exit edit mode) buttons.

Notifications

The Routes interface provides automatic notifications for all operations:

Success

Success messages auto-dismiss after 10 seconds. These include confirmations for route creation, enabling, disabling, deletion, and configuration updates. Hover to pause the auto-close timer, or click X to dismiss manually.

Errors

Error notifications persist until manually dismissed. These include failures for enable, disable, delete, update operations, and validation errors. Review error details and take corrective action before dismissing.