[opcua]

Settings for the OPC UA client

[opcua] alarmFallbackAddress

Type
string
Default
ns=0;i=0
This entry allows to specify a fallback address for the reception of alarms. It can be used to receive alarms with unknown condition id. If this address is not equal the null-nodeid (ns=0;i=0), all received alarms, which cannot be mapped to a configured condition id are mapped to the node id defined by the this entry.

[opcua] alertCounterAddValue

Type
uint
Default
0
Range
0..32
This config entry enables an alert counter which is incremented for equal time alerts. The given value specifies on which additional value the counter can be stored. Therefore, the user can use this additional value as sorting option in the Alert and Event panel for alerts with the same time. Default = 0 -> no writing of alert count to additional value. For further information refer to the chapter Alarms and Conditions.

[opcua] applicationUri

Type
string
Default
urn:host:ETMpc:WinCC_OA_Client
Range
Uri
If specific certificates are used for the OPC UA client, it might be necessary to adapt the "Application URI" and the "Product URI" parameters of the client in order to avoid problems in the encrypted mode. You have to adapt the Application URI" and the "Product URI" since some servers check these parameters in the certificate and in the OPC UA CreateSession request. In this case use the config entries "applicationUri" und "productUri": The default values for these entries are: applicationUri = "urn:host:ETMpc:WinCC_OA_Client productUri = "urn:ETMpc:WinCC_OA_Client"

[opcua] autoGQ

Type
uint
Default
0
Range
0-3
Specifies whether the client is executed an automatic general query (GQ).
  • 0 -> no automatic GQ
  • 1 -> automatic GQ during connection establishment
  • 2 -> automatic GQ during redundancy switchover
  • 3 -> automatic GQ during connection establishment and redundancy switchover

Note:
If the config entry driverNegativeSourceTimeDiff (see chapter Event Manager) is used, and Subscriptions are used with a time stamp from the server or from the source, its not allowed to perform a redundancy switchover during the GQ, otherwise the time stamps are taken from different servers / sources. Thus autoGQ must be 0 or 1.

[opcua] certificateStore

Type
string
Path to the directory, where the public key infrastructure directory is stored. By default the PKI directory for the WinCC OA OPC UA client is located in <WinCC OA version_dir>/data/opcua/client -> certificateStore = "" or config entry is not set in the config file.

[opcua] checkCertificateHost

Type
bool
Default
1
Range
0|1
Specifies if the client verifies if the hostname/IP address in the server URL is matching with the hostname/IP address in the server certificate. If the verification fails no secured communication is possible.

[opcua] connUserBitWriteFeedback

Type
int
Default
0
Range
0..15
The defined user bit must be set for a dpSet on a DPE with I/O address in order to receive a write service feedback from UA client. The value 0 means the write feedback is never written on the DPE.

[opcua] eventFallbackAddress

Type
string
Default
ns=0;i=0
Range
node ID of the fallback address

This entry allows to specify a fallback address for the reception of events.

The default of this entry is ns=0;i=0. If the namespace index is 0, no fallback handling is done. If the namespace is not zero, the following fallback handling is executed:

  • If there is no sourceNode available or configured, the driver tries to map the event to an address which consists of the namespace index and the sourceName of the event (e.g. "ns=20;s=myEventSourceName").
  • If the fallback nodeId identifier is not zero and no matching source node or source name is configured, the event is mapped to eventFallbackAddress (namespace and identifier).

Therefore, you can use the sourceName as an alternative to the sourceNode.

Example:

[opcua]
eventFallbackAddress = "ns=10;s=all_other_events"

If you configure the address "ns=10;s=all_other_events", you will receive all events, which cannot be mapped to sourceNode address or "ns=10;s=sourcename" address.

[opcua] historyReadMode

Type
uint
Default
0
Range
0|1
Defines whether the passive client transmits historical requests to the server. 0 (default): passive client transmits request just as the active client 1: passive client does not transmit requests to the server

[opcua] maxItemsInRequest

Type
uint
Default
1000
Defines how many items are allowed in one read or write request. Reducing the number of items might be necessary for server which support only limited size requests.

[opcua] maxPendingMethodCalls

Type
uint
Default
100
Range
1..10000
Defines the maximum number of method calls the client executes in parallel per connection. Are more method calls in the output queue these have to wait until the pending methods are answered by the server.

[opcua] maxRequestQueueSize

Type
uint
Default
10000
Defines the size of the request queue for an OPC UA server connection. If this is overrunning because of, for example, of too fast writing, data loss is the consequent. Thus, this queue size has to be adjusted to the expected load.

[opcua] nullValueToInvalid

Type
int
Default
1
Range
0-2
The OPC UA client maps "null" values in 3 different ways. Following options are available: 0 ... simply discard null value 1 ... set DPE to invalid with current timestamp 2 ... set DPE to invalid without change of timestamp

[opcua] productUri

Type
string
Default
urn:ETMpc:WinCC_OA_Client
Range
Uri
If specific certificates are used for the OPC UA client, it might be necessary to adapt the "Application URI" and the "Product URI" parameters of the client in order to avoid problems in the encrypted mode. You have to adapt the Application URI" and the "Product URI" since some servers check these parameters in the certificate and in the OPC UA CreateSession request. In this case use the config entries "applicationUri" und "productUri": The default values for these entries are: applicationUri = "urn:host:ETMpc:WinCC_OA_Client productUri = "urn:ETMpc:WinCC_OA_Client"

[opcua] server

Type
string
Specifies the name of the internal connection datapoint that is used for the server. This config entry is no longer required because the assignment of datapoint is now dynamically using address config or internal data point.

[opcua] serverStateTimer

Type
uint
Default
5000
Range
>0
Defines the interval in milliseconds for reading the server status.

[opcua] sessionName

Type
string
Default
WCCOAopcua:hostname:projectName:driverNum
This entry defines the used "OPC UA Session Name".

[opcua] sessionTimeout

Type
uint
Default
1200000
Range
>5000
Specifies the OPC UA session timeout, which shall be requested by the client. The server can overrule the value is it is not suitable for the server.

[opcua] setInvalidForConnLoss

Type
uint
Default
0
Range
0 - 2
Using this config entry, the values sent by the driver can be set invalid when a connection loss occurs. Optional the timestamp can be set to the time of the connection loss. Following options are available:
  • 0 => Invalid bit will not be set
  • 1 => Invalid bit will be set (and the timestamp will be changed)
  • 2 => Invalid bit will be set (without changing the timestamp)

[opcua] timestampDefaultForRead

Type
int
Default
3
This entry specifies which timestamp is used for read requests for items not assigned to a subscription. There are the following possibilities:
  • 0 => use timestamp from source
  • 1 => use timestamp from server
  • 2 => not used (both timestamps)
  • 3 => use reception timestamp

[opcua] timestampWriteMode

Type
int
Default
0
Range
0..3
Defines which timestamp should be set when sending write requests to a server.
  • 0..the driver does not send the source/server timestamp to the server when issuing a write request (default)
  • 1..the driver sends the _stime of the value as source timestamp when issuing a write request, server timestamp is not sent
  • 2..the driver sends the _stime of the value as server timestamp when issuing a write request, source timestamp is not sent
  • 3..the driver sends the _stime of the value as server and source timestamp when issuing a write request

[opcua] uaCallTimeout

Type
int
Default
10000
Defines the time range in milliseconds in which a OPC UA service call must be executed. If the call is not done in this time range, it is terminated with an error Bad_Timeout. A small timeout makes connection error detection faster, but increases the risk that a service is termination if the server needs more time to process the service.

[opcua] uaLocalIds

Type
string
Default
en
This entry defines the list of desired language ids, which shall be used for the OPC UA session, with respect to localized texts. The UA server selects the first language, of the list, which it can provide. If the server cannot provide any of the specified languages the server selects one of the languages it can provide. The language identifier must be entered seperated with ',' (e.g. "en,de-AT,de").

[opcua] userBitHistoryRead

Type
int
Default
0
Range
0..32
The defined user bit is set for values returned by a historical request. The value 0 means that no userbit is set. Additionally the config entry histDataBits in section [opcua] must be set accordingly in case that the values of a historical request shall be written as correction values.

[opcua] userBitWriteFeedback

Type
int
Default
0
Range
0..32
The defined user bit is used to mark valure changes resulting from write feedback. The value 0 means that the feedback value is not marked.