rework/rework-backend-service

Deployment configuration settings

Those are defined as environment variables and typically do not need to change during runtime. Below is a description of those available.

Table 1. Deployment configuration settings
Environment Variable	Description	Default Value
Logging Settings
NEXEED_REWORK_SERVICE_Logging__Console__LogLevel__Default	Sets the default log level for log messages shown in console.	Warning
NEXEED_REWORK_SERVICE_Logging__Console__LogLevel__Bosch	Sets the default log level for log messages shown in console with scope of Bosch (e.g. Foundation Components and application code).	Information
NEXEED_REWORK_SERVICE_Logging__Console__LogLevel__Microsoft	Sets the default log level for log messages shown in console with scope of Microsoft (e.g. components with namespace Microsoft.Extensions.*)	Information
NEXEED_REWORK_SERVICE_Logging__Console__LogLevel__System	Sets the default log level for log messages shown in console with scope of System (e.g. components with namespace System.Net.Http.*)	Information
Tenant Settings
NEXEED_REWORK_SERVICE_TenantConfig__Tenant0	The tenant0 identifier.	Placeholder value <tenant-id>, which is invalid. In Helm deployments, value is set automatically to match the tenant for the umbrella chart deployment.
OpenID Connect (OIDC) Settings
NEXEED_REWORK_SERVICE_OIDC__ServiceUrl	The URL of MACMA.	Placeholder value <server>/iam/, which is invalid. In Helm deployments, value matches the MACMA deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_OIDC__ClientId	The client ID value for Rework Control defined in MACMA.	Placeholder value <rework-client-id>, which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_OIDC__ClientSecret	The client Secret value for Rework Control defined in MACMA.	Placeholder value <rework-client-secret>, which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_OIDC__Acl__RefreshInterval	How often the ACLs should be refreshed in seconds.	60
NEXEED_REWORK_SERVICE_OIDC__Introspection__EnableCaching	Whether or not caching should be enabled for results returned by the introspection endpoint.	false
NEXEED_REWORK_SERVICE_OIDC__Introspection__CachingDuration	How long introspection results should be cached in seconds. It is recommended to be less than 1 minute.	30
OIDC Clients Settings
NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__DefaultTokenEndpoint	The default endpoint to use for fetching access tokens from MACMA.	Placeholder value <server>/iam/auth/realms/<tenant-id>/protocol/openid-connect/token which is invalid. In Helm deployments, value is set automatically to match the MACMA deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__LineControl__Scopes__0	The scope needed when requesting access token for Line Control API.	Placeholder value aud:<linecon-client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of Line Control generated in MACMA.
NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__ERPConnectivity__Scopes__0	The scope needed when requesting access token for ERP Connectivity API.	Placeholder value aud:<erpconn-client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of ERP Connectivity generated in MACMA.
NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__DataBrowserClient__Scopes__0 NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__DataCollectorClient__Scopes__0 NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__QualityGateClient__Scopes__0	The scope needed when requesting access token for Part Traceability API.	Placeholder value aud:<parttrace-client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of Part Traceability generated in MACMA.
NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__BlockManagement__Scopes__0	The scope needed when requesting access token for Block Management API.	Placeholder value aud:<blockman-client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of Block Management generated in MACMA.
NEXEED_REWORK_SERVICE_OIDC__NamedHttpClients__Clients__SetupControlClient__Scopes__0	The scope needed when requesting access token for SetupSpecs API.	Placeholder value aud:<specs-client-id> which is invalid. In Helm deployments, value is set automatically to match the client ID of SetupSpecs generated in MACMA.
RabbitMQ Settings
NEXEED_REWORK_SERVICE_RabbitMQ__Connections__ERPConnectivity__Hostname	The hostname for connecting to the RabbitMQ broker used for listening for ERP Connectivity notifications.	Placeholder value <rabbitmq-host> which is invalid. In Helm deployments, value is set automatically to match the RabbitMQ deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_RabbitMQ__Connections__ERPConnectivity__Port	The port number for connecting to the RabbitMQ broker used for listening for ERP Connectivity notifications.	5672 In Helm deployments, value is set automatically to match the RabbitMQ deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_RabbitMQ__Connections__ERPConnectivity__UserName	The user name for connecting to the RabbitMQ broker used for listening for ERP Connectivity notifications.	Placeholder value <username> which is invalid. In Helm deployments, value is set automatically to match the RabbitMQ deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_RabbitMQ__Connections__ERPConnectivity__Password	The password for connecting to the RabbitMQ broker used for listening for ERP Connectivity notifications.	None In Helm deployments, value is set automatically to match the RabbitMQ deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_RabbitMQ__Connections__ERPConnectivity__SslEnabled	Whether to enable SSL for connecting to the RabbitMQ broker used for listening for ERP Connectivity notifications.	false
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Name	The name of the consumer instance for ERP Connectivity notifications.	ERPConnectivityNotificationSubscriber
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Exchange__Name	The name of the exchange dedicated for rework module to bind for ERP Connectivity notifications.	x.rework.erpconnectivity
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Exchange__Type	The type of the exchange dedicated for rework module to bind for ERP Connectivity notifications. Possible values are 'TOPIC', 'DIRECT', 'FANOUT', and 'HEADERS'. Typically 'TOPIC'.	TOPIC
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__BindToExchanges__0__Name	The name of the integration events exchange used by Nexeed.	x.nexeed.integration
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__BindToExchanges__0__RoutingKeys__0	The first routing key to bind from the integration events exchange.	nexeed.mes.erpconnectivity.masterdata.costcenters
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__BindToExchanges__0__RoutingKeys__1	The second routing key to bind from the integration events exchange.	nexeed.mes.erpconnectivity.production.scrapreasons
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Queue__Name	The name of the queue to use for ERP Connectivity notifications.	q.rework.erpconnectivity
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Queue__Durable	Whether the queue should survive broker restarts (durable).	true
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Queue__Exclusive	Whether the queue is exclusive to the connection.	false
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Queue__AutoDelete	Whether the queue is automatically deleted when no longer in use.	false
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Queue__Ttl	The time-to-live (TTL) for messages in the queue, in milliseconds. Use -1 for unlimited.	-1
NEXEED_REWORK_SERVICE_RabbitMQ__Consumers__ERPConnectivity__Queue__QueueType	The type of the queue to use or create, if not present. Possible values are 'Quorum' and 'Classic'. Defaults to 'Quorum' starting from Rework Control version 6.3, or 'Classic' for older versions. Please note that if a queue with the specified name already exists as type 'Classic', it will continue to be used as a classic queue and will not be automatically converted or replaced by a quorum queue. To use a 'Quorum' queue, you must manually delete the existing 'Classic' queue with the same name before deployment; this manual operation is required so that a new 'Quorum' queue can be created.	Quorum (version >= 6.3), Classic (version < 6.3)
LineControl Endpoint Settings
NEXEED_REWORK_SERVICE_Endpoints__LineControl__BaseUrl	The base URL for Line Control module.	Placeholder value which is invalid. In Helm deployments, value is set automatically to match Line Control deployment via the umbrella chart.
ERP Connectivity Endpoint Settings
NEXEED_REWORK_SERVICE_Endpoints__ERPConnectivity__BaseUrl	The base URL for ERP Connectivity module.	Placeholder value which is invalid. In Helm deployments, value is set automatically to match ERP Connectivity deployment via the umbrella chart. However, it shall be overriden at installation time in the custom-values.yaml file of the umbrella chart to point to the external MES ERP Connectivity REST service which is not part of IAS installation.
Part Traceability Endpoint Settings
NEXEED_REWORK_SERVICE_Endpoints__DataBrowser__BaseUrl	The base URL for the data browser service in Part Traceability module.	Placeholder value which is invalid. In Helm deployments, value is set automatically to match Part Traceability deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_Endpoints__DataCollector__BaseUrl	The base URL for the data collector service in Part Traceability module.	Placeholder value which is invalid. In Helm deployments, value is set automatically to match Part Traceability deployment via the umbrella chart.
NEXEED_REWORK_SERVICE_Endpoints__QualityGate__BaseUrl	The base URL for the part quality service in Part Traceability module.	Placeholder value which is invalid. In Helm deployments, value is set automatically to match Part Traceability deployment via the umbrella chart.
BlockManagement Endpoint Settings
NEXEED_REWORK_SERVICE_Endpoints__BlockManagement__BaseUrl	The base URL for Block Management module.	Placeholder value which is invalid. In Helm deployments, value is set automatically to match Block Management deployment via the umbrella chart.
SetupSpecs Endpoint Settings
NEXEED_REWORK_SERVICE_Endpoints__SetupControl__BaseUrl	The base URL for SetupSpecs module (legacy name was Setup Control).	Placeholder value which is invalid. In Helm deployments, value is set automatically to match SetupSpecs deployment via the umbrella chart.
Health Checks Settings In the keys below, <CheckName> is the name of the health check. The name is used to identify the check in the logs and in the health check endpoint response. The name is also used to identify the check in the configuration settings. The values that are defined by default for this placeholder are MACMA, LineControl, DataBrowser, DataCollector, ERPConnectivity, BlockManagement, SetupSpecs and QualtiyGate.
NEXEED_REWORK_SERVICE_HealthChecks__S2s__<CheckName>_BaseUrl	The base URL of the service for which to check its health.	Empty string.
NEXEED_REWORK_SERVICE_HealthChecks__S2s__<CheckName>_BaseUrlConfigKey	The configuration key path to the base URL for the service to check. This setting is used only if NEXEED_REWORK_SERVICE_HealthChecks__S2s__<CheckName>_BaseUrl is not set.	For MACMA the value OIDC:ServiceUrl. For all others the value Endpoints:<CheckName>:BaseUrl.
NEXEED_REWORK_SERVICE_HealthChecks__S2s__<CheckName>_CheckType	The type of endpoint to check for health of the corresponding service. Allowed values are Ping (for <baseUrl>/ping) and Health (for <baseUrl>/health).	Ping.
NEXEED_REWORK_SERVICE_HealthChecks__S2s__<CheckName>_Required	Whether the check is mandatory or optional to pass. If it is required and the result was `unhealthy`, then it will make the backend service also `unhealthy`, and it will stop receiving external requests. If it was optional and failed, the backend service health will be `degraded`, and it will continue serving external requests.	true for MACMA, LineControl, DataBrowser and DataCollector, and false otherwise.
NEXEED_REWORK_SERVICE_HealthChecks__S2s__<CheckName>_Enabled	Whether the check is enabled. If false, then the corresponding check won’t be made at all and won’t be included in the backend health checks.	true.

Business configuration settings

Those are defined in files that can be uploaded via the Nexeed Web Portal by navigating to the Rework Control > Configuration link.

After a fresh installation, none of these files are present and have to be uploaded manually as part of the installation process.
The files are uploaded to a persistent volume. For this, the Helm chart for Rework Control has a persistent volume claim with access mode as ReadWriteMany. The claim is auto created after deployment.

Below is an overview of those files and what kind of settings are defined inside.

Table 2. Overview of configuration files
File Name	Description	Recommended Editor
ReworkDataStore.xml	Contains definition of part errors, including relevant process numbers and related texts with translation and available actions to list per error. These settings affect the values available in the desktop client when coding a part.	OpCon Server Systems (OSS) application
ReworkClientData.xml	Contains data generated by the client. Currently, it only contains comments on parts typically written by line operators.	Data set editor/Text editor
DDLTemplates.xml	Contains templates for telegrams sent to DirectDataLink in the relevant use cases.	Data set editor/Text editor
SetupControlData.xml	Contains part type information. These are used to fill in placeholder values in DDLTemplates.xml. Also they are used in running some validation checks before making an action available to execute on a given part.	Data set editor/Text editor
qualitydata.json	Contains settings for configuring targets in Part Traceabililty as well as max execution time.	Text editor
SetupControlSettings.json	Contains a setting whether to use a live SetupSpecs service or only rely on local values configured in SetupControlData.xml. Also contains settings for filtering the fetched part type data based on production area, family and partition identifier.	Text editor

Configuration file samples

Listing 1. ReworkClientData.xml

<ReworkClientData xmlns="http://tempuri.org/ReworkClientData.xsd">
</ReworkClientData>

Listing 2. qualitydata.json

{
    "DataCollectorTarget": "QD_OLTP",
    "DataBrowserTarget": "QD_OLTP",
    "MaxExecutionTime": 10000,
    "RequestRecursionDepth": 10,
    "DefaultQueryDetailsLevel": 8192,
    "QuerySnoIfNoProtocol": true
}

Listing 3. SetupControlSettings.json

{
    "UseSetupControl": true,
    "ProductionArea": "Rework_Test_Area",
    "ProductFamily": "Rework_Test_Family_1",
    "PartitionIdentifier": "Rework"
}

The value of UseSetupControl determines whether to fetch data from SetupSpecs service or use local data file. If UseSetupControl is set to false, the local data file SetupControlData.xml is used. Otherwise, the SetupSpecs service is used.

Custom function scenario settings

There are custom function buttons in Rework Control client, which are defined for different customers. In the Rework Control Client, the workflows for custom functions load according to the configured Scenario name. To activate a scenario, the setting has be done before the installation. The variable NEXEED_REWORK_SERVICE_ModuleConfig__CustomFunctionScenario has to be modified in Values.yaml file. This will set an environment variable.

Below is an overview of custom functions, workflow files and settings.

Table 3. Variables for custom function scenario
Variable	Description	Value
CustomFunctionScenario	Define the scenario for different customers to load the workflows with custom functions.	Default value "General", also can be defined like "AE", "SzP", "HDEV6".

Workflows mapping with custom function scenario

Table 4. Overview of workflow mappings with custom function scenario
Workflow	Custom Function Scenario
ReadBalluffCustomFunction	General
ExchangeComponentsCustomFunction	General
MarryCustomFunction	General
ReadID200CustomFunction	General
SeparateCustomFunction	General
CreateEmptyWpcCustomFunction	HDEV6
FromWeldingCustomFunction	HDEV6
ToWeldingCustomFunction	HDEV6
ChangeProductVariantCustomFunction	SzP
SendDDLTelegramCustomFunction	SzP
AddTracedataCustomFunction	AE
ChangeErrorCodeCustomFunction	AE