mmpd/equipment-service
Equipment service settings
| Name | Required | Defaults to | Description |
|---|---|---|---|
Equipment__PredefinedCustomProperties |
No |
1 item (see below) |
List of predefined properties that will be displayed by the UI |
Equipment__PredefinedCustomProperties__0__Name |
No |
Watchdog Timer |
Name of property |
Equipment__PredefinedCustomProperties__0__Description |
No |
Timespan elapsed before a deviation is triggered by Information Router |
Property description |
Equipment__PredefinedCustomProperties__0__Unit |
No |
s |
Unit |
Equipment__PredefinedCustomProperties__0__DefaultValue |
No |
0 |
Default value |
Equipment__PredefinedCustomProperties__0__DataType |
No |
Number |
One of: String, Number, Boolean, Datetime |
Equipment__PredefinedCustomProperties__0__Mandatory |
No |
true |
true/false |
DisableNotifyProcessClient |
No |
false |
Disable notification of Process Service |
Equipment__Health__CheckConfiguration__process__isregistered |
No |
false |
Disable Process Service health check |
Equipment__Health__CheckConfiguration__process__isrequired |
No |
false |
If true the module is required and affects the global state and /ready endpoint for Process Service |
Equipment__Caching__WebResponseCachingEnabled |
No |
true |
Activates or deactivates API response caching |
Equipment__Caching__CacheSizeLimit |
No |
10000 |
Sets the size in bytes for the Web Response Cache. This is an approximate value of the actual memory that will be used and is based on the response body length for the cached data |
Equipment__Caching__SlidingExpirationInSeconds |
No |
600 |
Sets the expiration time for a cached response. After that time, if that request is not received anymore the cache entry will be deleted |
Equipment__Caching__UnknownMessageCacheMinutes |
No |
1440 |
Sets the cache duration for unknown devices and measuring points received via event messages. IF a device or measuring point has previously been created it is assumed to be in the database and is not checked / created anymore. |
DbSetCache__Facility__DefaultExpirationSeconds |
No |
3600 |
If set, the cached items will expire after the given time. |
DbSetCache__Facility__SizeLimit |
No |
- |
The number of items to keep in the cache. This is not a bytes limit and has no correlation to memory. One item is the entire subtree for a node, a list of parents for a node or the list of facilities and their hasChildren property. |
CORSCONFIGURATION__ALLOWEDORIGINS__0 |
No |
- |
Allows the service to indicate any origins from which a browser should permit loading resources. |
CMR integration
| Name | Required | Defaults to | Description |
|---|---|---|---|
Equipment__CMR__Available |
No |
False |
Corporate Machine Registry (CMR) is available in current deployment scenario. If this is set to false then the other Equipment_CMR variables are not taken into account. |
Equipment__CMR__Url |
No |
|
Used to retrieve the CMR GIAI search URL. |
Equipment__CMR__KeyId |
No |
e1278d19-4028-4bea-8cc5-134a1e9abc29 |
Used as key identifier in request to retrieve the CMR GIAI search URL. |
Equipment__CMR__DummyGIAI |
No |
405497299999999999999999 |
In case CMR should be available in the deployment scenario but it is not accessible due to infrastructure issues, GIAI will have the "DummyValue". |
Data Publisher integration
This settings are required only if you need to enable the Data Publisher integration, else they can be ignored.
| Name | Required | Defaults to | Description |
|---|---|---|---|
DATAPLATFORMENABLED |
No |
false |
Global enable / disable for the Data Publisher registration and Data Events messaging. Use true/false to enable/disable integration with Data Publisher module. |
DATAEVENTSMESSAGING__CONNECTOR__HOSTNAME |
Yes |
The host name, eg: rabbitmq-service.shared.svc.cluster.local |
|
DATAEVENTSMESSAGING__CONNECTOR__PORT |
Yes |
Port number, eg: 5672 |
|
DATAEVENTSMESSAGING__CONNECTOR__VIRTUALHOST |
Yes |
datapublisher-inbound |
The virtual host. Use "/" for root, or else the vhost name. |
DATAEVENTSMESSAGING__CONNECTOR__USERNAME |
Yes |
The user name |
|
DATAEVENTSMESSAGING__CONNECTOR__PASSWORD |
Yes |
The password |
|
DATAEVENTSMESSAGING__CONNECTOR__SSLENABLED |
Yes |
Whether to use SSL or not. Valid values: true, false |
|
DATAEVENTSMESSAGING__CONNECTOR__SSLVERSION |
Yes |
SSL version. eg: "TLS12" |
| Name | Required | Defaults to | Description |
|---|---|---|---|
DATAEVENTSMESSAGING__CUSTOMPARAMETERS__RETRYLIMIT |
No |
3 |
Number of retries if a connection fails |
DATAEVENTSMESSAGING__CUSTOMPARAMETERS__RETRYINTERVAL |
No |
0.00:00:10 |
Delay between retry attempts. (Default: 10 sec) |
DATAEVENTSMESSAGING__EXCHANGES__0__NAME |
No |
x.mdm.{tenantId}.{entity}.v1{suffix} |
Template for the exchange name created for datapublisher integration. This must match the name in the registration request |
DATAEVENTSMESSAGING__EXCHANGES__0__TYPE |
No |
fanout |
Exchange type created for datapublisher integration |
| Name | Required | Defaults to | Description |
|---|---|---|---|
DATAPUBLISHER__BASEURL |
Yes |
The base url for Equipment service that is registered to Data Publisher. Leave empty to skip registration, else use |
| Name | Required | Defaults to | Description |
|---|---|---|---|
DATAPUBLISHER__DATATYPES__0__EXCHANGENAME |
No |
x.mdm.{tenantId}.measuringpoint.v1 |
Exchange name for the measuring points live data. Has to match the exchange template. |
DATAPUBLISHER__DATATYPES__0__HISTORICALDATA__EXCHANGENAME |
No |
x.mdm.{tenantId}.measuringpoint.v1.history |
Exchange name for the measuring points historical data. Has to match the exchange template. |
DATAPUBLISHER__DATATYPES__1__EXCHANGENAME |
No |
x.mdm.{tenantId}.material.v1 |
Exchange name for the material live data. Has to match the exchange template. |
DATAPUBLISHER__DATATYPES__1__HISTORICALDATA__EXCHANGENAME |
No |
x.mdm.{tenantId}.material.v1.history |
Exchange name for the material historical data. Has to match the exchange template. |
DATAPUBLISHER__DATATYPES__2__EXCHANGENAME |
No |
x.mdm.{tenantId}.process.v1 |
Exchange name for the process live data. Has to match the exchange template. |
DATAPUBLISHER__DATATYPES__2__HISTORICALDATA__EXCHANGENAME |
No |
x.mdm.{tenantId}.process.v1.history |
Exchange name for the process historical data. Has to match the exchange template. |
Database connections
| Name | Required | Defaults to | Description |
|---|---|---|---|
PERSISTENCECONFIGURATION__DATABASETYPE |
Yes |
- |
Database type used by service |
PERSISTENCECONFIGURATION__CONNECTIONSTRING |
Yes |
- |
Connection string to database |
PERSISTENCECONFIGURATION__DATABASE_TLS_ENABLED |
No |
false |
Enable/Disable TLS |
Swagger
| Name | Required | Defaults to | Description |
|---|---|---|---|
SWAGGER__ENABLED |
No |
false |
Enables access to application API through Swagger framework, mainly for testing purposes |
RabbitMq settings
| Name | Required | Defaults to | Description |
|---|---|---|---|
MESSAGINGENABLED |
Yes |
true |
Toggle for enabling publishing CRUD database events into message broker. |
MESSAGING__CONNECTOR__HOSTNAME |
Yes |
mdmRabbitMqConnector |
Hostname for RabbitMq connector. |
MESSAGING__CONNECTOR__PORT |
Yes |
5672 |
Port of RabbitMq connector. |
MESSAGING__CONNECTOR__VIRTUALHOST |
Yes |
- |
Virtual host of RabbitMq connector. |
MESSAGING__CONNECTOR__USERNAME |
Yes |
- |
Username for user of RabbitMq connector. |
MESSAGING__CONNECTOR__PASSWORD |
Yes |
- |
Password for user of RabbitMq connector. |
MESSAGING__CONNECTOR__SSLENABLED |
No |
false |
Toggle for enabling SSL communication with broker. |
MESSAGING__CONNECTOR__SSLVERSION |
No |
Tls12 |
Version type for SSL communication. |
MESSAGING__MESSAGEPROVIDER__MESSAGESENDER |
Yes |
- |
The message sender URL. |
MESSAGING__PUBLISHER__EXCHANGE__NAME |
Yes |
- |
The name of broker exchange that the messages would be sent to. |
MESSAGING__PUBLISHER__EXCHANGE__TYPE |
Yes |
Topic |
The type of broker exchange that the messages would be sent to. |
MESSAGING__PUBLISHER__EXCHANGE__DECLAREPASSIVE |
No |
false |
Declares the exchange if it’s not yet present on the broker |
RabbitMq queues migration
| Name | Required | Defaults to | Description |
|---|---|---|---|
RabbitMqMigration__MigrationStrategy |
Yes |
CheckOnly |
Defines how the service handles queues migration. On dependency job MigrateOnly applies all pending migrations automatically. |
RabbitMqMigration__Host |
Yes |
mdmRabbitMqConnector |
Hostname for RabbitMq connector. |
RabbitMqMigration__VHost |
Yes |
- |
Virtual host of RabbitMq connector. |
RabbitMqMigration__User |
Yes |
- |
Username for user of RabbitMq connector. |
RabbitMqMigration__Pass |
Yes |
- |
Password for user of RabbitMq connector. |
RabbitMqMigration__Port |
Yes |
5672 |
Port of RabbitMq connector. |
RabbitMqMigration__ManagementApiBase |
Yes |
- |
Hostname for RabbitMq management api. |
Portal settings
| Name | Required | Defaults to | Description |
|---|---|---|---|
PORTAL__INFO__VERSION |
Yes |
- |
The MDM module version |
PORTAL__URL |
Yes |
- |
External Portal URL |
PORTAL__INFO__ID |
Yes |
- |
The MDM client id |
PORTAL__INFO__BASEURL |
Yes |
- |
External MDM URL |
PORTAL__INFO__AUTHPROVIDERCLIENTID |
Yes |
- |
The MDM client id |
PORTAL__SCSREGISTRY__SERVICEURL |
Yes |
- |
SCS registry external URL |
Macma settings
| Name | Required | Defaults to | Description |
|---|---|---|---|
OIDC__SERVICEURL |
Yes |
{macma_module_url} |
MACMA’s Service Url |
OIDC__CLIENTID |
Yes |
- |
MDM client-id |
OIDC__CLIENTSECRET |
Yes |
- |
MDM client secret |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__MACMACLIENT__TOKENENDPOINT |
Yes |
{macma_module_url}/access-management/v1/tenants/{nexeedMacmaTenant0Id}/openid-connect/token |
Token endpoint for macma client |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__MACMACLIENT__SCOPES__0 |
Yes |
aud:macma |
Audience for macma client |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__PORTALCLIENT__TOKENENDPOINT |
Yes |
{macma_module_url}/access-management/v1/tenants/{nexeedMacmaTenant0Id}/openid-connect/token |
Token endpoint for portal client |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__PORTALCLIENT__SCOPES__0 |
Yes |
aud:{portal_client_id} |
Audience for portal client |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__DATAPUBLISHER__TOKENENDPOINT |
No |
{macma_module_url}/access-management/v1/tenants/ {nexeedMacmaTenant0Id}/openid-connect/token |
Token endpoint for datapublisher client |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__DATAPUBLISHER__BASEADDRESS |
No |
{datapublisher_module_url}/ |
Data Publisher’s Service Url |
OIDC__NAMEDHTTPCLIENTS__CLIENTS__DATAPUBLISHER__SCOPES__0 |
No |
aud: {datapublisher_client_id} |
Audience for data publisher client |