Global Properties and Model
The root level of the YAML file defines the global properties of the data model, including versioning, localization, and the core model definition.
Global Properties
| Field | Type | Description | Example |
|---|---|---|---|
|
|
String |
The YAML schema version. |
"1.0"
|
|
|
String |
Locale for metadata fields. |
|
|
|
String |
Locale for formatting dates and numbers. |
"en-US"
|
model
|
Array |
Contains the core model definition (usually a single object). |
|
|
|
String |
A fingerprint (checksum) that can be used to verify the integrity of the exported data and detect if changes have been made since the export. |
"127476cd..."
|
Model Object Properties
The model array primary object contains the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
|
|
Object |
Core identity of the model. Contains primaryLocale (the locale of the user who created the object), objectId (the unique 32-character hex identifier for the object), subType (for example, report_emma_cube), name, and description. |
{ name: "Call Center Daily Sales Analysis" }
|
|
|
Object |
Access Control List defining permissions for different user/group IDs (for more information, see Access Control List). |
|
|
|
Object |
Localized strings for the model's name and description (for more information, see Translations). |
{ name: { translationValues: { 1033: ... } } }
|
dataServeMode
|
String |
Specifies how data is served. |
|
|
|
Boolean |
Enables data wrangling suggestions. |
true
|
|
|
Boolean |
Automatically infers hierarchy relationships. |
|
enableAutoGenerateFriendlyNames
|
Boolean | Enables automatically generated user-friendly object names. | true
|
|
|
Boolean |
Enables related attribute columns to automatically merge. |
|
enableAutoCreateMultiFormAttributes
|
Boolean | Enables automatically created attributes with multiple forms. | true
|
|
|
Object |
Data loading sampling configuration. |
|
partition
|
Object | Data partitioning configuration. | { mode: "automatic", number: 4 }
|
|
|
Boolean |
Automatically joins tables based on relationships. |
|
tables
|
Array | List of logical tables in the model. | See Table Array. |
|
|
Array |
List of business dimensions. |
See Attributes Array. |
factMetrics
|
Array | List of fact-based numeric measures. | See Fact Metrics Array. |
|
|
Array |
List of derived calculations. |
See Metrics Array. |
hierarchy
|
Array | Defines relationships between attributes. | See Hierarchy. |
|
|
Array |
Connections to external Mosaic models. |
|
externalDataModels
|
Array | External Mosaic models registry. | See Links and External Models. |
|
|
Array |
Defines row-level security rules. |
|
folders
|
Array | Organizational structure for model objects. | See Folders Array. |
Example
See the following global properties file example:
version: "1.0"
metadataLocale: "en-US"
dateNumberLocale: "en-US"
model:
- information:
primaryLocale: "en-US"
objectId: "5CB60D2F25D6461185108F47BE10E66C"
subType: "report_emma_cube"
name: "Call Center Daily Sales Analysis"
description: "Analyzing daily sales performance"
acl:
"0AB3BC27425A061AEFCEEF9868D5E69A":
granted: 0
denied: 255
inheritable: false
translations:
name:
targetName: "Object Name"
translationValues:
1033:
translation: "Call Center Daily Sales Analysis"
dataServeMode: "in_memory"
enableWrangleRecommendations: true
enableAutoHierarchyRelationships: true
enableAutoGenerateFriendlyNames: true
enableAutoMergeAttributeColumns: true
enableAutoCreateMultiFormAttributes: true
sampling:
type: "first"
rowCount: 1000
partition:
mode: "automatic"
number: 4
autoJoin: true
tables: ...
attributes: ...
factMetrics: ...
metrics: ...
hierarchy: ...
links: ...
externalDataModels: ...
securityFilters: ...
folders: ...
fingerprint: "127476cd979acb99554ec2555325097bb733c7896b73b8e454ae40c3866cb655"
