Environment variables
ERP Connectivity containers must be configured using environment variables. Second option to configure ERP Connectivity is to use HELM charts. ERP Connectivity is already providing a HELM chart. Reading thorugh the environment variables you always find a column "HELM deployment configuration" with information on how to configure these values via HELM chart.
In the HELM chart used and in this operator documentation mentioned variables are listed below. However, there are more variables available than documented, if you are missing something, please reach out to us via the applicable support channels for your case.
Note that some environment variables use single _ and double __ underscores!
|
Feature flags
You must add the prefix NEXEED_ERPCONNECTIVITY_FeatureFlags__ to core variables e.g. NEXEED_ERPCONNECTIVITY_FeatureFlags__ConnectorPackageCreationEnabled
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Flag to enable the Connector Package creation wizard in the WebUI |
No |
false |
Core
You must add the prefix NEXEED_ERPCONNECTIVITY_ to core variables e.g. NEXEED_ERPCONNECTIVITY_Encryption__AESEncryption__EncryptionKey
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Number of seconds to allow ongoing processes for completion upon shutdown request. |
No |
30 |
|
Key used to encrypt passwords stored in the database. Requirements: at least 1 lowercase character, one uppercase character, one number, one special character and at least 100 characters in total. |
Yes |
- |
|
Nexeed Web Portal base URL |
Yes |
- |
|
ERP Connectivity base URL |
No |
- |
|
Enables Swagger UI for public API of ERP Connectivity |
No |
false |
|
ERP Connectivity base URL |
No |
- |
Logging
You must add the prefix NEXEED_ERPCONNECTIVITY_Logging__LogLevel__ to logging variables e.g. NEXEED_ERPCONNECTIVITY_Logging__LogLevel__Default
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Default log level |
No |
Warning |
|
Log level for all Bosch implementations |
No |
Warning |
|
Log level for ERP Connectivity |
No |
Warning |
|
Log level for all dotnet namespaces starting with Microsoft |
No |
Warning |
|
Log level for Microsoft.EntityFrameworkCore.Database.Command namespace |
No |
Warning |
|
Log level for Microsoft.EntityFrameworkCore.ChangeTracking namespace |
No |
Warning |
|
Log level for System.Net.Http namespace |
No |
Warning |
|
Log level for Bosch.Nexeed.ErpConnectivity.Common.Components.Stores namespace |
No |
Warning |
Database
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__Database__ to database variables e.g. NEXEED_ERPCONNECTIVITY_Components__Database__Provider
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
MSSQL or ORACLE. Depends on which database should be used. MSSQL Collation setting: SQL_Latin1_General_CP1_CI_AS |
Yes |
MSSQL |
|
dotnet connection string to connect to database |
Yes |
- |
|
Defines at which interval the automatic database cleanup is performed. This fully removes soft-deleted Connector and Orchestration Packages as well as expired Message Logs and Orchestrator Logs. Note that higher values make the user-configured Log Retention Period less accurate and can lead to confusing results, therefore it is recommended to use a value under 1 hour and tune performance with the following parameters. Default interval is 15 minutes. Format: hh:mm:ss |
No |
00:15:00 |
|
Tunes how many deletable Message-/Orchestrator Logs respectively to fetch from the database per cleanup run. This defines the maximum number of entries that can be deleted each interval. A value of zero disables cleanup-batching, but can put heavy load on the database when there is a high number of pending deletions. |
no |
1000 |
|
Tunes how many of the fetched Message-/Orchestrator Logs to delete at once. A value of zero disables delete-batching, which is equivalent to setting it to the value of fetchBatchSize, but can put heavy load on the database when there is a high number of pending deletions. |
no |
100 |
|
How long to wait between submitting individual delete-batches to the database. The maximum total duration of the cleanup job in seconds can be approximated with the formula (fetchBatchSize/purgeBatchSize)*(purgeIntervalMs/1000). A value of zero disables delete-batching, like for purgeBatchSize. Format: milliseconds |
no |
2000 |
|
The time span that defines how long logs should be retained before they are deleted. When set with an integer value, it is treated as the number of days. For non-integer values, use the TimeSpan format to specify the exact duration. Format: d.hh:mm:ss |
no |
30.00:00:00 |
Messaging
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__Messaging__ to messaging variables e.g. NEXEED_ERPCONNECTIVITY_Components__Messaging__NexeedAccessUrl__UrlPattern
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Exchange name where information about new execution results (including payload) of ConnectorPackages should be published to |
No |
direct-responses.tx |
|
URL pattern on how to access execution results from ConnectorPackages and OrchestratorPackages |
Yes |
https://localhost:8001/api/v1/{tenantId}/{packageType}/{businessArea}/{operation}/result/{resultId} |
Internal broker connection
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__Communication__InternalAmqpOptions__ to internal broker variables e.g. NEXEED_ERPCONNECTIVITY_Components__Communication__InternalAmqpOptions__Hostname
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Hostname of RabbitMQ instance (for ERP Connectivity internal usage) |
Yes |
- |
|
Port of RabbitMQ instance that should be connected to (for ERP Connectivity internal usage) |
No |
5672 |
|
Virtual host of RabbitMQ instance that should be used (for ERP Connectivity internal usage) |
No |
/ |
|
Username for RabbitMQ instance needed for authentication (for ERP Connectivity internal usage) |
Yes |
- |
|
Password for RabbitMQ instance needed for authentication (for ERP Connectivity internal usage) |
Yes |
- |
|
True if SSL should be enabled (for ERP Connectivity internal usage) |
No |
false |
|
SSL Versions to use (only if SSL is enabled) Setting needs to be given in dotnet format - see the Microsoft documentation |
No |
15360 |
|
A readable name for the connection to identify it in logs |
No |
InternalRabbit |
|
Number of retries for connecting to RabbitMQ (for ERP Connectivity internal usage) |
No |
300 |
|
Interval in milliseconds that should be waited before next connection retry attempt (for ERP Connectivity internal usage) |
No |
1000 |
|
How many internal AMQP 0.9.1 messages from the same queue can be processed in parallel (for ERP Connectivity internal usage) |
No |
20 |
External broker connection
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__Communication__ExternalAmqpOptions__ to external broker variables e.g. NEXEED_ERPCONNECTIVITY_Components__Communication__ExternalAmqpOptions__Hostname
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Hostname of RabbitMQ instance |
Yes |
- |
|
Port of RabbitMQ instance that should be connected to |
no |
5672 |
|
Virtual host of RabbitMQ instance that should be used |
Yes |
- |
|
Username for RabbitMQ instance needed for authentication |
Yes |
- |
|
Password for RabbitMQ instance needed for authentication |
Yes |
- |
|
True if SSL should be enabled |
No |
false |
|
SSL Versions to use (only if SSL is enabled) Setting needs to be given in dotnet format - see the Microsoft documentation |
No |
15360 |
|
A readable name for the connection to identify it in logs |
No |
ExternalRabbit |
|
Client Id of ERP Connectivity |
No |
- |
|
True if connection losses should be automatically recovered |
No |
true |
External broker connection for business events including payload
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__Communication__DirectAsyncResponseAmqpOptions__ to external broker variables e.g. NEXEED_ERPCONNECTIVITY_Components__Communication__DirectAsyncResponseAmqpOptions__Hostname
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Hostname of RabbitMQ instance |
Yes |
- |
|
Port of RabbitMQ instance that should be connected to |
no |
5672 |
|
Virtual host of RabbitMQ instance that should be used |
Yes |
- |
|
Username for RabbitMQ instance needed for authentication |
Yes |
- |
|
Password for RabbitMQ instance needed for authentication |
Yes |
- |
|
True if SSL should be enabled |
No |
false |
|
SSL Versions to use (only if SSL is enabled) Setting needs to be given in dotnet format - see https://learn.microsoft.com/de-de/dotnet/api/system.security.authentication.sslprotocols?view=net-6.0 |
No |
15360 |
|
A readable name for the connection to identify it in logs |
No |
DirectAsyncResponseRabbit |
|
Client Id of ERP Connectivity |
No |
- |
|
True if connection losses should be automatically recovered |
No |
true |
Core
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__CodeCompilation__ to package compilation variables e.g. NEXEED_ERPCONNECTIVITY_Components__CodeCompilation__ConcurrencyLimit
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
How many Connector Packages and Orchestrator Packages can be compiled simultaneously. Increasing this number can speed up application startup at the expense of higher system resource usage. A value of 0 or less defaults to 1 |
No |
5 |
|
How long a package can wait to be compiled, in seconds, before ignoring the configured ConcurrencyLimit and commencing compilation regardless. A lower value prefers startup speed, a higher value prefers strictly limiting resource usage. A value of 0 or less defaults to 1 |
No |
10 |
Core
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__Connectors__ to connector variables e.g. NEXEED_ERPCONNECTIVITY_Components__Connectors__SolaceAmqpConnector__FailoverOptions__MaxReconnectAttempts
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
The maximum number of failover/reconnect attempts the Amqp1Connector can perform before the package is disabled with an unrecoverable failure. Applies to all Connector and Orchestrator Packages using the Amqp1Connector. |
No |
5 |
|
The time that the Amqp1Connector should wait between failover/reconnect attempts. Applies to all Connector and Orchestrator Packages using the Amqp1Connector. |
No |
00:00:15 |
|
How long to allow for a connection-related operations of the Amqp1Connector to take before considering the attempt failed. Applies to all Connector and Orchestrator Packages using the Amqp1Connector. |
No |
00:00:10 |
|
Whether multiple Amqp1Connector instances should communicate through shared network connections if the target system and credentials are identical. Applies to all Connector and Orchestrator Packages using the Amqp1Connector. |
No |
true |
MACMA
You must add the prefix NEXEED_ERPCONNECTIVITY_ to MACMA variables e.g. NEXEED_ERPCONNECTIVITY_OIDC__ServiceUrl
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
MACMA URL with base tenant (e.g. https://domain.com/iam/auth/realms/7311ea8c-5d48-43fe-acf9-980eedf24b6c) |
Yes |
- |
|
Is HTTPS required to fetch the token |
No |
true |
|
ERP Connectivity Public Client Id |
Yes |
- |
|
ERP Connectivity Client Id |
Yes |
- |
|
ERP Connectivity Client Secret |
Yes |
- |
|
ERP Connectivity OIDC Application Name |
No |
Nexeed ERPConnectivity |
|
ERP Connectivity OIDC Tenant Id |
Yes |
- |
|
BCI Tenant Id of deployed system |
Yes |
- |
|
MACMA audience scope |
No |
aud:macma |
|
ERP Connectivity Client Id |
Yes |
- |
|
ERP Connectivity Client Secret |
Yes |
- |
|
ERP Connectivity OIDC Application Name |
Yes |
- |
|
Default token endpoint of MACMA |
Yes |
- |
|
Whether or not caching should be enabled for results returned by the introspection endpoint. |
Yes |
true |
|
How long introspection results should be cached (in seconds). It should be less than 1 minute. |
Yes |
30 |
|
ERP Connectivity OIDC Application Name |
Yes |
- |
|
BCI Tenant Id of deployed system |
Yes |
- |
|
BCI Tenant Id of deployed system |
Yes |
- |
Portal
You must add the prefix NEXEED_ERPCONNECTIVITY_ to core variables e.g. NEXEED_ERPCONNECTIVITY_Portal__Info__version
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Url of Nexeed Portal |
Yes |
- |
|
version of ERP Connectivity that should be shown in Nexeed Portal |
Yes |
- |
|
ERP Connectivity Client Id |
Yes |
- |
|
ERP Connectivity base Url |
Yes |
- |
|
ERP Connectivity Client Id |
Yes |
- |
|
Portal registration Url |
Yes |
- |
|
Initial delay for the portal registration in seconds (ideal value: 20) |
Yes |
- |
|
Retry delay (interval) in seconds for the portal registration retry (ideal value: 30) |
Yes |
- |
|
Token endpoint of MACMA used by ERP Connectivity to register in Nexeed Portal |
Yes |
- |
|
Scope that needs to be used to register in Nexeed Portal |
Yes |
- |
Named clients
You must add the prefix NEXEED_ERPCONNECTIVITY_OIDC__NamedHttpClients__Clients__ to core variables e.g. NEXEED_ERPCONNECTIVITY_OIDC__NamedHttpClients__Clients__ProductSetupManagement__TokenEndpoint
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Base address of Product Setup Management used by ERP Connectivity to call Product Setup Management |
Yes |
- |
|
Scope that needs to be used to call Product Setup Management |
Yes |
- |
|
Base address of Material Management used by ERP Connectivity to call Material Management |
Yes |
- |
|
Scope that needs to be used to call Material Management |
Yes |
- |
|
Base address of Order Management used by ERP Connectivity to call Order Management |
Yes |
- |
|
Scope that needs to be used to call Order Management |
Yes |
- |
Orchestrator
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__OrchestrationEngine__ to orchestrator engine variables e.g. NEXEED_ERPCONNECTIVITY_Components__OrchestrationEngine__Interpreter__MaxExecutionDepth
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Maximum allowed number of transitions between activities in the workflow, after which the workflow execution is forcefully aborted to prevent infinite loops. |
no |
250 |
Orchestrator internal communication
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__OrchestratorCommunication__ to orchestrator communication variables e.g. NEXEED_ERPCONNECTIVITY_Components__OrchestratorCommunication__ResponseWaitTimeout
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Maximum execution time of Connector Packages that were triggered from an Orchestrator Package. Should be less than |
no |
"00:05:00" |
|
Maximum execution time of Orchestrator Package workflows. Format is HH:MM:SS |
no |
"00:10:00" |
Orchestrator client provider
You must add the prefix NEXEED_ERPCONNECTIVITY_Components__OrchestrationEngine__ClientProviderSettings__ to orchestrator client provider variables e.g. NEXEED_ERPCONNECTIVITY_Components__OrchestrationEngine__ClientProviderSettings__Macma__BaseAddress
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Url of MACMA |
Only for workflows that communicate with MACMA |
- |
|
S2S Client ID to use for requests to MACMA |
Only for workflows that communicate with MACMA |
- |
|
Url of Maintenance Management |
Only for workflows that communicate with Maintenance Management |
- |
|
S2S Client ID to use for requests to Maintenance Management |
Only for workflows that communicate with Maintenance Management |
- |
|
Url of Master Data Management |
Only for workflows that communicate with Master Data Management |
- |
|
S2S Client ID to use for requests to Master Data Management |
Only for workflows that communicate with Master Data Management |
- |
|
Url of Tool Management |
Only for workflows that communicate with Tool Management |
- |
|
S2S Client ID to use for requests to Tool Management |
Only for workflows that communicate with Tool Management |
- |
Application Performance Monitoring
You must add the prefix NEXEED_ERPCONNECTIVITY_OpenTelemetry__ to OpenTelemetry variables e.g. NEXEED_ERPCONNECTIVITY_OpenTelemetry__Enabled
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Enables collection of Metrics and Traces within ERP Connectivity |
No |
false |
|
Enables the export of collected Metrics and Traces with the OpenTelemetryProtocol |
No |
false |
|
Service Name to be shown in Metrics/Traces |
Yes - if |
- |
|
Service Namespace to be shown in Metrics/Traces |
Yes - if |
- |
|
Service Version to be shown in Metrics/Traces |
Yes - if |
- |
|
Deployment Environment to be shown in Metrics/Traces |
Yes - if |
- |
|
Endpoint of Metrics/Traces collector that supports OpenTelemetryProtocol |
Yes - if |
- |
|
HTTP Headers that shall be used when calling the |
Yes - if |
- |
Observability
You must add the prefix NEXEED_ERPCONNECTIVITY_Observability__ to observability variables e.g. NEXEED_ERPCONNECTIVITY_Observability__EnableTracing
|
| Variable | Description | Required | Default |
|---|---|---|---|
|
Whether or not to collect performance traces during runtime. Disabling this can lead to slightly lower resource usage, but would make it impossible to get dedicated support in case of performance issues and is therefore recommended to keep enabled. |
no |
true |