UaGateway  1.5.9.466
OPC Server Configuration

The Configuration Tool can be used to add, configure and connect to OPC COM AE/DA, OPC UA and OPC XML-DA servers.

To add and connect to different underlying servers, the Configuration Tool of the UaGateway provides a GUI based configuration. To start the Configuration Tool, either right-click on the Notification Area Icon and select "Configuration Tool" or select Program menu → Unified Automation → UaGateway → UaGateway Configuration.

To add a new server, select the corresponding entry in the Device Address Space window and press the button "Add Server..." in the main window.

config_add_new_server.png
Configuration—Add New Server

A new window will appear where you have to enter the information necessary to add the server. Please refer to one of the following sections for details:

It is possible that not all of the entries above show up in the Device Address Space window. For a description on how to enable/disable these channels, see Channels.

OPC COM AE/DA/HDA Server

Adding or configuring an OPC COM AE, DA or HDA Server to the UaGateway is similar. After pressing the button "Add Server..." a dialog window will open.

config_add_local_com_server.png
Add Local COM Server

To add a COM Server, expand the tree at "Local" and select the server you’d like to add then press "Add & Continue" to add the selected server without closing the window (e.g. if you would like to add other servers). At clicking on "Add & Close" the server is added and the dialog window is closed. To exit the dialog window without changing the configuration, click "Close".

Warning
Only connections to local COM servers are supported see No Remote DCOM Connections.

The UaGateway automatically connects to newly added COM Servers. To disconnect a server or edit its configuration, select it in the Devices Address Space window. Now the server status and configuration details will be displayed in the main window.

config_com_server_details.png
COM Server Details

At "Server Status", the connection status is shown and there are buttons for connecting/disconnecting the server.

At "Configuration OPC COM AE/DA/HDA Server Connection", you can edit the Watchdog Time or the host name and ProgId of the connected server.

The Watchdog Time is used as interval between connection checks or reconnect attempts in the case of a connection interruption.

For COM DA servers, it is possible to disable Write, for COM AE servers, Acknowledge can be disabled by checking the respective box.

Handling of In Process COM Servers

By default, the UaGateway does only connect to out of process or remote OPC Data Access servers. However, when absolutely necessary, the connection to in process servers can be enabled.

Warning
The connection to in process servers is not recommended and can cause issues if the server to connect to is not stable.
Please be extremely careful when editing the configuration file by hand. It should only be done when absolutely necessary. Use the Administration or Configuration Tool instead.

Open the file [Installation Directory]/uagateway.config.xml containing the configuration of UaGateway. The configuration information for a COM DA Server has the following structure:

1 <OpcComDa>
2 ...
3  <OpcComDaServer>
4  <Name>OPCSample.OpcDaServer.1</Name>
5  <Url>opcda://localhost/OPCSample.OpcDaServer.1</Url>
6  <ConnectFlag>true</ConnectFlag>
7  <WatchdogTime>10000</WatchdogTime>
8  <ForceDa2Browsing>false</ForceDa2Browsing>
9  <ForceComInproc>false</ForceComInproc>
10  </OpcComDaServer>
11 </OpcComDa>

To allow the connection to in process servers, set ForceComInproc to true and restart the UaGateway.

OPC UA Server

After pressing the button "Add Server..." a dialog window will open.

If the server you would like to connect to is registered at the Local Discovery Server, you can simply expand the tree at "Local", browse for the server and pick the endpoint to use. Browsing the local network for an OPC UA server works in a similar way.

config_add_local_ua_server.png
Add Local UA Server

But as every OPC UA Server has to provide a discovery endpoint, the Server URL can be used for discovery as well. Double click on "Double click to Add Server..." to open a dialog window for entering the address of the OPC UA Server in the following form:

  • opc.tcp://<Hostname>:<Port>
  • opc.tcp://<IP Address>:<Port>
config_enter_url.png
Enter URL of Discovery Server

The server will now appear below "Custom Discovery" in the tree view, showing all open endpoints.

config_ua_custom_discovery.png
Add Local UA Server

When selecting an endpoint, the necessary input fields are filled with default values which you can change to your needs:

Integration of the Server in the Address Space
Change the name of the Server, choose between "ServerUri" and "Name" as namespace prefix from the drop-down list
Security Settings
When connecting to a secure endpoint, you can choose between the message security modes "Sign" and "Sign & Encrypt".
Authentication Settings
You can connect with username/password authentication if supported by the server.

Press "Add & Continue" to add the selected server without closing the window (e.g. if you would like to add other servers). At clicking on "Add & Close" the server is added and the dialog window is closed. To exit the dialog window without changing the configuration, click "Close".

Note
When choosing a secure endpoint, the connection to the UA server is not established immediately, because the UaGateway’s certificate is not trusted yet. See HowTo: Add and Connect to an Underlying UA Server for an example.

After sucessfully adding a UA Server, it shows up in the Devices Address Space Window. Select it to modify settings and display additonal configuration options.

Server Settings

In the left column you can change the connection settings you chose when adding the server: endpoint URL, security settings, and authentication settings (see screenshot).

Configuration

At "Configuration" (top of the right column), you can change the following connection settings:

Connect Timeout
Timeout for connection establishment to the underlying OPC UA Server.
Service Timeout
Timeout for service calls to the underlying OPC UA Server.
Watchdog Time
Interval between connection checks or reconnect attempts in the case of a connection interruption.
Watchdog Timeout
Timeout for status read calls to the underlying OPC UA Server used to check the connection.
Max Operations per Service Call
Underlying OPC UA Servers may have limitations for the number of operations in Read, Write or CreateMonitoredItems service calls. This setting forces the UaGateway to split calls into several service invocations to the underlying OPC UA Server if the number of operation exceeds this setting.
config_ua_server_config.png
Configuration Options for UA Servers

Hidden Configuration Switches

Some features are not available in the GUI of the Configuration Tool.

Warning
Before editing the configuration file by hand shutdown UaGateway. Do not touch any settings other than the settings described in this section. Otherwise you might break the configuration and UaGateway won't start anymore.

Open the file [Installation Directory]/uagateway.config.xml. For each configured connection to an underlying OPC UA server you find an entry like this:

1 <OpcUaServer>
2  <Name>UaServerCpp@test-pc-08</Name>
3  <Url>opc.tcp://test-pc-08:48010</Url>
4 ...
5  <LocaleId>de</LocaleId>
6 </OpcUaServer>

To set the LocaleId for a connection to an underlying OPC UA server add/edit the entry for LocaleId. Note that this is a global setting for the configured connection to an OPC UA Server. That means any client connected to UaGateway will get localized texts for that LocaleId. Dependent on the underlying OPC UA server this applies to e.g. DisplayNames, MessageText for Events and Alarms.

Security Check Overrides

Some of the OPC UA security checks are optional in OPC UA or cause interoperability issues with older OPC UA servers. Check the box in front of an override to activate it.

config_ua_server_security_overrides.png
Security Check Overrides

Some of the OPC UA security checks are optional in OPC UA or cause interoperability issues with older OPC UA servers. Check the box in front of an override to activate it.

OPC XML-DA Server

After pressing the button "Add Server..." a dialog window will open. Enter the server information into the respective fields.

config_add_xmlda_server.png
Add OPC XML-DA Server

Press "Add & Continue" to add the selected server without closing the window (e.g. if you would like to add other servers). At clicking on "Add & Close" the server is added and the dialog window is closed. To exit the dialog window without changing the configuration, click "Close".

After successfully adding the XML-DA Server, it will be displayed in the Devices Address Space Window. Select the server to display its status and change the configuration. It is also possible to edit the Watchdog Time.

The Watchdog Time is used as interval between connection checks or reconnect attempts in the case of a connection interruption.

config_xmlda_server_config.png
Configure OPC XML-DA Server