Professional Documents
Culture Documents
en-US
en-US
en-US
Security Expert
SmartConnector
Installation & User Guide
March 2021
Prepared By:
Global Engineering Centre of Excellence
Global Engineering Centre of Excellence
The Schneider Electric brand and any registered trademarks of Schneider Electric Industries SAS referred to in this guide are
the sole property of Schneider Electric SA and its subsidiaries. They may not be used for any purpose without the owner's
permission, given in writing. This guide and its content are protected, within the meaning of the French intellectual property
code (Code de la propriété intellectuelle français, referred to hereafter as "the Code"), under the laws of copyright covering
texts, drawings and models, as well as by trademark law. You agree not to reproduce, other than for your own personal, non-
commercial use as defined in the Code, all or part of this guide on any medium whatsoever without Schneider Electric's
permission, given in writing. You also agree not to establish any hypertext links to this guide or its content. Schneider Electric
does not grant any right or license for the personal and non-commercial use of the guide or its content, except for a non-
exclusive license to consult it on an "as is" basis, at your own risk. All other rights are reserved.
Trademarks and registered trademarks are the property of their respective owners.
Contents
1 Introduction .................................................................................................................................... 6
1.1 Architecture ............................................................................................................................. 6
2 Versions & Prerequisites ................................................................................................................. 8
2.1 SmartConnector Service Version ............................................................................................. 8
2.2 Security Expert Version ........................................................................................................... 8
2.3 Prerequisites ............................................................................................................................ 8
2.4 Licensing .................................................................................................................................. 9
2.5 Security Expert Prerequisites .................................................................................................. 9
2.6 Quick Start Installation Sequence ......................................................................................... 10
3 SmartConnector Framework Installation...................................................................................... 11
3.1 Download the SmartConnector Framework ......................................................................... 11
3.2 Install the SmartConnector Framework ................................................................................ 12
3.2.1 Install SmartConnector Framework ......................................................................... 12
3.2.2 Validate SmartConnector Framework ..................................................................... 14
3.2.3 Change Default Credentials ...................................................................................... 16
3.2.4 Install SmartConnector Framework Runtime License .......................................... 17
4 Security Expert SmartConnector Extension Installation ............................................................... 21
4.1 Downloading the Security Expert SmartConnector .............................................................. 21
4.2 Installing Security Expert SmartConnector Extension ........................................................... 22
4.3 Install and License Security Expert SmartConnector Extension ............................................ 23
4.4 Configure Security Expert SmartConnector Discovery Extension Processors ....................... 25
4.5 Configure Security Expert SmartConnector Alarm Update Extension Processors ................ 28
4.6 Configure Schedule on Alarm Update Processor .................................................................. 28
4.7 Assign a Schedule to Security Expert Update Alarms Processors ......................................... 29
5 Host Security Expert Objects in EcoStruxure Building Operation ................................................. 30
5.1 Create Security Expert EWS Interface in EBO........................................................................ 30
5.2 Host Security Expert Objects in EcoStruxure Building Operation ......................................... 32
6 Troubleshooting ............................................................................................................................ 33
6.1 SmartConnector Log File ....................................................................................................... 33
6.2 Framework Licensing Error .................................................................................................... 34
6.3 SmartConnector Extension Licensing Error ........................................................................... 35
1 Introduction
This document outlines the installation and configuration of the Security Expert
SmartConnector Extension required to integrate Security Expert with EcoStruxure
Building Operations. This document assumes that EcoStruxure Building Operations
and Security Expert systems have already been installed and are functional as
independent systems.
Document Description
SmartConnector Installation and Complete installation guide for
Configuration Guide SmartConnector Framework that covers
in more depth – installation and
configuration options; troubleshooting
information on the SmartConnector
Framework. This manual will be
downloaded during the installation
process.
Security Expert SmartConnector This manual
Extension
1.1 Architecture
A Basic overview of the architecture is that SmartConnector Framework and Extension
will communicate to the Security Expert Server and the EcoStruxure Building
Operation Enterprise Server to share data and alarms.
2.3 Prerequisites
In order to install the Security Expert SmartConnector Extension, we must first install
and license the SmartConnector Framework. There are multiple configuration options
as to where the SmartConnector Framework can be installed – for use in this
document; the SmartConnector Framework and Extension will be installed on the
same machine as the EcoStruxure Enterprise Server and SQL Express. For additional
options using SQL or remote servers not containing the Enterprise Server refer to the
SmartConnector Installation and Configuration Guide.
The following prerequisites must be performed before you start the installation and
configuration of the SmartConnector Framework and Security Expert SmartConnector
Extension.
• Security Expert System - Installed, Configured and Functional
• EcoStruxure Building Operation Enterprise Server - Installed, Configured
and Functional
• Microsoft .NET v4.5 or later must be installed on the Enterprise Server
• SQL Express is installed on the Enterprise Server (or server for
SmartConnector installation
Note: if SQL is installed on a remote machine follow the detailed instructions in
the SmartConnector Framework Installation and Configuration Guide.pdf
• The specified user must have at least the public and dbcreator user roles
in the SQL server
Note: Additional Installation options for installing the SmartConnector
Framework can be located in the SmartConnector Installation and
Configuration Guide.
2.4 Licensing
The EcoStruxure Security Expert SmartConnector extension does not have a license
cost, but to deploy the SmartConnector solution, a SmartConnector deployment
license is required.
Use this part number to place orders for the SmartConnector Deployment license:
3 SmartConnector Framework
Installation
The first step in the process is to download SmartConnector Framework software from
www.smartconnectorserver.com, once downloaded you will install the SmartConnector
Framework software, obtain the machine thumbprint, license the Framework to the
machine thumbprint and finally configure the Framework system. Once the
SmartConnector Framework has been installed, configured and licensed we can extend
the Framework by adding the Security Expert SmartConnector Extension.
4. Click Next.
5. Review and accept the terms to the End User License Agreement
6. Click Next.
7. Choose the Setup Type you wish to perform. If this is a new installation, you must
choose Complete.
8. Click Next.
9. Enter the required information for the database server where you will install the
database to:
Note: The logged in user must have at least the public and dbcreator user roles in
the local SQL server. In this configuration SmartConnector runs under the NT
Authority\System account. See Appendix C
10. Click Install to complete the installation and create the default database.
7. Confirm that the “Local System account” is selected. This may be different
depending on the database authentication type you chose earlier.
8. Click the Recovery tab.
9. Set First failure: to Restart the Service
We recommended that you choose at least one recovery action in the event that the
SmartConnector Service experiences a failure. At a minimum, “Restart the Service”
should be selected
By default, SmartConnector will enable SmartConnector Portal on the local machine. Using
SmartConnector Portal, you must change the default password to a new password.
1. Open a web browser
2. Navigate to http://localhost:8082
3. At the Login Page, enter the default user credentials of admin and Admin!23.
At this point you will be presented with the Change Password Page as show below.
SmartConnector Framework requires a license in order to run. After changing the default
password, navigating to any page of SmartConnector Portal will return the user to the Install
License page where a runtime license must be installed.
I. SmartConnector Connected to the Web
If the Windows machine with SmartConnector Framework detects an active internet
connection, the Install SmartConnector License page will automatically be displayed.
Once authenticated with the License Manager, you only need to enter a License
Claim Token to “claim” the runtime license and it will be automatically installed.
Alternatively, the user may click “Upload License” to manually upload an already
obtained license file. License Claim tokens and license files can be obtained from
www.smartconnectorserver.com.
8. Paste in the machine thumbprint from the Windows clipboard (copied earlier)
9. Save the downloaded License file
10. Return to the Install SmartConnector License page
11. Select Upload License
12. SmartConnector Framework is now successfully licensed
To edit any field, you can either click the edit icon ( ) in that field or click the
Edit All button to enable all fields for editing.
The default settings will be acceptable for the initial installation of SmartConnector
Framework.
Users should use good security practices to define the expiration time for user
Passwords.
The EWS Portal address can also be modified here from the default port used
8082.
5. Review and/or change values as desired. Unless otherwise noted, changes made
here will take effect without a service restart.
6. After you have made the necessary changes, click Save to save them to the
database.
https://exchange.se.com/shop
https://www.smartconnectorserver.com/Marketplace
Note: You must be logged in to access the license claim page. If you are not logged
in, you will be directed to do so.
2. Enter “Security Expert” into the search box of webpage
To get the machine thumb print go to the SmartConnector web page on your
machine and login
http://localhost:8082
Select setup -> License
6. Click on the download licence button and download the licence file
9. Select Add+
7. Give a Name and a Description for this configuration and Press the Finish Button.
9. Click the + symbol to expand the Security Expert Setting Node. Update the following
properties:
SOAP Endpoint: Enter the SOAP address from the Security Expert machine
Operator Username: Enter the Security Expert Operator details
Operator Password: Enter the Security Expert Operator details
Note: The Username and Password MUST match an Operator that has been created
in Security Expert.
Database Site Id: Enter the database Id of the Security Expert site
10. Expand the Ews Server Node and update the following properties:
Note: The Username & Password specified above is the EWS User that EcoStruxure
Building Operation will authenticate with when connecting to the SmartConnector
Framework – This is not an EBO User or a Security Expert Operator. The password
must be a complex password.
11. Expand the Event Filter node and update the following properties:
12. Event Filter Id: Enter the database id of the event filter which has been configured in
Security Expert
14. Then click the validate button fix any errors which are displayed
Note: The Discovery Processor only needs to be run once, unless new objects are
created in Security Expert – In this case you will also need to perform an EBO EWS
Host of the new objects.
3. From there, navigate to and select the Schedule tab from the top
4. Select the Every 1 Second schedule from the Schedule field
Host the EWS objects that are available from the Security Expert EWS Service, by
performing the follow procedure. EcoStruxure Building Operation system will discover
all objects available from Security Expert and create an object in the Building
Operation database that can be used for programming, scheduling, or binding to
graphics.
The following steps can be used to Host an EWS Interface
1. Open the Enterprise Server
2. Open the System folder
3. Open the Hardware folder
4. Open the EcoStruxure Web Services
5. Open the Security Expert EWS
Interface
6. Right click on the Security Expert
object
7. Select Host EWS Objects
8. Select the EWS Interface created in
section 4.1
9. A dialog may appear “Hosting EWS
Objects”
10. Upon completion of the Hosting process, close the System folder
11. Open the Security Expert EWS Interface created in section 4.1
12. The Security Expert objects will all be hosted
You can now use these objects as any other Building Operations object to bind to a
program or a graphic.
6 Troubleshooting
6.1 SmartConnector Log File
SmartConnector includes integrated logging into log files where both SmartConnector
extensions and the SmartConnector framework can log any messages that may be
useful. These log files can be found generally in the directory
C:\\ProgramData\SmartConector\Logs on the machine where SmartConnector is
installed.
In general, if you are having problems with SmartConnector or the Security Expert
extension, it may be necessary to increase the logging level, or enable additional
logging filters.
1. To adjust the logging level, visit the Service Settings page and edit the Logging
Level setting.
2. To adjust the logging filters, visit the Logging Filters page. The logging filters most
likely to pertain to this solution is Processor and Ews Serve.
If you navigate to the SmartConnector portal and see a page similar to the below
screenshot. This means that either you have not yet got a license for your
SmartConnector framework, or your current license is no longer valid.
If you have not yet got a license for your SmartConnector framework:
Follow the instructions in the section Install SmartConnector Framework Runtime
License
If your Security Expert SmartConnector extension processors are not running, please
verify that they contain a valid license by:
1. Navigate to the processors configuration page.
2. Click on the ‘Validate’ button
3. If the error displayed is “License not found.” You will need to obtain a license for
the extension.
If you have not yet got a license for your Security Expert SmartConnector
extension
Follow the instructions in the section Install and License Security Expert
SmartConnector Extension
If you have already got a license for your Security Expert SmartConnector
extension
The Security Expert SmartConnector extension license is bound to a machine
thumbprint. This machine thumbprint is a key generated from multiple hardware
components of your machine, including the current network adapter that was being
used when the license was generated. If you have switched to a different network
adapter (e.g. going from a hard-wired connection to a WIFI connection), then it is very
likely this machine thumbprint has changed. Please follow the section Install and
License Security Expert SmartConnector Extension using your new thumbprint.
If SmartConnector cannot connect to its database, then the framework will fail to start.
If you notice that the SmartConnector Server is not starting, or starting and instantly
stopping, please review the SmartConnector logs for messages pertaining to SQL
Authentication. If this is the case, you may need to make sure that your SQL
Credentials are valid before starting the SmartConnector service.
If EBO is unable to make a connection to the EWS server created by the Security
Expert SmartConnector extension. First check the SmartConnector logs for any
information, such as authentication or other errors. If no errors are shown in the log,
check the following.
The IP address/ hostname configured in EBO is valid for connecting to the EWS
Server in SmartConnector
The port configured in the EWS Server in SmartConnector is the same port in
EBO
The endpoint configured in the EWS Server in SmartConnector (everything after
the port number e.g. http://localhost:51350/EcoStruxure/DataExchange) is the
same as the endpoint in EBO.
Firewall rules allow this connection to occur.
7.1 Folders
Name Description Read/Write
Doors Doors in the building Read Only
Floors Floors in the system Read Only
Salto Salto Door Objects Read Only
Inputs Input objects Read Only
Outputs Output objects Read Only
Misc. Alarms Extra alarms Read Only
Areas Areas in the system Read Only
Variables Variables from system Read Only
7.2 Doors
Value Item Description Read/Write Notes
Lock Status Door Lock Status Read Only Possible Values:
0 -Locked
1 -Unlocked by user
2 -Unlocked by schedule
3 -Unlocked by user timed
4 -Unlocked by user latched
5 -Unlocked by exit device
6 -Unlocked by entry device
7 -Unlocked by Operator
8 -Unlocked by operator timed
9 -Unlocked by operator latched
10 -Unlocked by area
11 -Unlocked by fire alarm
12 -Unlocked by calendar action
13 -Unlocked by calendar action
14 -Unlocked by user using
extended door time
15 -Unlocked by exit device using
extended door time
16 -Unlocked by entry device
using extended door time
17 -Unlocked by operator using
extended door time
7.4 Floors
Value Item Description Read/Write Notes
Floor # Activated or Read/Write Possible values:
Activation Deactivate floor 0 -Deactivate
Status 1 -Activate
2 -Activate Timed
7.5 Inputs
Value Item Description Read/Write Notes
Status Input’s status Read Only Possible values:
0 -Closed/Off
1 -Open/on
2 -Tamper
3 -Short Circuit
Bypass Input’s bypass Read Only Possible Values:
state 0 -Not bypassed
1 -input bypassed
2 -Siren Lockout
3 -Bypass latched
[Input Name] Bypass Control Read/Write Possible Values:
Bypass Control 0 -Remove Bypass
1 -Bypass until next disarm
2 -Bypass permanently
7.6 Outputs
Value Item Description Read/Write Notes
Activation Output’s status Read Only 0 = Off,
Status 1 = On,
2 = Pulse On,
3 = On timed,
4 = On pulse timed
7.8 Areas
Value Item Description Read/Write Notes
Arm Status Area Arm Status Read Only Possible values:
0 = Disarmed,
1 = Input(s) open waiting for user,
2 = Trouble Condition waiting for
user
3 = Bypass error waiting for user,
4 = Bypass warning waiting for
user,
5 = User count not zero waiting
for user,
6 = Unknown,
- = -,
127 = Unknown,
128 = Armed,
129 = Exit delay,
130 = Entry delay,
131 = Disarm delay,
132 = Code delay
24 Hr Status 24 Hour Area Read Only 0 = Disabled,
Status 1 = Busy,
128 = Enabled
This will stop the alarms from being displayed in the alarm banner.
Note: If the logged in Windows User did not have the proper SQL user roles during the
installation process, the DB tables will not be created. You will need to uninstall then reinstall
SmartConnector Framework to create the tables, once the Windows User has proper SQL
roles defined. An attempt to perform an installation selecting “Modify” or “Repair” will not create
the default DB for SmartConnector Framework.
10 Revision History
Version File Details Date
11 References
SmartConnector Installation and Configuration Guide.pdf
SmartConnector Manuals
12 SmartConnector Maintenance
SmartConnector uses an SQL database which needs to have regular maintenance
performed on it to keep the size of the database within an acceptable limit. To help with the
task of carrying out database maintenance a SmartConnector extension has been created
which can be scheduled to run every night and perform database maintenance.
1. Extract the files from the SmartConnector. Utilities EWS Maintenance zip file to a
temporary directory
9. Give a Name and a Description for this configuration and Press the Finish Button.
11. Expand the SmartConnector Ews Server settings Node and update the following
properties:
Server Name : EWS Server Name (Default: SecurityExpertServer)
Server Address : EWS Server Address (Default
http://localhost:51350/EcoStruxure/DataExchange)
Realm: EWS Realm (Default: SecurityExpert)
EWS Username: Username for EWS Server
EWS Password: Password for EWS Server
The following procedure will create schedules that will be used to execute the alarm update
processor.
1. Select Setup -> Configuration Schedules.
2. From the Configuration Schedules page, select Add New +
3. Enter ‘Every 24 Hours’ in the Description field
4. Select the current date and time from the Start Date field
5. Select Time Interval from the Type field
6. Enter ‘24’ in the Interval Gap field
7. Select Hours from the Interval Gap Units field
8. Select Save to save the Schedule
11. From there, navigate to and select the Schedule tab from the top
12. Select the Every 24 Hours schedule from the Schedule field