Manual
Reference guide for Helmut4 Scout.
What Is Helmut4 Scout
Helmut4 Scout builds a searchable reference and audit database from a live Helmut4 system or a MongoDB backup. It connects streams, nodes, variables, metadata, profiles, tasks, cron schedules, watchfolders, users, groups, and wildcards into one reference view and surfaces configuration issues automatically.
Use it to audit stream health, trace where variables and metadata are used, review profile assignments, detect deprecated or incompatible nodes, and understand the overall complexity and structure of a Helmut4 installation.
Getting Started
- Open Settings and activate a license key under License Activation.
- Choose Live Helmut4 System or MongoDB backup as the import source.
- For a live import: enter the Helmut4 server URL and bearer token.
- For a backup import: enter the backup directory path, click the scan button, and select the target from the dropdown.
- Click Run workflow. Confirm overwrite if existing data is present.
- After the workflow finishes, select a reference version in Compatibility Checkup and click Perform compatibility checkup.
Import
Two import modes are available. Switching the import source automatically disables the Import Schedule as a safety measure to prevent unintended cross-source execution.
Live Helmut4 System
Connects directly to a running Helmut4 instance via a server URL (HTTP or HTTPS) and a bearer token. The container must have network access to the Helmut4 server.
Imports streams, stream designs, store variables, preferences, metadata, metadata sets, profiles, tasks, cron jobs, users, groups, watchfolders, access presets, and product event catalogs in real time.
MongoDB Backup
Imports from a local backup without a running Helmut4 system. Supported formats:
- Uncompressed mongodump directory โ output of
mongodumpwithout archiving, containing database sub-directories with.bsonfiles. Detected and labelled [DB] automatically. - .zip / .tar.gz โ a mongodump directory packed as a standard archive.
- .archive.gz โ a MongoDB 8.x native archive produced with
mongodump --archive.
Use the Backup Directory field to enter a container path and click the scan button (โป). The dropdown lists all eligible files and directories sorted by last-modified date, newest first. Uncompressed mongodump directories are labelled [DB], generic directories [DIR].
The selected path must be accessible inside the container โ typically a bind-mounted volume such as /backup.
Import Schedule
Defines a cron expression for recurring automatic imports. Available for both live and backup sources. Disabled by default; must be manually enabled after configuring the source.
- Live imports โ connects to the configured Helmut4 server at each scheduled time.
- Backup imports โ automatically selects the most recently modified file or directory from the backup scan directory. No manual selection is needed at run time.
Safety: changing the import source (live โ backup) immediately unchecks the schedule toggle and forces sync_enabled = false on save, so a scheduled run cannot execute against the wrong source without explicit re-activation.
Each scheduled run overwrites the current database โ identical to clicking Run workflow manually. Cron expressions use 5-field standard format (e.g. 0 2 * * * = daily at 02:00). The plain-language translation is shown live as you type. All schedules are interpreted in the server's local timezone.
Views
Dashboard
Overview with total counts, a severity distribution chart including acknowledged-issue breakdown and comparison against the previous import, recent issues, and the most complex streams.
Issues
Searchable, filterable list of all detected reference issues. Filter by severity level or search term. Issues can be acknowledged (hidden by default) to reduce noise after review โ acknowledgements persist across workflow re-runs.
Issue Resolver
Diagnostic sub-page (accessible via the Issues sidebar item) that correlates related issues into actionable groups:
- Case mismatch โ variables or metadata keys used in streams under one capitalisation but defined under another. Suggests renaming the definition to match stream usage.
- Compatibility โ all Compatibility findings grouped for review with node resolution and stream deep-links.
- Deprecated โ all deprecated-node findings with recommendations.
- Temp variable orphans โ Read/Write Pairs, Read Without Write, and Write Without Read, with deep-links to the exact stream and node.
Each section can be exported as a Markdown report via Export Markdown.
Variables
Catalog of store variables, Helmut variables, encrypted variables, and temp stream variables. Shows type, name, status, definition source, value/expression, and usage counts. Expandable detail reveals direction, dynamic flag, and which streams read and write each variable.
Metadata
Project and job metadata catalog. Shows field type, allowed values, metadata set assignments, readers, and setters. Expandable detail reveals status, mandatory/readonly/preresolve flags, and stream usage.
Metadata Sets / Groups
Lists metadata set and group definitions with their field assignments. Links to individual set detail pages.
Profiles
Maps Helmut4 profiles to their main stream, pre-stream, metadata set, and product event. Expandable detail shows profile ID, priority, hidden flag, node filters, and event/host/product/tag configuration for both pre and main stream.
Streams
Catalog of all streams with complexity scores, node counts, issue counts, and reference counts. Expandable detail shows tags, reference type breakdown, and HTTP/command/JavaScript complexity sub-scores. Issue rows with node references deep-link directly to the node within the stream detail page.
Watchfolders
All configured watchfolder definitions. Shows name, path, enabled state, recursive flag, and interval. Expandable detail shows the linked profile and any cron schedules that trigger the watchfolder.
Tasks
Helmut4 task definitions. Shows name, linked profile, filter mode, and creator. Expandable detail shows the profile link and filter configuration.
Cron
All cron schedule entries sorted by type then name. Shows name, type (TASK, WATCHFOLDER, ACTIVE_DIRECTORY, โฆ), cron expression, and resolved target. Expandable detail includes:
- Schedule โ plain-language translation of the cron expression. Seconds shown only when non-zero.
- Expression breakdown โ visual field-by-field grid (Second / Minute / Hour / Day / Month / Weekday).
- Target resolution โ watchfolder entries link to the watchfolder by name; Active Directory entries show the CN group name and full AD configuration (groups, access preset, role, products, actions).
Stream Workshop
Standalone stream analysis and upgrade tool. Works without a database import. Paste a Helmut4 stream exchange key (plain JSON or base64-encoded) and select a reference version.
- Inspect โ reports deprecated nodes, version mismatches, unknown node classes, enum option issues, and unknown triggers. Extracts all variable and metadata references. Shows a compatibility score and a Blocked state when the trigger is unknown.
- Upgrade โ replaces deprecated and unsupported nodes with the best available equivalent for the target version. Parameter values are migrated by variable name; operator keys, canvas positions, and stream links are preserved. Old
%variable%syntax is converted to{variable}across all nodes. Returns a migration report and a new base64-encoded exchange key ready to paste back into the stream designer.
A stream can also be opened directly from its detail page via the compatibility metric box.
Node Conductor
Standalone stream layout preview and alignment tool. It focuses on canvas positioning rather than compatibility analysis, and is available at /node-conductor.
- Render preview โ parses a Helmut4 stream exchange key (plain JSON or base64-encoded) and shows the current node layout with zoom and pan controls.
- Conduct Alignment โ runs the current alignment engine and returns an aligned exchange key that can be copied back into the Helmut4 stream designer.
The alignment selector offers spaghetti_solver as the default layout engine and stream_surgeon as a built-in style-aware alternate. Node Conductor requires an active license, so it is intended for trusted users who need to inspect or normalize stream layouts before import.
Graph
Interactive vis-network reference graph covering streams, variables, metadata, profiles, tasks, cron schedules, and products. Supports Light/Dark theme, Dynamic Layout toggle, and a search field with per-node focus and match navigation (โ / โถ, keyboard shortcuts: Enter, Arrow Up/Down, Escape).
Nodes
Catalog of all individual stream nodes across the system. Shows node type, title, stream (linked), event, host, and deprecated state. Expandable detail reveals stream context, reference count, summary, references, and old wildcards.
Wildcards
Wildcard reference grouped by token โ one row per unique wildcard regardless of stream count. Shows category, syntax, supported events/hosts, description, and a linked list of every stream that uses it. Old %percent% syntax is flagged with a badge.
Table
Direct paginated access to all generated SQLite tables for deeper inspection of raw reference data. Hidden by default โ toggle with Ctrl+Shift+T.
API Docs
Interactive Swagger UI with the full OpenAPI specification for all Helmut4 Scout API endpoints. Accessible without a license.
Issue Severity Levels
Error
Something referenced by a stream or configuration object is missing or cannot be resolved โ for example a variable used in a node that has no definition in the system.
Deprecated
Deprecated stream nodes, malformed reference wrappers, or other constructs that are still functional but should be updated. The Issue Resolver Deprecated section groups these with recommendations.
Old Wildcard
Nodes using the legacy %variable.name% syntax instead of the current {variable.name} form. The Stream Workshop upgrade tool converts these automatically.
Compatibility
Findings generated by the Compatibility Checkup against a selected reference version. Detected conditions:
- Node not in reference โ the node class is absent from the selected version. When a versioned class (e.g.
ActionV5) is used but the reference only provides up toV3, the exact version gap is reported. - Deprecated node โ the node class exists in the reference but is flagged as deprecated for that version.
- Parameter value not in reference โ a configured property value is not in the allowed enum list for the target version.
- Design enum values not in reference โ the stream design configures option values absent from the selected version.
- Design enum options missing โ the reference defines options not present in the design's configured list.
- Wildcard not in reference โ a wildcard used in the stream is not in the selected version's catalog.
Warning
Potentially risky setup โ for example read-only temp variables or disabled stream links.
Orphan
Configured objects that appear unused or disconnected from the analysed setup.
Dynamic Reference
References whose final value is resolved at runtime from stream context, user context, project metadata, node results, or string functions. Documented as detected; require manual review since their value cannot be statically determined.
Info
Low-risk findings, often useful for cleanup or documentation purposes.
Workflow Status
The Workflow Status panel at the bottom of the Settings page shows the live state of the reference build. The Message field persists after the run finishes. For successful runs it may include WARNING: lines from the build output โ for example when an optional backup collection was not present in the archive. These warnings do not abort the import; the affected data is simply omitted.
The full build log is accessible via Ctrl+Shift+D on the Settings page.
Generated Outputs
SQLite database
helmut_reference.sqlite โ the main database used by all viewer pages. Rebuilt from scratch on each workflow run.
Markdown files
Documentation-friendly reference files for profiles, metadata, store variables, Helmut variables, encrypted variables, and temp stream variables. Downloadable from the Artifacts page.
Graph
helmut_reference_graph.html โ the interactive vis-network relationship graph, served via the Graph view.
SVG graphs
Static graph summaries generated when graph generation is enabled and Graphviz is available in the container. Downloadable from the Artifacts page.
Issue snapshots
issue_snapshot.json and issue_snapshot_previous.json record issue counts after each successful workflow run, powering the Dashboard severity comparison chart. Both files are removed when the database is dropped.