Skip to content

[Atscale-26967] catalogs packages perspectives updates #28

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions sml-reference/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ repository name and settings for building aggregates. Each repository
must contain a file called `catalog.yml` at the root level.

Sample `catalog` file:
```

```yaml
unique_name: sml-models
object_type: catalog
label: SML Model Library
Expand Down Expand Up @@ -113,12 +114,14 @@ Supported properties:
- `allow_peer_aggs`: Boolean, optional. Enables aggregation on data
derived from datasets in data warehouses that are different from the
source dataset.
- `allow_preferred_aggs`: Boolean, optional. Allow aggregates to be built
in preferred storage.

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

dataset1:
create_hinted_aggregate: true
allow_peer_aggs: true

**Note:** Datasets are typically defined at the repository level, in
`catalog.yml`; however, datasets used by a specific model (typically
Expand Down
25 changes: 13 additions & 12 deletions sml-reference/model.md
Original file line number Diff line number Diff line change
Expand Up @@ -465,37 +465,36 @@ file.
- **Type:** array
- **Required:** N

A list of the specific metrics and calculations available in the
A list of the specific metrics and calculations to be hidden in the
perspective.

### dimensions

- **Type:** array
- **Required:** N

A list of the specific dimensions and their hierarchies available in the
A list of the specific dimensions and their hierarchies to be hidden in the
perspective.

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

Supported properties:

- `name`: String, required. The name of the dimension to include in the
- `name`: String, required. The name of the dimension to be hidden in the
perspective.

- `hierarchies`: Array, optional. A list of the specific hierarchies
within the `name` dimension to include in the perspective. Supported
properties:
within the dimension to hide in the perspective. Supported properties:
- `name`: String, required. The name of the hierarchy.
- `levels`: Array, optional. A list of the levels within the
hierarchy to include in the perspective.
- `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.

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

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

## drillthroughs

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

Expand Down
2 changes: 1 addition & 1 deletion sml-reference/package.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ individual objects (such as dimensions) across multiple models.

Sample `package` file:

```
```yaml
packages:
- name: shared
url: https://github.com/company/shared
Expand Down