Skip to content

Commit 7b29391

Browse files
committed
incorporate AW feedback
1 parent f9aaebb commit 7b29391

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

docs/build/mapping-creator/index.md

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,60 +7,66 @@ tags:
77
---
88
# Mapping Creator
99

10-
## Configuration
10+
## Configuration Info
11+
12+
A specific configuration is require to activate this feature.
13+
Furthermore, for best experience an LLM provider configuration is also needed.
14+
See the link in the info box for details.
1115

1216
!!! info "Configuration"
1317

1418
See [Mapping Creator and LLM Configuration](../../deploy-and-configure/configuration/dataintegration/index.md#mapping-creator-and-llm-configuration) to learn how to enable and configure this feature.
1519

16-
The Mapping Creator need to configured in order to be activated and used.
17-
Furthermore, for best experience it requires an LLM provider configuration, see the link in the info box for the details.
18-
1920
## Usage
2021

22+
The Mapping Creator is a feature of BUILD transformation tasks (_BUILD_> _Project_> (_Workflow_>) _Transformation_> _Mapping Creator_).
23+
2124
!!! question "Help"
2225

2326
![Help](mapping-creator-help.png){ class="bordered" width="20%" align=right padding=40 }
2427

2528
Access help and a feature tour via the help menu :eccenca-item-question:.
2629

27-
**TODO:** describe how to get there in the first place!!! BUILD > Project > [ Workflow > ] Transformation > Mapping Creator
28-
2930
Use the Mapping Creator to connect your data to semantic models.
30-
Using visual tools, drag-and-drop, and suggestions, you’ll create mappings between your source data and knowledge graph classes as well as their properties.
31+
Using visual tools, drag-and-drop, and suggestions, you are able to create mappings between your source data and knowledge graph classes as well as their properties.
3132

3233
![Mapping Creator](mapping-creator.png){ class="bordered" }
3334

34-
The Mapping Creator is split into three parts:
35-
36-
- The left sidebar shows the source schema
37-
- The right sidebar shows the target schema
38-
- Mappings between elements in the source schema and elements in the target schema.
35+
The Mapping Creator consists of three parts:
3936

40-
**TODO**: rename _sidebar_ and describe the actual _sidebars_ properly (left: schema information, right: see below (Edit saved mapping rule))
37+
- Source schema shown on the left side
38+
- Target Schema shown on the right side
39+
- Mappings between elements in the source schema and in the target schema
4140

4241
You can move, connect or disconnect, and inspect each element visually.
4342

43+
<!--
44+
**TODO**: Clicking on an element in the source schema opens a detail view showing more schema information and describe the actual _sidebars_ properly (left: schema information, right: see below (Edit saved mapping rule)) **TODO**:@rpietzsch please add Details...
45+
-->
46+
4447
### Color Legend
4548

49+
Each color and visual element used in the Mapping Creator has a specific meaning as shown in the screenshot below.
50+
4651
**TODO:** show the color legend here, too
4752

48-
<figure markdown="span">
49-
![Color Legend](mapping-creator-color-legend.png){ class="bordered" }
50-
<figcaption>Color Legend Image Caption</figcaption>
51-
</figure>
53+
![Color Legend](mapping-creator-color-legend.png){ class="bordered" }
5254

5355
### Manual creation
5456

55-
Every mapping begins by selecting or creating a target class.
56-
This defines where your data will be be mapped in the knowledge graph.
57+
To start a mapping you need to select or define a target class first.
58+
The target class defines where your data will be be mapped in the knowledge graph.
5759

5860
#### Add properties
5961

6062
![Resource edit actions](mapping-creator-edit-actions.png){ class="bordered" width="40%" }
6163

6264
To complete a mapping properties need to be added to complete your desired target schema (i.e. the graph fragment that your transformation shall yield).
63-
The following two options exist to add properties.
65+
66+
There are two options to add properties:
67+
68+
- during class selection
69+
- from vocabularies
6470

6571
##### During class selection
6672

@@ -74,7 +80,7 @@ In the _add target class_ dialog you may select different kind of properties:
7480

7581
The property preview helps to confirm your choice.
7682

77-
##### By adding a property from your vocabularies
83+
##### From vocabularies
7884

7985
![Adding a property from your vocabulary](mapping-creator-property-selection.png){ class="bordered" width="80%" }
8086

@@ -96,15 +102,15 @@ Click on an already saved target element to show more details.
96102
With the :eccenca-item-edit: Pencil icon you can edit the mapping rule and rename elements, or adjust configurations.
97103
Advanced users can refine transformation logic here.
98104

99-
### Smart suggestions
105+
### Smart suggestions with AI support
100106

101107
!!! info
102108
Note that this feature is only available if a Large Language Model is configured.
103109

104110
Click the :eccenca-application-ai-suggestion: Magic Wand to automatically generate mapping suggestions based on your data and the selected class.
105111
Accept (:octicons-thumbsup-16:) or reject (:octicons-thumbsdown-16:) each suggestion as needed.
106112

107-
#### Class Suggestions
113+
#### Class suggestions
108114

109115
![Smart Class Suggestions](mapping-creator-class-suggestion.png){ class="bordered" }
110116

@@ -113,7 +119,7 @@ Alternatively, you can search for classes manually by typing text into the searc
113119

114120
Hover over the wand icon for each suggestion to understand why this class has been recommended.
115121

116-
#### Property Suggestions
122+
#### Property suggestions
117123

118124
Property suggestions are generated that map your source data to elements of the selected target vocabularies.
119125
You can accept (:octicons-thumbsup-16:) or reject (:octicons-thumbsdown-16:) each suggestion.

0 commit comments

Comments
 (0)