Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coreflux.org/llms.txt

Use this file to discover all available pages before exploring further.

Coreflux HUB Routes section showing route cards with connection status indicators, sort and filter controls, and route management options

​
Why Use the Routes Section?

You need to manage Routes from the browser—add new routes, edit configuration, check connection status, and troubleshoot with logs. The Routes section of the Coreflux HUB lets you configure routes with a visual editor or LoT code, view connected and disconnected routes, and inspect route-specific logs.

​
When to Use It

  • Adding routes — Create routes from templates (PostgreSQL, MongoDB, Modbus, etc.) or write LoT code directly
  • Configuring routes — Edit configuration, events, mappings, and tags in Visual or LoT mode
  • Monitoring — See which routes are connected and which are not, and view real-time status metrics
  • Troubleshooting — View route logs, filter by level, and export for analysis

​
Routes Tools

Routes Configuration

Edit routes, view status (connected/not connected), and delete routes.

Routes Monitoring

View real-time status metrics and logs filtered by route, export as JSON/CSV/LOG.

​
Route List and Status

The Routes Manager displays all defined routes as cards. Each route card shows the route name, type (e.g., SIEMENS_S7), and a status indicator dot in the top-right corner. The dot color tells you the current connection state at a glance:
ColorStatus
GreenConnected
RedNot connected
GrayUnknown status
YellowReconnecting
Coreflux HUB route card titled SiemensS7Route with the SIEMENS_S7 type badge, a green status dot in the top-right corner indicating a connected route, and four action icons along the bottom for configuration, monitor, documentation, and delete
Use the controls at the top to sort routes by name and filter by type. The Delete All button removes all routes, and the Add a route + button opens the route creation options.

​
Route Card Actions

Click on a route card to open its context menu with three options:
Coreflux HUB SiemensS7Route card with the SIEMENS_S7 type badge and a row of four action icons at the bottom — a gear for Configuration, a monitor for Monitor, a globe for Documentation, and a trash can for Delete
ActionDescription
ConfigurationOpens the Routes Configuration panel to edit settings, events, mappings, and tags
MonitorOpens the Routes Monitoring window with a Status tab (connection, health, messages, errors) and a Logs tab (real-time route logs)
DocumentationOpens the Coreflux documentation for the route type directly inside the HUB

​
Route Documentation

The Documentation option opens the Coreflux docs page for the route type in an embedded viewer inside the HUB. This gives you quick access to syntax reference, configuration parameters, and examples without leaving the interface.
Coreflux HUB embedded Docs window titled SiemensS7Route loading the Siemens S7 Route page from docs.coreflux.org with Routes navigation on the left, Siemens S7 Overview and Basic Syntax content in the center, and an On this page outline on the right, plus Refresh and Open in Browser controls

​
Adding a Route

Click Add a route + in the Routes Manager. The Create a New Route modal appears with two options:
  • Start from Scratch — Opens the LoT code editor where you write your route definition from scratch
  • Start from Template — Opens the template list where you pick a route type and configure it visually
Coreflux HUB Create a New Route modal overlaid on the Route Manager asking How would you like to get started with two options — Start from Scratch to write a route definition in LoT code from scratch and Start from Template to choose from available route templates and customize with a visual or code editor
MethodBest For
Start from ScratchCustom routes, full control over syntax, copying from documentation
Start from TemplateQuick setup for common route types with a visual configuration form

​
Start from Scratch

Select Start from Scratch to open the Create Route with Code Editor modal. Write your route definition in LoT language and click Create Route to deploy.
Coreflux HUB Create Route with Code Editor modal prompting to write your route definition in LoT language, showing an empty numbered code editor with Enter route definition here placeholder, Collapse All and fullscreen controls at the top, and Cancel and Create Route buttons at the bottom
Example: 
DEFINE ROUTE MyPostgres WITH TYPE POSTGRESQL
  ADD SQL_CONFIG
    WITH SERVER "localhost"
    WITH PORT '5432'
    WITH DATABASE "iot_data"
    WITH USERNAME "admin"
    WITH PASSWORD "your_password"
  ADD EVENT StoreSensor
    WITH SOURCE_TOPIC "sensors/#"
    WITH QUERY "INSERT INTO readings (topic, value) VALUES ('{topic}', '{value.json}')"

​
Start from Template

Select Start from Template to open the templates list. Choose a route type to configure it visually.
  1. Select Start from Template from the Create a New Route modal.
  2. The Templates list opens with available route types.
Coreflux HUB Templates modal titled Choose a route type to get started with a Search by type field and a scrollable list of route templates including PostgreSQL, MariaDB, MySQL, SQL Server, MongoDB, and OpenSearch, each with a description of its database route purpose
  1. Use Search by type… to filter (e.g., “PostgreSQL”, “Modbus”).
  2. Select a template. The route creation view opens with a configuration form.
When you select a template, a configuration tab opens with Visual Mode and LoT Mode. Visual Mode displays all configuration fields and events as a form. LoT Mode shows the raw LoT code.
Coreflux HUB Create PostgreSQL Route view for Route NewPostgreSQL_1776353175451 with Configuration and Events tabs, Configuration Fields panel showing SQL Configuration with five fields — SERVER required string set to localhost, PORT int set to 5432, DATABASE required string set to test_db, USERNAME required string set to admin, and PASSWORD required string hidden — plus an + Add Field button and Cancel and Create Route buttons at the bottom
  • Configuration — Fill in the connection fields (server, port, database, username, password). Required fields are marked with a badge. Use + Add Field to include optional parameters.
  • Events — Define events for the route (e.g., queries triggered by MQTT messages).
  • LoT Mode — Switch to LoT Mode to view or edit the generated LoT code directly.
  1. Fill in the configuration fields and add events as needed.
  2. Click Create Route to deploy. Click Cancel to discard.
Templates are available for all supported route types. See the Routes Overview for the full list of available types and their documentation.

​
Next Steps

Routes Configuration

Edit routes with Visual or LoT mode.

LoT Routes

Learn route syntax and available route types.