Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
396e4c3
re-add marketplace drafts
rpietzsch Jun 24, 2026
8bf7d57
add how to install / develop a marketplace package
adelahaye-ecc Jul 8, 2026
68973b2
fix image correct folder & revert unwanted deletion
adelahaye-ecc Jul 8, 2026
c2940fb
Merge branch 'feature/marketplace-packages' into marketplace_package_…
rpietzsch Aug 5, 2026
b902ff4
Merge pull request #229 from adelahaye-ecc/marketplace_package_creation
rpietzsch Aug 5, 2026
2d96b9b
docs(user-guide): add description of content language setting and cle…
MaximilianWenzel Jul 13, 2026
8acd7ab
Update doc for execution variables
robertisele Jul 7, 2026
d46c9aa
Make related-plugin references clickable links in the generated refer…
Jul 14, 2026
8b4a7ca
Run the unit test suite in CI
Jul 15, 2026
780b7d9
Extract plugin_paths construction into its own function, unit-tested.
Jul 15, 2026
1a27ec8
Small cleanup
Jul 15, 2026
d2f8bd8
Validate related-plugin references before wiping the output directory
Jul 16, 2026
942d79a
Read the related-plugin page path from the existing index instead of …
Jul 17, 2026
b8c95da
Collect all unresolvable related-plugin references instead of bailing…
Jul 17, 2026
de9c449
Delete unused variable in test code
Jul 17, 2026
f567165
Test related-plugin link rendering beyond the one happy path it had
Jul 17, 2026
8f4327b
add AI Disclaimers
rpietzsch Jul 10, 2026
d6f9c91
Refine wording and align with product UI text.
rpietzsch Jul 10, 2026
e6017ff
refine explanation, CMEM-7488
rpietzsch Jul 14, 2026
9326333
Update System Architecture
rpietzsch Jul 16, 2026
460eafc
Use posixpath functions instead of handwritten ones.
robertisele Jul 21, 2026
5fb14fb
align license requirement statement
rpietzsch Jul 30, 2026
41ad9dc
allow additional (html) elements
rpietzsch Aug 4, 2026
7a3600f
regenerationg di-reference, apply fix:format
rpietzsch Aug 4, 2026
ba20902
- satisfy rumdl complaints
rpietzsch Aug 5, 2026
fd69776
update cmemc cli reference
rpietzsch Aug 5, 2026
abfd49e
consolidate packages drafts
rpietzsch Aug 5, 2026
60d956c
apply rumdl auto-fixes
rpietzsch Aug 5, 2026
20ea4c7
move tutorial, fix links
rpietzsch Aug 5, 2026
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
3 changes: 3 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ jobs:
- name: reconfigure private repository access
run: ACCESS_TOKEN=${{ secrets.ACCESS_TOKEN }} task use:insider-https-token

- name: test
run: task test:unit

- name: check
run: task check

Expand Down
3 changes: 3 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@
"figcaption",
"figure",
"img",
"key",
"name",
"p",
"param",
"span",
"summary"
]
Expand Down
21 changes: 20 additions & 1 deletion Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ tasks:
- poetry install

check:
desc: Run complete test suite
desc: Check documentation links and Markdown style
deps:
- check:links
- check:rumdl
Expand All @@ -60,6 +60,25 @@ tasks:
cmds:
- poetry run linkcheckMarkdown -r docs 2>&1 | grep -v "ResourceWarning"

test:
desc: Run the Python unit test suite
deps:
- test:unit

test:unit:
desc: Run tests that need no external service
deps:
- install
cmds:
- poetry run pytest -m "not integration"

test:integration:
desc: Run tests that need a live CO instance
deps:
- install
cmds:
- poetry run pytest -m integration

build:
desc: Build the page
deps:
Expand Down
711 changes: 634 additions & 77 deletions data/plugins.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,267 @@
---
title: "cmemc: Command Group - admin view"
description: "List and update explore application view configurations."
icon: octicons/cross-reference-24
tags:
- cmemc
---

# admin view Command Group

<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->

List and update explore application view configurations.

This command group manages Explore (DataPlatform) application view configurations. Application view configurations control the behavior of specific Explore view profiles including companion services and other settings.


## admin view list

List explore application view configurations.

```shell-session title="Usage"
cmemc admin view list [OPTIONS]
```




Outputs a list of application view configurations from the Explore component. The default application view (id: 'default') is always listed first, followed by any custom application view configurations.

Profile IDs can be used as a reference for the other commands of the `admin view` command group.



??? info "Options"
```text

--raw Outputs raw JSON.
--id-only Lists only profile IDs. This is useful for piping
the IDs into other commands.
--filter <TEXT TEXT>... Filter application view configurations by one of
the following filter names and a corresponding
value: id, label.
```

## admin view export

Export application view configurations to a JSON file.

```shell-session title="Usage"
$ cmemc admin view export [OPTIONS] [PROFILE_IDS]...
```




Application view configurations can be exported based on profile IDs, filters, or all at once. The exported JSON can be imported back using the `admin view import` command.

```shell-session title="Example"
$ cmemc admin view export --all
```


```shell-session title="Example"
$ cmemc admin view export --all --output-file configs.json
```


```shell-session title="Example"
$ cmemc admin view export --filter id my-view
```


```shell-session title="Example"
$ cmemc admin view export my-view
```




??? info "Options"
```text

-a, --all Export all application view configurations.
--filter <TEXT TEXT>... Filter application view configurations by one
of the following filter names and a
corresponding value: id, label.
--output-file FILE Export to this file. Use '-' for stdout. If
specified, overrides --output-dir and
--filename-template.
--output-dir DIRECTORY The base directory where the export file will
be created. Ignored if --output-file is
specified. [default: .]
-t, --filename-template TEXT Template for the export file name. Possible
placeholders are (Jinja2): {{connection}}
(from the --connection option) and {{date}}
(the current date as YYYY-MM-DD). Ignored if
--output-file is specified. [default:
{{date}}-{{connection}}.view-configs.json]
--replace Replace an existing export file. This is a
dangerous option, so use it with care.
```

## admin view import

Import application view configurations from a JSON file.

```shell-session title="Usage"
cmemc admin view import [OPTIONS] INPUT_FILE
```




This command imports application view configurations from a JSON file that was created using the `admin view export` command.

If `--replace` is specified, existing configurations with the same profile ID will be updated. Otherwise, existing configurations will be skipped.

!!! note
Importing the default application view configuration updates the project-level overrides stored in /api/conf/workspaces/projectDefault.


```shell-session title="Example"
cmemc admin view import configs.json
```


```shell-session title="Example"
cmemc admin view import --replace configs.json
```




??? info "Options"
```text

--replace Replace existing application view configurations. By default,
import will skip configurations that already exist.
--id TEXT Import the configuration under this profile ID instead of the
one stored in the file.
```

## admin view delete

Delete custom application view configurations.

```shell-session title="Usage"
cmemc admin view delete [OPTIONS] [PROFILE_IDS]...
```




!!! warning
Application view configurations will be deleted without prompting.


!!! note
The default application view configuration cannot be deleted. Use the `admin view list` command to list available application view configurations.




??? info "Options"
```text

-a, --all Delete all custom application view configurations.
This is a dangerous option, so use it with care.
--filter <TEXT TEXT>... Filter application view configurations by one of
the following filter names and a corresponding
value: id, label.
```

## admin view create

Create a new explore application view configuration.

```shell-session title="Usage"
cmemc admin view create [OPTIONS] PROFILE_ID
```




The new profile is created with its ID and label only. Use the `admin view update` command to set configuration values such as enableCompanion or module toggles.

!!! note
Application view configurations can be listed with the `admin view list` command.




??? info "Options"
```text

--label TEXT Label for the application view configuration. Defaults to the
profile ID.
```

## admin view update

Update a key in an existing explore application view configuration.

```shell-session title="Usage"
cmemc admin view update [OPTIONS] PROFILE_ID
```




Any configuration key can be updated, including nested module keys. All other fields are preserved.

```shell-session title="Example"
cmemc admin view update my-profile --key enableCompanion --value true
```


```shell-session title="Example"
cmemc admin view update my-profile --key modules.marketplaceModuleConfiguration.enabled --value false
```




??? info "Options"
```text

--key TEXT The configuration key to update. Supports nested keys using
'a.b[i].c' notation, e.g.
modules.marketplaceModuleConfiguration.enabled. [required]
--value TEXT The new value. Parsed as JSON when possible (e.g. true, false,
1), otherwise used as a plain string. [required]
```

## admin view inspect

Inspect the configuration of an application view profile.

```shell-session title="Usage"
cmemc admin view inspect [OPTIONS] PROFILE_ID
```




For accessing nested configuration values, use the following notation: exploreGraphLists[4].comments[0]

!!! note
Some shell environments require quotes around expressions with square brackets.


Examples: cmemc admin view inspect my-profile

cmemc admin view inspect my-profile `--key` enable

cmemc admin view inspect my-profile `--key` "exploreGraphLists[4].comments[0]"




??? info "Options"
```text

--key TEXT Get a specific key only from the configuration.
--raw Outputs raw JSON.
```
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ The file name is optional and will be generated with by the template if absent.
option, so use it with care.
--type TEXT Type of the exported workspace file.
[default: xmlZip]
--without-userdata Do not export user-identifying metadata
(creation/modification timestamps and account
names) in the exported archive.
-t, --filename-template TEXT Template for the export file name. Possible
placeholders are (Jinja2): {{connection}}
(from the --connection option) and {{date}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ After the update, the snapshot is hot-swapped.
following filter names and a corresponding
value: id, main-graph, status, affected-
graph, valid.
-a, --all Delete all snapshots.
-a, --all Update all snapshots.
--wait Wait until snapshot creation is done.
--polling-interval INTEGER RANGE
How many seconds to wait between status
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,13 @@ tags:
| [admin user](admin/user/index.md) | [delete](admin/user/index.md#admin-user-delete) | Delete user accounts. |
| [admin user](admin/user/index.md) | [password](admin/user/index.md#admin-user-password) | Change the password of a user account. |
| [admin user](admin/user/index.md) | [open](admin/user/index.md#admin-user-open) | Open user in the browser. |
| [admin view](admin/view/index.md) | [list](admin/view/index.md#admin-view-list) | List explore application view configurations. |
| [admin view](admin/view/index.md) | [export](admin/view/index.md#admin-view-export) | Export application view configurations to a JSON file. |
| [admin view](admin/view/index.md) | [import](admin/view/index.md#admin-view-import) | Import application view configurations from a JSON file. |
| [admin view](admin/view/index.md) | [delete](admin/view/index.md#admin-view-delete) | Delete custom application view configurations. |
| [admin view](admin/view/index.md) | [create](admin/view/index.md#admin-view-create) | Create a new explore application view configuration. |
| [admin view](admin/view/index.md) | [update](admin/view/index.md#admin-view-update) | Update a key in an existing explore application view configuration. |
| [admin view](admin/view/index.md) | [inspect](admin/view/index.md#admin-view-inspect) | Inspect the configuration of an application view profile. |
| [admin workspace](admin/workspace/index.md) | [export](admin/workspace/index.md#admin-workspace-export) | Export the complete workspace (all projects) to a ZIP file. |
| [admin workspace](admin/workspace/index.md) | [import](admin/workspace/index.md#admin-workspace-import) | Import the workspace from a file. |
| [admin workspace](admin/workspace/index.md) | [reload](admin/workspace/index.md#admin-workspace-reload) | Reload the workspace from the backend. |
Expand Down Expand Up @@ -90,13 +97,22 @@ tags:
| [graph validation](graph/validation/index.md) | [inspect](graph/validation/index.md#graph-validation-inspect) | List and inspect errors found with a validation process. |
| [graph validation](graph/validation/index.md) | [cancel](graph/validation/index.md#graph-validation-cancel) | Cancel a running validation process. |
| [graph validation](graph/validation/index.md) | [export](graph/validation/index.md#graph-validation-export) | Export a report of finished validations. |
| [package](package/index.md) | [inspect](package/index.md#package-inspect) | Inspect the manifest of a package. |
| [package](package/index.md) | [list](package/index.md#package-list) | List installed packages. |
| [package](package/index.md) | [install](package/index.md#package-install) | Install packages. |
| [package](package/index.md) | [uninstall](package/index.md#package-uninstall) | Uninstall installed packages. |
| [package](package/index.md) | [export](package/index.md#package-export) | Export installed packages to package directories. |
| [package](package/index.md) | [build](package/index.md#package-build) | Build a package archive from a package directory. |
| [package](package/index.md) | [publish](package/index.md#package-publish) | Publish a package archive to the marketplace server. |
| [package](package/index.md) | [search](package/index.md#package-search) | Search for available packages with a given search text. |
| [project](project/index.md) | [open](project/index.md#project-open) | Open projects in the browser. |
| [project](project/index.md) | [list](project/index.md#project-list) | List available projects. |
| [project](project/index.md) | [export](project/index.md#project-export) | Export projects to files. |
| [project](project/index.md) | [import](project/index.md#project-import) | Import a project from a file or directory. |
| [project](project/index.md) | [delete](project/index.md#project-delete) | Delete projects. |
| [project](project/index.md) | [create](project/index.md#project-create) | Create projects. |
| [project](project/index.md) | [reload](project/index.md#project-reload) | Reload projects from the workspace provider. |
| [project](project/index.md) | [status](project/index.md#project-status) | Show task loading errors of projects. |
| [project file](project/file/index.md) | [list](project/file/index.md#project-file-list) | List available file resources. |
| [project file](project/file/index.md) | [delete](project/file/index.md#project-file-delete) | Delete file resources. |
| [project file](project/file/index.md) | [download](project/file/index.md#project-file-download) | Download file resources to the local file system. |
Expand All @@ -120,7 +136,7 @@ tags:
| [query](query/index.md) | [delete](query/index.md#query-delete) | Delete queries from a query catalog. |
| [vocabulary](vocabulary/index.md) | [open](vocabulary/index.md#vocabulary-open) | Open / explore a vocabulary graph in the browser. |
| [vocabulary](vocabulary/index.md) | [list](vocabulary/index.md#vocabulary-list) | Output a list of vocabularies. |
| [vocabulary](vocabulary/index.md) | [install](vocabulary/index.md#vocabulary-install) | Install one or more vocabularies from the catalog. |
| [vocabulary](vocabulary/index.md) | [install](vocabulary/index.md#vocabulary-install) | Install one or more vocabularies from the catalog (deprecated). |
| [vocabulary](vocabulary/index.md) | [uninstall](vocabulary/index.md#vocabulary-uninstall) | Uninstall one or more vocabularies. |
| [vocabulary](vocabulary/index.md) | [import](vocabulary/index.md#vocabulary-import) | Import a turtle file as a vocabulary. |
| [vocabulary cache](vocabulary/cache/index.md) | [update](vocabulary/cache/index.md#vocabulary-cache-update) | Reload / updates the data integration cache for a vocabulary. |
Expand Down
Loading
Loading