Business Vault configuration

Table of Contents

General settings
SCD2 defaults
Target loading
Data Vault model path

Business Vault configuration is project metadata that many .hbv files can share. Create it in the Metadata perspective under EDW and select it on Edit model. Older .hbv files may still embed a <configuration> block; Extract to project configuration… promotes that copy.

General settings

Setting Description

Setting	Description
Target database	Database connection (`DatabaseMeta`) where Business Vault tables are created and loaded. Required for DDL, Debug, and Business Vault Update. May be a different connection from the linked Data Vault model target — satellite history is read from the DV connection; BV tables are written (and incremental watermarks resolved) on this connection.
Generated pipeline folder	Optional folder where generated build pipelines are saved when debugging or updating. Variables supported.
SCD2 pipeline name prefix	Prefix for generated SCD2 build pipeline names (default `bv-scd2-`).
PIT pipeline name prefix	Prefix for generated PIT build pipelines (default `bv-pit-`).
Business table pipeline name prefix	Prefix for future business table pipelines (default `bv-biz-`).

Target database

Database connection (DatabaseMeta) where Business Vault tables are created and loaded. Required for DDL, Debug, and Business Vault Update. May be a different connection from the linked Data Vault model target — satellite history is read from the DV connection; BV tables are written (and incremental watermarks resolved) on this connection.

Generated pipeline folder

Optional folder where generated build pipelines are saved when debugging or updating. Variables supported.

SCD2 pipeline name prefix

Prefix for generated SCD2 build pipeline names (default bv-scd2-).

PIT pipeline name prefix

Prefix for generated PIT build pipelines (default bv-pit-).

Business table pipeline name prefix

Prefix for future business table pipelines (default bv-biz-).

SCD2 defaults

These values apply when an SCD2 table does not override them.

Setting Description

Setting	Description
Functional timestamp field	Default satellite column for the functional timeline. Leave empty to use the load-date fallback.
Load date fallback field	Used when no functional timestamp is set on the model or table (default follows Data Vault `loadDateField`, often `x_load_ts`).
Valid from field	Output column name for interval start (default `valid_from`; sample project uses `x_from_ts`).
Valid to field	Output column name for interval end (default `valid_to`; sample project uses `x_to_ts`).
Open start sentinel	Substituted when `valid_from` is null (default `1900-01-01 00:00:00`).
Open end sentinel	Substituted when `valid_to` is null (default `9999-12-31 23:59:59`).
Generate primary keys in DDL	When enabled, generated CREATE TABLE statements include a `PRIMARY KEY` on Business Vault identity columns (for example SCD2 grain + `valid_from`, or PIT hash key + snapshot date). Off by default. CREATE only (no ALTER retrofit). When the primary key is off, update DDL adds a non-unique index on that grain (identity map `hk_raw`, SCD2 grain, PIT grain, bridge hash keys). Business SQL tables are not indexed. A later structure update adds a missing index. Snowflake is skipped.
Generate foreign keys in DDL	When enabled, generated CREATE TABLE statements may include `FOREIGN KEY` constraints to parent Data Vault tables only when the BV target database is the same connection as the linked DV model. Skipped for cross-database BV/DV setups and on engines without FK support (for example SingleStore). Off by default.

Functional timestamp field

Default satellite column for the functional timeline. Leave empty to use the load-date fallback.

Load date fallback field

Used when no functional timestamp is set on the model or table (default follows Data Vault loadDateField, often x_load_ts).

Valid from field

Output column name for interval start (default valid_from; sample project uses x_from_ts).

Valid to field

Output column name for interval end (default valid_to; sample project uses x_to_ts).

Open start sentinel

Substituted when valid_from is null (default 1900-01-01 00:00:00).

Open end sentinel

Substituted when valid_to is null (default 9999-12-31 23:59:59).

Generate primary keys in DDL

When enabled, generated CREATE TABLE statements include a PRIMARY KEY on Business Vault identity columns (for example SCD2 grain + valid_from, or PIT hash key + snapshot date). Off by default. CREATE only (no ALTER retrofit). When the primary key is off, update DDL adds a non-unique index on that grain (identity map hk_raw, SCD2 grain, PIT grain, bridge hash keys). Business SQL tables are not indexed. A later structure update adds a missing index. Snowflake is skipped.

Generate foreign keys in DDL

When enabled, generated CREATE TABLE statements may include FOREIGN KEY constraints to parent Data Vault tables only when the BV target database is the same connection as the linked DV model. Skipped for cross-database BV/DV setups and on engines without FK support (for example SingleStore). Off by default.

Target loading

Setting Description

Setting	Description
Target table batch size	Commit size for generated `TableOutput` transforms (default 1000).
Target table parallel copies	Parallel copies hint for table output (default 1).

Target table batch size

Commit size for generated TableOutput transforms (default 1000).

Target table parallel copies

Parallel copies hint for table output (default 1).

Data Vault model path

Configured on the Business Vault model itself (not inside the configuration block):

Data Vault model file — path to the linked .hdv file
Use ${PROJECT_HOME} when the model lives inside a Hop project
Reload DV model refreshes the linked model from disk after external edits

The linked .hdv must have its own target database configured — Business Vault reads satellite (and hub) history from that connection. Using separate Hop connection names for DV and BV is supported and recommended when raw vault and business vault live in different databases.