# Helmut4 Stream Reference Documentation

This folder contains generated documentation for Helmut4 stream references, variables, metadata, profiles, event products, and graph views.

The primary machine-readable artifact is `helmut_reference.sqlite`. CSV files are still generated for compatibility and spreadsheet inspection.

## Main files

- `helmut_reference.sqlite`: SQLite database containing all generated CSV tables plus helper views.
- `stream_reference_table.csv`: stream-level reference table with event product mapping.
- `stream_event_products.csv`: stream event to product mapping.
- `task_reference.csv`: HK tasks, their search filters, and linked profiles.
- `cronjob_reference.csv`: cron schedules and their task/watchfolder/AD group targets.
- `user_reference.csv`: users, roles, groups, products, and access preset summary.
- `group_reference.csv`: groups and their access preset summary.
- `access_preset_reference.csv`: access preset definitions by product.
- `access_assignment_reference.csv`: user/group links to access presets by product.
- `dynamic_reference_candidates.csv`: possible static definitions for dynamic references.
- `stream_node_reference.csv`: node-level catalog with node classes, labels, property keys, references, and compact property JSON.
- `wildcard_catalog.csv`: official wildcard definitions with detected usage counts.
- `wildcard_reference.csv`: one row per detected wildcard usage, including stream, path, syntax, definition, and description.
- `stream_complexity.csv`: stream complexity and performance-risk metrics.
- `variable_catalog.csv`: variables, definitions, usage, setters, and dependency expressions.
- `metadata_catalog.csv`: metadata definitions, assignments, usage, and setters.
- `profile_reference.md`: compact profile documentation.
- `metadata_reference.md`: metadata documentation with usage and assignment context.
- `store_variable_reference.md`: store variable documentation.
- `helmut_variable_reference.md`: Helmut variable documentation.
- `encrypted_variable_reference.md`: encrypted variable documentation.
- `temporary_variable_reference.md`: Temp Stream Variable documentation.
- `reference_issues.csv`: errors, warnings, and informational cleanup candidates.
- `profile_stream_references.csv`: profile links to stream, pre-stream, and metadata set.
- `helmut_reference_graph.html`: interactive graph.

## Graph modes

```bash
bash stream_variable_metadata_reference.sh
GRAPH_MODE=audit bash stream_variable_metadata_reference.sh
GRAPH_MODE=configuration bash stream_variable_metadata_reference.sh
```