diff --git a/docs/.pages b/docs/.pages index 612e668d5..2384a5e63 100644 --- a/docs/.pages +++ b/docs/.pages @@ -1,6 +1,6 @@ nav: - Build: build - - Explore and Author: explore-and-author + - Explore: explore-and-author - Consume: consume - Deploy and Configure: deploy-and-configure - Automate: automate diff --git a/docs/build/define-prefixes-namespaces/index.md b/docs/build/define-prefixes-namespaces/index.md index 1ccfdcf2b..95a8da08a 100644 --- a/docs/build/define-prefixes-namespaces/index.md +++ b/docs/build/define-prefixes-namespaces/index.md @@ -22,9 +22,10 @@ This is particularly useful when you have to write source code in Turtle and SPA ## Managing Namespace Declarations -### Using the Vocabulary Catalog +### Using Installed Ontologies / Vocabularies -After installing a vocabulary from the [Vocabulary Catalog](../../explore-and-author/vocabulary-catalog/index.md), the vocabulary namespace declaration is automatically added to all integration projects. +Vocabularies and ontologies are installed either as a package from the **Marketplace**, or directly from an RDF file. +In both cases, the vocabulary namespace declaration is automatically added to all integration projects. In order to get the **prefix name** and the **namespace IRI** from the vocabulary graph, the following terms from the [VANN vocabulary](https://vocab.org/vann/) need to be used on the Ontology resource. @@ -33,7 +34,7 @@ In order to get the **prefix name** and the **namespace IRI** from the vocabular In the Explore area, an Ontology with a correct namespace declaration looks like this: -![An ontology (graph) resource in the EXPLORE > Knowledge Graphs view](ontology-graph-resource.png) +![An ontology (graph) resource in the EXPLORE > Knowledge Graphs view](ontology-graph-resource.png){ class="bordered" } ### Using cmemc @@ -60,11 +61,11 @@ Prefixes in Data Integration are defined on a project basis. When creating a new After selecting a project from the search results the prefix management is available in the project configuration in the lower right area: -![Build (DataIntegration) workspace](DI-workspace.png) +![Build (DataIntegration) workspace](DI-workspace.png){ class="bordered" } By using the **Edit Prefix Settings** button in this Configuration area, you will see the **Manage Prefixes** dialog: -![Build (DataIntegration) workspace prefix setup dialog](DI-workspace-prefix-dialog.png) +![Build (DataIntegration) workspace prefix setup dialog](DI-workspace-prefix-dialog.png){ class="bordered" } In this dialog, you are able to @@ -75,7 +76,7 @@ In this dialog, you are able to After adding namespace declarations to a project you are able to use the abbreviated IRIs in the user interface, for instance, in the mapping editor, the Turtle editor or the Query editor: -![Prefixes displayed in the mapping dialogs, e.g. property selection.](prefix-displayed-in-mapping.png) +![Prefixes displayed in the mapping dialogs, e.g. property selection.](prefix-displayed-in-mapping.png){ class="bordered" } ![Query Editor](DM-query-editor.png){ class="bordered" } diff --git a/docs/deploy-and-configure/configuration/explore/index.md b/docs/deploy-and-configure/configuration/explore/index.md index 6c32a3f57..134d17058 100644 --- a/docs/deploy-and-configure/configuration/explore/index.md +++ b/docs/deploy-and-configure/configuration/explore/index.md @@ -8,7 +8,7 @@ tags: This page describes how to configure the eccenca Explore component which is done in two parts: -1. The Explore frontend (DataManager) is configured visually through the :eccenca-module-workspace-configuration: _Workspace configuration_ module. +1. The Explore frontend (DataManager) is configured visually through the :eccenca-module-workspace-configuration: _Application view configuration_ module. 2. [The Explore backend (DataPlatform)](dataplatform/index.md), all details are described on the respective sub-page eccenca Explore frontend (DataManager) is a single-page JavaScript application, which means the application consists of a single HTML page which loads all needed web resources in the browser after loading the page itself. diff --git a/docs/deploy-and-configure/configuration/graphinsights/index.md b/docs/deploy-and-configure/configuration/graphinsights/index.md index 044555f50..e0269f76f 100644 --- a/docs/deploy-and-configure/configuration/graphinsights/index.md +++ b/docs/deploy-and-configure/configuration/graphinsights/index.md @@ -72,9 +72,10 @@ for more information. ## Activate and verify the installation -First, you have to enable the Graph Insight in your Explore workspace. By default, it is disabled. +First, you have to enable the Graph Insight in your Explore Application view configuration. By default, it is disabled. -![Explore workspace configuration](explore-workspace-enable-graphinsights.png) + +![Explore Application view configuration](explore-workspace-enable-graphinsights.png) Then you are able to create a snapshot, send it to Graph Insights and select the Graph Insights tab in explore. diff --git a/docs/explore-and-author/.pages b/docs/explore-and-author/.pages index 4e3ff2d6f..cf419ec53 100644 --- a/docs/explore-and-author/.pages +++ b/docs/explore-and-author/.pages @@ -1,13 +1,12 @@ nav: - - Explore and Author: index.md - - Workspace Selection and Configuration: workspace-configuration - - Graph Exploration: graph-exploration - - Companion: companion - - Business Knowledge Editor Module: bke-module - - Query Module: query-module - - Thesauri Management: thesauri-management - - Vocabulary Catalog: vocabulary-catalog - - Charts Catalog: charts-catalog - - Link Rules: link-rules - - Embedding Services via the Integrations Module: embedding-services-via-the-integrations-module + - Explore: index.md + - Knowledge graphs: graph-exploration + - Business knowledge editor: bke-module + - Queries: query-module + - Thesauri: thesauri-management + - Charts: charts-catalog + - Companion AI chat: companion + - Services integrations: embedding-services-via-the-integrations-module + - Link rules: link-rules + - Application view: workspace-configuration diff --git a/docs/explore-and-author/bke-module/index.md b/docs/explore-and-author/bke-module/index.md index 6a661c4e8..641fed893 100644 --- a/docs/explore-and-author/bke-module/index.md +++ b/docs/explore-and-author/bke-module/index.md @@ -4,14 +4,15 @@ tags: - KnowledgeGraph - Video --- - -# Business Knowledge Editor Module + + +# Business Knowledge Editor ## Introduction -This feature allows for the visual exploration of Knowledge Graphs. +This module allows the visual exploration of Knowledge Graphs. It allows to save and share explorations. -Furthermore, sophisticated individual search settings (filter presets) can be created and configured per workspace. +Furthermore, sophisticated individual search settings (filter presets) can be created and configured per Application view. ## Usage @@ -26,9 +27,9 @@ At the module welcome screen the user can either load a saved visualization of s !!! Note The graph selection drop-down might or might not be visible depending the existence of an (optional) `Business Knowledge Editor Module` configuration. - In case no specific module configuration exists or non has not has been set for the current workspace the graph selection will be shown. - A `EasBusiness Knowledge EditoryNav Module` configuration pre-configures a graph. - Thus, the dropdown will not be shown if such has been configured for the current workspace. + In case no specific module configuration exists or non has not has been set for the current Application view the graph selection will be shown. + A `Business Knowledge Editor Module` configuration pre-configures a graph. + Thus, the dropdown will not be shown if such has been configured for the current Application view. ![Initial search on the welcome screen.](easynav-welcome-search.png) @@ -59,21 +60,21 @@ The `Visualization catalog` dialog shows the saved exploration and allows to :oc ## Setup This feature is enabled by default. -It can be customized or disabled in the respective workspace configuration section. +It can be customized or disabled in the respective Application view configuration section. -Without further (workspace) specific configuration the feature can be used asking for the graph that shall be explored every time a new exploration is started. +Without further (Application view) specific configuration the feature can be used asking for the graph that shall be explored every time a new exploration is started. -Optionally a `Business Knowledge Editor Module` configuration can be created to provide a fixed graph selection and search filter settings. +Optionally a `Business Knowledge Editor` configuration can be created to provide a fixed graph selection and search filter settings. -### Create a Business Knowledge Editor Module Configuration +### Create a Business Knowledge Editor Configuration -![Create a `Business Knowledge Editor Module` Configuration](easynav-config-EasyNavModule.png) +![Create a `Business Knowledge Editor` Configuration](easynav-config-EasyNavModule.png) In the `Knowledge Graphs` module navigate to the `CMEM Configuration` graph. -Select the class `Business Knowledge Editor Module` and `Create a new "Business Knowledge Editor Module"`. +Select the class `Business Knowledge Editor` module and `Create a new "Business Knowledge Editor"`. -![New `Business Knowledge Editor Module` dialog](easynav-config-newEasyNavModule-dialog.png) +![New `Business Knowledge Editor` dialog](easynav-config-newEasyNavModule-dialog.png) Provide a `Name` for your configuration and select the `Default Graph` which contains the nodes you want to explore visually. This graph can of course be an integration graph. @@ -81,25 +82,9 @@ This graph can of course be an integration graph. `Search Configuration` is optional but a powerful feature to create predefined search filter/facets. If want to use this capability select existing `Search Configuration`s in the drop down or create stubs for the configurations you want to setup. -### Set the Business Knowledge Editor Module in the Workspace configuration - -![Select `Business Knowledge Editor Module` in `Workspace` configuration](easynav-config-select-in-workspace.png) - -After creating the `Business Knowledge Editor Module` configuration it need to be selected in workspace configuration(s) that shall be using it. - -### Create a Search Configuration - -Follow the stub link from creating a new configuration in the `Module` dialog. -Then click edit to provide the necessary details. - -![Setup a `Search Configuration`](easynav-config-search-config-dialog.png) - -At least a `Name` and `Search Weight` need to be specified. -The weight can be used to boost the results of one search configuration over another in case multiple `Search Configuration`s are used. +### Set the Business Knowledge Editor module in the Application view configuration -`Graph Resource Pattern` are a topic on its own and explained [here](../../deploy-and-configure/configuration/explore/graph-resource-pattern/index.md). +![Select `Business Knowledge Editor` module in `Application view` configuration](easynav-config-select-in-workspace.png) -## Technical Background +After creating the `Business Knowledge Editor` module configuration it need to be selected in Application view configuration(s) that shall be using it. -`Search Configuration`s will be cumulatively executed when search terms are provided. -Which means each additional `Search Configuration` increases the time to produce results. diff --git a/docs/explore-and-author/charts-catalog/index.md b/docs/explore-and-author/charts-catalog/index.md index b4bc86429..f416b1d3d 100644 --- a/docs/explore-and-author/charts-catalog/index.md +++ b/docs/explore-and-author/charts-catalog/index.md @@ -5,33 +5,38 @@ tags: - Dashboards --- -# Charts Catalog and Charts Integration +# Charts -The **Charts Catalog** is a module suitable to visualize your data in a chart. +This section describes how charts can be defined in the **Charts module** and how they are integrated in your SHAPE configurations. -## Graph Selection +## Charts Module -The charts module lists all the graphs containing queries - which will be the data foundation for your charts. -Select the graphs that contains the queries you want to user to get started. -You will see the charts that are already defined based select any to edit or add a new with **Create chart**. +The **Charts module** is used to define and manage visualizations of your data. + +### Graph Selection + +The **Charts module** lists all the graphs containing queries - which will be the data foundation for your charts. +Select the graph that contains the queries you want to use to get started. +You will see the charts that are already defined. +Select any to edit or add a new chart with **Create chart**. ![](Chart-graph-selection.png){ class="bordered" } -## Charts Management +### Charts Management -You can open the Charts Catalog from the main menu on the left. -You will see a list of existing charts or the information **Your charts catalog is empty**. +You can open the **Charts module** from the main menu on the left. +You will see a list of existing charts or that **Your charts catalog is empty**. Here you can create a new chart or edit an existing one. ![](23-03-ChartCreation.gif){ class="bordered" } After selecting **Create Chart** or an existing Chart, you will see the Chart Editor, which is divided into four components: -### Metadata +#### Metadata You can give your charts a name and a description. -### Query selection +#### Query Selection Select a query from the :eccenca-application-queries: [Query Catalog](../query-module/index.md) to retrieve the data you want to visualize. @@ -44,7 +49,7 @@ The following activities can be performed in this component: - **Preview** — View a preview of the retrieved data. - **View in query catalog** — Opens the query in the query catalog. -### Chart forms +#### Chart Forms There are two types of forms: **Assisted** and **Advanced**. @@ -56,7 +61,7 @@ It consists of a JSON editor that allows you to configure the chart yourself. For more information about chart configuration and examples, visit the [echarts.apache.org](https://echarts.apache.org/examples/en/index.html). -### Preview +#### Preview The main content on the right side is the preview, where you can see the visual results of your changes in the configuration. diff --git a/docs/explore-and-author/companion/index.md b/docs/explore-and-author/companion/index.md index 4a472f5b6..7af251116 100644 --- a/docs/explore-and-author/companion/index.md +++ b/docs/explore-and-author/companion/index.md @@ -1,11 +1,10 @@ --- icon: eccenca/application-ai-suggestion -subtitle: LLM and MCP-tools based chat status: new tags: - Reference --- -# Companion +# Companion AI Chat !!! info "AI Disclaimer" @@ -49,7 +48,7 @@ In the companion sidebar, use: To maximize the relevance and accuracy of the generated answer, your question is automatically enriched based on the context of the current view (e.g. the query text, the graph and the resource IRI). -### Tool selection +### Tool Selection ![Companion Tool Selection](companion-tool-selection.png){ class="bordered" width="40%" } @@ -110,7 +109,7 @@ If your use case or question requires you to limit the available tools (e.g. if `resource_get` : Retrieves the Concise Bounded Description (CBD) of a resource from the knowledge graph and returns it as JSON-LD. -### Interactive answers +### Interactive Answers ![Enriched answers](companion-response-enrichment.png){ class="bordered" } diff --git a/docs/explore-and-author/embedding-services-via-the-integrations-module/index.md b/docs/explore-and-author/embedding-services-via-the-integrations-module/index.md index 05a9d1f42..730161242 100644 --- a/docs/explore-and-author/embedding-services-via-the-integrations-module/index.md +++ b/docs/explore-and-author/embedding-services-via-the-integrations-module/index.md @@ -3,6 +3,26 @@ icon: eccenca/module-integrations tags: - Dashboards --- -# Embedding Services via the Integrations Module +# Service integrations -A Explore module is available that can be used to embed / integrate other web-services in Corporate Memory. The module can be used and configured visually through the :eccenca-module-workspace-configuration: _Workspace configuration_ module. +!!! info + + This module is not activated by default and can be configured in the application view configuration. + +The **Service integrations** module embeds external web applications directly into the Corporate Memory user interface. +Instead of switching to a separate tool, users open the integrated service from the main navigation and work with it without leaving their Application view. + +A typical use case is a dashboarding service that visualizes data from your Enterprise Knowledge Graph. + +![The Service integrations module showing an embedded dashboard](integration.png){ class="bordered" } + +## Usage + +Open the module by selecting :eccenca-module-integrations: **Service integrations** in the main navigation. +Each configured service is shown as a tab and renders with its own controls and filters. + +## Configuration + +Which services are embedded, and under which name they appear, is configured per application view in the +:eccenca-module-workspace-configuration: [Application view](../workspace-configuration/index.md) configuration module. +Different application views can therefore offer different services. diff --git a/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md b/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md index c1f20681d..bf6cf8e45 100644 --- a/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md +++ b/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/property-shapes/index.md @@ -126,7 +126,7 @@ The following placeholders can be used in the SPARQL query text: For proper usage, include `?graph` or `?_graph` in the projection, bound to the IRI of the graph where the relation statement is stored or the context in which it was inferred. -Link changing variables: If you bind the magic variables `?_linkGraph`/`?linkGraph` or `?_linkWorkspace`/`?linkWorkspace`, they override the default link behavior for generated context/workspace parts of links. Use the IRI of the target graph or the ID of the target workspace. The values apply to `?resource` or, if not present, the first variable in the projection. +Link changing variables: If you bind the magic variables `?_linkGraph`/`?linkGraph` or `?_linkWorkspace`/`?linkWorkspace`, they override the default link behavior for generated context/Application view parts of links. Use the IRI of the target graph or the ID of the target Application view. The values apply to `?resource` or, if not present, the first variable in the projection. If the connected property value is a resource, the variables in the projection are used to populate the columns in the complex widget and the advanced editor. diff --git a/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/sparql-constraints/index.md b/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/sparql-constraints/index.md index 50e8a694f..bcb6ed314 100644 --- a/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/sparql-constraints/index.md +++ b/docs/explore-and-author/graph-exploration/building-a-customized-user-interface/sparql-constraints/index.md @@ -29,12 +29,16 @@ Similar to property shapes, SPARQL Constraints needed to be linked from a Node S In our running example, we create a Node Shape for `foaf:Person` resources. Then we add a SPARQL Constrain shape, which checks if the label of these resources contains the term `eccenca`. -### Install Vocabularies +### Install Ontologies / Vocabularies -Go to the **:eccenca-application-vocabularies: [Vocabulary catalog](../../../vocabulary-catalog/index.md)** and install the RDF Schema and FOAF Vocabulary. -Your vocabulary catalog should look like this after installation +Install the RDF Schema and FOAF vocabulary, either as a package from the **Marketplace** or from an RDF file. -![Vocabulary Catalog with Installed Vocabularies](vocabulary-catalog.png){ class="bordered" } + ### Create Shape Catalog diff --git a/docs/explore-and-author/graph-exploration/index.md b/docs/explore-and-author/graph-exploration/index.md index 6279699ed..6843c0890 100644 --- a/docs/explore-and-author/graph-exploration/index.md +++ b/docs/explore-and-author/graph-exploration/index.md @@ -3,7 +3,7 @@ icon: eccenca/application-explore tags: - KnowledgeGraph --- -# Graph Exploration +# Knowledge Graphs ## Introduction @@ -42,7 +42,7 @@ In the main area, the Metadata view of the selected graph appears, showing sev !!! note inline end This default categorization is just a suggestion and can be modified by - changing the workspace configuration in the **CMEM Configuration** graph. + changing the Application view configuration in the **CMEM Configuration** graph. The Graphs are categorized into groups as follows: @@ -67,7 +67,7 @@ To add a new graph to the Graphs list: 1. More concrete, you select a shape here. - This can be configured in the workspace configuration as well. + This can be configured in the Application view configuration as well. ### :eccenca-item-download: Downloading a graph diff --git a/docs/explore-and-author/index.md b/docs/explore-and-author/index.md index 47989f4c5..fb0741744 100644 --- a/docs/explore-and-author/index.md +++ b/docs/explore-and-author/index.md @@ -8,9 +8,10 @@ hide: ![Your are here](overview-explore.drawio.png "You are here") -# :material-star: Explore and Author +# :material-star: Explore In the Explore section you will learn how Corporate Memory allows you to interact with your Enterprise Knowledge Graph. +Exploring includes authoring: besides browsing, searching and visualizing, the modules described here let you create, edit and curate graph content. All relevant modules and functionalities are described. You will also learn how we make use of [SHACL Shapes](https://www.w3.org/TR/shacl/) in order to [customize the way how you can interact with your data](./graph-exploration/building-a-customized-user-interface/index.md). @@ -18,28 +19,59 @@ You will also learn how we make use of [SHACL Shapes](https://www.w3.org/TR/sha
-- :eccenca-application-explore: [Graph Exploration](graph-exploration/index.md) +- :eccenca-application-explore: [Knowledge graphs](graph-exploration/index.md) --- - This module provides a generic and extensible RDF data browser and editor. + The Knowledge graphs module provides a generic and extensible RDF data browser and editor. -- :eccenca-application-vocabularies: [Vocabulary Catalog](vocabulary-catalog/index.md) +- :eccenca-module-bke: [Business knowledge editor](bke-module/index.md) --- - This module allows for managing vocabularies in Corporate Memory that are accessible for the user. + The Business knowledge editor module allows the visual exploration of Knowledge graphs. -- :eccenca-module-thesauri: [Thesauri Management](thesauri-management/index.md) +- :eccenca-application-queries: [Queries](query-module/index.md) --- - The Thesaurus module provides a user interface to create, browse and edit thesaurus resources and general taxonomical data modeled in SKOS. + The Queries module provides a user interface to store, describe, search and edit SPARQL queries. -- :eccenca-application-queries: [Query Module](query-module/index.md) +- :eccenca-module-thesauri: [Thesauri](thesauri-management/index.md) --- - The Query module provides a user interface to store, describe, search and edit SPARQL queries. + The Thesauri module provides a user interface to create, browse and edit thesaurus resources and general taxonomical data modeled in SKOS. + +- :eccenca-module-charts: [Charts](charts-catalog/index.md) + + --- + + The Charts module provides a user interface to define and manage visualizations of your query results and to integrate them into your shape configurations. + +- :eccenca-application-ai-suggestion: [Companion AI chat](companion/index.md) + + --- + + The Companion AI chat allows you to interact with your graphs, vocabularies, resources and queries in a chat-like way. + +- :eccenca-module-integrations: [Service integrations](embedding-services-via-the-integrations-module/index.md) + + --- + + The Service integrations module embeds external web applications, such as dashboard services, directly into the Corporate Memory user interface. + +- :eccenca-artefact-linking: [Link rules](link-rules/index.md) + + --- + + The Link rules module provides a template-based user interface to create, execute and manage rules which link resources of your Knowledge graphs. + +- :eccenca-module-workspace-configuration: [Application view](workspace-configuration/index.md) + + --- + + The Application view module provides a user interface to select, create and configure application views and the modules they offer. +
diff --git a/docs/explore-and-author/link-rules/index.md b/docs/explore-and-author/link-rules/index.md index 9c5f53f67..3533d02b3 100644 --- a/docs/explore-and-author/link-rules/index.md +++ b/docs/explore-and-author/link-rules/index.md @@ -4,13 +4,13 @@ tags: - LinkRules - KnowledgeGraph --- -# Link Rules Module +# Link Rules ## Introduction -The Link Rules module provides mechanisms to simplify creating data linking and to imposes role specific workflows over the whole process. +The Link Rules provides mechanisms to simplify creating data linking and to imposes role specific workflows over the whole process. -Linking tasks allow the creation of links between resources based on rules in the Corporate Memory Build component. Such a linking task demands the configuration of source and target input resource selections (dataset, resource type or additional restrictions), the link type and an output dataset. These configurations demand a thorough understanding of your Knowledge Graph internals and may become a repetitive task. The Link rules module allows to streamline this process in a way that also users with limited understanding of the knowledge graph can create link rules based on pre-defined templates. +Linking tasks allow the creation of links between resources based on rules in the Corporate Memory Build component. Such a linking task demands the configuration of source and target input resource selections (dataset, resource type or additional restrictions), the link type and an output dataset. These configurations demand a thorough understanding of your Knowledge Graph internals and may become a repetitive task. The Link rules allows to streamline this process in a way that also users with limited understanding of the knowledge graph can create link rules based on pre-defined templates. ## Usage @@ -119,7 +119,7 @@ In order to enable users to use the Link Rules Module, the following must be all - **Graph pattern for granting write access** - Pattern according to the *Output Graph Template*, e.g. `http://eccenca.com/user_rules/result_*` -### Workspace configuration +### Application view configuration Enable the *Link Rules* module. diff --git a/docs/explore-and-author/query-module/index.md b/docs/explore-and-author/query-module/index.md index 86b1921ba..c5e2f861c 100644 --- a/docs/explore-and-author/query-module/index.md +++ b/docs/explore-and-author/query-module/index.md @@ -5,7 +5,7 @@ tags: - KnowledgeGraph - Video --- -# Query Module +# Queries ## Introduction diff --git a/docs/explore-and-author/thesauri-management/index.md b/docs/explore-and-author/thesauri-management/index.md index 94128e208..93d175981 100644 --- a/docs/explore-and-author/thesauri-management/index.md +++ b/docs/explore-and-author/thesauri-management/index.md @@ -3,7 +3,7 @@ icon: eccenca/module-thesauri tags: - Vocabulary --- -# Thesauri Management +# Thesauri ## Introduction @@ -30,7 +30,9 @@ The Thesaurus module allows to create, browse and edit such structures, providin !!! info - Before you start working with the Thesaurus module ensure that the vocabulary *Simple Knowledge Organization System* is installed in the Vocabulary catalog (see section [Vocabulary Catalog](../vocabulary-catalog/index.md)). + Before you start working with the Thesaurus module ensure that the vocabulary *Simple Knowledge Organization System* (SKOS) is installed. + Install it as a package from the **Marketplace**, or from an RDF file. + Click **:eccenca-module-thesauri: Thesauri** in the main menu, to open the Thesaurus project catalog. diff --git a/docs/explore-and-author/workspace-configuration/add-workspace.png b/docs/explore-and-author/workspace-configuration/add-workspace.png index 3157aae15..7e10f979e 100644 Binary files a/docs/explore-and-author/workspace-configuration/add-workspace.png and b/docs/explore-and-author/workspace-configuration/add-workspace.png differ diff --git a/docs/explore-and-author/workspace-configuration/application-view-details.png b/docs/explore-and-author/workspace-configuration/application-view-details.png new file mode 100644 index 000000000..580ce7bb1 Binary files /dev/null and b/docs/explore-and-author/workspace-configuration/application-view-details.png differ diff --git a/docs/explore-and-author/workspace-configuration/configuration.png b/docs/explore-and-author/workspace-configuration/configuration.png index cc8c594f1..b691aaad7 100644 Binary files a/docs/explore-and-author/workspace-configuration/configuration.png and b/docs/explore-and-author/workspace-configuration/configuration.png differ diff --git a/docs/explore-and-author/workspace-configuration/create-new-workspace.png b/docs/explore-and-author/workspace-configuration/create-new-workspace.png index a1de69403..aa403fc7e 100644 Binary files a/docs/explore-and-author/workspace-configuration/create-new-workspace.png and b/docs/explore-and-author/workspace-configuration/create-new-workspace.png differ diff --git a/docs/explore-and-author/workspace-configuration/delete-application-view.png b/docs/explore-and-author/workspace-configuration/delete-application-view.png new file mode 100644 index 000000000..c2520e14b Binary files /dev/null and b/docs/explore-and-author/workspace-configuration/delete-application-view.png differ diff --git a/docs/explore-and-author/workspace-configuration/delete-select.png b/docs/explore-and-author/workspace-configuration/delete-select.png index 91e4576d2..9d15b1017 100644 Binary files a/docs/explore-and-author/workspace-configuration/delete-select.png and b/docs/explore-and-author/workspace-configuration/delete-select.png differ diff --git a/docs/explore-and-author/workspace-configuration/delete-stepresult.png b/docs/explore-and-author/workspace-configuration/delete-stepresult.png deleted file mode 100644 index 09a9c746a..000000000 Binary files a/docs/explore-and-author/workspace-configuration/delete-stepresult.png and /dev/null differ diff --git a/docs/explore-and-author/workspace-configuration/delete.png b/docs/explore-and-author/workspace-configuration/delete.png index 74553d037..241c1fd5b 100644 Binary files a/docs/explore-and-author/workspace-configuration/delete.png and b/docs/explore-and-author/workspace-configuration/delete.png differ diff --git a/docs/explore-and-author/workspace-configuration/details.png b/docs/explore-and-author/workspace-configuration/details.png index c1058a042..e680a3c53 100644 Binary files a/docs/explore-and-author/workspace-configuration/details.png and b/docs/explore-and-author/workspace-configuration/details.png differ diff --git a/docs/explore-and-author/workspace-configuration/enable.png b/docs/explore-and-author/workspace-configuration/enable.png deleted file mode 100644 index cd7d3a0f8..000000000 Binary files a/docs/explore-and-author/workspace-configuration/enable.png and /dev/null differ diff --git a/docs/explore-and-author/workspace-configuration/index.md b/docs/explore-and-author/workspace-configuration/index.md index 40eada9f8..274f5c6f7 100644 --- a/docs/explore-and-author/workspace-configuration/index.md +++ b/docs/explore-and-author/workspace-configuration/index.md @@ -1,87 +1,69 @@ --- -icon: eccenca/application-config +icon: eccenca/module-workspace-configuration tags: - KnowledgeGraph --- -# Workspaces +# Application view -The specific configuration of the application defines which options are available here, i.e. whether you can select one of several workspaces, access only a default workspace or are allowed to create own workspaces. +An Application view determines which modules are available in the Corporate Memory +user interface. The Application view configuration module lets you select the +Application view you work in, configure its details, and create or delete +Application views. -## Select a workspace +## Select an Application view -To select a workspace click on the **user icon** on the right side of the page +To select an Application view click on the **user icon** in the top right corner. ![User menu](user.png){ class="bordered" } -Click the drop-down list and click the workspace you want to open. +Click the drop-down list and click the Application view you want to open. -![Workspace selector](workspace.png){ class="bordered" } +![Application view selector](workspace.png){ class="bordered" } -!!! success "Step Result" +## Configure an Application view - The workspace opens and now you can enable or disabled the modules and change modeule configuration as per your requirement. - - ![Configuration module de-/activation](enable.png){ class="bordered" } - -## Configure a workspace - -Click on the **user icon** on the right side of the page then click on **Configuration**. +Click the :eccenca-module-workspace-configuration: **Application view configuration** icon in the main menu. ![Configuration module](configuration.png){ class="bordered" } -Click on **Workspace** then select the workspace you want to see the details. +Select the Application view from the dropdown menu to configure. -![Select workspace to configure](select-workspace.png){ class="bordered" } +![Select Application view to configure](select-workspace.png){ class="bordered" width="70%" } - Click on down arrow to expand the **Workspace** and **DI Workspace Configuration** to see the configuration details as shown below. +Click the down arrows to expand the sections to configure the details as shown below (like **Application view** or **Build configuration**). +![Configuration module settings](application-view-details.png){ class="bordered" } ![Configuration module settings](details.png){ class="bordered" } -## Add a Workspace +## Add an Application view -Click on the **user icon** on the right side of the page then click on **Configuration**. +Click on :eccenca-module-workspace-configuration: **Application view configuration** icon in the main menu then click on **Create new application view** -![Configuration module](configuration.png){ class="bordered" } - -Click on **Workspace** on the left side of the page then click on **Create New Workspace** - -![Create workspace](create-new-workspace.png){ class="bordered" } +![Create Application view](create-new-workspace.png){ class="bordered" } Type the **Id** and **Label** name then click on **Add** -![Add new workspace](add-workspace.png){ class="bordered" } - -!!! success "Step Result" +![Add new Application view](add-workspace.png){ class="bordered" width="50%" } - The workspace created sucessfully and now you can enable or disabled the modules and change modeule configuration as per your requirement. +## Delete an Application view - ![Workspace created](enable.png){ class="bordered" } +Click on :eccenca-module-workspace-configuration: **Application view configuration** icon in the main menu then click on **Application view** + +![Delete Application view](delete-application-view.png){ class="bordered" } -## Delete a workspace +Select the Application view from the drop-down you want to delete -Click on **User Icon** on the right side of the page then click on **Configuration** then click on **Workspace** - -![Create workspace](create-new-workspace.png){ class="bordered" } - -Select the Workspace from the drop-down you want to delete - -![Select workspace to configure](select-workspace-1.png){ class="bordered" } +![Select Application view to configure](select-workspace-1.png){ class="bordered" } Click on the **Delete Icon** on the right side of the page. -![Delete selected workspace](delete.png){ class="bordered" } +![Delete selected Application view](delete.png){ class="bordered" } Click on **Delete** -![Delete confirmation dialog](delete-select.png){ class="bordered" } - -!!! success "Step Result" - - The workspace has been deleted. - - ![Deletion result](delete-stepresult.png){ class="bordered" } +![Delete confirmation dialog](delete-select.png){ class="bordered" width="50%" } !!! note - When you delete a workspace, no graphs or Build projects are deleted. + When you delete an Application view, no graphs or Build projects are deleted. diff --git a/docs/explore-and-author/workspace-configuration/select-workspace-1.png b/docs/explore-and-author/workspace-configuration/select-workspace-1.png index 697691353..27b4520ed 100644 Binary files a/docs/explore-and-author/workspace-configuration/select-workspace-1.png and b/docs/explore-and-author/workspace-configuration/select-workspace-1.png differ diff --git a/docs/explore-and-author/workspace-configuration/select-workspace.png b/docs/explore-and-author/workspace-configuration/select-workspace.png index 0b0f952ad..2851c2e4c 100644 Binary files a/docs/explore-and-author/workspace-configuration/select-workspace.png and b/docs/explore-and-author/workspace-configuration/select-workspace.png differ diff --git a/docs/explore-and-author/workspace-configuration/user.png b/docs/explore-and-author/workspace-configuration/user.png index 6496b96ed..ed112c870 100644 Binary files a/docs/explore-and-author/workspace-configuration/user.png and b/docs/explore-and-author/workspace-configuration/user.png differ diff --git a/docs/explore-and-author/workspace-configuration/workspace.png b/docs/explore-and-author/workspace-configuration/workspace.png index e949f6872..79a3cff65 100644 Binary files a/docs/explore-and-author/workspace-configuration/workspace.png and b/docs/explore-and-author/workspace-configuration/workspace.png differ diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 6c6de8e94..f088dfed5 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -51,11 +51,11 @@ After you logged in to your Corporate Memory instance, the main application view To log out, open the menu :material-dots-vertical: in the Module bar and click Logout. -## Workspaces +## Application views -The specific configuration of the application defines which options are available here, i.e. whether you can select one of several workspaces, access only a default workspace or are allowed to create own workspaces. +The specific configuration of the application defines which options are available here, i.e. whether you can select one of several Application views, access only a default Application view or are allowed to create own Application views. -See the [workspaces](../explore-and-author/workspace-configuration/index.md) section for more details. +See the [Application views](../explore-and-author/workspace-configuration/index.md) section for more details. ## User interface and modules @@ -71,11 +71,12 @@ To access a module, click the module name. The active module is highlighted. By default, Corporate Memory provides the following modules: -- EXPLORE - for Knowledge Graph browsing and exploration, specifically - - [Knowledge Graphs](../explore-and-author/index.md) - a generic and extensible RDF data browser and editor - - [Vocabularies](../explore-and-author/vocabulary-catalog/index.md) - for vocabulary management - - [Thesauri](../explore-and-author/thesauri-management/index.md) - for managing thesauri and taxonomies based on SKOS +- [EXPLORE](../explore-and-author/index.md) - for Knowledge Graph browsing and exploration, specifically + - [Knowledge Graphs](../explore-and-author/graph-exploration/index.md) - a generic and extensible RDF data browser and editor + - [Business knowledge editor](../explore-and-author/bke-module/index.md) - for visual graph interaction - [Queries](../explore-and-author/query-module/index.md) - a SPARQL query interface + - [Thesauri](../explore-and-author/thesauri-management/index.md) - for managing thesauri and taxonomies based on SKOS + - [Charts](../explore-and-author/charts-catalog/index.md) - for data visualization - [BUILD](../build/index.md) - for creating and integrating Knowledge Graphs, with specific links to - Projects - the BUILD Projects level - Datasets - the Datasets across all BUILD Projects diff --git a/docs/getting-started/with-your-sandbox/index.md b/docs/getting-started/with-your-sandbox/index.md index 6fbe797cd..bd167cf63 100644 --- a/docs/getting-started/with-your-sandbox/index.md +++ b/docs/getting-started/with-your-sandbox/index.md @@ -33,7 +33,7 @@ eccenca's Corporate Memory is a platform for creating and managing Enterprise Kn --- - The sandbox includes a sample build project named _"Product Data Integration Demo"_ and the graphs generated by that project, as well as an integration graph as an entry point: _"Products - Integration"_. Shacl shapes are provided for the product vocabulary. These are used in the Business Knowledge Editor module for visual exploration as well as in a custom workspace configuration called _Product Data Integration_ to demonstrate how the user interface can be customized. + The sandbox includes a sample build project named _"Product Data Integration Demo"_ and the graphs generated by that project, as well as an integration graph as an entry point: _"Products - Integration"_. Shacl shapes are provided for the product vocabulary. These are used in the Business Knowledge Editor module for visual exploration as well as in a custom Application view configuration called _Product Data Integration_ to demonstrate how the user interface can be customized. - :fontawesome-solid-graduation-cap:{ .lg .middle } __Masterclass Material__