Skip to content

Commit e1cfdd4

Browse files
committed
initial review with aw.
1 parent cd84fe5 commit e1cfdd4

2 files changed

Lines changed: 32 additions & 13 deletions

File tree

docs/build/mapping-creator/index.md

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

10-
??? info "Configuration"
10+
## Configuration
11+
12+
!!! info "Configuration"
1113

1214
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.
1315

14-
!!! question "Inline help"
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+
19+
## Usage
1520

16-
![Inline Help](mapping-creator-help.png){ class="bordered" width="20%" align=right padding=40 }
21+
!!! question "Help"
1722

18-
Access inline help and a feature tour via the help menu :eccenca-item-question:.
23+
![Help](mapping-creator-help.png){ class="bordered" width="20%" align=right padding=40 }
1924

25+
Access help and a feature tour via the help menu :eccenca-item-question:.
26+
27+
**TODO:** describe how to get there in the first place!!! BUILD > Project > [ Workflow > ] Transformation > Mapping Creator
2028

2129
Use the Mapping Creator to connect your data to semantic models.
2230
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.
@@ -29,21 +37,32 @@ The Mapping Creator is split into three parts:
2937
- The right sidebar shows the target schema
3038
- Mappings between elements in the source schema and elements in the target schema.
3139

40+
**TODO**: rename _sidebar_ and describe the actual _sidebars_ properly (left: schema information, right: see below (Edit saved mapping rule))
41+
3242
You can move, connect or disconnect, and inspect each element visually.
3343

34-
## Manual creation
44+
### Color Legend
45+
46+
**TODO:** show the color legend here, too
47+
48+
<figure markdown="span">
49+
![Color Legend](mapping-creator-color-legend.png){ class="bordered" }
50+
<figcaption>Color Legend Image Caption</figcaption>
51+
</figure>
52+
53+
### Manual creation
3554

3655
Every mapping begins by selecting or creating a target class.
3756
This defines where your data will be be mapped in the knowledge graph.
3857

39-
### Add properties
58+
#### Add properties
4059

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

4362
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).
4463
The following two options exist to add properties.
4564

46-
#### During class selection
65+
##### During class selection
4766

4867
![Properties option in the class selection dialog](mapping-creator-class-selection.png){ class="bordered" width="80%" }
4968

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

5675
The property preview helps to confirm your choice.
5776

58-
#### By adding a property from your vocabularies
77+
##### By adding a property from your vocabularies
5978

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

@@ -64,28 +83,28 @@ The _add property from vocabularies_ dialog allows to search and select a proper
6483
- redefine the role of a property, to use a DatatypeProperty in the role of an ObjectProperty, or vice versa
6584
- define the _direction_ an ObjectProperty should be used in
6685

67-
### Create direct mappings
86+
#### Create direct mappings
6887

6988
Drag from a property in your source data to a class or property in the canvas to create your mapping.
7089
This is helpful when smart suggestions are not sufficient.
7190

72-
### Edit saved mapping rule
91+
#### Edit saved mapping rule
7392

7493
![Editing a saved rule](mapping-creator-edit-rule.png){ class="bordered" width="60%" }
7594

7695
Click on an already saved target element to show more details.
7796
With the :eccenca-item-edit: Pencil icon you can edit the mapping rule and rename elements, or adjust configurations.
7897
Advanced users can refine transformation logic here.
7998

80-
## Smart suggestions
99+
### Smart suggestions
81100

82101
!!! info
83102
Note that this feature is only available if a Large Language Model is configured.
84103

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

88-
### Class Suggestions
107+
#### Class Suggestions
89108

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

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

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

97-
### Property Suggestions
116+
#### Property Suggestions
98117

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

0 commit comments

Comments
 (0)