Skip to content

Commit

Permalink
Merge pull request #168 from eccenca/feature/easynav-renamed-bke
Browse files Browse the repository at this point in the history
Feature/easynav renamed bke
  • Loading branch information
seebi authored Oct 2, 2024
2 parents e225558 + 00263b5 commit ce83040
Show file tree
Hide file tree
Showing 19 changed files with 27 additions and 57 deletions.
1 change: 0 additions & 1 deletion docs/deploy-and-configure/configuration/datamanager/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ nav:
- workspaces-authorization
- dataset-module
- explore-module
- easynav-module
- graph-resource-pattern
- query-module
- vocabs-module
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ tags:

# Graph Resource Pattern

This chapter specifies the JSON object used to provide a EasyNav Search (query) configuration.
The `GraphResourcePattern` is part of an optional advanced configuration of the EasyNav module.
This chapter specifies the JSON object used to provide a Business Knowledge Editor search (query) configuration.
The `GraphResourcePattern` is part of an optional advanced configuration of the Business Knowledge Editor module.
It can be used to provide search filter / facets in order to tailor the search results presented to the end user.

The `GraphResourcePattern` object reference is provided in different ways depending on your preferences:
Expand Down Expand Up @@ -205,7 +205,7 @@ The `GraphResourcePattern` object reference is provided in different ways depend
}
```

A _human friendly_ representation can be generatled using [json-schema-for-humans](https://json-schema-viewer.vercel.app/view?url=https%3A%2F%2Fdev.documentation.eccenca.com%2Fexplore-and-author%2Feasynav-module%2FGraphResourcePattern%2Fschema.json&description_is_markdown=on&expand_buttons=on&show_breadcrumbs=on&with_footer=on&template_name=js#pathFilters).
A _human friendly_ representation can be generatled using [json-schema-for-humans](https://json-schema-viewer.vercel.app/view?url=https%3A%2F%2Fdev.documentation.eccenca.com%2Fdeploy-and-configure%2Fconfiguration%2Fdatamanager%2Fgraph-resource-pattern%2Fschema.json&description_is_markdown=on&expand_buttons=on&show_breadcrumbs=on&with_footer=on&template_name=js#pathFilters).

A valid configuration must use a `subjectVarName` called `resource`. This is the binding that yields results.

Expand Down
2 changes: 1 addition & 1 deletion docs/explore-and-author/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ nav:
- Explore and Author: index.md
- Workspace Selection and Configuration: workspace-configuration
- Graph Exploration: graph-exploration
- EasyNav Module: easynav-module
- Business Knowledge Editor Module: bke-module
- Query Module: query-module
- Thesauri Management: thesauri-management
- Vocabulary Catalog: vocabulary-catalog
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
icon: eccenca/module-easynav
icon: eccenca/module-bke
status: new
tags:
- KnowledgeGraph
---

# EasyNav Module
# Business Knowledge Editor Module

## Introduction

Expand All @@ -17,17 +17,17 @@ Furthermore, sophisticated individual search settings (filter presets) can be cr

If enabled, content of Knowledge Graphs can be explored in a visual way, rendering nodes and edges and allowing the user to expand along the relationships between the nodes.

Start using `EasyNav` by selecting the respective module entry in the main navigation.
Start using `Business Knowledge Editor` by selecting the respective module entry in the main navigation.

![](easynav-start.png)

At the module welcome screen the user can either load a saved visualization of start searching for an initial node / resource by providing a search term.

!!! Note

The graph selection drop-down might or might not be visible depending the existence of an (optional) `EasyNav Module` configuration.
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 `EasyNav Module` configuration pre-configures a graph.
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.

![Initial search on the welcome screen.](easynav-welcome-search.png)
Expand Down Expand Up @@ -58,34 +58,34 @@ The `Visualization catalog` dialog shows the saved exploration and allows to :oc

## Setup

This feature needs to be initially enabled in the DataManager configuration file (`application.yml`).
See [configuration of EasyNav module](../../deploy-and-configure/configuration/datamanager/easynav-module/index.md) for details how to enable it.
This feature is enabled by default.
It can be customized or disabled in the respective workspace 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.

Optionally a `EasyNav Module` configuration can be created to provide a fixed graph selection and search filter settings.
Optionally a `Business Knowledge Editor Module` configuration can be created to provide a fixed graph selection and search filter settings.

### Create a EasyNav Module Configuration
### Create a Business Knowledge Editor Module Configuration

![Create a `EasyNav Module` Configuration](easynav-config-EasyNavModule.png)
![Create a `Business Knowledge Editor Module` Configuration](easynav-config-EasyNavModule.png)

In the `Knowledge Graphs` module navigate to the `CMEM Configuration` graph.

Select the class `EasyNav Module` and `Create a new "EasyNav Module"`.
Select the class `Business Knowledge Editor Module` and `Create a new "Business Knowledge Editor Module"`.

![New `EasyNav Module` dialog](easynav-config-newEasyNavModule-dialog.png)
![New `Business Knowledge Editor Module` 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 EasyNav Module in the Workspace configuration
### Set the Business Knowledge Editor Module in the Workspace configuration

![Select `EasyNav Module` in `Workspace` configuration](easynav-config-select-in-workspace.png)
![Select `Business Knowledge Editor Module` in `Workspace` configuration](easynav-config-select-in-workspace.png)

After creating the `EasyNav Module` configuration it need to be selected in workspace configuration(s) that shall be using it.
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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,15 +134,15 @@ Used Path: `shacl:property`
### Path


The datatype or object property used in this shape. This path will be ignored if there is a table report defined for the property shape. However, in Easynav, this path can always be used for exploration.
The datatype or object property used in this shape. This path will be ignored if there is a table report defined for the property shape. However, in Business Knowledge Editor, this path can always be used for exploration.

Used Path: `shacl:path`


### Node kind


The type of the linked nodes. In Easynav, if these nodes are literals, they cannot be explored, but will be shown as metadata.
The type of the linked nodes. In Business Knowledge Editor, if these nodes are literals, they cannot be explored, but will be shown as metadata.

Used Path: `shacl:nodeKind`

Expand Down Expand Up @@ -224,7 +224,7 @@ Used Path: `shacl:uniqueLang`
### Class


Class of the connected IRI if its nodeKind is sh:IRI. In Easynav, any new node that a user creates by means of this property shape, will be an instance this class.
Class of the connected IRI if its nodeKind is sh:IRI. In Business Knowledge Editor, any new node that a user creates by means of this property shape, will be an instance this class.

Used Path: `shacl:class`

Expand All @@ -236,7 +236,7 @@ This query allows for listing selectable resources in the dropdown list for this

You need to provide the projection variable `resource` in your query.

Beta Feature: This query will be used as well to populate the selectable resources for the advanced editor and the candidate resources in EasyNav.
Beta Feature: This query will be used as well to populate the selectable resources for the advanced editor and the candidate resources in Business Knowledge Editor.

Used Path: `shui:uiQuery`

Expand Down Expand Up @@ -304,7 +304,7 @@ The following placeholder can be used in the query text of the SPARQL query:
- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage) ;
- `{{shuiResource}}` - refers to the resource which is rendered in the node shape where this property shape is used (maybe a sub-shape) ;
- `{{shuiGraph}}` - the currently used graph.


Used Path: `shui:onInsertUpdate`

Expand All @@ -318,7 +318,7 @@ The following placeholder can be used in the query text of the SPARQL query:

- `{{shuiMainResource}}` - refers to the main resource rendered in the start node shape of the currently displayed node shape tree (only relevant in case of sub-shape usage) ;
- `{{shuiGraph}}` - the currently used graph.


Used Path: `shui:onDeleteUpdate`

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/with-your-sandbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 EasyNav 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 workspace configuration called _Product Data Integration_ to demonstrate how the user interface can be customized.

- :fontawesome-solid-graduation-cap:{ .lg .middle } __Masterclass Material__

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/corporate-memory-23-3/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The highlights of this release are:

- Explore and Author:
- new **[charts catalog](../../explore-and-author/charts-catalog/index.md)** module added, which allows for defining BI widgets / charts which can be integrated into shapes
- preview release of our generative AI / LLM based **[Ontology](../../explore-and-author/easynav-module/index.md#llm-ontology-assist) and [Query](../../explore-and-author/query-module/index.md#llm-query-assist) Assistant**
- preview release of our generative AI / LLM based **[Ontology](../../explore-and-author/bke-module/index.md#llm-ontology-assist) and [Query](../../explore-and-author/query-module/index.md#llm-query-assist) Assistant**
- Build:
- operate BUILD like never before by using the new **keyboard shortcuts** (press "?" in the build module to learn the details)
- several **improvements to the workflows view**: create new datasets and other workflow-operators in place, dependencies and execution order is now explicitly modeled, show schema or ports
Expand Down
File renamed without changes

0 comments on commit ce83040

Please sign in to comment.