Routes: 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 a flow diagram showing connections between devices and targets.

Interface Components:

Left Panel - Devices:

• Device type boxes showing configured devices
• Each box displays device icon, name, and type
• Click + button to add device to flow
• Devices appear on the left side of the canvas

Right Panel - Targets:

• Target type boxes showing configured targets
• Each box displays target icon, name, and type
• Click + button to add target to flow
• Targets appear on the right side of the canvas

Center Canvas - Flow Diagram:

• Visual representation of data flows
• Connection lines between devices and targets
• Pipeline nodes on connection lines (optional)
• Direct connections or pipeline-mediated connections

Creating

Add Device to Flow:

1. Locate device type in left panel
2. Click + button on device box
3. Drawer opens with device selection
4. Select device from list
5. Device appears on canvas

Add Target to Flow:

1. Locate target type in right panel
2. Click + button on target box
3. Drawer opens with target selection
4. Select target from list
5. Target appears on canvas

Connect Device to Target:

Connection happens automatically when both device and target are added to the canvas. The system creates a direct route connection.

Add Pipeline to Connection:

1. Click on connection line between device and target
2. Select Pipeline modal appears
3. Choose pipeline from dropdown list
4. Click Select to add pipeline to connection
5. Pipeline node appears on connection line
6. Data flows through: Device → Pipeline → Target

Managing

View Route Details:

• Hover over connection line to see route name
• Click connection line to see route configuration
• Pipeline nodes show pipeline name

Remove Pipeline from Route:

1. Click on pipeline node on connection line
2. Connection reverts to direct device-to-target flow

Delete Route:

1. Click connection line
2. Modal appears with delete confirmation
3. Confirm to remove route
4. Connection line disappears from canvas

Remove Device:

1. Click device node on canvas
2. Delete modal appears
3. Confirm to remove device
4. All routes using this device are deleted

Remove Target:

1. Click target node on canvas
2. Delete modal appears
3. Confirm to remove target
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, Status (Active/Passive), Director assignments, Pipeline name, Default Target, and an Actions menu (⋮) for each route.

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

Actions

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

View and Edit:

• Edit route - Navigate to route edit interface
• View details - Navigate to route detail view

Status Management:

• Activate Route - Set route to Active status
• Deactivate Route - Set route to Passive 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:

Name:

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

Description:

• Optional route explanation
• Character counter (max 100 characters)
• Describes route purpose

Filter:

• Optional filter expression
• Determines which events match this route
• Uses expression syntax for conditional matching
• Tooltip provides link to documentation
• Example: event.type == "security" && event.severity > 3

Default Target:

• Fallback destination for events that don't match specific targets
• Dropdown showing all configured targets
• Special "null" target option for dropping unmatched events
• Tooltip explains default target behavior

Pipeline:

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

Route Status:

• Toggle between Active and Passive
• Active: Route processes events
• Passive: Route is configured but not processing

Configuration

Configure device-to-target connections with optional filtering and pipeline routing.

Route Configuration Interface:

This step defines the specific data flow paths within the route.

Device Selection:

• Select which devices feed into this route
• Multiple devices can be selected
• Filter expressions can target specific devices

Target Mapping:

• Define which targets receive processed data
• Multiple targets can be configured
• Conditional target selection based on event content

Processing Flow:

• Device events enter route
• Route filter expression evaluated (from Step 1)
• Pipeline processes matching events (from Step 1)
• Events routed to appropriate targets
• Unmatched events go to default target

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.

Review and Create

Configuration Summary:

• Review all route settings
• Verify Director selections
• Confirm scheduling configuration
• Check device and target connections

Create Route:

• Create Route button finalizes configuration
• Success notification on successful creation
• Redirect to Advanced Routes list

Navigation

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
• Back - Return to previous step
• Next - Advance to next step with validation
• Create Route - Finalize route creation (final step)

Detail View

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

Tabs

Route Details Tab:

Displays and allows editing of route configuration from Step 1:

• Name - Editable route name
• Description - Editable route description
• Filter Expression - Event filtering logic
• Director Selection - Selected Directors (MultiSelect)
• Default Target - Fallback destination
• Pipeline - Processing pipeline
• Status - Active/Passive toggle
• Edit Mode - Click edit to modify settings

Route Configuration Tab:

Displays device-to-target connection configuration from Step 2:

• Device selections
• Target mappings
• Processing flow diagram
• Edit mode allows modification

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

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 Activate Route or Deactivate Route
4. Success notification confirms the status change

Active routes process events based on configuration. Passive 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. Deletion modal appears with confirmation
5. Confirm route name matches
6. Click Delete to proceed
7. Success notification confirms deletion
8. 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 Edit button in top-right of tab
3. Form fields become editable
4. Save 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 button
2. System validates changes
3. Success notification displays confirmation
4. Edit mode exits
5. Tab displays updated values

Cancel Changes:

1. Click Cancel button
2. Form reverts to original values
3. Edit mode exits
4. No changes are saved

Tab Navigation Protection:

If you attempt to navigate to another tab while in edit mode:

• Unsaved Changes Modal appears
• Modal Contents:
  • "Unsaved changes" heading
  • "You have unsaved changes. Are you sure you want to leave?" message
  • Discard Changes - Exit edit mode and switch tabs
  • Continue Editing - Return to current tab
  • Cancel - Close modal

Notifications

The Routes interface provides automatic notifications for all operations:

Success

Success messages auto-dismiss after 10 seconds. These include confirmations for route creation, activation, deactivation, 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 activate, deactivate, delete, update operations, and validation errors. Review error details and take corrective action before dismissing.