Shared Template Properties
This document outlines the common properties that are shared across all of your Data Vault object templates, regardless of their specific entity_type. These properties provide fundamental configurations for naming, type identification, and refresh behavior. Other object specific properties are described in respective object references.
Shared Template Properties
All Data Vault object YAML templates will include the following core properties:
| Property Name | Expected Type | Description |
|---|---|---|
name | string | The unique name of the Data Vault object. This name is used for identification and corresponds to the generated table name in your Data Vault. |
entity_type | enumeration | Specifies the type of Data Vault object being defined by the template. Posible values are: hub, link, non_historized_link, hubsat, linksat, reference |
enable_refresh | boolean | Controls whether the Data Vault object is enabled for automatic refresh. Set to true if this object receives new data, set to false if it reflects only historical data without any automatic updates. |
entity_source/s | Entity Source | Defines one or more sources that feed data into the Data Vault object. Depending on whether the object is allowed to have multiple sources or not, its definition varies slightly. |
Important Note on Entity Source for Link Satellites:
The entity_source property is not present in Link Satellite templates. This is because satellites associated with Links are designed to inherit their entity source directly from the Link itself, eliminating the need for separate source configuration within the satellite template.
Read more about entity sources property in the next chapter.