Actions

Difference between revisions of "OPC UA for AlphaCom - Installation"

From Zenitel Wiki

m
m
Line 31: Line 31:
 
*VS-OPC UA for AlphaCom_Setup_v1.0.3.0.msi
 
*VS-OPC UA for AlphaCom_Setup_v1.0.3.0.msi
 
<br>
 
<br>
By default, the software is installed in the following directory: C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom
+
By default, the software is installed in the following directory: '''C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom'''
Ensure that '''ALL''' executables in this directory run in 'Administrator Mode'.
+
Ensure that '''ALL''' executables in this directory run in '''Administrator Mode'''.
 
Right click on each executable and select 'Properties->Compatibility'. Set check mark in 'Run this program as an administrator'. This is necessary because the executable accesses restricted areas.
 
Right click on each executable and select 'Properties->Compatibility'. Set check mark in 'Run this program as an administrator'. This is necessary because the executable accesses restricted areas.
  
Line 39: Line 39:
 
The LDS is included in the installation package. The latest release can be downloaded from the following link:
 
The LDS is included in the installation package. The latest release can be downloaded from the following link:
 
https://opcfoundation.org/developer-tools/developer-kits-unified-architecture/local-discovery-server-lds
 
https://opcfoundation.org/developer-tools/developer-kits-unified-architecture/local-discovery-server-lds
*Navigate to 'C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom'
+
*Navigate to '''C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom'''
*Double-click on the installation package and follow the instructions:'OPC UA Local Discovery Server 1.03.355.exe'
+
*Double-click on the installation package and follow the instructions:'''OPC UA Local Discovery Server 1.03.355.exe'''
 
Check in the services dialog that OPC UA Local Discovery Server is running and will automatically start at system reboot.
 
Check in the services dialog that OPC UA Local Discovery Server is running and will automatically start at system reboot.
*Open 'Search Windows' and enter 'Services' in the input field. Click on the search result 'Services'
+
*Open '''Search Windows''' and enter '''Services''' in the input field. Click on the search result '''Services'''
 
[[File:LDS_Service.PNG|thumb|left|500px|LDS status: Running and Automatic]]
 
[[File:LDS_Service.PNG|thumb|left|500px|LDS status: Running and Automatic]]
 
<br style="clear:both;" />
 
<br style="clear:both;" />
 
*Status: Running
 
*Status: Running
 
*Startup Type: Automatic
 
*Startup Type: Automatic
in case these settings are not made, right click on the entry in the services dialog and select Properties. Make the appropriate selections under the TAB 'General' and click OK.
+
in case these settings are not made, right click on the entry in the services dialog and select Properties. Make the appropriate selections under the TAB '''General''' and click OK.
  
 
==UA Security==
 
==UA Security==
Line 53: Line 53:
 
The UA security is based on X509 Certificates.<br>
 
The UA security is based on X509 Certificates.<br>
 
Each UA server and client application requires a certificate with the Application URI of the application.
 
Each UA server and client application requires a certificate with the Application URI of the application.
Self-signed certificates can be created with the 'uaPLUS UaServerConfigHelper' utility. uaPLUS maintains certificates in the Windows Certificates Store.
+
Self-signed certificates can be created with the '''uaPLUS UaServerConfigHelper''' utility. uaPLUS maintains certificates in the Windows Certificates Store.
 
The certificates are by default in the stores  LocalMachine\UA Applications and LocalMachine\Trusted UA Applications
 
The certificates are by default in the stores  LocalMachine\UA Applications and LocalMachine\Trusted UA Applications
 
The stores are defined in the application UA configuration and can be changed if necessary.
 
The stores are defined in the application UA configuration and can be changed if necessary.
Line 105: Line 105:
 
Click '''Done'''
 
Click '''Done'''
  
===Check installed certificates===
+
===Creating a certificate for clients===
*Open a Command Prompt window as Administrator
+
 
*Type mmc and press the ENTER key. Note that to view certificates in the local machine store,  
+
===Creating a Certificate for DA3TestClientUaNet4===
*On the File menu, click Add/Remove Snap In.
+
The UaClientConfigHelper utility is provided with the uaPLUS server toolkit.  
*In the Available snap-ins box, select Certificates.
+
This utility is only needed for the configuration of the provided test client applications, mainly the management of the needed certificates.  
*Click Add.
+
The main dialog manages the configuration files.
In the Certificates snap-in dialog box, select Computer account and click Next. Optionally, you can select My User account or Service account. If you are not an administrator of the computer, you can manage certificates only for your user account.
+
 
*In the Select Computer dialog box, click Finish.
+
To create a certificate for a client drag the DA3TestClientUaNet4.exe over UaClientConfigHelperNet4.exe
*On the Add/Remove Snap-in dialog box, click OK.
+
 
*In the Console Root window, click Certificates (Local Computer) to view the certificate stores for the computer.
+
 
 +
===Creating a Certificate for AE-UATestClientNet4===
 +
 
 +
 
 +
===Make Clients Trusted Applications for the Server===
 +
 
 +
===Make OPC UA Server trust LDS===
 +
 
 +
===Make LDS trust OPC UA Server===
  
  

Revision as of 12:48, 31 August 2017

This article is under construction. The software described here is not available yet.
Please refer to OPC Server - Installation

Introduction

This document is an installation manual describing how to install the Vingtor-Stentofon OPC UA Server and all required additional software components. The Vingtor-Stentofon OPC UA Server makes it possible to control and monitor the Alphacom using the OPC UA protocol.

Scope

The article describes:

  • The software packages required for the installation
  • Installation of packages
  • Configuration of the OPC UA Server, Local Discovery Server and test clients.
  • Setup and use of the test OPC UA DA (data) and OPC UA AE (Alarm & Event) Clients

Prerequisites

Vingtor-Stentofon OPC UA Server is based on .NET version 4.6.2. This package can be freely downloaded from Microsoft.

Software package contents

The software packages consist of

  • The Vingtor-Stentofon OPC UA package (VS-OPC UA). Installing this packages
    • AE-UATestClientNet4.exe
    • DA3TestClientUaNet4.exe
    • UaClientConfigHelper.exe
    • UaPLUS.Net4.exe
    • UaServerConfigHelperNet4.exe
  • UA Local Discovery Server (OPC Foundation Home Page)

Software installation

Double-click on the msi-installation package and follow the instructions:

  • VS-OPC UA for AlphaCom_Setup_v1.0.3.0.msi


By default, the software is installed in the following directory: C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom Ensure that ALL executables in this directory run in Administrator Mode. Right click on each executable and select 'Properties->Compatibility'. Set check mark in 'Run this program as an administrator'. This is necessary because the executable accesses restricted areas.

UA Local Discovery Server

The Local Discovery Server (LDS) provides the necessary infrastructure to publicly expose the OPC UA Servers available on a given computer. The LDS is included in the installation package. The latest release can be downloaded from the following link: https://opcfoundation.org/developer-tools/developer-kits-unified-architecture/local-discovery-server-lds

  • Navigate to C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom
  • Double-click on the installation package and follow the instructions:OPC UA Local Discovery Server 1.03.355.exe

Check in the services dialog that OPC UA Local Discovery Server is running and will automatically start at system reboot.

  • Open Search Windows and enter Services in the input field. Click on the search result Services
LDS status: Running and Automatic


  • Status: Running
  • Startup Type: Automatic

in case these settings are not made, right click on the entry in the services dialog and select Properties. Make the appropriate selections under the TAB General and click OK.

UA Security

Introduction

The UA security is based on X509 Certificates.
Each UA server and client application requires a certificate with the Application URI of the application. Self-signed certificates can be created with the uaPLUS UaServerConfigHelper utility. uaPLUS maintains certificates in the Windows Certificates Store. The certificates are by default in the stores LocalMachine\UA Applications and LocalMachine\Trusted UA Applications The stores are defined in the application UA configuration and can be changed if necessary. The UaServerConfigHelper utility creates and imports certificates into the stores defined in the configura-tion. With the server and client on the same machine the certificates are in the right place when created or imported with the Advosol UaServerConfigHelper and UaClientConfigHelper utilities. With server and client on different machine the following steps are required:

  • On the server machine create a certificate for the server. UaClientConfigHelper automatically ex-ports created certificates into a .DER file in the utility directory.
  • Copy the client certificate .DER file to the server machine and import it with the UaServerCon-figHelper utility.
  • Copy the server .DER certificate file to the client machine and import it. The location depends on the client application. For Advosol UA client applications the UaClientConfigHelper utility imports the certificate to the proper location.

uaPLUS stores untrusted certificates it receives from connecting clients in the store defined in the UA configuration settings for rejected certificates (default: LocalMachine\Rejected UA Certificates). Instead of importing the client certificate before the client connects, the rejected certificate can be copied after a failed connect. The UaServerConfigHelper utility has an option (MOVE button) to copy the certificate. Note: The certificates must be configured for the Windows store type.

The Windows Certificates manager can be used to check and maintain the certificates beyond the capa-bilities of the UaServerConfigHelper utility.

Creating a Certificate for uaPLUS Server

The UaServerConfigHelper utility is provided with the uaPLUS server toolkit. This utility should be used to edit the UA server configuration file whenever possible. The UaServerConfigHelper also supports the import, export and creation of the necessary certificates. Certificates need to be created with this tool to meet all UA requirements. The Edit UA Configuration dialog edits the UA configuration XML file for the selected application.

The uaPLUS.Net4.exe is the generic part of the OPC UA server. Creating a certificate for the server is carried out in the way described below.

Drag the uaPLUS.Net4.exe over the UaServerConfigHelperNet4.exe. This gives a quick access to the server configuration:

Drag and drop uaPLUS.Net4.exe onto UaServerConfigHelperNet4.exe



UA Server Configuration Helper main screen


Press the 'Create UA Configuration' button and accept any changes.

Press the “Edit UA Configuration” and check if it looks as shown below. 'User Name' is not supported in the current version of the server.

UA Configuration


Note: The default directory for the trace log file is where the executables are installed: C:\Program Files (x86)\Vingtor Stentofon\VS-OPC UA for AlphaCom. This is a restricted area. Therefore, the log file name specification should be prefixed with for instance C:\Tmp\Log\ as is shown in the picture above.
The Trace Mask can be changed by clicking the Change button. Enabling all options will set the trace mask to the value 1023 as shown above.
Click Save to save the changes.
Click on Certificates

Manage Certificates


Click Create to create a certificate.
Click OK
Click Save and Close
In the UA Server Configuration Helper main screen, click on Firewall Exceptions. Make certain that port 62841 is in the column Ports Open in Firewall.

Port 62841 Open in Firewall


Click Done
Click Done

Creating a certificate for clients

Creating a Certificate for DA3TestClientUaNet4

The UaClientConfigHelper utility is provided with the uaPLUS server toolkit. This utility is only needed for the configuration of the provided test client applications, mainly the management of the needed certificates. The main dialog manages the configuration files.

To create a certificate for a client drag the DA3TestClientUaNet4.exe over UaClientConfigHelperNet4.exe


Creating a Certificate for AE-UATestClientNet4

Make Clients Trusted Applications for the Server

Make OPC UA Server trust LDS

Make LDS trust OPC UA Server

Related articles