Skip to content
Open
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
2 changes: 1 addition & 1 deletion docs/.pages
Original file line number Diff line number Diff line change
@@ -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
Expand Down
13 changes: 7 additions & 6 deletions docs/build/define-prefixes-namespaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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" }

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-and-configure/configuration/explore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
<!--TODO: Update screenshot-->
![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.

Expand Down
21 changes: 10 additions & 11 deletions docs/explore-and-author/.pages
Original file line number Diff line number Diff line change
@@ -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

51 changes: 18 additions & 33 deletions docs/explore-and-author/bke-module/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ tags:
- KnowledgeGraph
- Video
---

# Business Knowledge Editor Module
<!--TODO: Update all screenshots-->
<!--TODO: revise as defaults have changed-->
# 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

Expand All @@ -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)

Expand Down Expand Up @@ -59,47 +60,31 @@ 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.

`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.
31 changes: 18 additions & 13 deletions docs/explore-and-author/charts-catalog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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**.

Expand All @@ -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.

Expand Down
7 changes: 3 additions & 4 deletions docs/explore-and-author/companion/index.md
Original file line number Diff line number Diff line change
@@ -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"

Expand Down Expand Up @@ -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%" }

Expand Down Expand Up @@ -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" }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
<!-- TODO: the Vocabulary catalog was replaced by the Marketplace / package concept.
Re-take the screenshot with the new installation flow, then re-enable the two lines below.


![Marketplace with Installed Vocabularies](vocabulary-catalog.png){ class="bordered" }
-->

### Create Shape Catalog

Expand Down
6 changes: 3 additions & 3 deletions docs/explore-and-author/graph-exploration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ icon: eccenca/application-explore
tags:
- KnowledgeGraph
---
# Graph Exploration
# Knowledge Graphs

## Introduction

Expand Down Expand Up @@ -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:

Expand All @@ -67,7 +67,7 @@ To add a new graph to the Graphs list:
</div>

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

Expand Down
Loading
Loading