The Reference Guide is the go-to resource for in-depth, component-level documentation. Unlike the How-to guides and tutorials that walk you through specific tasks, the Reference Guide gives you a complete and precise picture of what each part of beVault does, how it works, and what options are available to you. Whether you need to understand a specific screen in the interface, configure a workflow, or identify the right Worker for a data task, this is where you'll find the authoritative answer.
The Reference Guide is organized around the three core components of the beVault platform:
1. 🧩 beVault (metaVault) — User Reference Guide
The beVault User Reference Guide is the comprehensive resource for working with metaVault, the main modeling and data management application of the platform.
metaVault is where users design and manage their Data Vault models. It provides a user-friendly interface organized into modules and submodules, each corresponding to a specific stage in the data management lifecycle — from building data pipelines and enriching data, to verifying data quality and exploring insights.
2. ⚙️ States — User Reference Guide
The States User Reference Guide documents States, beVault's built-in workflow orchestration engine.
States is responsible for scheduling and executing all the processes required to operate your data platform — from loading data from source systems into the Raw Vault, to running snapshots and triggering downstream processes.
3. 🔧 Workers — Reference Guide
The Workers Reference Guide documents the Workers and Stores that power beVault's data execution layer.
Workers are specialized software components that function as web services. They are called by the States orchestrator to execute precise, atomic tasks within your data workflows: reading a CSV file, running a SQL query, making an HTTP call, compressing archives, moving files, and much more. Workers operate on a polling model — they continuously query States to check for available tasks, execute them with the provided parameters, and return results.
Workers can be deployed alongside beVault components or directly on the client's infrastructure, avoiding the need to expose sensitive databases to the internet
This section of the Reference Guide covers the full catalog of available Workers, identified by their Activity name, along with their minimum required beVault version and a description of their function.