Edit Page

Agent configuration

The Rhize agent collects data that is emitted in the manufacturing process and makes this data visible in the Rhize system. It works by connecting to equipment or groups of equipment that run over protocols such as OPC UA.

As the communication bridge between the Rhize Data Hub and your plant, the agent has multiple functions:

  • It subscribes to tags and republishes the changes in NATS.
  • It creates an interface for the BPMN engine to send reads and writes to a data source and its associated equipment.

OPC UA authentication types

When authenticating over OPC UA, Rhize supports the following authentication types:

Authentication typeBehavior
AnonymousConnects without any necessary credential.
UsernameAuthenticates through a username and password in the config file, or through a Kubernetes secret.
CertificateUses the certificate on disk specified in the OPCUA.CertFile and OPCUA.KeyFile configs. If no certificate exists and the config specifies the OPCUA.GenCert property as true, automatically generates one.

logging

Logs the configurations to the console.

AttributesDescription
typeSpecifies the logging configuration type: json, multi, or console.
(Default: console)
LevelConfigures the level of logging: Trace, Debug, Info, Warn, Error, Fatal, Panic. Defaults to Trace.
(Default: trace)

libreDataStoreGraphQL

AttributeDescription
GRAPHQL_URLThe URL of the GraphQL endpoint to use for interacting with Rhize services.
(Default: http://localhost:8080/graphql)

NATS

AttributeDescription
SERVER_URLThe URL for connecting to the NATS server.
(Default: nats://system:system@localhost:4222)

OIDC

Configurations for Keycloak authentication and connection with OpenID Connect.

AttributeDescription
serverUrlThe URL of the OpenID Connect server.
(Default: http://localhost:8090)
realmIdentifies the authentication domain for which the authentication request is being made.
client_idThe unique identifier assigned to the client application by the OIDC server.
client_secretUsed to authenticate the client alongside the client ID when making confidential requests.
usernameThe username credentials to authenticate with the OIDC server.
passwordThe password credentials to authenticate with the OIDC server.

OpenTelemetry

AttributeDescription
serverUrlThe URL of the OpenTelemetry server.
(Default: localhost:4317)

OPCUA

AttributeDescription
DiscoveryUrlThe URL to locate and connect to OPC UA servers on a network.
(Default: opc.tcp://localhost:4840)
EndpointThe URL of the OPC UA service server.
(Default: opc.tcp://localhost:4840)
UsernameThe username credentials to authenticate with the OPC UA server.
PasswordThe password credentials to authenticate with the OPC UA server.
ModeThe operational mode of the OPC UA server/client.
(Default: None)
PolicyThe security measures for OPC UA server communication.
(Default: None)
AuthThe authentication mechanisms and user access control.
(Default: Anonymous)
AppUriThe application’s unique URI within the OPC UA system.
(Default: opc.tcp://localhost:4840)

BUFFERS

AttributeDescription
ProtocolQueueTypeThe type of queue used for buffering communication protocol data.
(Default: 0)

HEALTH

AttributeDescription
PollIntervalThe frequency of scans for component status and health.
(Default: 1000)
SubscriptionTimeoutThe maximum duration to wait to receive updates from subscribed data sources.
(Default: 60000)
SubscriptionMaxCountThe maximum number of concurrent subscriptions for monitoring.
(Default: 5)

MQTT

AttributeDescription
VersionThe version of MQTT used: 5.0 or 3.1.1.
(Default: 3.1.1)
ClientIdThe ID used in the MQTT broker.
(Default: mqtt-client)
EndpointThe URL of the MQTT broker.
(Default: mqtt://localhost:1883)
UsernameThe username credentials to authenticate with the MQTT broker.
PasswordThe password credentials to authenticate with the MQTT broker.
DecomposeJSONEnables or disables JSON payload decomposition into individual data fields.
(Default: false)
TimestampFieldThe field to search to return timestamp information.
(Default: timestamp)
RequestTimeoutThe maximum duration to wait to receive a response to an MQTT request from the broker.
(Default: 10)

DATASOURCE

AttributeDescription
IDThe source ID to retrieve payload data from.
(Default: DS_0806)

AZURE

AttributeDescription
CLIENT_IDThe ID used to securely authenticate Azure service access.
CLIENT_SECRETThe secret key associated with the client ID for authentication.
TENANT_IDThe ID of the Azure Active Directory tenant where the service is registered.
SERVICEBUS_HOSTNAMEThe URL of the Azure Service Bus namespace used for Azure ecosystem communication.
(Default: bsl-dev.servicebus.windows.net)