EcoStruxure Building Operation - System Upgrade Reference Guide
EcoStruxure Building Operation - System Upgrade Reference Guide
System Upgrade
Reference Guide
04-30011-01-en
May 2019
EcoStruxure Building Operation
System Upgrade
Reference Guide
04-30011-01-en
May 2019
Copyright © 2019 Schneider Electric. All rights reserved.
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
Introduction
1 About This Guide ........................................................ 13
1.1 Purpose of This Guide ............................................................... 15
1.2 How This Guide is Organized .................................................... 16
1.3 Safety Information ...................................................................... 17
Reference
3 System Upgrade ........................................................ 25
3.1 System Upgrade Overview ........................................................ 27
3.1.1 Runtime Compatibility .............................................................. 27
3.1.2 EcoStruxure Building Operation Software Requirements ........ 27
3.1.3 System Upgrade Workflows .................................................... 28
3.1.4 SmartX Server Upgrade ........................................................... 28
3.2 Runtime Compatibility ................................................................ 29
3.3 EcoStruxure Building Operation Software Requirements .......... 33
3.3.1 Operating Systems .................................................................. 33
3.3.2 Microsoft .NET Framework versions ........................................ 34
3.3.3 Microsoft SQL Servers ............................................................. 35
3.3.4 Microsoft Office Visio ............................................................... 36
3.4 System Upgrade Workflows ...................................................... 37
3.4.1 Enterprise Server System Upgrade Workflow .......................... 37
3.4.2 SmartX Server System Upgrade Workflow .............................. 37
3.4.3 WebReports Upgrade Workflow .............................................. 38
3.5 Enterprise Central Upgrade Workflow ....................................... 39
3.5.1 Prepare for Upgrade ................................................................ 39
3.5.2 Upgrade the EcoStruxure Building Operation Software .......... 40
3.5.3 Reset and Confirm Server Functions ....................................... 41
3.6 Enterprise Server System Upgrade Workflow ............................ 44
3.6.1 Repair LonWorks Systems Running Version 1.8 ...................... 44
3.6.2 Prepare for Upgrade ................................................................ 47
3.6.3 Upgrade the EcoStruxure Building Operation Software .......... 48
Topics
Purpose of This Guide
How This Guide is Organized
Safety Information
1 About This Guide
1.1 Purpose of This Guide
Introduction
The Introduction part contains information on the purpose of this guide, how this
guide is organized, where to find more information, and information on
regulatory notices.
Reference
The Reference part contains conceptual information, procedures, user interface
descriptions and troubleshooting information. If you want more information, see
WebHelp or the other EcoStruxure BMS guides.
DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in
death or serious injury.
WARNING
WARNING indicates a hazardous situation which, if not avoided, could result
in death or serious injury.
CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result
in minor or moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
Please Note
Electrical equipment should be installed, operated, serviced, and maintained
only by qualified personnel. No responsibility is assumed by Schneider Electric
for any consequences arising out of the use of this material.
A qualified person is one who has skills and knowledge related to the
construction, installation, and operation of electrical equipment and has
received safety training to recognize and avoid the hazards involved.
Topics
Where to Find Additional Information
2 Additional Information
2.1 Where to Find Additional Information
Finding information
The easiest way to find information on WebHelp is to search for it.
All technical information is gathered in one place, so you do not need to know
which guide, specification sheet, or installation sheet the information is in.
Topics
System Upgrade Overview
Runtime Compatibility
EcoStruxure Building Operation Software Requirements
System Upgrade Workflows
Enterprise Central Upgrade Workflow
Enterprise Server System Upgrade Workflow
SmartX Server System Upgrade Workflow
WebReports Upgrade Workflow
Upgrade to Native MNB BACnet Devices
Upgrade MNB BACnet Devices Workflow
Importing and Assigning MNB Application Types After an
Upgrade
3 System Upgrade
3.1 System Upgrade Overview
NOTICE
You can perform an upgrade from version 1.8, 1.9, or, 2.0 directly to version
3.0 with runtime compatibilty.
For more information, see section 3.4 “System Upgrade Workflows” on page
37.
For more information, see section 3.2 “Runtime Compatibility” on page 29.
NOTICE
You have to upgrade the Enterprise Server to version 3.0 in order for it to be
runtime compatible with child SmartX servers running an earlier version, such
as 1.8, 1.9, or 2.0.
1.8 Yes
1.9 Yes
2.0 Yes
Navigate
You can navigate in the System Tree pane of a SmartX server running version
1.8, 1.9, or 3.0 with WorkStation and Enterprise Server running version 3.0.
However, object and property types removed in version 3.0 compared to the
earlier versions are not displayed in the System Tree pane.
For more information, see section 4.1 “System Tree Pane” on page 75.
Search
You can perform an object or property search on a SmartX server running
version 1.8, 1.9, or 2.0 with WorkStation and Enterprise Server running version
3.0. However, object and property types removed in version 3.0 compared to
the earlier versions are not displayed in the search list.
For more information, see section 4.2 “Search Overview” on page 76.
View events
You can view detailed information and perform commands on events on a
SmartX server running version 1.8, 1.9, or 2.0, with WorkStation and Enterprise
Server running version 3.0. The version 3.0 Enterprise Server will also store
events from a SmartX server running version 1.8, 1.9, or 2.0.
For more information, see section 4.3 “Alarm and Event Details ” on page 78.
View graphics
You can navigate to and view a graphic on a SmartX server running the version
1.8, 1.9, or 2.0, with WorkStation and Enterprise Server at version 3.0. Graphic
variable values can be changed, but configuration data cannot be changed.
For more information, see section 4.5 “Graphics Editor ” on page 83.
View alarms
You can view detailed alarm information from a SmartX server running version
1.8, 1.9, or 2.0, with WorkStation and Enterprise Server at version 3.0. Actions on
alarms can also be performed, such as assigning or disabling an alarm and
enabling state-change logging.
For more information, see section 4.3 “Alarm and Event Details ” on page 78.
Transfer values
You can transfer values from or to a SmartX server running version 1.8, 1.9, or
2.0, with an Enterprise Server or SmartX server running version 3.0.
For more information, see section 4.8 “Server Values” on page 90.
Configuration
You cannot make any configuration changes on a SmartX server running version
1.8, 1.9, or 2.0, with WorkStation and Enterprise Server running version 3.0.
However, you can make most changes using a parallel WorkStation running an
earlier version that is connected to the SmartX server running the same earlier
version.
Backup
You can backup and restore a SmartX server running version 1.8, 1.9, or 2.0,
with WorkStation and Enterprise Server running version 3.0. Log on to the
Enterprise Server and then make a backup of the SmartX server running version
1.8, 1.9, or 2.0.
You can also log on directly to the SmartX server running version 1.8, 1.9, or 2.0,
with WorkStation running the same earlier version, and then make a backup of
the SmartX server.
For more information, see section 4.13 “Backup” on page 99.
a) WorkStation, including Function Block Editor, Script Editor, Graphics Editor, and WorkPlace
Tech Editor
b) Device Administrator
c) License Administrator, including License Server
d) Enterprise Central, including Software Administrator
e) Enterprise Server, including Software Administrator
f) Reports Server
NOTICE
For Reports Server only the following editions are supported:
• Microsoft Windows 7: Professional
• Microsoft Windows 8.1: Pro and Enterprise
• Microsoft Windows 10: Pro and Enterprise
• Microsoft Windows Server 2008 R2: Standard, Web, Enterprise, Datacenter,
and Itanium
• Microsoft Windows Server 2012: Standard
• Microsoft Windows Server 2012 R2: Datacenter and Standard
• Microsoft Windows Server 2016: Datacenter, Standard, and Essentials
Continued
Microsoft .NET Framework WSa DAb LAc ECd ESe RSf
version
a) WorkStation, including Function Block Editor, Script Editor, Graphics Editor, and WorkPlace
Tech Editor
b) Device Administrator
c) License Administrator, including License Server
d) Enterprise Central, including Software Administrator. Microsoft .NET Framework is required by
Software Administrator.
e) Enterprise Server, including Software Administrator. Microsoft .NET Framework is required by
Software Administrator.
f) Reports Server
* Microsoft SQL Server 2012 SP1, SP2, SP3, or SP4 is required if the operating
system Windows Server 2012 R2 is used
Microsoft SQL Server 2014 and Microsoft SQL Server 2016 editions
The following Microsoft SQL Server 2014 and Microsoft SQL Server 2016
editions are supported: Enterprise, Standard, and Express with Advanced
Services.
NOTICE
When necessary, you can change the operating system or replace the
computer on which the EcoStruxure Building Operation software is installed.
You can also migrate WebReports from one computer to another. For more
information, see section 4.15 “Replace Enterprise Server or WebReports
Computer Workflow” on page 104.
For more information, see section 3.6 “Enterprise Server System Upgrade
Workflow” on page 44.
If your EcoStruxure BMS contains an Enterprise Central, use the Enterprise
Central Upgrade Workflow.
For more information, see section 3.5 “Enterprise Central Upgrade Workflow” on
page 39.
For more information, see section 4.19 “Backing Up EcoStruxure BMS Servers
Manually” on page 115.
For Enterprise Central that includes Reports Server, back up the Web reports
database.
For more information, see section 4.43 “Backing Up the WebReports Database”
on page 146.
NOTICE
If a newer version of Enterprise Central already is installed, ensure that the
Enterprise Central Windows service of this version is stopped.
NOTICE
If Device Administrator is running on the same PC as the Enterprise Central,
you can simulate the Enterprise Central upgrade to see if you can fix
configuration issues in the Enterprise Central before you upgrade it. For more
information, see section 4.22 “Previewing the Enterprise Server or Enterprise
Central Database Upgrade” on page 118.
NOTICE
The Enterprise Central Windows service automatically restarts after the
Enterprise Central upgrade is complete. If the Enterprise Central Windows
service does not start, restart the computer.
Upgrade WorkStations
Upgrade WorkStation and select the editor tools and language packs you want
to upgrade. For more information, see section 4.25 “Upgrading WorkStation and
Client Tools Installation” on page 124.
Figure:
NOTICE
In the Security Certificate Risk dialog box, click Trust certificate to temporarily
trust the certificate and log on to the EcoStruxure BMS server.
For more information, see section 4.48 “Activating a Certificate” on page 153.
NOTICE
If your system contains any MNB BACnet devices make sure to upgrade them.
For more information, see section 3.9 “Upgrade to Native MNB BACnet
Devices ” on page 66.
NOTICE
Ensure you have installed the hotfix v1.8.1.34000, or a later consolidation point
where the hotfix is included, for WorkStation and the EcoStruxure BMS servers
before you repair the LonWorks configurations. WorkStation and the
EcoStruxure BMS servers must be running hotfix v1.8.1.34000, or a later
consolidation point where the hotfix is included.
NOTICE
You cannot upgrade to version 3.0 until the LonWorks configurations in all
EcoStruxure BMS servers running version v1.8.1.34000, or a later, are
repaired.
NOTICE
Ensure that all EcoStruxure BMS servers in the configuration are updated to
version v1.8.1.34000, or later.
For more information, see section 4.49 “Delete Obsolete LonWorks Objects” on
page 154.
For more information, see section 4.50 “Deleting Obsolete LonWorks Objects”
on page 155.
NOTICE
If a newer version of Enterprise Server already is installed, ensure that the
Enterprise Server Windows service of this version is stopped.
NOTICE
If Device Administrator is running on the same PC as the Enterprise Server,
you can simulate the Enterprise Server upgrade to see if you can fix
configuration issues in the Enterprise Server before you upgrade it. For more
information, see section 4.22 “Previewing the Enterprise Server or Enterprise
Central Database Upgrade” on page 118.
NOTICE
The Enterprise Server Windows service automatically restarts after the
Enterprise Server upgrade is complete. If the Enterprise Server Windows
service does not start, restart the computer.
Upgrade WorkStations
Upgrade WorkStation and select the editor tools and language packs you want
to upgrade. For more information, see section 4.25 “Upgrading WorkStation and
Client Tools Installation” on page 124.
NOTICE
Keep one WorkStation at version 1.8.1.34000
1.8.1.34000, 1.9, or 2.0 in case you need to
make configuration changes to EcoStruxure BMS servers running 1.8.x, or
1.9.x or 2.0 if you need to perform LonWorks configuration preparations or
repair locally on a SmartX server before version 3.0 upgrade.
Install certificates
Install certificates to establish a trusted chain between the computer running
Device Administrator and the Smart X servers. This increases the security of
your system and must be use if you have licensed features on the SmartX
servers.
NOTICE
You can postpone the upgrade of some SmartX servers running version 1.8,
1.9, or 2.0, while you upgrade the Enterprise Server, WorkStation, and other
SmartX servers to version 3.0.
Open the conversion log and the high priority conversion log
Open the two conversion logs to see warning and error messages that occurred
when the databases were upgraded.
Use Device Administrator to open the conversion log. For more information, see
section 4.34 “Opening the Conversion Log” on page 137.
In Windows, open the high priority conversion log. For more information, see
section 4.35 “Opening the High Priority Conversion Log” on page 138.
Figure:
NOTICE
In the Security Certificate Risk dialog box, click Trust certificate to temporarily
trust the certificate and log on to the EcoStruxure BMS server.
NOTICE
The system may require 10 to 30 minutes to complete the process of resolving
invalid or unresolved bindings. Wait for this process to finish before editing the
bindings.
NOTICE
If your system contains any MNB BACnet devices make sure to upgrade them.
For more information, see section 3.9 “Upgrade to Native MNB BACnet
Devices ” on page 66.
Install the hotfix on all SmartX servers hosting LonWorks devices that are based
on the LonWorks imported device templates (.XIF) or resource kits (.DRF). If you
are uncertain, install the hotfix on all SmartX servers hosting LonWorks devices.
NOTICE
Ensure you have installed the hotfix v1.8.1.34000, or a later consolidation point
where the hotfix is included, for WorkStation and the EcoStruxure BMS servers
before you repair the LonWorks configurations. WorkStation and the
EcoStruxure BMS servers must be running hotfix v1.8.1.34000, or a later
consolidation point where the hotfix is included.
NOTICE
You cannot upgrade to version 3.0 until the LonWorks configurations in all
EcoStruxure BMS servers running version v1.8.1.34000, or a later, are
repaired.
NOTICE
Ensure that all EcoStruxure BMS servers in the configuration are updated to
version v1.8.1.34000, or later.
For more information, see section 4.49 “Delete Obsolete LonWorks Objects” on
page 154.
For more information, see section 4.50 “Deleting Obsolete LonWorks Objects”
on page 155.
Install certificates
Install certificates to establish a trusted chain between the computer running
Device Administrator and the Smart X servers. This increases the security of
your system and must be use if you have licensed features on the SmartX
servers.
Open the conversion log and the high priority conversion log
Open the two conversion logs to see warning and error messages that occurred
when the databases were upgraded.
Use Device Administrator to open the conversion log. For more information, see
section 4.34 “Opening the Conversion Log” on page 137.
In Windows, open the high priority conversion log. For more information, see
section 4.35 “Opening the High Priority Conversion Log” on page 138.
Upgrade WorkStations
Upgrade WorkStation and select the editor tools and language packs you want
to upgrade. For more information, see section 4.25 “Upgrading WorkStation and
Client Tools Installation” on page 124.
NOTICE
In the Security Certificate Risk dialog box, click Trust certificate to temporarily
trust the certificate and log on to the SmartX server.
Upgrade WebReports
Upgrade WebReports to upgrade the existing WebReports software version,
and to upgrade and retain the existing database. For more information, see
section 4.44 “Upgrading WebReports” on page 147.
NOTICE
Following the upgrade, each upgraded MNB BACnet device in the
WorkStation Device List indicates that a download is needed. This is normal.
NOTICE
Although the devices will resume function following the upgrade, it is
recommended that you resolve invalid bindings after upgrading the MNB
devices as part of an EcoStruxure Building Operation software upgrade.
NOTICE
It is required that you upload hosted objects after upgrading the MNB devices
as part of an EcoStruxure Building Operation software upgrade. Although the
devices will resume function following the upgrade, failing to upload hosted
objects will result in loss of data.
NOTICE
At the completion of an upgrade, the object name of each upgraded MNB
BACnet device in the WorkStation Device List is followed by a Download
Required indicator. Although this indication is normal, an upload is the action
that is actually required.
NOTICE
Applications must be from WorkPlace Tech version 4.0 or later, in order to be
imported into the EcoStruxure Building Operation database.
For more information, see section 3.10 “Upgrade MNB BACnet Devices
Workflow” on page 67.
NOTICE
Application file names may only contain digits 1 through 9, uppercase
letters A through Z, lowercase letters a through z, hyphen (-), and
underscore (_) in order to be imported into the EcoStruxure Building
Operation database.
NOTICE
Duplicate application names are appended with an underscore followed
by a number when imported into the EcoStruxure Building Operation
database.
9. Click Open
Open.
10. On the Ready to Import page, verify the number of files that will be
imported and then click Next
Next.
NOTICE
If the Import Wizard pauses and displays a message during the import
process, click OK to proceed.
11. Review the import log file and then click Finish
Finish.
12. For each MNB BACnet device, assign the respective application.
For more information, see section 4.52 “Assigning an MNL or MNB
Application ” on page 157.
13. For each MNB BACnet device, upload hosted objects to those devices. To
more easily upload multiple objects, use the multi-select technique.
For more information, see section 4.51 “Uploading Hosted Objects to an
EcoStruxure BMS Server” on page 156.
14. For each MNB BACnet device, download the respective application.
For more information, see section 4.53 “Downloading an MNB BACnet
Application Type” on page 158.
NOTICE
Before downloading the application, be sure that hosted objects have
been uploaded to the MNB BACnet device as outlined in the preceding
step.
You can view the new application types in the WorkPlace Tech Applications
view in WorkStation. You can view the MNB BACnet devices in the device list in
WorkStation.
Topics
System Tree Pane
Search Overview
Alarm and Event Details
Trend Log Lists
Graphics Editor
Watch Pane and Watch View
Variables
Server Values
Forced Values
Lead and Shadow Relationship
Security Overview
Alarm Control Panel Objects in Multiple Servers
Backup
Domains
Replace Enterprise Server or WebReports Computer
Workflow
Repairing LonWorks Configurations in EcoStruxure BMS
Servers Running Version 1.8.1 Before Upgrade
Warm Starting a SmartX Server
4 Warm Starting an Enterprise Server
Backing Up EcoStruxure BMS Servers Manually
Stopping the Reporting Agent Windows Service
Stopping the License Server
Previewing the Enterprise Server or Enterprise Central
Database Upgrade
Upgrading the License Administrator and the License Server
Upgrading the Enterprise Server
Upgrading WorkStation and Client Tools Installation
Upgrading the Device Administrator Installation
Device Administrator Certificate Workflow
Device Administrator Licenses
Uploading and Upgrading a SmartX Server
SmartX Server Upgrade
Conversion Logs
Log Entry Interpretation
Opening the Upgrade Log
Opening the Conversion Log
Opening the High Priority Conversion Log
Downloading an Upgraded Database to a SmartX Server
Adding a Language in WebStation
Changing the Language in WebStation
Starting the Enterprise Server or Enterprise Central
Windows Service
Checking the Status of Bindings
Binding Values Manually
Bindings Management
Backing Up the WebReports Database
Upgrading WebReports
Starting the Reporting Agent Windows Service
4 Generating a Certificate
Adding a Certificate
Activating a Certificate
Delete Obsolete LonWorks Objects
Deleting Obsolete LonWorks Objects
Uploading Hosted Objects to an EcoStruxure BMS Server
Assigning an MNL or MNB Application
Downloading an MNB BACnet Application Type
4 Related Concepts and Procedures
4.1 System Tree Pane
Collapse all
Click to collapse the System Tree so that
only the EcoStruxure BMS server of the
EcoStruxure BMS is visible.
4.2.2 Search
You use search to find objects and properties in the EcoStruxure Building
Operation database.
For more information, see the Search topic on WebHelp.
NOTICE
• When you save a search, only the setting for the search is saved. The search
result is never saved.
If you have configured your search object with a locked reference, the search is
performed on the specific folder or container object even if the folder or
container object is renamed or moved. By default, search paths are locked.
~ Locked reference
Searches in the configured folder or
container object
You can manually add records to a trend log list for any type of trend log.
4.4.6
NOTICE
You have to have a valid Graphics Editor license to start the Graphics Editor.
For more information, see the Licenses topic on WebHelp.
In Graphics Editor, you can create advanced graphics. Graphics Editor contains
tools to make geometrical figures, symbols, texts, flexible data conversions,
animations, dynamics and interactivity. You can transform, move, align, arrange,
and distribute graphics objects in a work area in several ways.
Often used functionality, standard symbols, and components representing
common functions are available in libraries delivered with Graphics Editor. You
can add to these libraries.
You can open and import graphics or photographs into Graphics Editor, paste
graphics into other graphics, and export from Graphics Editor.
You can link figures, for example, illustrations, symbols, and text, to database
objects in the EcoStruxure Building Operation database. When the system is
running, the graphic objects can be displayed in WorkStation and automatically
updated as values at the site change.
You can print the graphics on any printer supported by Microsoft Windows.
A graphic component is a predefined graphic that contains one or several other
parts. Components are meant for reuse and typically represent a feature or a
device in a live system. Components can be designed as symbols which can be
used as building blocks and reused in several graphics. Components reside in
dedicated libraries and are displayed in the Components pane. The analog
watch is an example of a component.
When you design components, it is recommended that you set Graphics Editor
Component mode to Graphics.
When you create a new component, the default work area is 200x200 pixels
(where a pixel is the smallest possible drawing unit). A standard graphic work
area is 600x800. This smaller work area is usually sufficient to draw a fairly
detailed component. When you use the component in the TGML graphic,
however, the component is automatically scaled to one fifth of the graphic size.
This default size of 40x40 pixels makes the component comparable in size to the
ISO and DIN standard components.
For more information, see the TGML File Format topic on WebHelp.
When you create a component, the root element, ComponentContent, is used
(instead of TGML for a graphic object). When the component is stored in a
library and used in a graphic, the ComponentContent element is replaced with
the Component element.
The root element of a component always includes at least two metadata
elements describing the component: Name and Description. These metadata
elements automatically get their values when you save the component.
The ComponentContent has the following properties:
• Opacity
• Visibility
• Height
• Width
The height and width values are copied to the ComponentHeight and
ComponentWidth properties of the Component element when you store the
component. When you use the component in a TGML graphic, however, the
height and width values are scaled to 20%, as mentioned above.
Thus, the component has one size when you use it in a graphic and another size
(usually larger) when you create or edit the component.
Components are stored as separate files in subfolders of the Components
folder. Typically, you would save different categories of components in different
subfolders. The subfolder names are displayed as separate bars in the
Components pane.
4.5.2 Figures
A figure is the smallest independent element of a graphic, for example, a circle.
For more information, see the Figures topic on WebHelp.
4.5.3 Components
Components are standardized, predefined graphics for defined use.
For more information, see the Components topic on WebHelp.
4.5.7 Test
You can test the behavior of graphics and components offline in Preview mode
by setting test values in the Test pane.
For more information, see the Test topic on WebHelp.
4.5.8 Console
The console is used for testing and troubleshooting scripts.
For more information, see the Console topic on WebHelp.
4.7 Variables
A variable is a run-time (dynamically changing) property of an object.
Script supports program, system, and runtime variables.
• Configure the transfer interval. For more information, see the Configuring the
Value Transfer Interval topic on WebHelp.
• Bind the server value object to the program input. For more information, see
section 4.41 “Binding Values Manually” on page 144.
Indication in WorkStation
A forced value is indicated by orange color in the properties dialog boxes. In in
the Watch pane, a forced value is indicated by a pointing hand .
In the List View and Search View, a forced value is indicated by the text [Forced]
in the 'Value' column.
In WorkStation, you can view the unforced value, which is the real value from the
system, at any time. For more information, see the Viewing an Unforced Value
topic on WebHelp.
Indication in WebStation
A forced value is indicated by orange color and a pointing hand in the List view.
Figure: Changes in the lead object are automatically reflected in the connected shadow
objects
When you set up a lead and shadow relationship, you define which object is the
lead object in the properties of the shadow object. For example, to synchronize
an Enterprise Server object with an Enterprise Central object, you define the
lead object, in this case the Enterprise Central object, in the properties of the
Enterprise Server.
A server on a higher level, such as an Enterprise Central, typically acts as the
lead. However, a lead and shadow relationship can be established between two
SmartX servers.
When you configure lead objects on an Enterprise Central, the shadow objects
on Enterprise Servers can, in turn, control objects on SmartX server.
4.11.1 Firewall
You can configure the devices that are allowed to communicate with the
Automation Server to prevent connection attempts from unauthorized devices.
The IP addresses of the devices that are allowed to communicate with the
Automation Server are added to the whitelist.
For more information, see the Firewall topic on WebHelp.
4.11.6 Certificates
The EcoStruxure Building Operation software supports certificates. Certificates
are electronic credentials that are used to certify the identities of computers, and
other entities on a network.
For more information, see the Certificates topic on WebHelp.
NOTICE
You need to export Alarm Control Panel objects from the child server
(Enterprise Server or a SmartX server) and import them to the parent server
(Enterprise Central or Enterprise Server) before you synchronize the Alarm
Control Panel. During synchronization, all the Alarm Control Panel objects are
erased from the child server. In particular, ensure that you secured the Alarm
Control Panel of your SmartX server before adding it to the Enterprise Server.
For more information, see the Synchronizing Alarm Control Panels topic on
WebHelp.
4.13 Backup
Backup is the process of copying and storing data so that the copy can be used
to restore data if a loss occurs. You can also use a backup to revert to an older
version. In the EcoStruxure BMS, you can perform backups on an all
EcoStruxure BMS servers and their devices. EcoStruxure BMS server backups
should take place during non-business hours.
Using WorkStation, you can back up data to the local drive of each installed
EcoStruxure BMS server. The EcoStruxure Building Operation software stores
the files by date in a predefined directory location on the server to which
WorkStation is connected. For more information, see the Backup Sets topic on
WebHelp.
4.14 Domains
An EcoStruxure Building Operation domain contains user accounts, user
account groups, software permissions, workspaces, and one or several
EcoStruxure BMS servers. The EcoStruxure BMS server that hosts and
administers the domain is called the domain controller.
Normally, a user account or user account group that is a member of a domain
that hosts several EcoStruxure Building Operation servers has access to all
servers within the domain without additional logon. The user account or user
account group can have restricted path permissions preventing the user to
access the servers.
You can set up domains in several ways. You can have a communication
domain that only contains EcoStruxure Building Operation servers and another
domain that contains users, workspaces, and software permissions. Or you can
have a combined domain that manages both servers and users.
NOTICE
An EcoStruxure Building Operation server can belong to more than one
domain.
For example, an EcoStruxure BMS consists of two domains, the Inner City
domain and the Outer city domain. The user Larry has a user account in the
Inner City domain. The Inner City domain contains several Enterprise Servers
and Automation Servers. One of the Automation Servers belongs to both the
Inner City domain and the Outer City domain. Larry cannot access the servers in
the Outer City domain, except for the shared Automation Server.
NOTICE
You cannot change the name of a domain that is shared between EcoStruxure
BMS servers.
Do not name an EcoStruxure Building Operation domain with the same name as
any Windows domain in your network. An EcoStruxure Building Operation
domain and a Windows domain in your network that are named in the same way
can cause conflicts when you use an integrated Windows log on for the
EcoStruxure Building Operation domains.
NOTICE
If the Windows Active Directory name is changed, you have to manually
update the change in EcoStruxure Building Operation software.
NOTICE
On a Local domain, you cannot view bound values from an EcoStruxure BMS
server higher or on the same tier in the EcoStruxure BMS hierarchy.
4.15.1 Preparation
Prior to changing the operating system where the Enterprise Server is installed
or migrating the Enterprise Server to another computer, complete the tasks
listed in the following flowchart. Related information can be found in the sections
after the diagram.
Migrate WebReports?
If you plan to migrate WebReports to another computer, you need to continue.
NOTICE
When you repair LonWorks configurations from the Enterprise Server, all
attached SmartX servers are also repaired.
For more information, see section 3.4 “System Upgrade Workflows” on page 37.
NOTICE
The time to repair the LonWorks configurations depends on the number
of LonWorks devices in the configuration and the complexity (“size”) of
each device type.
include in the backup, or click the Select All button to include all the
listed EcoStruxure BMS servers in the backup.
6. In the Backup content column, select the type of data you want to back up
for each EcoStruxure BMS server:
• Select Configuration only to back up the configuration database and
custom object type data.
• Select All data to back up the configuration, historical data, and
custom object type data.
7. In the Backup set description column, type a brief description up to 255
characters to help identify the content of each backup.
8. Click the Synchronize Description button to add the same backup set
description entered for one EcoStruxure BMS server to all the other backup
sets.
9. Click the Synchronize Content button to add the same content type
chosen for one EcoStruxure BMS server to all the other backup sets.
10. Click the Synchronize All button to add both the backup set
description and the content type chosen for one EcoStruxure BMS server to
all the other backup sets.
11. Click Backup
Backup.
12. In the Backup Status dialog box, verify that the backups succeeded and
click Close
Close.
NOTICE
Device Administrator must be installed on the same computer that runs the
Enterprise Server or Enterprise Central. The procedure cannot be done
remotely.
For more information, see section 4.31 “Conversion Logs” on page 134.
NOTICE
• To upgrade License Administrator and License Server, you must have
access to an installation package with a higher number than the currently
installed version.
For more information, see section 3.6 “Enterprise Server System Upgrade
Workflow” on page 44.
NOTICE
If you previously selected a custom folder for your installation, select a
different installation folder to aviod data loss.
NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
10. In the License Server address box, type @ and then type the address to
the license server.
NOTICE
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
NOTICE
• To upgrade Enterprise Server, you must have access to an installation
package with a higher number than currently installed version.
• Before upgrading, you preview the upgrade in Device Administrator to
ensure you are fully prepared to upgrade. For more information, see section
4.22 “Previewing the Enterprise Server or Enterprise Central Database
Upgrade” on page 118.
For more information, see section 3.6 “Enterprise Server System Upgrade
Workflow” on page 44.
NOTICE
If you previously selected a custom folder for your installation, select a
different installation folder to aviod data loss.
NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
7. In Database Files page, in the Database Folder box, enter the path to the
location where you want to save the Enterprise Server database.
NOTICE
The database folder path can contain up to 140 characters.
8. Click Next
Next.
NOTICE
If WebReports resides on the same Windows server as the Enterprise
Server, you have to configure the HTTP ports to use different numbers.
For example, if you configure the HTTP port for the Reports Server to 80
80,
then you must configure the HTTP port for the Enterprise Server to use a
different number, such as 81
81. If WebReports resides on another Windows
server, configure the Enterprise Server HTTP port to the default, 80
80.
14. In the HTTPS Port box, type the port number the Enterprise Server listens
to when communicating through the secure Hypertext Transfer Protocol.
15. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
16. Click Next
Next.
17. In the Windows Services page, select Local system to run the Enterprise
Server service under the Local system account.
NOTICE
• For security reasons, it is recommended that you run the Enterprise
Server service under a custom Windows user account with limited
permissions.
• To run the Enterprise Server service under a custom Windows account,
select Custom, enter the domain and user account names, click Verify
Account to verify that the account exists, and then type the user
account password.
• To be able to log on to WebStation, the selected Windows user account
has to have write permissions to C:\Program Files (x86)\Schneider
Electric EcoStruxure\Building Operation x.x\Enterprise Server.
18. In the License Server address box, type @ and then type the address to
the license server.
NOTICE
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
20. Revise the information on the Summary page and then click Install
Install.
NOTICE
The Enterprise Server Windows service stops automatically.
NOTICE
• To upgrade WorkStation, you must have access to an installation package
with a higher number than the currently installed version.
• For upgrading WorkStation, it is assumed that you already have working and
available WorkStation, Graphics, Script, and Menta / Function Block
licenses. A working license for each product is required to start and log on. If
necessary, acquire the needed licenses. For more information, see the
Licenses topic on WebHelp.
• If you intend to use WorkPlace Tech Editor, install a compatible version of
Microsoft Office Visio first. Then install WorkStation, which includes this
editor as an installation option.
For more information, see section 3.3 “EcoStruxure Building Operation
Software Requirements” on page 33.
For more information, see the WorkPlace Tech Overview topic on WebHelp.
For more information, see section 3.6 “Enterprise Server System Upgrade
Workflow” on page 44.
NOTICE
If User Account Control (UAC) is enabled on the computer on which you
are installing WorkStation, you must run the installer as an administrator.
To do this, right-click the WorkStation installation file and then, in the
shortcut menu, choose Run as administrator
administrator.
2. Click Yes to confirm that you want to run Workstation installation package.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
5. In the Program Files page, enter the installation folder and then click Next
Next.
NOTICE
If you previously selected a custom folder for your installation, select a
different installation folder to aviod data loss.
NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
6. In the Choose Components page, select the components that you want to
upgrade and then click Next
Next.
NOTICE
Upgrade all components to the new version. It is not recommended to run
products with different version numbers.
NOTICE
Before selecting the WorkPlace Tech Editor component, be sure the
appropriate versions of Microsoft Visio and .NET 3.5 SP1 are installed.
For more information, see the WorkPlace Tech Editor topic on WebHelp.
For more information, see section 3.3 “EcoStruxure Building Operation
Software Requirements” on page 33.
NOTICE
• If the License Server uses a port other than the default port range
27000-27009, type the port number in front of @. For example,
567@localhost.
• Use a semicolon to separate addresses to different License Servers.
NOTICE
To upgrade Device Administrator, you must have access to an installation
package with a higher number than the currently installed version.
NOTICE
If you previously selected a custom folder for your installation, select a
different installation folder to aviod data loss.
NOTICE
• When upgrading to a later version, the installation path is changed to
the default installation folder for that version. The default installation
folder is always located on the C: drive
• The complete installation path can have maximum 115 characters.
NOTICE
The certificates are included in the SmartX server’s backup. You do not need
to generate a new certificate if you restore a SmartX server from a backup
generated after the certificate was transferred to the SmartX server if you retain
the original root certificate.
WebStation
Every SmartX server contains one default license that allows you to connect to
the SmartX server with one instance of WebStation.
If you want more instances of WebStation to connect to that SmartX server, more
licenses are required. Licenses are required for the total number of WebStation
clients simultaneously connected to a SmartX server. For a SmartX server to
communicate with ten WebStation clients at the same time, 10 licenses are
needed.
SmartDrivers
To be able to use SmartDrivers on a SmartX server, one or more, license is
needed for every SmartDriver that runs on the SmartX server.
SNMP Notifications
To be able to use SNMP Notification on a SmartX server, a license is required.
One license for SNMP Notifications allows you to use any number of SNMP
Notifications on that SmartX server.
Personal Dashboards
To be able to create personal dashboards on a SmartX server, you need a
license. Personal dashboards are used in WebStation.
One license allows the connected users of that SmartX server to create any
number of Personal Dashboards.
4.28.4 Certificates
It is recommended to use HTTPS for the communication between Device
Administrator and SmartX servers when you manage licenses.
For more information, see the Certificates in Device Administrator topic on
WebHelp.
NOTICE
Do not use any USB analytics programs during uploading and upgrading
using USB.
For more information, see the SmartX Server Device Administration topic on
WebHelp.
NOTICE
When you select New database from the Upgrade servers box the
existing database will be lost.
NOTICE
If you choose New database
database, select Set time on device to transfer the
time on the computer that runs Device Administrator to the SmartX server.
For more information, see the SmartX Server Device Administration topic
on WebHelp.
9. Click OK
OK.
NOTICE
When upgrading a SmartX server, you need to follow an upgrade workflow for
your system configuration. For more information, see section 3.4 “System
Upgrade Workflows” on page 37.
4.30.2 Status
After upload and conversion, the color of the progress bar in the Device
Administrator indicates the status of the database conversion:
• Green: The database conversion is complete.
• Yellow: The database conversion is complete. Open the Conversion Logs
and determine if you can use the converted database for download or if you
need to fix configuration issues in the SmartX server.
• Red: The database conversion has failed. Open the Conversion Logs and
determine the configuration issues that you need to fix in the SmartX server.
For more information, see section 4.34 “Opening the Conversion Log” on page
137.
For more information, see section 4.35 “Opening the High Priority Conversion
Log” on page 138.
NOTICE
To view only the most important warnings, go to
C:\ProgramData\Schneider Electric EcoStruxure\Building Operation
x.x\Device Administrator\Conversion Logs and then open the file
hostname/IP_only_hi_prio.txt
hostname/IP_only_hi_prio.txt, where hostname/IP is the host name or IP
address of the SmartX server. For more information, see section 4.35
“Opening the High Priority Conversion Log” on page 138.
NOTICE
Do not download the upgraded database until this log is empty, or nearly
empty and you are comfortable with the contents.
NOTICE
• If any of the SmartX server listed in the Device Administrator do not
have a status of Ready for download but you proceed with the
download, those SmartX server will not have their databases
downloaded.
• You are notified and recommended to upload and upgrade the
database again when the converted database is older than 24 hours
and not has been downloaded.
NOTICE
To add a language in WebStation, you must log on with a user account that
belongs to a user account group that has the property Allow members to
access Automation Server Web Configuration selected in the Policies view.
NOTICE
When an EcoStruxure BMS server is upgraded, the language pack in
WebStation must be added once again.
NOTICE
Ensure that you have a working and available license. A working license is
required to start the server. For more information, see the Licenses topic on
WebHelp.
NOTICE
• Enterprise Server or Enterprise Central are automatically started when
installed and when Windows is started.
You can also drag objects from the System Tree pane, or values from the
Search pane, or you can type the binding path in the Binding box.
NOTICE
For information on how to add, remove, and view the contents of a
backup destination, see the Microsoft SQL Server product
documentation.
6. Click OK
OK.
7. Click OK again.
To upgrade WebReports
1. Double-click on the WebReports installation file to start the installation
wizard.
2. In the Specify extraction path page, enter the extraction path and then
click Ok
Ok.
3. Make sure that you agree with the End User License Agreement (EULA)
and then click Accept
Accept.
4. In the Installation Type page, click Upgrade
Upgrade.
5. Click Next
Next.
6. In the System Check page, click Next
Next.
7. In the Enterprise Server / Central page, in the Path box, type the IP
address and the port number of the Enterprise Server.
NOTICE
If WebReports resides on the same server as the Enterprise Server,
configure the HTTP port for the Enterprise Server to 81 (if also configured
during the installation of the Enterprise Server). If WebReports does not
reside on the Enterprise Server, configure the port to 80, which is the
default.
In the Path box, the URL should be https://<Enterprise Server IP
address:HTTPS Port>
8. In the User name box, type the user name that is used to access the
Enterprise Server. The user name is your user account in WorkStation.
NOTICE
The user account must belong to the Reports Administrators user group.
For more information, see the User Account – Group Membership Tab
topic on WebHelp.
9. In the Password box, type the password that is used to access the
Enterprise Server.
10. Click Next
Next.
11. In the SQL Configuration page, click Next
Next.
NOTICE
If you want to take the database backup, select Yes and enter the path
where backup is to be saved.
NOTICE
Generating a certificate may take some time. This is particularly true when you
batch generate certificate for many SmartX servers at one time.
To generate a certificate
1. In WorkStation, in the System Tree pane, select the SmartX server you
want to configure.
2. Click the Control Panel tab.
3. Click Security Settings
Settings.
4. In the Security Settings Control Panel, click Certificates
Certificates.
5. In the Certificates tab, expand Certificate settings
settings.
6. Select the SmartX servers in the server list.
7. Click Manage Certificate
Certificate.
8. In the Manage Certificates dialog box, click Generate certificate
certificate.
9. In the Generate Certificate dialog box, in the Name box, type a name for
the certificate.
10. In the Description box, type a description.
11. In the Common name box, type the DNS address or IP address of the
SmartX server where the certificate is used.
12. Select Use IP/DNS from communication settings to automatically collect
the IP address or DNS address from the communication setting on the
SmartX server and add it to the certificate.
13. In the Email address box, type the email address to the person or unit that
is responsible for the certificate.
14. In the Organizational unit box, type the organizational unit responsible for
the certificate.
15. In the Organization box, type the name of the organization responsible for
the certificate.
16. In the Country box, select the country.
17. In the Valid from box, displays the time when the certificate starts. This
date is always the current date.
18. In the Valid to box, enter the date when the certificate expires.
19. In the Password box, enter a password.
Continued on next page
To add a certificate
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Security Settings
Settings.
4. In the Security Manager Control Panel, click Certificates
Certificates.
5. In the Certificates tab, expand Certificate settings
settings.
6. Select the EcoStruxure BMS server where you want to add the certificate.
7. Click Manage Certificate
Certificate.
8. In the Manage Certificates dialog box, click the Add certificate button
.
9. Click Add existing certificate
certificate.
10. In the Add Certificate dialog box, in the Name box, enter a name for the
certificate.
11. In the Description box, enter a description.
12. In the Host certificate box, enter the host certificate.
13. In the Intermediate Certificate box, enter the intermediate certificate.
14. In the Private key box, enter the private key.
15. In the Password box, enter the password.
16. Click OK
OK.
Now that you have added a certificate, you need to activate the certificate for it
to be in effect.
For more information, see section 4.48 “Activating a Certificate” on page 153.
To activate a certificate
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server you want to configure.
2. Click the Control Panel tab.
3. Click Security Settings
Settings.
4. Click Certificates
Certificates.
5. In the Certificates tab, expand Certificate settings
settings.
6. Click on the EcoStruxure BMS server in the server list.
7. In the Certificate list, select the certificate you want to activate.
NOTICE
This dialog box displays when there are no hosted objects for the device
in the EcoStruxure BMS server database.
NOTICE
The Assign application option is not available when you select multiple
MNL LonWorks or MNB BACnet devices.
NOTICE
In EcoStruxure BMS, use WorkStation to download MNB device applications.
Do not use WorkPlace Tech Tool 5.x to download an MNB device that has
already been assigned an application in EcoStruxure Building Operation
software.
For more information, see the Download of MNB BACnet Application Types topic
on WebHelp.
NOTICE
Prior to MNB application download, manually override critical equipment
controlled by the device. Personal injury or equipment damage can result
if overrides or commands are removed while servicing the equipment.
Topics
Installation Wizard – Choose Components Page
Installation Wizard – Installation Type Page
Installation Wizard – License Server Configuration Page
Server Installation Wizard – Configuration Page
WebReports Upgrade Wizard – Installation Type Page
WebReports Upgrade Wizard – Installation Type: Installation
Path Page
WebReports Upgrade Wizard - System Check Page
WebReports Upgrade Wizard – Enterprise Server Page
WebReports Upgrade Wizard - SQL Configuration:Database
Backup Page
Pre-upgrade LonWorks Configuration Wizard – Analyze
Database Page
Pre-upgrade LonWorks Configuration Wizard – Prepare
LonWorks Configurations for Upgrade Page
Repair LonWorks Configuration Wizard – Analyze Database
Page
Repair LonWorks Configuration Wizard – Repair
Configurations Page
5 Installation User interface
5.1 Installation Wizard – Choose Components Page
Continued
Component Description
Menta / Function Block Editor Select to install Menta Editor and Function
Block Editor, which you use to graphically
design function block programs for Xenta
280/300/401 LonWorks devices and
SmartX servers.
Continued
Component Description
Backup path Enter the path where you want save the
backup.
04-30011-01-en
May 2019