Installation instructions
VSE OPC UA server
VOS050
V1.3.0 or higher
11420265 / 0204 / 2023
GB
VOS050
2
Contents
1 Preliminary note ............................................................. 3
1.1 Legal and copyright information ............................................ 3
1.2 Open source information.................................................. 3
1.3 Legal notice OPC Foundation SDK.......................................... 3
1.4 Symbols used.......................................................... 3
2 Safety instructions............................................................ 4
3 Intended use................................................................ 5
4 Installation under Windows..................................................... 6
4.1 System requirements .................................................... 6
4.2 Ports used............................................................. 6
4.3 Installation............................................................. 6
4.3.1 Password requirements .............................................. 7
5 Installation under Linux........................................................ 8
5.1 System requirements .................................................... 8
5.2 Ports used............................................................. 8
5.3 Installation............................................................. 8
5.3.1 Password requirements .............................................. 9
6 First login to the Configurator ................................................... 10
6.1 Releasing the certificate in the browser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
6.2 Signing in ............................................................. 10
6.3 Licence activation....................................................... 10
6.3.1 Activating a test licence............................................... 10
6.3.2 Limitation of the test licence ........................................... 10
6.3.3 Activating a permanent licence......................................... 10
6.3.3.1 Online licence activation......................................... 11
6.3.3.2 Offline licence activation......................................... 11
6.4 Connecting devices...................................................... 11
6.4.1 Adding a device / data source.......................................... 11
7 Uninstallation under Windows................................................... 13
8 Uninstallation under Linux...................................................... 14
VOS050
3
1 Preliminary note
This document explains the set-up and use of the VSEOPC UA Server software.
1.1 Legal and copyright information
© All rights reserved by ifm electronic gmbh. No part of these instructions may be reproduced and
used without the consent of ifm electronic gmbh.
All product names, pictures, companies or other brands used are the property of the respective rights
owners.
• Microsoft® is the property of Microsoft Corporation, USA
• Windows® is the property of Microsoft Corporation, USA
• Linux® is the registered trademark of Linus Torvalds in the USA and in other countries.
• Debian is a registered trademark of Software in the Public Interest, Inc., USA
1.2 Open source information
For more open source information see: documentation.ifm.com.
1.3 Legal notice OPC Foundation SDK
This product includes software under the OPC Redistributables Agreement of Use of the OPC
Foundation in the version current at the time of order.
1.4 Symbols used
üCondition
uInstruction
wInterim result, interim reaction
wFinal result, reaction
[…] Designation of keys, buttons or indications
Ò See link, cross-reference
Important note
Non-compliance may result in malfunction or interference
Information
Supplementary note
VOS050
4
2 Safety instructions
Please read the installation instructions before installing the software.
Ensure that the software is suitable for your application without any restrictions.
If the operating instructions or the technical data are not adhered to, personal injury and/or damage to
property may occur.
Non-observance of the instructions, operation which is not in accordance with use as prescribed
below, wrong installation or incorrect handling can affect the safety of operators and machinery.
The use must comply with the applicable national and international standards. Responsibility lies with
the person installing the software.
VOS050
5
3 Intended use
The VSE OPC UA Server provides data values of the integrated ifm VSE diagnostic electronics via the
OPC UA interface for further processing on an OPC UA client (not included in the scope of delivery).
The VSE OPC UA Server Configurator software is used by the user to maintain and configure the VSE
OPC UA Server.
VOS050
6
4 Installation under Windows
4.1 System requirements
See data sheet and technical specification at www.ifm.com.
4.2 Ports used
The following ports are used by VSE OPC UA Server under Windows and must not be used by other
applications:
Port Application Changeable
5433 (TCP) PostgreSQL Yes, for first installation
44350 (TCP) Configurator Yes, for first installation
32210 (TCP) Server Port Yes, in the Configurator
5093 (TCP/UDP) Sentinel RMS License Manager No
3321 (TCP) VSE units Standard VSE Device Port
(depending on the VSE configuration)
The software cannot be installed correctly and function properly if at least one of these ports is
used or blocked by other applications.
4.3 Installation
uPrior to the installation make sure that you have administrator rights.
uPerform the installation as administrator.
uRecommendation: Keep the default installation settings if possible.
uEnsure that the selected ports are free.
uFor external network access, ensure that the ports in any existing firewall are configured
accordingly.
Install the software as follows:
Step 1: Start the installation and agree to the licence conditions
uOpen the installation file VSE OPC UA Server_v.x.x.x.exe an administrator (right mouse button
[Run as administrator]).
uAccept the licence conditions and click on [Install].
wVSE OPC UA Server is installed (among others in the path C:\Program Files\ifm electronic\VSE
OPC UA Server).
wThen: The [VSE OPC UA Server Database Setup Wizard] appears.
Step 2 Installing the database
uClick on [Next].
wThe [PostgreSQL database configuration] view appears.
wAddress is displayed.
uEnter the TCP port in the database in the field [Port] Default: 5433
uEnter the name of the database in the field [Database name]. Default: OPCConfiguration
uClick on [Install].
VOS050
7
wInstallation of the database is in progress.
uClick on [Finish].
wThe database is installed.
w[VSE OPC UA Server Configurator] setup wizard appears.
Step 3: Install the VSE OPC UA Server Configurator
uClick on [Next].
wThe [Adjust Configurator Settings] view appears:
uEther the TCP port of the Configurator in the [Port] field. Default: 44350
uEnter the user name in the [User] field. Default: admin
uEnter the user password in the [Password] field. Please note: Password requirements (Ò/7)
User and password are required to log in to the Configurator web interface.
uClick on [Install].
wThe [VSE OPC UA Server Configurator] installation is running
wThe [Setup successful] view appears.
uClick on [Finish]
wVSE OPC UA Server Configurator has been installed.
uAfter the installation has been completed, click on [Launch] to start the [VSE OPC UA Server
Configurator].
OR
uAfter the installation is complete, click on [Close] to close the installation program.
4.3.1 Password requirements
• Minimum length: 8 characters
• Must contain:
– at least one upper case letter
– at least one lower case letter
– At least one number
– At least one special character
VOS050
8
5 Installation under Linux
5.1 System requirements
See data sheet and technical specification at www.ifm.com.
5.2 Ports used
The following ports are used by VSE OPC UA Server under Linux and must not be used by other
applications:
Port Application Changeable
5433 (TCP) PostgreSQL No
44350 (TCP) Configurator No
32210 (TCP) Server Port Yes, in the Configurator
5093 (TCP/UDP) Sentinel RMS License Manager No
3321 (TCP) VSE devices Standard VSE device port
(depending on the VSE configuration)
The software cannot be installed correctly and function properly if at least one of these ports is
used or blocked by other applications.
5.3 Installation
uPrior to the installation make sure that you have sudo rights.
uRecommendation: Keep the default installation settings if possible.
uEnsure that the selected ports are free.
uFor external network access, ensure that the ports in any existing firewall are configured
accordingly.
uDocker Engine and Docker Compose are installed.
Install the software as follows:
Carrying out the installation
uCopy the binary file VSE_OPC_UA_Server_Installer_1.1.0.tar to the system with the Debian-
based Linux distribution.
uChange to the installation directory.
uChange the permission of the binary file so that it becomes executable: chmod u+x
VSE_OPC_UA_Server_Installer_1.1.0.tar
uStart the installation: ./VSE_OPC_UA_Server_Installer_1.1.0.tar
wAfter successful installation, a message appears with the URL for access and the standard login
information.
wIf Docker-Engine and Docker-Compose are not installed, a message appears with links to the
installation steps.
The standard login credentials are not suitable for permanent use.
uChange the password after logging in for the first time.
User and password are required to log in to the Configurator web interface.
VOS050
9
Exporting log files and database
uTo save a backup of the log files and the database in the file VSE_OPC_UA_Server_Backup.tar ,
execute the following command
sudo docker run --rm -v vse_opc_ua_server_postgres:/Backup/Database -v
vse_opc_ua_server_server_logs:/Backup/Server -v
vse_opc_ua_server_configurator_logs:/Backup/Configurator -v ~:/backup ubuntu
tar cvf /backup/VSE_OPC_UA_Server_Backup.tar /Backup
wThe backup is created under: ~/VSE_OPC_UA_Server_Backup.tar
Opening Docker volumes
Open the Docker volumes manually via:
• For Docker installation with apt package manager: /var/lib/docker/volumes
• For Docker installation with snap package manager: /var/snap/docker/common/var-lib-
docker/volumes/
5.3.1 Password requirements
• Minimum length: 8 characters
• Must contain:
– at least one upper case letter
– at least one lower case letter
– At least one number
– At least one special character
VOS050
10
6 First login to the Configurator
For Linux installations:
The standard login credentials are not suitable for permanent use.
uChange the password after logging in for the first time.
6.1 Releasing the certificate in the browser
When the VSE OPC UA Server Configurator is called up in the browser for the first time, the URL may
be recognised as a security risk.
To enable access:
uRelease the certificate in the respective browser.
6.2 Signing in
üUse a recommended browser: Google Chrome, Mozilla Firefox or Microsoft Edge.
uCall the URL of the VSE OPC UA Server Configurator in the browser:
https://<IP or Hostname>:<Configurator-Port>/
Default: https://localhost:44350/
wThe login screen will be displayed.
uLog in with the login data assigned during installation.
If an incorrect password to an existing user is entered 3 times, the login for this user will be
blocked for 10 minutes.
wThe Configurator interface appears.
6.3 Licence activation
The software is always delivered with a time-limited test licence. You can choose in the licence
activation window whether you want to activate the test licence or whether you want to activate a
permanent licence.
6.3.1 Activating a test licence
After activating the test licence, the software can be used to a limited extent for 30 days. After the test
licence has expired, the software can no longer be used. For further use of the software, a permanent
licence activation is required. If no permanent licence has been activated, the software will inform you
of the imminent expiry of the test licence in a notification window when you log in. The information is
provided 10 days before the licence expires.
6.3.2 Limitation of the test licence
The test licence is limited. The test licence enables the connection to a VSE device for a period of 30
days.
6.3.3 Activating a permanent licence
As a registered ifm customer, you can activate the permanent licence online or offline.
Licence activation code (LAC):
During the activation process, you need to enter the licence activation code (LAC).
VOS050
11
• If you have purchased the software and the accompanying licences directly from ifm, ifm will have
sent you the LAC by email.
6.3.3.1 Online licence activation
uClick on[Add licence] (not during the first activation after the installation of the software).
uSelect [Online activation].
uClick on [NEXT].
uEnter the licence activation code (LAC) received via email.
uClick on [NEXT].
uClick on [FINISH].
wAll activated licences are displayed.
6.3.3.2 Offline licence activation
If no online activation is possible because there is no Internet connection, licences can also be
activated offline.
uClick on[Add licence] (not during the first activation after the installation of the software).
uSelect [Offline activation].
uClick on [NEXT].
uNote down the indicated fingerprint.
OR
Click on [Save as .txt file], select the required directory and save fingerprint.txt.
uOpen the page https://licensing.ifm.com on a computer with an online connection, click on [Activate
licence], follow the instructions of this page and copy the generated licence key.
uContinue the licensing process in the software:
Click on [NEXT].
uEnter the licence key you received.
uClick on [NEXT].
uClick on [FINISH].
wAll activated licences are displayed.
6.4 Connecting devices
6.4.1 Adding a device / data source
uUnder[Datasources], click on [Device].
wThe dialogue window[Add VSE device] appears.
uSelect the option[Scan network] to seach for all available devices in the network.
uClick on[Scan].
wThe program searches for available devices.
wThe table shows all detected devices.
VOS050
12
The option[Scan network] searches for all available devices via broadcast. Not all available
devices in a network environment may be detected, e.g. due to network segmentation, use of
firewalls or routers.
üIf not all devices are found:
uAdd all devices with the help of the options[Specific] or[Range], see below.
OR
uSelect the option[Specific] and enter the IP address and port of a device.
uClick on[Add to list].
wThe program adds the devices to the table.
Only after the device has been added to the view[Datasources] and the server has been
restarted, the program will check whether the device exists in the network.
OR
uSelect the option[Range] and enter the start and end address of an IP range and the port.
uClick on[Add to list].
wThe program will add all devices of the IP range to the table.
Only after the device has been added to the view[Datasources] and the server has been
restarted, the program will check whether the device exists in the network.
üDevices are listed in the table.
uActivate the devices in the table that are to be included in the view[Datasources] .
uDeactivate the devices in the table that are not to be included in the view[Datasources] .
uClick on[Add devices] to include the selected devices in the view[Datasources] .
wThe view[Datasources] shows all added devices.
wThe view[Datasources] shows the available functions (column[Actions]).
uClick on [Upload changes] to upload the changes to the server. For the changes to take effect,
restart the server in the[Server status] area.
OR
uClick on [Upload and Restart] to upload the changes to the server and restart the server.
OR
uClick on [Reset changes] to discard the changes.
uOptional: Filtering the data source list
VOS050
13
7 Uninstallation under Windows
The program can be uninstalled via the Windows control panel.
The licences are not deleted by the uninstallation and can be used again after reinstalling the
programme.
Uninstall the software as follows:
üThe user has administrator rights in Windows.
uOpen the Windows control panel.
uClick on [Programs and Features].
uInstall the [VSE OPC UA Server x.x].
uClick on [Uninstall] and confirm the security query.
uClick [Uninstall] in the setup window.
wThe program will be unistalled.
uAfter successful deinstallation click on [Close].
wThe program has been uninstalled.
uIf the program is to be installed again or a new version of the program is to be installed, restart the
system first.
VOS050
14
8 Uninstallation under Linux
The licences are not deleted by the uninstallation and can be used again after reinstalling the
programme.
Uninstall the software under Linux as follows:
uExecute the following command: uninstall-vse-opc-ua-server.sh
wThe Docker containers (server, configurator and database) are stopped.
wThe Docker containers are deleted.
wThe Docker images are not deleted.
wThe Docker volumes are not deleted.
wThe GemaltoRMS service is unregistered and the binary files are deleted. (/opt/ifm/
GemaltoRMS)
wThe LicenseGateway service is unregistered and the binary files are deleted. (/opt/ifm/
LicenseGateway)
wThe uninstall script is deleted. (/usr/local/bin/uninstall-vse-opc-ua-server.sh)
-
1
-
2
-
3
-
4
-
5
-
6
-
7
-
8
-
9
-
10
-
11
-
12
-
13
-
14
Ask a question and I''ll find the answer in the document
Finding information in a document is now easier with AI
Related papers
Other documents
-
Fronius CENTRUM User manual
-
Eurotherm Suite User guide
-
WAGO 16-Channel Digital Input User manual
-
WAGO 16-Channel Digital Output User manual
-
-
WAGO 8-Channel Digital Input/Output User manual
-
-
-
-
Barco Overture User guide