Skip to content

Commit 8f4ced8

Browse files
Merge pull request #28 from semanticdatalayer/ATSCALE-26967-catalogs-packages-perspectives
[Atscale-26967] catalogs packages perspectives updates
2 parents 4ba1745 + e3815e7 commit 8f4ced8

File tree

3 files changed

+19
-15
lines changed

3 files changed

+19
-15
lines changed

sml-reference/catalog.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ repository name and settings for building aggregates. Each repository
66
must contain a file called `catalog.yml` at the root level.
77

88
Sample `catalog` file:
9-
```
9+
10+
```yaml
1011
unique_name: sml-models
1112
object_type: catalog
1213
label: SML Model Library
@@ -113,12 +114,14 @@ Supported properties:
113114
- `allow_peer_aggs`: Boolean, optional. Enables aggregation on data
114115
derived from datasets in data warehouses that are different from the
115116
source dataset.
117+
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
118+
in preferred storage.
116119

117120
Specify the `unique_name` of the dataset followed by the properties and
118121
values you want to set for it at the repository level. For example:
119122

120123
dataset1:
121-
create_hinted_aggregate: true
124+
allow_peer_aggs: true
122125

123126
**Note:** Datasets are typically defined at the repository level, in
124127
`catalog.yml`; however, datasets used by a specific model (typically

sml-reference/model.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -465,37 +465,36 @@ file.
465465
- **Type:** array
466466
- **Required:** N
467467

468-
A list of the specific metrics and calculations available in the
468+
A list of the specific metrics and calculations to be hidden in the
469469
perspective.
470470

471471
### dimensions
472472

473473
- **Type:** array
474474
- **Required:** N
475475

476-
A list of the specific dimensions and their hierarchies available in the
476+
A list of the specific dimensions and their hierarchies to be hidden in the
477477
perspective.
478478

479-
By default, all objects within a dimension are visible. Hiding a level
480-
in a hierarchy hides all levels below it, as well as their secondary
481-
attributes.
479+
By default, all objects within a dimension are visible. The lowest granularity objects specified are
480+
hidden and the objects above it are not. Hiding a level in a hierarchy hides all levels below it.
481+
Hiding a hierarchy hides all levels in it. Hiding a dimension hides all objects within it including hierarchies
482+
and secondary attributes. If a dimension is not hidden, secondary attributes can be hidden individually.
482483

483484
Supported properties:
484485

485-
- `name`: String, required. The name of the dimension to include in the
486+
- `name`: String, required. The name of the dimension to be hidden in the
486487
perspective.
487488

488489
- `hierarchies`: Array, optional. A list of the specific hierarchies
489-
within the `name` dimension to include in the perspective. Supported
490-
properties:
490+
within the dimension to hide in the perspective. Supported properties:
491491
- `name`: String, required. The name of the hierarchy.
492-
- `levels`: Array, optional. A list of the levels within the
493-
hierarchy to include in the perspective.
492+
- `levels`: Array, optional. Defines a single level in the hierarchy to be hidden in the perspective. All levels below the specified level will also be hidden. Only one level should be provided.
494493

495494
- `secondary_attributes`: Array, optional. A list of the dimension's
496-
secondary attributes to include in the perspective.
495+
secondary attributes to hide in the perspective.
497496

498-
- `relationships_path`: Array, optional. A list of relationships path.
497+
- `relationships_path`: Array, optional. A list of relationships used to specify role-playing.
499498

500499
## drillthroughs
501500

@@ -734,6 +733,8 @@ Supported properties:
734733
- `allow_peer_aggs`: Boolean, optional. Enables aggregation on data
735734
derived from datasets in data warehouses that are different from the
736735
source dataset.
736+
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
737+
in preferred storage.
737738
- `create_hinted_aggregate`: Boolean, options. Enables the creation of
738739
hinted aggregates for the dataset.
739740

sml-reference/package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ individual objects (such as dimensions) across multiple models.
66

77
Sample `package` file:
88

9-
```
9+
```yaml
1010
packages:
1111
- name: shared
1212
url: https://github.com/company/shared

0 commit comments

Comments
 (0)