1

EBO-OPC Server OPC Server for Schneider Electric's

EcoStruxure Building Operation (EBO)

User's Guide

Control See Software Solutions Ltd.

All Rights Reserved. 1995-2019

www.controlsee.com

2

Trademarks EBO-OPC® is a trademark of Control See Software Solutions Ltd. EcoStruxure® is a trademark of Schneider Electric Inc. SmartConnector® is a trademark of Schneider Electric Inc. EBO® is a trademark of Schneider Electric Inc. Windows® is a trademark of Microsoft Inc.

Software requirements

• Microsoft Windows® 7, Microsoft Windows® 8, Microsoft Windows® 8.1, Microsoft Windows® 10, Microsoft Windows® 2008 Server, Microsoft Windows® Server 2012, Microsoft Windows® Server 2016.

• Schneider Electric Building Operation Workstation (EBO) Version 1.9.1.95 or higher

• Schneider Electric SmartConnector version 2.4.7 or higher.

Hardware requirements

• Intel® Pentium® 4 Processor

• 512 MB RAM

• Minimum 32 MB of available hard disk space

• Super VGA (800 × 600) or higher-resolution monitor with 256 colors

• Mouse pointing device

3

Installing the EBO-OPC Server's SmartConnector extension

The EBO-OPC server uses a SmartConnector extension. To install the extension, stop the

SmartConnector service and copy the extension files. The files can be found in the following folder:

C:\Program Files (x86)\Control-See\EBO-OPC server\SmartConnector Extension

Copy the following files:

EBOOpc.Extension.dll

EBOOpc.Extension.dll.Config

To the SmartConnector folder:

C:\Program Files (x86)\Schneider Electric\SmartConnector

After the files are copied, you may start the SmartConnector service.

Adding the EBO-OPC Item discovery processor

The purpose of the EBO-OPC server is to discover all value name that are defined in the EBO and in

the controllers that are defined in the EBO system. Click on Configuration > Processor. The following

window will be displayed.

Click on the button. The following window will be displayed.

4

Double-Click on the "EBOOpc.Extension" item.

The following window will be displayed.

Double-click on the "EBOOpc.Extension.EboValueItemDiscoveryProcessor" item. The following

window will be displayed.

5

Click on the button. Click on the tab. The following window will be displayed.

Set the EBO-OPC server folder name. In most cases it should be: "C:\Program Files (x86)\Control-See\EBO-OPC server\BIN"

Click on the button. The following window will be displayed.

Set the server's Address field. The port number (8019 in this case) can be seen in the Building

Operation Software Administrator software. See below.

6

Set the EBO User Name and Password.

Click on the button.

Click on the tab. The following window will be displayed.

Make sure that "Runs on Start" is set to "False". "Runs on Schedule" is set to "False". "Manually

Startable" is set to "True", and "Manually Stoppable" is set to "True".

Click on the button.

Adding the EBO-OPC End-Point.

Click on Configurations > Endpoint. The following window will be displayed.

7

Click on the button. The following window will be displayed.

Double click on the "Ews.RestExtensions" item.

The following window will be displayed.

Double click on the "Ews.RestExtensions.SoapEwsRestProvider" item.

The following window will be displayed.

8

Click on the button.

Click on the tab. The following window will be displayed.

Click on the button.

"Base Route" should be set to "SBO".

Under , set the "Server Address" field.

For example: http://localhost:8019/EcoStruxure/DataExchange

"Access Token Expire Time Span Minutes" should be set to "60"

"Name" should be set to "SBO".

Under the tab, and under the tab, set the "Per

Minute" value to "6000".

Click on the button.

Click on the button.

Click on the button to start the endpoint.

9

Installing the EBO-OPC Server

Run the setup program. The following window will be displayed:

Click on the button to continue. The following window will be displayed:

Check the "I accept the terms in the license agreement" and then click on the

button to continue.

10

The following window will be displayed:

Type your User Name and Organization name and click on the button to continue.

The following window will be displayed:

Click on the button. The following window will be displayed:

11

After few seconds, the following window should be displayed:

Click on the button to complete the installation.

12

EBO OPC server configuration

The EBO-OPC server creates a shortcut on your desktop. See below.

Double click on this shortcut to start the EBO-OPC server configuration. The following window will be

displayed:

You will need to Login first. Click on the Login menu item. See above. The following dialog will be

displayed.

The initial password is "Admin!23". You may modify this password later. If this is the first-time

installation, the following message will be displayed:

Click on the to define your settings.

13

The following window will be displayed:

Type your SmartConnector Endpoint URL. For example: http://127.0.0.1:8083/SBO/. You can verify

the URL of the endpoint in the SmartConnector portal. See below.

Type your EBO Username and EBO Password.

Check the Enable modify EBO values if you want to allow OPC clients to modify EBO values. The

property is unchecked by default.

Click on the button to modify your password for the EBO-OPC server

configuration program.

To view the EBO-OPC server log file, click on View > EBO-OPC Server log…The following tail program

will be loaded to show you the tail of the log file. See below.

14

The EBO-OPC service

The EBO-OPC server is installed as a Windows Service. See the service in the services window below.

Once an OPC client connects with the EBO-OPC server, the service will start running. Once there are

no OPC clients connected to the server, the service will be stopped.

Note: the EBO-OPC server is installed as a Windows service. By default, there are no dependency

services associated with the EBO-OPC service. To modify this, you can add the SmartConnector

service as a dependency service. To do that, open a CMD window as Administrator and type the

following command:

sc config EBOOpc depend= SmartConnectorService

You should get the following response:

[SC] ChangeServiceConfig SUCCESS

See the following window.

15

To verify the above command, open the Windows services window, find the EBOOPC Server, right

click and click on Properties. Then click on the Dependencies tab. See the window below. The

SmartConnector service should be displayed.

16

Installing the EBO-OPC server license

Start the EBO-OPC server License Manager program. The following window will be displayed.

Choose the MAC address that you wish to be associated with your license and click on the

button. The following window will be displayed.

Now you can copy your MAC address and send it to Control-See to get a trial or permanent license.

Once you receive a license file, load it using the File > Load License File menu item. Then click on the

button. The license information will be displayed in the lower part of the

window. For example: "Valid license. Version 1.0".

17

Connecting to the EBO-OPC server using an OPC DA client software

You may connect to the EBO-OPC server locally or from a remote computer. If you are connecting

from a remote computer, you should set your DCOM settings on the EBO-OPC server computer.

For more details on DCOM settings, see the Matrikon DCOM settings document that is installed with

the EBO-OPC server. Click on the Windows Start button and then on Control-See > EBO-OPC

server > DCOM Settings User's Guide. You need a PDF viewer to view this file.

Note: In some cases, you may also need to modify your DCOM settings also when connecting from a

local computer.

To test the connection with the EBO-OPC DA server, start the Matrikon OPC Explorer that is installed

with the EBO-OPC server . The following window will be displayed.

Double click on the ControlSee.EBOOpc.1 server. Once it is connected, its icon will indicate that it is

connected.

18

Right click on the ControlSee.EBOOpc.1 server and then on Add Group. The following window will be

displayed.

Set the Group Name and the Update Rate fields.

Note: The Update Rate field determines the rate which the EBO-OPC server will update the OPC

client. If you need to update large number of values(thousands), you better increase the Update Rate

value to 5 seconds (5000 milliseconds) or more. This will decrease the load on Schneider Electric's

EWS (EcoStruxure Web Services) system.

Click on the button. The following window will be displayed.

Now you can browse your EBO system values and select the ones you want to display.

19

Click on the button.

20

You will also need to browse for the UpdateSubscription item and add to the tag list. See below.

Modifying the value of this item to "1", will force the EBO-OPC server to update its EBO subscription

items.

See below EBO values displayed in Matrikon OPC Explorer.

21

Connecting to the EBO-OPC server using an OPC UA client software

You may connect to the EBO-OPC server locally or from a remote computer. When the OPC UA client

is running on the same computer where the EBO-OPC server is running the endpoint URL is

opc.tcp://127.0.0.1:59595 or endpoint URL = opc.tcp://localhost:59595.

If the OPC UA client software is running on a remote computer, the endpoint URL is

opc.tcp://[Computer-Name]:59595 where [Computer-Name] is a placeholder for the computer name

where the EBO-OPC server is running.

To test the connection with the EBO-OPC UA server, you may use an OPC UA Client. For example: UA-

Expert. See this link:

https://www.unified-automation.com/products/development-tools/uaexpert.html

22

Using the UA-Expert software, after connecting with the EBO-OPC UA server, select the values you

wish to view by dragging and dropping the values to the list. See below.

Note: The EBO-OPC server service must be running before the OPC UA client is connecting.

Open the services window and make sure that the "Startup-Type" is "Automatic". See below.

Click on Apply and OK.

23

EBO-OPC UA Server – security settings

General concept

To connect to the EBO-OPC server, a client needs information like network address, protocol, and security settings. For this purpose, OPC UA defines a set of discovery features.

All information which is required to establish a connection between the UA client and EBO-OPC server is stored in a so-called endpoint. A server can provide several endpoints, each containing

• Endpoint URL (protocol and network address)

• Security Policy – should be one of the following: o Basic 128 Rsa 15: Sign o Basic 128 Rsa 15: Sign and Encrypt o Basic256: Sign o Basic256: Sign and Encrypt

• Message Security Mode (security level for exchanged messages)

• User Token Type (types of user authentication supported by the server)

See a sample endpoint definition in the UE-Expert software below.

24

Certificates, Certificate Store and Trust List

The EBO-OPC server maintains several folders for the certificates. These folder can be found in C:\Program Files (x86)\Control-See\EBO-OPC server\BIN\PKI\CA. See below.

The EBO-OPC UA server required a secure certificate for each OPC UA client. The OPC UA client should create a certification file. You need to copy the certification file to the "certs" sub-folder on the EBO-OPC server computer. See below.

In addition, there is typically a Rejected directory where the EBO-OPC UA server stores certificates from other OPC UA clients that tried to connect but were not trusted. Administrators can move certificates from Rejected to Trusted if the OPC UA client is allowed to connect. See below.

25

Troubleshooting

Problem: How do I get more details in the EBOOPC.log file?

Solution: Edit the EBOOpc.exe.config XML file. Modify the following line:

<level value="ERROR"/>

To: <level value="DEBUG"/>

Save the file and reconnect to the EBO-OPC server.

Problem: I don't see the EBO-OPC server in the services list.

Solution: Open a Command Prompt window as Administrator. See below.

Type the following command in the command prompt window: CD C:\Program Files (x86)\Control-See\EBO-OPC server\BIN

See below.

Run the following command:

26

EBOOPC /regserver

See below.

This command should register the EBO-OPC server as a Windows service.

Problem: I don't see the EBO values in my OPC Client software.

Solution: Open the SmartConnector local portal and Run the EBO OPC Item Discovery Processor. See

below.