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
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

4 changes: 2 additions & 2 deletions docs/explore-and-author/bke-module/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ tags:
- 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.

Expand Down
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 workspace.

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 @@ -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
2 changes: 1 addition & 1 deletion 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
19 changes: 10 additions & 9 deletions docs/explore-and-author/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,38 +8,39 @@ 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).

**:octicons-people-24: Intended audience:** Linked Data Experts and Domain Experts

<div class="grid cards" markdown>

- :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.

</div>
6 changes: 3 additions & 3 deletions docs/explore-and-author/link-rules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/explore-and-author/query-module/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tags:
- KnowledgeGraph
- Video
---
# Query Module
# Queries

## Introduction

Expand Down
6 changes: 4 additions & 2 deletions docs/explore-and-author/thesauri-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ icon: eccenca/module-thesauri
tags:
- Vocabulary
---
# Thesauri Management
# Thesauri

## Introduction

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

Expand Down
9 changes: 5 additions & 4 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading