OPC UA Client Interface Reference
OPC UA Client Interface Reference
Release 511
2
Contents
CONTENTS
Contents 3
Chapter 1 - Planning considerations for OPC UA controllers 5
OPC UA Client support 6
Devices supported by the OPC UA Client interface 9
Other documentation for OPC UA Client 9
Architectures for OPC UA Client 9
Single connection to an OPC UA Server 10
Dual LAN connection to an OPC UA Server 10
Communication settings for OPC UA Client 11
Chapter 2 - OPC UA channel and controller reference 13
Main properties for an OPC UA channel 14
Advanced properties for an OPC UA channel 15
Main properties for an OPC UA controller 16
Security properties for an OPC UA controller 18
Advanced properties for an OPC UA controller 19
About time synchronization on OPC UA Client 20
About behavior of redundant communication links 20
Optimizing OPC UA Client scanning performance 20
Chapter 3 - OPC UA points reference 25
Defining an OPC UA address for a point parameter 26
Address syntax for OPC UA controllers 26
Address syntax for OPC UA methods 31
Configuring communication with an OPC UA Server 33
Chapter 4 - OPC UA security reference 37
Generating Experion OPC UA Client certificates 38
3
Contents
4
CHAPTER
Revision history
Revision Date Description
Step Go to
5
Chapter 1 - Planning considerations for OPC UA controllers
Step Go to
Secure connection
The Experion server optionally supports secure connection in the
communication with an OPC UA server by using Sign or Sign And Encrypt
message modes with certificates. To establish a secure connection between
the OPC UA Client and an OPC UA server, you need to generate an OPC
UA Client certificate, export the OPC UA server certificate, and configure the
URLs of the OPC UA server on the Experion server. For more information,
see "OPC UA security reference" on page 37.
User authentication
The Experion server supports the username/ password authentication to
identify itself to the OPC UA server. The anonymous authentication is another
option if the OPC UA server supports it.
6
Chapter 1 - Planning considerations for OPC UA controllers
Data types
The Experion server supports the following OPC UA data types:
OPC UA
String
Data Analog Point Status Point Analog UDSP1 Status UDSP
UDSP
Type
Double Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
No bit wise No bit wise
extraction extraction
Float Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
No bit wise No bit wise
extraction extraction
Int16 Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
Int32 Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
Cannot control the Cannot control the
upper 16 bit of upper 16 bit of
value for bit wise value for bit wise
control control
Int64 Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
No bit wise No bit wise
Cast to double extraction Cast to double extraction
precision precision
UInt16 Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
UInt32 Scan and Scan and Control Scan and Scan and Control Not
1UDSP stands for user-defined scanned parameter. For more information, see "About user-
defined scanned parameters" in the Quick Builder User’s Guide.
7
Chapter 1 - Planning considerations for OPC UA controllers
OPC UA
String
Data Analog Point Status Point Analog UDSP1 Status UDSP
UDSP
Type
UInt64 Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
No bit wise No bit wise
Cast to double extraction Cast to double extraction
precision precision
Byte Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
Signed Scan and Scan and Control Scan and Scan and Control Not
Byte Control Control supported
Boolean Scan and Scan and Control Scan and Scan and Control Not
Control Control supported
String Not supported Not supported Not supported Not supported Scan
only, up
to 64
bytes
Date Scan only Not supported Scan only Not supported Not
Time supported
Need format of Need format of
DATETIME DATETIME
Displayed in Displayed in
local time zone local time zone
of the Experion of the Experion
server server
1UDSP stands for user-defined scanned parameter. For more information, see "About user-
defined scanned parameters" in the Quick Builder User’s Guide.
8
Chapter 1 - Planning considerations for OPC UA controllers
9
Chapter 1 - Planning considerations for OPC UA controllers
10
Chapter 1 - Planning considerations for OPC UA controllers
11
Chapter 1 - Planning considerations for OPC UA controllers
12
CHAPTER
In this section:
13
Chapter 2 - OPC UA channel and controller reference
Property Description
14
Chapter 2 - OPC UA channel and controller reference
Property Description
You can change the Item Number if you need to match your current server
database configuration. The number must be between 0001 and the maximum
number of channels allowed for your system. For more information about
setting the maximum value, see the topic titled "Adjusting sizing of non-licensed
items" in the Supplementary Installation Tasks Guide. Note that the maximum
number of channels that may be used in a system is defined in the Experion
specification for that Experion release, This number is likely to be less than the
maximum number that can be configured in the database as shown in
"Adjusting sizing of non-licensed items."
Property/Action Description
Namespaces The table lists the abbreviations and the associated namespace URIs to be
used for OPC UA node addressing.
The default Namespaces are listed in the table in non-editable rows. For
example, the default abbreviations include OPCUA, PLC, PLCFB, SVRURI,
UA_DI, and MDIS.
Add Add a namespace abbreviation that does not conflict with the default
abbreviations along with the associated full namespace URI.
TIP:
l You can define a maximum of 6 alphanumeric characters with
no space for each abbreviation. The namespace URI is case
sensitive.
l The total length of the namespace URIs combined cannot
exceed 300 characters.
l The namespace abbreviation should not be only digits as that
may be confused with Namespace Array Index in OPC UA
node addresses.
15
Chapter 2 - OPC UA channel and controller reference
Property/Action Description
Delete Delete the selected user defined namespace entry from the table.
Property Description
Marginal The communications alarm marginal limit at which the controller is declared to
Alarm Limit be marginal. When this limit is reached, a high priority alarm is generated.
To change the priority of the alarm system wide, see "Configuring system
alarm priorities" in the Server and Client Configuration Guide. To change the
priority of the alarm for one controller, see "About configuring custom system
alarm priorities for an individual channel or controller" in the Server and Client
Configuration Guide.
A controller barometer monitors the total number of requests and the number
of times the controller did not respond or response was incorrect. The
barometer increments by two or more, depending on the error, and
decrements for each valid response received within the read timeout.
16
Chapter 2 - OPC UA channel and controller reference
Property Description
failed. When this barometer limit is reached, an urgent alarm is generated and
Experion attempts to reconnect to the OPC UA server at the diagnostic rate
configured on the assigned OPC UA channel.
To change the priority of the alarm system wide, see "Configuring system
alarm priorities" in the Server and Client Configuration Guide. To change the
priority of the alarm for one controller, see "About configuring custom system
alarm priorities for an individual channel or controller" in the Server and Client
Configuration Guide.
Typically, set this to double the value specified for the controller Marginal Alarm
Limit.
Dynamic Select the Dynamic Scanning check box to enable dynamic scanning of all point
Scanning parameters on this controller. The default setting for this check box is selected.
Fastest Define the fastest possible scan period (in seconds) that dynamic scanning will
Scan Period scan point parameters on this controller. The default is 1 second.
The dynamic scanning period does not affect the static scanning rate for a
parameter. For example, if the scanning rate for a parameter is 10 seconds,
and the dynamic scanning rate for the controller is 15 seconds, the parameter
will still be subscribed to scan at a period of 10 seconds.
Link A Provide the OPC UA server endpoint URL, which is typically in the format Host
Endpoint IP Address:Port Number . For example,10.2.3.15:4840 . It can also be in the
URL format Host Name:Port Number:Addition Text, as required to address the OPC
UA server endpoint URL.
Link B
Endpoint If the Redundant Channel option is enabled on the assigned OPC UA channel,
URL the Link B Endpoint URL will be visible for redundant communications link.
Item Type The type of controller specified when this item was created.
Last The date and time the controller properties were modified.
Modified
17
Chapter 2 - OPC UA channel and controller reference
Property Description
Last The date and time the controller was last downloaded to the server.
Downloaded
Item The unique item number currently assigned to this controller, in the format
Number RTUnnnnn .
You can change the Item Number if you need to match your current server
database configuration. The number must be between 00001 and the
maximum number of controllers allowed for your system.
For more information about setting the maximum value, see the topic titled
"Adjusting sizing of non-licensed items" in the Supplementary Installation
Tasks Guide.
Note that the maximum number of controllers that may be used in a system is
defined in the Experion specification for that Experion release, This number is
likely to be less than the maximum number that can be configured in the
database as shown in "Adjusting sizing of non-licensed items."
Property Description
TIP: If Sign and Encrypt or Sign Only is selected, a message appears stating
that certificates must be installed to use the security mode. For information
about how to install the certificates, see "OPC UA security reference" on
page 37.
Security The security policy for the OPC UA connection. A Security Level must be selected if
Level Sign and Encrypt or Sign Only security mode is used.
NOTE: This selection must match the security policy of the certificate that
18
Chapter 2 - OPC UA channel and controller reference
Property Description
For more information about the security model for OPC UA, see "OPC UA
Specification Part 2: Security Model" and "Practical Security
Recommendations for Building OPC UA applications" from the
OPC Foundation website http://www.opcfoundation.org.
Property Description
Use the OPC UA If selected, any alarm raised as a result of a value change from the
server timestamp OPC UA server should be raised with the time sent by the OPC UA
when raising alarms server with the value change (the source field time).
19
Chapter 2 - OPC UA channel and controller reference
Property Description
This may be used, for example, if there is a node in the address space
which contains all the nodes of interest for this OPC UA controller,
and it is desirable to have shorter addresses on the points.
For more information about the relative path syntax, see "BNF
definition" in the OPC UA Specification.
20
Chapter 2 - OPC UA channel and controller reference
Point Scanned
Range to use for calculating OPC UA Server subscription deadband
type parameter
Analog SP, PV, The "0% Range Value" and "100% Range Value" configured for the
A1, A2, point. Use the drift deadband configuration on the point for percentage
A3, A4 calculations.
Status PV, OP No drift deadband.
Analog OP 0 - 100 range is always applied for calculating deadband for OP
parameter.
All UDSP — Use the EUHI/EULO configured for the UDSP.
Numeric
All UDSP — No drift deadband.
Status
All MD No drift deadband.
ATTENTION:
l If multiple points address the same address in the OPC UA server,
it is highly recommended that the same drift deadband is applied
on all of these points. If a different drift deadband is configured, the
smallest deadband of all points will be used for the deadband sent
21
Chapter 2 - OPC UA channel and controller reference
The following parameters are valid and can be used to monitor performance
of the communications channel:
CNQLength Queue of
controls
(writes) to be
written to the
OPC UA
server.
RequestsPerSec RequestsPerSecLinkA RequestsPerSecLinkB Count of
requests and
value change
callbacks being
processed per
second.
22
Chapter 2 - OPC UA channel and controller reference
23
Chapter 2 - OPC UA channel and controller reference
ATTENTION:
l A communication's channel trace on an OPC UA channel does not
contain data sent or received over the wire to the OPC UA server.
If there is a requirement to analyze communication's traffic, 3rd
party network monitoring tools such as Wireshark must be used in
place of the communication's trace.
l The Channel Marginal and Fail limits are intentially set to 0 as all
communications is via TCP/IP connection which is logically
maintained per controller, not per channel. Increasing the
controller marginal and fail limits from their defaults, may
negatively impact the recovery of communications after
communication failures are resolved or upon a redundant link
failover.
l Wireshark is a registered trademark of the Wireshark Foundation
(https://www.wireshark.org/about.html.)
You verify your scanning strategy by using the List Scan utility, lisscn , to
inspect the list of OPC UA Node IDs you have built. For more information
about the lisscn utility, see "lisscn" in the Server and Client Configuration
Guide.
24
CHAPTER
This section describes how to configure points for an OPC UA controller using
Quick Builder.
In this section:
25
Chapter 3 - OPC UA points reference
Part Description
Part Description
26
Chapter 3 - OPC UA points reference
Part Description
default or user added abbreviations defined in the Advanced tab for
the OPC UA channel. It can also be a numeric value to reference the
namespace index in the OPC UA server directly.
D (Only applicable to address type N.) Specifies the Node ID data type,
the value is a single letter which can be:
address The format of address is dependent on the address type and Node
ID data type.
For more information about the syntax of the Node ID for different
variable types, refer to the T and D part descriptions above.
(Optional) [Array (Optional) Specifies the address is an array element for a Node ID
Index] that has the value of an array. The Array Index must be in the format
of [index], e.g., [10]. Index must be between 0 to the maximum value
of signed 32 bit integer.
[B:b|W:w|DataFormat] Specifies the optional Bit number extraction (b), the Bit field width
(w), or Data Format which specifies a scaled or unscaled, system or
user defined, data format to apply scaling to the value from the OPC
UA server.
27
Chapter 3 - OPC UA points reference
Part Description
If you want to use a user-defined data format, you must define the
format on the server. For more information, see "About user-defined
data formats" in the Server and Client Configuration Guide.
Sample address
28
Chapter 3 - OPC UA points reference
urces/4:eclrRes/3:GlobalVars/EDGPLC:zStaticINT32
Var
29
Chapter 3 - OPC UA points reference
1S = Signed, U = Unsigned
30
Chapter 3 - OPC UA points reference
ATTENTION: If auxiliary parameters have a data format type that requires scaling
(U4095, U999, and so on), they take the same range as the PV.
ATTENTION:
l The OPC UA method address is only valid for a parameter's
destination address.
l The OPC UA method address defined refers to the Method
Context Object Node, not the Method itself. For more information,
see "Method NodeClass" in the OPC UA Specification.
l If the OPC UA method call fails, it is treated as a control failure.
1S = Signed, U = Unsigned
31
Chapter 3 - OPC UA points reference
Part Description
address The format of address is dependent on the address type and Node ID data type.
32
Chapter 3 - OPC UA points reference
Part Description
identify the method that is referenced by the Method's Context Object Node. It's
value contains two elements: name and namespace index/abbreviations.
l Each method can have only one argument set as the control value being
written in the point parameter.
For example, Double(6.2) Double Double(3.0) . This method has 3
arguments of data type Double , Argument 1 is set with the fixed value 6.2 ,
Argument 2 is set with the control value Double , Argument 3 is set with
the fixed value 3.0 .
Prerequisites
n You have logged on to Configuration Studio using an account with
engineer or manager privileges, and you have connected to the Experion
server.
n You have logged on to Station using an account with manager privileges.
33
Chapter 3 - OPC UA points reference
2. From the Channels section within the Library, drag and drop the OPC UA
Channel item into the List View.
3. Configure the channel in the properties tabs.
For more information, see "Main properties for an OPC UA channel" on
page 14 .
l In the Security tab, in the Security Level field, select High Security
(BASIC256 SHA-256) from the drop-down list.
For more information, see "Main properties for an OPC UA controller" on
page 16 .
34
Chapter 3 - OPC UA points reference
35
Chapter 3 - OPC UA points reference
36
CHAPTER
In this section:
37
Chapter 4 - OPC UA security reference
Prerequisite
You have logged on to the Experion server using a Windows account that is a
member of the Product Administrators group.
TIP: This is the actual computer name of the Experion server, not
the base name.
38
Chapter 4 - OPC UA security reference
TIP: Check the Details tab and the value of Subject Alternative
Name . The Subject Alternative Name value should contain the
expected hostname, URI, DNS suffix, and IP address(es).
TIP: Make sure the CA certificate's file name is different from the
client certificate's file name created in "To generate a client
certificate as the OPC UA Client certificate " on the previous page.
39
Chapter 4 - OPC UA security reference
ATTENTION:
Prerequisites
n You have confirmed that the third-party OPC UA server is compatible with
the Experion OPC UA Client.
n You have connected the third-party OPC UA server to the Experion
server.
40
Chapter 4 - OPC UA security reference
Prerequisite
You have logged on to the Experion server using a Windows account that is a
member of the Product Administrators group.
TIP: Type 0 if you use the same OPC UA Client certificate for all
OPC UA connections. If you are prompted for entering a channel
number to use the same OPC UA Client certificate for a single
OPC UA channel, you can type 0 to use the same OPC UA Client
certificate for all OPC UA channels.
41
Chapter 4 - OPC UA security reference
ATTENTION:
Prerequisites
n On the OPC UA controller Security tab, the login type has been set to
Username .
n You have logged on to the Experion server using a Windows account that
is a member of the Local Engineers group.
42
Chapter 4 - OPC UA security reference
43
Chapter 4 - OPC UA security reference
44
CHAPTER
5 TROUBLESHOOTING OPC UA
CLIENT ISSUES
This section describes troubleshooting tasks for OPC UA Client that you can
perform either on the server or from any Station.
In this section:
45
Chapter 5 - Troubleshooting OPC UA Client issues
To resolve:
Correct the address configuration in Configuration Studio. In this example,
correct the address of which the Value is currently configured to
Demo.Static.Scalar.NonExistent as in the second log message above.
46
Chapter 5 - Troubleshooting OPC UA Client issues
To resolve:
For the address configured to these NodeIDs, ensure that a 0 deadband is
configured on the point configuration in Configuration Studio, and re-
download any points for which the deadband is changed.
47
Chapter 5 - Troubleshooting OPC UA Client issues
pascn.exe:OPCUATransaction.cpp:1000:
COPCUATransaction::ProcessDataValue (rtu=50, link=0, tid=159) .. AddressId 1:
Node Id is an array value but address is not configured with an array index
24-Feb-17 11:47:57.2062 ( -1 16728 11804 T00000000)
pascn.exe:OPCUATransaction.cpp:1003:
COPCUATransaction::ProcessDataValue .. NodeId : Type=String,
Value='Demo.Static.Arrays.Int32', NamespaceIndex=2
To resolve:
1. Correct the address for any points with the Value as given in the second
log message above.
2. Ensure the Array Index of the address is configured according to the
address configuration.
3. Ensure there is a space between the NodeID and the Array Index.
4. Re-download any points for which the address is changed.
To resolve:
1. Correct the address for any points with the Value as given in the second
log message above.
2. Ensure the Array Index of the address is configured within the range of
48
Chapter 5 - Troubleshooting OPC UA Client issues
To resolve:
Correct the data type for any NodeIDs with the Value as given in the second
log message above.
TIP:
49
Chapter 5 - Troubleshooting OPC UA Client issues
Runtime errors
Log messages similar to the following example indicate that no response was
received from the OPC UA server within the READ timeout configured for the
channel. You can filter on the bold and italic text to show just these messages.
To resolve:
To resolve:
50
Chapter 5 - Troubleshooting OPC UA Client issues
1. Run certtool and select the option to show certificates that have been
configured for the controller.
2. Find out which certificate/key file is missing from the following list:
l Server certificate: server.cer
l Client certificate: client.cer
l Client private key: client.key
l (Optional) Client certification authority certificate: client.ca.cer
l (Optional) Client certification authority CRL: client.ca.crl
l (Optional) Server certification authority certificate: server.ca.cer
l (Optional) Server certification authority CRL: server.ca.crl
3. Use certtool to store the missing certificate/key on the controller. For more
information, see "Configuring an OPC UA controller to use OPC UA
certificates" on page 41.
To resolve:
n Check the OPC UA server's certificate configuration and ensure the client
certificate is configured for access on the OPC UA server.
n For the uStatus value that is provided on the log message above, further
information is available by looking at the descriptive text provided by the
OPC Foundation for OPC UA Status Codes
(https://opcfoundation.org/UA/schemas/1.02/Opc.Ua.StatusCodes.csv.)
51
Chapter 5 - Troubleshooting OPC UA Client issues
filter on the bold and italic text to show just these messages.
To resolve:
Use rtucredentials to correct the username/password configuration. For more
information, see "Configuring the username and password for OPC UA
controllers" on page 42.
Cause
Most typically, the cause is an invalid address for the OPC UA server.
Solution
Confirm the address for the OPC UA server is correct. For more information,
see "Defining an OPC UA address for a point parameter" on page 26.
52
Notices
NOTICES
Trademarks
Experion®, PlantScape®, and SafeBrowse® are registered trademarks of
Honeywell International, Inc.
Other trademarks
Microsoft and SQL Server are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Trademarks that appear in this document are used only to the benefit of the
trademark owner, with no intention of trademark infringement.
Third-party licenses
This product may contain or be derived from materials, including software, of
third parties. The third party materials may be subject to licenses, notices,
restrictions and obligations imposed by the licensor. The licenses, notices,
restrictions and obligations, if any, may be found in the materials
accompanying the product, in the documents or files accompanying such third
party materials, in a file named third_party_licenses on the media containing
the product, or at http://www.honeywell.com/ps/thirdpartylicenses.
Documentation feedback
You can find the most up-to-date documents on the Honeywell Process
Solutions support website at: http://www.honeywellprocess.com/support
If you have comments about Honeywell Process Solutions documentation,
send your feedback to: [email protected]
Use this email address to provide feedback, or to report errors and omissions
in the documentation. For immediate help with a technical problem, contact
your local Honeywell Technical Assistance Center (TAC).
53
Notices
Support
For support, contact your local Honeywell Process Solutions Customer
Contact Center (CCC). To find your local CCC visit the website,
https://www.honeywellprocess.com/en-US/contact-us/customer-support-
contacts/Pages/default.aspx.
Training classes
Honeywell holds technical training classes that are taught by process control
systems experts. For more information about these classes, contact your
Honeywell representative, or see http://www.automationcollege.com.
54