Skip to content

Commit d1c3d72

Browse files
committed
add configuration section and cross references, https://jira.eccenca.com/browse/CMEM-6923
1 parent 070c14e commit d1c3d72

2 files changed

Lines changed: 81 additions & 4 deletions

File tree

  • docs
    • build/mapping-creator
    • deploy-and-configure/configuration/dataintegration

docs/build/mapping-creator/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ tags:
77
---
88
# Mapping Creator
99

10-
!!! info
10+
??? info "Configuration"
11+
12+
See [Mapping Creator and LLM Configuration](../../deploy-and-configure/configuration/dataintegration/#mapping-creator-and-llm-configuration) to learn how to enable and configure this feature.
13+
14+
!!! question "Inline help"
1115

1216
Access inline help and a feature tour via the help menu :eccenca-item-question:.
1317

docs/deploy-and-configure/configuration/dataintegration/index.md

Lines changed: 76 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This section is intended to be a reference for all available eccenca Build (Data
88
The configuration format is based on [HOCON](https://github.com/typesafehub/config).
99

1010
The following sections introduce the most important configuration parameters.
11-
The entire list of available configuration parameters can be found in the dataintegration.conf file found in the release package.
11+
The entire list of available configuration parameters can be found in the `dataintegration.conf` file found in the release package.
1212

1313
## OAuth
1414

@@ -62,7 +62,7 @@ oauth.clientSecret = "secret"
6262
# oauth.requestParameters = "&resource=value"
6363
```
6464

65-
## Explore configuration
65+
## Explore Configuration
6666

6767
eccenca Build (DataIntegration) can only be run by OAuth users that are granted the `https://vocab.eccenca.com/auth/Action/Build` action by the Explore component (aka DataPlatform/DataManager).
6868
An example condition can be seen at [Access Conditions > Access to Build (DataIntegration)](../access-conditions/index.md#access-to-dataintegration)
@@ -687,7 +687,7 @@ pluginRegistry {
687687
}
688688
```
689689

690-
## Spark configuration
690+
## Spark Configuration
691691

692692
The following chapters describe configuration options relevant for the execution of eccenca Build (DataIntegration) workflows on Spark. All options regarding the execution of Build (DataIntegration) on Spark are set in the `dataintegration.conf` file. The option to define SparkExecutor as the execution engine is `execution.manager.plugin` and needs to be changed from the default value:
693693

@@ -1020,3 +1020,76 @@ spark.interpreter.options = {
10201020
enableHiveSupport = false
10211021
}
10221022
```
1023+
1024+
## Mapping Creator and LLM Configuration
1025+
1026+
Enable (or disable) the new visual [Mapping Create UI](../../../build/mapping-creator/index.md) with `com.eccenca.di.mappingCreatorEnabled = true` (or `false` to disable).
1027+
1028+
```bash linenums="1"
1029+
#################################################
1030+
### Mapping creator
1031+
#################################################
1032+
1033+
com.eccenca.di.mappingCreatorEnabled = true
1034+
```
1035+
1036+
The [Mapping Creator can optionally use LLM](../../../build/mapping-creator/index.md#smart-suggestions) to automatically generate class and property mappings.
1037+
Use the following configuration section as a blueprint to set up your OpenAI-compatible endpoint, providing:
1038+
1039+
- the API key,
1040+
- a model,
1041+
- reasoning level,
1042+
- and (optionally) benchmarking outputs.
1043+
1044+
```bash linenums="1"
1045+
#################################################
1046+
### AI assistant
1047+
#################################################
1048+
1049+
# Preliminary LLM config. Will be changed in the future.
1050+
com.eccenca.di.assistant = {
1051+
ApiConfig = {
1052+
# API key
1053+
# apiKey = ""
1054+
1055+
# Optional organisation id for OpenAI accounts
1056+
# orgId = ""
1057+
1058+
# Model to use for mapping suggestions
1059+
model = "gpt-5-mini"
1060+
1061+
# URL of OpenAI-compatible endpoint, leave empty for official OpenAI API
1062+
# coreUrl = "https://openrouter.ai/api/v1"
1063+
1064+
# Controls how many reasoning tokens the model generates before producing a response.
1065+
# One of "low", "medium, "high". Set to null for default.
1066+
reasoningEffort = "low"
1067+
1068+
# Extra parameters to be passed to the API
1069+
# extraParameters = {
1070+
# provider = {
1071+
# require_parameters: true
1072+
# }
1073+
# }
1074+
1075+
# Log prompts and responses
1076+
logQueries = false
1077+
}
1078+
1079+
BenchmarkConfig = {
1080+
# If set, only this project / transform task / mapping will be benchmarked
1081+
# project = "myProject"
1082+
# transform = "myTransform"
1083+
mapping = "root"
1084+
1085+
# Number of runs for each benchmark
1086+
numberOfRuns = 10
1087+
1088+
# If true, an HTML report will be generated in addition to the Markdown report
1089+
generateHtml = true
1090+
1091+
# Directory where benchmark results are stored
1092+
outputDirectory = "benchmark_results"
1093+
}
1094+
}
1095+
```

0 commit comments

Comments
 (0)