-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: [SDCOSMO-1901] add miscellaneous doc file with dataset filter p…
…recisions
- Loading branch information
1 parent
c68d11e
commit d5534b0
Showing
2 changed files
with
43 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Miscellaneous | ||
|
||
## Dataset filter | ||
|
||
In order to filter datasets in scenario creation dialog (for scenario master only), there are two options: | ||
|
||
- API (Recommended) | ||
- Dataset filter (Deprecated) | ||
|
||
### API (Recommended) | ||
|
||
All datasets that are needed to be selectable in dataset list must be linked to the matching workspace by using `workspace/link` or `dataset/link` API endpoint. | ||
In the same way, datasets that are needed not to be visible must be unlinked from the workspace by using `workspace/unlink` or `dataset/unlink` API endpoint. | ||
|
||
This consists of using **_workspace/dataset_** `/link` - `/unlink` API endpoint | ||
|
||
### Dataset Filter workspace option (Deprecated) | ||
|
||
Datasets included in the `[workspace].webApp.options.datasetFilter` array attribute will be added in the datasets list in addition to to datasets. So it is recommended to set this attribute to _null_ | ||
|
||
<details> | ||
<summary>JSON Workspace file example</summary> | ||
|
||
```json | ||
{ | ||
"webApp": { | ||
"url": "https://sample.app.cosmotech.com", | ||
"iframes": null, | ||
"options": { | ||
"datasetFilter": ["d-77w1eq1mmd5"] | ||
} | ||
} | ||
} | ||
``` | ||
|
||
</details> | ||
|
||
> **Warning** | ||
> | ||
> **Potential weird behavior**: If a dataset is set in both attributes, it will be displayed twice |
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