server.opc-da

OpcDa server

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • moduleId

The OPC DA module module.opc-da ↗️ that this server will refer to.

For example modules.opc-da.opc-da-1 is the default OnSphere path of the OPC DA module.

type

string

  • connectionParameters

The connection settings to connect to the OpcDa server.

OpcDaConnectionConfiguration

  • retryConnectionTimeout

The connection retry timeout. This will trigger a connection to the OPC DA server every retryConnectionTimeout until the server is reachable.

default

value

500

unit

MILLISECONDS

DurationConfigurationEntity

additionalProperties

False

OpcDaConnectionConfiguration

type

object

properties

  • host

The IP address of the OPC DA device. This address is used by the client to locate and connect to the OPC DA server on the network.

For example, the host can be 192.168.42.1.

Learn more about OPC UA ↗️.

type

string

  • username

The username to use for the connection to the server. Is often the same as the windows user.

It can be for example sysadmin.

Learn more about OPC DA ↗️.

type

string

  • passwordProvider

The password to use for the connection to the server.

It can be defined as plaintext or via a secret.

Learn more about OPC DA ↗️.

oneOf

PLAINTEXT

SECRET

  • domain

The domain of the windows machine to connect to.

type

string

  • progId

The programmeId of the OpcDa Server. It is recommended to use the classId.

type

string

  • classId

The classId of the OpcDa Server.

type

string

  • readFrequency

The read frequency to update values that are read on the OpcDa server.

default

value

500

unit

MILLISECONDS

DurationConfigurationEntity

additionalProperties

False

PLAINTEXT

type

object

properties

  • type

type

string

enum

PLAINTEXT

default

PLAINTEXT

  • password

The password to use in plaintext. It can be for example thisIs@TestPassword123.

type

string

additionalProperties

False

SECRET

type

object

properties

  • type

type

string

enum

SECRET

default

SECRET

  • secretPath

The path of the secret containing the password. This is a path to the secret containing the password.

type

string

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • value

The amount of time expressed with the unit

type

integer

  • unit

The unit of time expressed with the value

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

additionalProperties

False