Properties

The OpcUa module has the following properties:

|Name|Description|ID|Flags| |-| BrowseTypeFilter|The type definition base class for nodes returned from browsing.|1025|Persisted, Enumerated, ExpertPage| BatchSize|The batch size for the number of operations per rpc message towards the ua server. Default is 10000.|1054|Persisted, ExpertPage| CatchupChunkSize|How many values to read per node during catchup read operations. Maps to 'numValuesPerNode' parameter of 'ReadRawModifiedDetails'. Default is 1000.|1261|Persisted, ExpertPage| CatchupMode|

Enables data catchup functionality of the communication.

  • NoCatchup: No data catchup, just pure real-time communication.
  • SerializedCatchup: Historical data is streamed through Hive sample-by-sample, until we have caught up real-time. Note that this requires the UA server to implement the OPC UA HA profile!
  • SerializedCatchup_PauseAfterInitial: Same as 'SerializedCatchup', but with one stop in playback sequence after first StepNext, use CommandItem #ContinueCatchup# to continue playback sequence.
  • PartialCatchup: Only data missing locally, per item, is read from remote server and streamed through Hive, sample-by-sample, until we have caught up real-time.
  • PartialCatchup_PauseAfterInitial: Same as 'PartialCatchup', but with one stop in playback sequence after first StepNext, use CommandItem #ContinueCatchup# to continue playback sequence.

Note that to fully benefit from using catchup, the UA server is required to implement the OPC UA HA profile!

More details on how to use catchup can be found here.

|1250|Persisted, Enumerated, ExpertPage| CatchupNumberOfChunks|How many chunks of data to cache during catchup history read operations. Must be between 0-255. Default is 5|1260|Persisted, ExpertPage| CatchupPeriod|The maximum period of time to look back for historical data, when initiating a catchup operation. Select a preset, or enter a custom value in seconds.|1262|Persisted, Enumerated, ExpertPage| EnableModelChangeEvent|By enabling this property, any model change events issued from the OPC server as a result of items being added, will automaticlly add items to this module.|1230|Persisted, ExpertPage| ExchangeRate|The exchange rate in milliseconds for the 'ExternalItems' timer event. By default, used for updating external items values.|100|Persisted| ItemNameFormat|

How to generate item names on items from the UA NodeID, DisplayName and/or BrowseName. Set of predefined choices, or a custom string, containig following specifiers:

  • {dn} = DisplayName
  • {bn} = BrowseName
  • {ni} = NodeId

Example: {bn}mystring{dn}

|1020|Persisted, Enumerated, ExpertPage| ItemNameSeparator|A character or string used when concatenating item names. Applies only when ItemNameFormat is ConcatenateDisplayName or ConcatenateBrowseName.|1022|Persisted, ExpertPage| LifetimeCount|Requested lifetime count. The lifetime count shall be a minimum of three times the keep keep-alive count. When the publishing timer has expired this number of times without a Publish request being available to send a NotificationMessage, then the Subscription shall be deleted by the Server.|1052|Persisted, ExpertPage| MaxKeepAliveCount|Requested maximum keep-alive count. When the publishing timer has expired this number of times without requiring any NotificationMessage to be sent, the Subscription sends a keep-alive Message to the Client. The negotiated value for this parameter is returned in the response. If the requested value is 0, the server shall revise with the smallest supported keep-alive count.|1051|Persisted, ExpertPage| NotificationsPerPublish|The maximum number of notifications that the Client wishes to receive in a single Publish response. A value of zero indicates that there is no limit. The number of notifications per Publish is the sum of monitoredItems in the DataChangeNotification and events in the EventNotificationList.|1053|Persisted, ExpertPage| PublishingInterval|This interval defines the cyclic rate that the Subscription is being requested to return Notifications to the Client. This interval is expressed in milliseconds. The negotiated value for this parameter returned in the response is used as the default sampling interval for MonitoredItems assigned to this Subscription. If the requested value is 0 or negative, the server shall revise with the fastest supported publishing interval.|1050|Persisted| QualityOverriding|This property controls whether the module itself is allowed to set item qualities, in some situations. If 'when connection lost', qualities will be set to 'Bad: not connected', when connection to ua server gets lost. If 'when write fails', qualities will be set to whatever the write class returned when a failed write happens. If set to 'never', no qualities other than what is received from the UA server will be set on item qualities. Note: this property only applies when CatchupMode = NoCatchup.|1340|Persisted, Enumerated, ExpertPage| Server|The OpcUa connection or OpcUa cluster item to use for the server connection.|1000|Persisted, Enumerated| ServerWatchdog|A strategy for server communication monitoring. This can be useful when dealing with erronous servers that stop to operate correctly.|1360|Persisted, Enumerated, ExpertPage| ServerWatchdogItems|Set to one or more local items, when using ServerWatchdog = 'Restart if watchdog item(s) update interval > ReconnectTime'|1365|Persisted, ApisLocalItem, ExpertPage| SrvLCID|Locale ID of values coming from the server. You might need to specify this property if the OPC server provides string values that is converted to another type in your client (e.g. DDE bridges)|1218|Persisted, ExpertPage| StandardPropSync|

When to synchronize selected OpcUA Standard Properties from server nodes to local apis item attributes (Unit, EU).

  • never
  • first time adding item
  • each ua session
|1310|Persisted, Enumerated, ExpertPage| SubscriptionActive|Active flag for the subscription.|1300|ExpertPage| StandardPropSync|When to synchronize selected OpcUA Standard Properties from server nodes to local apis item attributes (Unit, EU).|1310|Persisted, Enumerated, ExpertPage| TimeReferenceItem|An item who's value will be used as the time reference for this module instead of the system time, when timestamping items.|200|Persisted, ApisItem, ExpertPage| TraceLogLevel|The level of trace messages to log.|1420|Persisted, Enumerated, ExpertPage| TraceOPCServer|Report specific OPC calls, return from those calls, as well as callbacks to the log files for log view in Apis Management Studio.|1400|Persisted, Enumerated, ExpertPage| TraceToFile|If set, all OPC calls and callbacks will be traced to this file. Should only be used for short time periods and for verbose troubleshooting of communication.|1410|Persisted, File, ExpertPage| TraceToFileVerbosity|Specifies how much information that are written to the trace-file, if property 'TraceToFile' is set to a valid file. (Property ID: 1411)|1411|Persisted, File, Enumerated, ExpertPage| UseApisTime|Use Apis timestamps instead of the timestamps given by the OPC server.|1223|Persisted, ExpertPage| WriteMode|How items are being written to the server. Synchronous: items are written through a blocking call; Asynchronous; items are written through a non-blocking call. When the module is data, it might be desirable to do so without blocking any executing thread/operation, like any other eventbroker commands configured on the same eventbroker event, i.e. like External items transfer.|1201|Persisted, Enumerated| WriteTimeStamp|Select the timestamp to include, if any, when writing a data value to the OPCUA server.|1500|Persisted, ExpertPage|

Informational properties:

|Name|Description|ID|Flags| |-| DebugInfo|Debug information for advanced troubleshooting|2200|ReadOnly, InfoPage| ExternalItem report|A status-report for the External Item manager of this module|110|InfoPage| RevisedKeepAliveCount|The actual maximum keep-alive count. The Server should attempt to honor the Client request for this parameter, but may negotiate this value up or down to meet its own constraints.|2111|InfoPage| RevisedLifetimeCount|The lifetime of the Subscription shall be a minimum of three times the keep-alive interval negotiated by the Server.|2112|InfoPage| RevisedPublishingInterval|The actual publishing interval that the Server will use, expressed in milliseconds. The Server should attempt to honor the Client request for this parameter, but may negotiate this value up or down to meet its own constraints.|2110|InfoPage| ServerNamespaceArray|The NamespaceArray of the UA server.|2060|Persisted, ReadOnly, InfoPage| SrvActive|Currently active server, when using redundant severs, this tells which of the two that is currently set as active server (Primary / Redundant).|2050|ReadOnly, InfoPage| SrvCurrentTime|The current time (UTC) as known by the OPC server.|2121|ReadOnly, InfoPage| SrvStartTime|Time (UTC) the server was started. This is constant for the server instance and is not reset when the server changes state. Each instance of a server should keep the time when the process started.|2120|ReadOnly, InfoPage| SrvState|The current status of the OPC server|2105|ReadOnly, InfoPage| UaLibSessionStatus|The last session status change, as reported by the UA client library.|2100|ReadOnly, InfoPage| UaLibSubscriptionStatus|The last subscrption status change, as reported by the UA client library.|2101|ReadOnly, InfoPage|

Performance properties:

|Name|Description|ID|Flags| |-| SrvLastWriteCallTime|The last time we have written (one or more items) to the OPC server.|3080|ReadOnly, PerformancePage| SrvAvgItemsPerCall|The average number of items in each update call.|3064|ReadOnly, PerformancePage| SrvLastUpdateInterval|The time in seconds between the last two updates.|3061|ReadOnly, PerformancePage| SrvPercentUpdateInvalid|The percentage of all updated items that was invalid (e.g. unknown item handles).|3070|ReadOnly, PerformancePage| SrvPercentUpdateSuccess|The percentage of all updated items that have been updated with success.|3066|ReadOnly, PerformancePage| SrvPercentUpdateUnneccessary|The percentage of all updated items that was unnecessary (neither value nor quality had changed).|3068|ReadOnly, PerformancePage| SrvPercentWriteCmplFail|The percentage of all write complete items that have failed.|3088|ReadOnly, PerformancePage| SrvPercentWriteCmplInvalid|The percentage of all write complete items that was invalid (e.g. unknown item handles).|3090|ReadOnly, PerformancePage| SrvPercentWriteCmplSuccess|The percentage of all write complete items that have succeeded.|3086|ReadOnly, PerformancePage| SrvUpdateCalls|The number of times the OPC server has called back to this client with updated item values.|3062|PerformancePage| SrvUpdateTimeClient|The time when this client received the last update, as known by the client.|3060|ReadOnly, PerformancePage| SrvWriteCalls|The number of times the OPC server has called back to this client with updated item values.|3082|PerformancePage|

Connection properties:

The following properties have been deprecated by the introduction of the Server property.
When the Server property is set to "<Custom configuration>", the properties in this list behave as in prior versions of Apis Hive. When the Server property is set to an OpcUa connection or OpcUa cluster, the properties in this list gets the additional flags ReadOnly and Hidden (except the ServerEndpoint property, which becomes ReadOnly but not Hidden; this property can then be used to check which server endpoint is active when connecting to an OpcUa cluster).

|Name|Description|ID|Flags| |-| |Authentication|The authentication method used when connecting to server. Can be:

  • Anonymous
  • Username/password

If set to 'Username/password, the properties 'Username' and 'Password' must also be specified.|1061|Persisted, Enumerated (ReadOnly, Hidden)| |CertificatePath|

Use this property to specify which certificate the OpcUaBee should use when connecting to the server.

When property 'PkiType' is 'Win32', this property specifies the subject-name of a certificate in the Windows Certificate Store. Typically this will be the name of the ApisHive instance.

  • Example using Win32: "ApisHive"

When property 'PkiType' is 'OpenSSL', this property specifies the name of a certificate file in the '<certificatestore>\trusted' folder.

  • Example using OpenSSL: "ApisHive.der"
|1042|

Persisted, File

(ReadOnly, Hidden)

| |CertificateStorePath|

This property specifies where the OpcUaBee should look for certificates. Default value is empty.

If PkiType is "Win32", this property specifies a folder within the Windows Certificate Store. If the property is empty, the OpcUaBee will use the value "UA Applications".

If PkiType is "OpenSSL", this property specifies a file system path relative to the ApisHive instance configuration folder. If the property is empty, the OpcUaBee will use the value "pki", which resolves to the folder "<APISDir>\Config&lt;InstanceName>\pki".

|1041|

Persisted, Folder

(ReadOnly, Hidden)

| |MessageSecurity|

This property sets the required security level for OpcUa messages. When setting this property, you may also have to set others.

If set to:

  • Unsecure: You must set 'SecurityPolicy' to 'None'.
  • 'Signed' or 'Signed and encrypted:' You must sprecify a 'SecurityPolicy' other than 'None'
|1045|

Persisted, Enumerated

(ReadOnly, Hidden)

| |NetworkTimeout|

This property specifies the timeout period for RPC messages sent to the OpcUa server, measured in milliseconds. Default is 5000.

|1111|

Persisted

(ReadOnly, Hidden)

| |PkiType|

This property selects which certificate handling implementation to use (PKI=Public Key Infrastructure). The options are:

  • OpenSSL: using the filesystem to access certificates
  • Win32: using the Windows Certificate Store.
|1040|

Persisted, Enumerated

(ReadOnly, Hidden)

| |Password|

Password used to authenticate with server. Only applies when the property 'Authentication' is 'Username/password'.

|1003|

Persisted

(ReadOnly, Hidden)

| |PrivateKeyPath|

This propery is used to select the private key for the active certificate.

When PkiType is 'OpenSSL', the property specifies the name of a key-file in the "<certificatestore>\private" folder, encoded in PEM format. Typically, if CertificatePath is "ApisHive.der", PrivateKeyPath would be "ApisHive.pem".

When PkiType is 'Win32', this property is ignored (the Windows Certificate Store handles the link between certificates and their private key).

|1043|

Persisted, File

(ReadOnly, Hidden)

| |ReconnectTime|

The time to wait before attempting to reconnect the server after an RPC failure, or time interval for watchdog evaluation if watchdog is configured.

|1355|Persisted, Enumerated, ExpertPage| |RedundantCertificatePath|

This property is identical to the CertificatePath property, but for the redundant server.

|1542|Persisted, File, ExpertPage| |RedundantCertificateStorePath|

This property is identical to the CertificateStorePath property, but for the redundant server.

|1541|Persisted, Folder, ExpertPage| |RedundantMessageSecurity|

This property is identical to the MessageSecurity property, but for the redundant server.

|1545|

Persisted, Enumerated, ExpertPage

(ReadOnly, Hidden)

| |RedundantPkiType|

This property is identical to the PkiType property, but for the redundant server.

|1540|

Persisted, Enumerated, ExpertPage

(ReadOnly, Hidden)

| |RedundantPrivateKeyPath|

This property is identical to the PrivateKeyPath property, but for the redundant server.

|1543|

Persisted, File

(ReadOnly, Hidden)

| |RedundantSecurityPolicy|

The OpcUa securitypolicy URI do use when connecting to the redundant server. Default value is "http://opcfoundation.org/UA/SecurityPolicy#None"

|1546|

Persisted, Enumerated

(ReadOnly, Hidden)

| |RedundantServerCertificatePath|

Path/name of redundant server certificate. This property must refer to a valid certificate when RedundantMessageSecurity is either "Signed" or "Signed and encrypted".

|1544|

Persisted, File, ExpertPage

(ReadOnly, Hidden)

| |RedundantServerEndpoint|

The Endpoint URL of any redundant OPC UA server. The use of a redundant server when the primary server is unavailable is triggered by setting this property.

|1501|

Persisted, ExpertPage

(ReadOnly, Hidden)

| |SecurityPolicy|

The OpcUa securitypolicy URI do use when connecting to the server. Default value is "http://opcfoundation.org/UA/SecurityPolicy#None"

|1046|

Persisted, Enumerated

(ReadOnly, Hidden)

| |ServerCertificatePath|

Path/name of server certificate. This property must refer to a valid certificate when MessageSecurity is either "Signed" or "Signed and encrypted". If MessageSecurity is 'None', this property is ignored.

When property 'PkiType' is 'Win32', this property specifies the subject-name of a certificate in the Windows Certificate Store.

  • Example using Win32: "ApisHiveUaServerInstance"

When property 'PkiType' is 'OpenSSL', this property specifies the name of a certificate file in the '<certificatestore>\trusted' folder.

  • Example using OpenSSL: "ApisHiveUaServerInstance.der"
|1044|

Persisted, File

(ReadOnly, Hidden)

| |EndpointUrl|

The endpoint URL used to connect with an OPC UA server. Syntax: opc.tcp://{HostName or IP address}:{port number}

Example: opc.tcp://localhost:4850

|1001|

Persisted

(ReadOnly)

| |ReverseConnection|

Specifies if the client or the server should initiate the connection

|1005|

Persisted

(ReadOnly)

| |SessionTimeout|

Requested maximum number of milliseconds that a Session should remain open without activity. If the Client fails to issue a Service request within this interval, then the Server shall automatically terminate the Client Session. Default is 60000 milliseconds.

|1112|

Persisted

(ReadOnly, Hidden)

| |TokenTimeout|

The timeout in seconds, of the security token if using 'MessageSecurity' other than 'None'. Default is 60000 seconds.

|1113|

Persisted

(ReadOnly, Hidden)

| |Username|

Username used to authenticate with server. Only applies when the property 'Authentication' is 'Username/password'.

|1002|

Persisted

(ReadOnly, Hidden)

|

See also Module Properties