Installation
Install AvensorOPC
AvensorOPC is designed to work behind a private network. Exposing the software to the internet introduces security risks. If the user already have a version of AvensorOPC installed, follow the First time installation otherwise follow Upgrade AvensorOPC.
First time installation
The AvensorOPC can be installed as a Windows service or in stand-alone mode. Regardless of the installation method the AvensorOPC creates the folder C:\ProgramData\AvensorOPC to store the data.
Windows service
- Unzip the given AvensorOPC zip file in a folder
- Run service-install-start.bat
- AvensorOPC is registered and starts as a Windows service
Stand-alone mode
AvensorOPC does not start automatically after a restart or when a remote session is closed. The user must delete the folder C:\ProgramData\AvensorOPC manually when the AvensorOPC is not used.
- Unzip the given AvensorOPC zip file in a folder
- Run: run.bat
Upgrade AvensorOPC
This section is applicable when the AvensorOPC is installed as a Windows service and a previous installation exists.
To upgrade the AvensorOPC:
- Unzip the new version of AvensorOPC in a folder. It creates two AvensorOPC installations:
Installation 1 | folderpath/avensor-opc-ua-connector-previous-version |
Installation 2 | folderpath/avensor-opc-ua-connector-new-version |
- Run avensor-opc-ua-connector-new-version/service-installstart.bat
Running the script installs and starts a new version of the AvensorOPC as a Windows service.
Stop AvensorOPC
This section is applicable when the AvensorOPC runs as a Windows service.
- Run service-stop.bat
Restart AvensorOPC
This section is applicable when the AvensorOPC runs as a Windows service.
- Run service-restart.bat
Uninstall AvensorOPC
This section is applicable when the AvensorOPC installed as a Windows service.
To uninstall the AvensorOPC, run one of the following scripts:
service-uninstall.bat | It deletes the AvensorOPC Windows service. |
service-uninstall-delete-data.bat | It deletes the AvensorOPC Windows service and the folder C:\ProgramData\AvensorOPC, which contains the configuration, certificates and data used by AvensorOPC. |
The user must manually delete the folder which contains the extracted AvensorOPC distribution file.
Enable Avensor Communication
- Open the chrome browser and navigate to the AvensorOPC Web UI.
http://localhost:8087 - Use the default credentials to log in.
Note: The default credentials are insecure, it is important to change the credentials before allowing clients to connect to AvensorOPC.
username | admin |
password | password |
- After login, the AvensorOPC Web UI asks for a password change if the default password was detected to be in the use. If the password is changed, the status view will be displayed.
- In the top menu, click on the Avensor credentials, to navigate to the Avensor credentials view.
- Click on the Edit button and enter a Client id and Client secret. The client ID and client secret are provided by a Xylem representative.
- Click Save, wait for 10 seconds, and then click Validate.
- A dialog with the message The credentials are valid appears. If the dialog shows an error, it means that client ID and client secret are not correct. Contact a Xylem representative for the valid credentials.
Add users
User roles
Users in AvensorOPC can have one of the roles below:
Role | Description |
Admin | Represents a system administrator that will configure the application via AvensorOPC Web UI and may also connect via OPC UA. |
OpcUa Read | Represents a user or client that will only connect via OPC UA with Read only mode but will not require access to AvensorOPC Web UI. |
OpcUa Read/Write | Represents a user or client that will only connect via OPC UA with Read/Write mode but will not require access to AvensorOPC Web UI. |
Feature | Admin | OPCUA Read | OPCUA Write |
Web UI access | X | ||
OPC UA Read | X | X | |
OPC UA R/W | X | X | X |
Create a user
- Navigate and login into AvensorOPC Web UI.
- In the top menu, click Users.
- Click the Add user button.
- Fill the required user information, and click Save.
Connect via OPC UA
Requirements: AvensorOPC server is succesfully setup and running. For details refer to Enable Avensor Communication
- Configure your OPCUA client to connect to the following URI: opc.tcp://[IP or computer name]:52531/OPCUA/avensor-opcua-connector
- Enter the endpoint in the OPC UA client.
- The user must replace the IP and the computer name in the url based on the AvensorOPC server setup. Do not copy and paste the url.
- All the available endpoints are listed under Status > endpoint link.
- Give the credentials of a user created in the section Add users.
- Choose one of the supported security policy:
Security Policy | Sign | Sign & Encrypt |
Basic256SHA256 | X | X* |
Basic256 | X |
* Recommended for best security
When an OPC UA client tries to connect to the AvensorOPC for the first time, the response Bad_SecurityChecksFailed(0x80130000) is received. By default, the client certificate is not trusted by the server. The user must configure the AvensorOPC to trust the certificate:
- Navigate and log in to AvensorOPC WebUI.
- In the top menu, click Certificates.
- Navigate to the tab Rejected.
- Find the certificate to trust, and click the icon Trust server certificate.
A client certificate can also be moved from Trusted to Rejected or even deleted if necessary.