-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from semanticdatalayer/reference-updates
adding composite models
- Loading branch information
Showing
3 changed files
with
68 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Composite Model | ||
|
||
Composite models are made up of multiple other models that all share a dimension, as well as calculations specific to the composite model itself. They are defined by `composite_model` files in SML. | ||
|
||
When you deploy a composite model, all of its referenced objects are deployed as a single model. Note, however, that deployed composite models do not include the following objects from their referenced models: | ||
- User defined aggregates | ||
- Partitions | ||
- Perspectives | ||
- Drill-throughs | ||
|
||
Composite model files support the following properties. | ||
|
||
## object_type | ||
|
||
- **Type:** const | ||
- **Required:** Y | ||
|
||
The type of object defined by the file. For composite models, this must be `composite_model`. | ||
|
||
## unique_name | ||
|
||
- **Type:** string | ||
- **Required:** Y | ||
|
||
The unique name of the composite model. This must be unique across all repositories and subrepositories. | ||
|
||
## label | ||
|
||
- **Type:** string | ||
- **Required:** Y | ||
|
||
The name of the composite model as it appears in the consumption tool. This value does not need to be unique. | ||
|
||
## models | ||
|
||
- **Type:** array | ||
- **Required:** Y | ||
|
||
A list of the models that make up the composite model. These must meet the following criteria: | ||
|
||
- They cannot be other composite models. | ||
- They must all have at least one dimension in common. | ||
|
||
|
||
## metrics | ||
|
||
- **Type:** array | ||
- **Required:** N | ||
|
||
A list of the calculations to include in the composite model. These must meet the following criteria: | ||
|
||
- They must be of object type `metric_calc`. | ||
- Each calculation’s MDX formula can only contain references to objects that appear in the referenced models. | ||
|
||
The `metrics` property supports the following properties: | ||
|
||
- `unique_name`: String, required. The unique name of the calculation. | ||
- `folder`: String, optional. The name of the folder in which this calculation appears in BI tools. | ||
|
||
## description | ||
|
||
- **Type:** string | ||
- **Required:** N | ||
|
||
A description of the composite model. | ||
|