0% found this document useful (0 votes)
780 views

EcoStruxure Building Operation - System Upgrade Reference Guide

Uploaded by

Walter Barba
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
780 views

EcoStruxure Building Operation - System Upgrade Reference Guide

Uploaded by

Walter Barba
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 178

EcoStruxure Building Operation

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

2 Additional Information ................................................. 19


2.1 Where to Find Additional Information ......................................... 21

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

04-30011-01-en, May 2019 System Upgrade


5
3.6.4 Upgrade SmartX servers ......................................................... 50
3.6.5 Reset and Confirm Server Functions ....................................... 52
3.7 SmartX Server System Upgrade Workflow ................................ 55
3.7.1 Repair LonWorks Systems Running Version 1.8 ...................... 55
3.7.2 Prepare for Upgrade ................................................................ 58
3.7.3 Upgrade EcoStruxure Building Operation Software Part 1 ...... 59
3.7.4 Upgrade SmartX Servers ........................................................ 59
3.7.5 Upgrade EcoStruxure Building Operation Software Part 2 ...... 61
3.7.6 Reset and Confirm Server Functions ....................................... 62
3.8 WebReports Upgrade Workflow ................................................ 65
3.9 Upgrade to Native MNB BACnet Devices ................................ 66
3.9.1 Upgrade MNB BACnet Devices Workflow ............................... 66
3.10 Upgrade MNB BACnet Devices Workflow ................................. 67
3.11 Importing and Assigning MNB Application Types After an
Upgrade .................................................................................... 69

4 Related Concepts and Procedures ............................ 71


4.1 System Tree Pane ...................................................................... 75
4.2 Search Overview ....................................................................... 76
4.2.1 Simple Search .......................................................................... 76
4.2.2 Search ..................................................................................... 76
4.2.3 Saved Search .......................................................................... 76
4.2.4 Relative or Locked Search Path ............................................... 76
4.3 Alarm and Event Details ............................................................ 78
4.3.1 Alarm and Event Details in WorkStation ................................... 78
4.3.2 Alarm and Event Details in WebStation .................................... 78
4.4 Trend Log Lists .......................................................................... 80
4.4.1 Time Zone Modes in a Trend Log List ...................................... 82
4.4.2 Calculation Methods ................................................................ 82
4.4.3 Period Timestamps in Trend Charts and Trend Log Lists ........ 82
4.4.4 Temporary Trend Log Lists ...................................................... 82
4.4.5 Floating Point Values NaN, INF, and -INF ................................ 82
4.4.6 ................................................................................................. 82
4.5 Graphics Editor ......................................................................... 83
4.5.1 Graphics in WorkStation .......................................................... 86
4.5.2 Figures ..................................................................................... 86
4.5.3 Components ............................................................................ 86
4.5.4 Graphic Menus ........................................................................ 86
4.5.5 Graphics Editor Libraries ......................................................... 86
4.5.6 Keyboard Shortcuts for Graphics Editor .................................. 86
4.5.7 Test .......................................................................................... 86
4.5.8 Console ................................................................................... 87
4.6 Watch Pane and Watch View ..................................................... 88
4.7 Variables .................................................................................... 89
4.7.1 Program Variables ................................................................... 89
4.7.2 System Variables ..................................................................... 89
4.7.3 System Variable Keywords ...................................................... 89

System Upgrade 04-30011-01-en, May 2019


6
4.7.4 Script Runtime Variables ......................................................... 89
4.8 Server Values ............................................................................. 90
4.8.1 Minimizing the Transfer Interval Intensity ................................. 90
4.8.2 Server Value Workflow ............................................................. 90
4.9 Forced Values ............................................................................ 92
4.10 Lead and Shadow Relationship ................................................. 93
4.10.1 Synchronize Network Time Settings ........................................ 94
4.10.2 Synchronize Time Zone Settings ............................................. 94
4.10.3 Content Type Synchronization ................................................. 94
4.10.4 Schedule and Calendar Synchronization ................................ 94
4.10.5 Alarm Control Panel Synchronization ....................................... 94
4.11 Security Overview ..................................................................... 95
4.11.1 Firewall .................................................................................... 95
4.11.2 Password Policy ....................................................................... 95
4.11.3 Embedded Content in WebStation .......................................... 95
4.11.4 Automatic Log Off .................................................................... 95
4.11.5 Security Banner ....................................................................... 95
4.11.6 Certificates .............................................................................. 96
4.11.7 Encrypted Communication ...................................................... 96
4.11.8 Web Server Access Logging ................................................... 96
4.11.9 SmartX Server Remote System Logging .................................. 96
4.11.10 Connect Agent ......................................................................... 96
4.11.11 Document Policy ...................................................................... 96
4.11.12 Disable SmartX Server Ports .................................................... 97
4.12 Alarm Control Panel Objects in Multiple Servers ....................... 98
4.13 Backup ...................................................................................... 99
4.13.1 Types of Data ........................................................................... 99
4.13.2 Backup Sets ............................................................................. 99
4.13.3 Scheduled Backups ................................................................ 99
4.13.4 Manual Backups ...................................................................... 99
4.13.5 Mass Backup ......................................................................... 100
4.13.6 System Backup ...................................................................... 100
4.13.7 Backup Status ........................................................................ 100
4.14 Domains ................................................................................... 101
4.14.1 Windows Active Directory Domain ......................................... 102
4.14.2 Server Local Domain ............................................................. 103
4.14.3 Administration Accounts in Server Local Domain .................. 103
4.15 Replace Enterprise Server or WebReports Computer
Workflow .................................................................................. 104
4.15.1 Preparation ............................................................................ 104
4.15.2 Install EcoStruxure Building Operation Software ................... 105
4.15.3 Restore the Enterprise Server Database ............................... 106
4.15.4 WebReports Migration Preparation ....................................... 108
4.15.5 Install WebReports ................................................................. 109
4.16 Repairing LonWorks Configurations in EcoStruxure BMS Servers
Running Version 1.8.1 Before Upgrade ................................... 112
4.17 Warm Starting a SmartX Server ............................................... 113

04-30011-01-en, May 2019 System Upgrade


7
4.18 Warm Starting an Enterprise Server ......................................... 114
4.19 Backing Up EcoStruxure BMS Servers Manually ..................... 115
4.20 Stopping the Reporting Agent Windows Service .................... 116
4.21 Stopping the License Server .................................................... 117
4.22 Previewing the Enterprise Server or Enterprise Central Database
Upgrade .................................................................................. 118
4.23 Upgrading the License Administrator and the License Server 119
4.24 Upgrading the Enterprise Server ............................................. 121
4.25 Upgrading WorkStation and Client Tools Installation ............... 124
4.26 Upgrading the Device Administrator Installation ..................... 126
4.27 Device Administrator Certificate Workflow ............................... 127
4.28 Device Administrator Licenses ................................................ 129
4.28.1 Licenses on SmartX Servers .................................................. 129
4.28.2 Entitlements, Products, and Licenses .................................... 129
4.28.3 Assign and Activate Licenses ................................................ 129
4.28.4 Certificates ............................................................................ 130
4.29 Uploading and Upgrading a SmartX Server ............................ 131
4.30 SmartX Server Upgrade ........................................................... 132
4.30.1 Upgrade Process ................................................................... 132
4.30.2 Status ..................................................................................... 132
4.30.3 Conversion Logs .................................................................... 133
4.30.4 Log Entry Interpretation ......................................................... 133
4.31 Conversion Logs ...................................................................... 134
4.32 Log Entry Interpretation ........................................................... 135
4.33 Opening the Upgrade Log ....................................................... 136
4.34 Opening the Conversion Log ................................................... 137
4.35 Opening the High Priority Conversion Log .............................. 138
4.36 Downloading an Upgraded Database to a SmartX Server ...... 139
4.37 Adding a Language in WebStation .......................................... 140
4.38 Changing the Language in WebStation ................................... 141
4.39 Starting the Enterprise Server or Enterprise Central Windows
Service ..................................................................................... 142
4.40 Checking the Status of Bindings .............................................. 143
4.41 Binding Values Manually .......................................................... 144
4.42 Bindings Management ............................................................. 145
4.43 Backing Up the WebReports Database ................................... 146
4.44 Upgrading WebReports ........................................................... 147
4.45 Starting the Reporting Agent Windows Service ...................... 149
4.46 Generating a Certificate ........................................................... 150
4.47 Adding a Certificate ................................................................. 152
4.48 Activating a Certificate ............................................................. 153
4.49 Delete Obsolete LonWorks Objects ......................................... 154
4.50 Deleting Obsolete LonWorks Objects ...................................... 155
4.51 Uploading Hosted Objects to an EcoStruxure BMS Server ..... 156
4.52 Assigning an MNL or MNB Application ................................... 157
4.53 Downloading an MNB BACnet Application Type ..................... 158

System Upgrade 04-30011-01-en, May 2019


8
5 Installation User interface ......................................... 159
5.1 Installation Wizard – Choose Components Page ..................... 161
5.2 Installation Wizard – Installation Type Page ............................. 163
5.3 Installation Wizard – License Server Configuration Page ........ 164
5.4 Server Installation Wizard – Configuration Page ...................... 165
5.5 WebReports Upgrade Wizard – Installation Type Page ........... 166
5.6 WebReports Upgrade Wizard – Installation Type: Installation Path
Page ........................................................................................ 167
5.7 WebReports Upgrade Wizard - System Check Page .............. 168
5.8 WebReports Upgrade Wizard – Enterprise Server Page ......... 170
5.9 WebReports Upgrade Wizard - SQL Configuration:Database
Backup Page ........................................................................... 171
5.10 Pre-upgrade LonWorks Configuration Wizard – Analyze Database
Page ........................................................................................ 172
5.11 Pre-upgrade LonWorks Configuration Wizard – Prepare
LonWorks Configurations for Upgrade Page ........................... 173
5.12 Repair LonWorks Configuration Wizard – Analyze Database
Page ........................................................................................ 174
5.13 Repair LonWorks Configuration Wizard – Repair Configurations
Page ........................................................................................ 175

04-30011-01-en, May 2019 System Upgrade


9
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.
1 About This Guide

Topics
Purpose of This Guide
How This Guide is Organized
Safety Information
1 About This Guide
1.1 Purpose of This Guide

1.1 Purpose of This Guide


This guide provides information about upgrading a system, such as backing up
data and upgrading software. This information is intended to help you
understand the system upgrade process so you can successfully upgrade your
system.

04-30011-01-en, May 2019 System Upgrade


15
1 About This Guide
1.2 How This Guide is Organized

1.2 How This Guide is Organized


This EcoStruxure Building Operation Guide is divided into the following parts:

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.

System Upgrade 04-30011-01-en, May 2019


16
1 About This Guide
1.3 Safety Information

1.3 Safety Information


Important Information
Read these instructions carefully and look at the equipment to become familiar
with the device before trying to install, operate, service or maintain it. The
following special messages may appear throughout this bulletin or on the
equipment to warn of potential hazards or to call attention to information that
clarifies or simplifies a procedure.

The addition of either symbol to a “Danger” or “Warning” safety label


indicates that an electrical hazard exists which will result in personal
injury if the instructions are not followed.

This is the safety alert symbol. It is used to alert you to potential


personal injury hazards. Obey all safety messages that follow this
symbol to avoid possible injury or death.

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.

04-30011-01-en, May 2019 System Upgrade


17
2 Additional Information

Topics
Where to Find Additional Information
2 Additional Information
2.1 Where to Find Additional Information

2.1 Where to Find Additional Information


All the technical EcoStruxure BMS information is available online, on WebHelp.
WebHelp is a web-based help system for the EcoStruxure Building Operation
software and SmartX devices, the software and hardware that powers the
EcoStruxure BMS.
By pressing F1 or clicking a Help button in the EcoStruxure Building Operation
software your web browser opens WebHelp with the latest, up-to-date, technical
documentation.

Figure: Help in EcoStruxure Building Operation software

Some EcoStruxure Building Operation software products give you context-


sensitive help by opening a WebHelp page that explains the view or dialog box
you have in focus. Some programs open up an overview page. From these
pages, you can follow the links to get more detailed information.
WebHelp contains all the technical information that is in the guides, specification
sheets, and installation sheets.

The WebHelp site


One of the advantages with WebHelp is that you can reach Help without having
the EcoStruxure Building Operation software installed on your computer. By
entering the URL address help.sbo.schneider-electric.com you can access
WebHelp from any computer, smartphone, or tablet connected to the internet.

Finding information
The easiest way to find information on WebHelp is to search for it.

Figure: Home page search

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.

Filtering the information


To narrow down the search results, you can use these filters:
• Product
• Functionality
• Information type

04-30011-01-en, May 2019 System Upgrade


21
2 Additional Information
2.1 Where to Find Additional Information

Figure: Search filters

System Upgrade 04-30011-01-en, May 2019


22
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.
3 System Upgrade

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

3.1 System Upgrade Overview


A system upgrade can include an Enterprise Server, Reports Server, one or
more SmartX servers and WorkStations, and the supporting administrator
software, such as Device Administrator.
Any EcoStruxure BMS that is currently at 1.8 or higher can be upgraded directly
to 3.0. If you are upgrading from a version that is older than 1.8, read the
documentation that describes the upgrading process for the relevant version.

Figure: Supported upgrade paths

3.1.1 Runtime Compatibility


Runtime compatibility means you can postpone the upgrade of some SmartX
servers running an earlier version, such as 1.8, 1.9, 2.0 while upgrading the
Enterprise Server, WorkStation, Reports Server, and some SmartX servers to
version 3.0.

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.

3.1.2 EcoStruxure Building Operation Software


Requirements
To be able to install or upgrade the EcoStruxure Building Operation software
products, you need to make sure that you have a supported operating system
and the required additional software installed on the computer.
For more information, see section 3.3 “EcoStruxure Building Operation Software
Requirements” on page 33.

04-30011-01-en, May 2019 System Upgrade


27
3 System Upgrade
3.1 System Upgrade Overview

3.1.3 System Upgrade Workflows


Using a workflow, you can upgrade a SmartX server system or an Enterprise
Server system. Select the workflow that meets the requirements of your site.
For more information, see section 3.4 “System Upgrade Workflows” on page 37.

3.1.4 SmartX Server Upgrade


You use Device Administrator to upgrade the SmartX server. You must upgrade
Device Administrator before you upgrade the SmartX server.
For more information, see section 4.30 “SmartX Server Upgrade” on page 132.

System Upgrade 04-30011-01-en, May 2019


28
3 System Upgrade
3.2 Runtime Compatibility

3.2 Runtime Compatibility


Runtime compatibility means you can postpone the upgrade of some SmartX
servers running an earlier version, such as 1.8, 1.9, 2.0 while upgrading the
Enterprise Server, WorkStation, Reports Server, and some SmartX servers to
version 3.0.
EcoStruxure BMS supports runtime compatibility between EcoStruxure BMS
servers running two versions on a single system, during an upgrade process.
EcoStruxure BMS servers running version 1.8, 1.9, 2.0 are runtime compatible
with EcoStruxure BMS servers running version 3.0. The system is able to
exchange runtime information between EcoStruxure BMS servers running
version 3.0 and the EcoStruxure BMS servers running the earlier versions.
However, configuration changes cannot be made from an upgraded
WorkStation through an upgraded Enterprise Server to a non-upgraded SmartX
server, such as creating, configuring, and deleting objects or changing
communication parameters.

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.

Figure: Runtime Compatibility concept

04-30011-01-en, May 2019 System Upgrade


29
3 System Upgrade
3.2 Runtime Compatibility

EcoStruxure BMS supports the following compatibility between versions:


Version Runtime Compatible with Version 3.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 trend logs and trend charts


You can view trend log lists and trend charts on a SmartX server running version
1.8, 1.9, or 2.0, with WorkStation and Enterprise Server running version 3.0.
Extended trend logs in the Enterprise Server running version 3.0 are functional
and able to retrieve values from trend logs in a SmartX server running version
1.8, 1.9, or 2.0.
For more information, see section 4.4 “Trend Log Lists” on page 80.

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.

System Upgrade 04-30011-01-en, May 2019


30
3 System Upgrade
3.2 Runtime Compatibility

View dynamic values


You can navigate to and view dynamic values in the Watch pane from a SmartX
server running version 1.8, 1.9, or 2.0, with WorkStation and Enterprise Server
running version 3.0. However, because there is no way to navigate to and view
objects or properties that have been removed in version 3.0, such dynamic
values cannot be viewed.
For more information, see section 4.6 “Watch Pane and Watch View” on page
88.

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.

Change and force variables


You can change and force variables using properties on a SmartX server
running version 1.8, 1.9, or 2.0, with WorkStation and Enterprise Server running
version 3.0.
For more information, see section 4.7 “Variables” on page 89.
For more information, see section 4.9 “Forced Values” on page 92.

Lead and shadow relationships


Lead and shadow relationships work for all objects with the runtime compatibility
support. However, the Security Manager Control Panel configurations in the
Enterpriser Server running version 3.0 are not synchronized with the SmartX
servers running version 1.8, 1.9, or 2.0. Also, the Alarm Control Panel
configurations are not synchronized with the SmartX servers running version 1.8,
1.9, or 2.0.
For more information, see section 4.10 “Lead and Shadow Relationship” on
page 93.
For more information, see section 4.11 “Security Overview ” on page 95.
For more information, see section 4.12 “Alarm Control Panel Objects in Multiple
Servers” on page 98.

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.

04-30011-01-en, May 2019 System Upgrade


31
3 System Upgrade
3.2 Runtime Compatibility

Log on to child SmartX servers


Before upgrading Enterprise Server to version 3.0, it is recommended that you
log on to Enterprise Server and create local users with sufficient permissions in
the child SmartX servers. Once you upgrade Enterprise Server to version 3.0,
you can no longer log on to the child SmartX servers running version 1.8, 1.9, or
2.0, with users that are members of a domain that is owned by Enterprise Server.
You must log on to the child SmartX servers running version 1.8, 1.9, or 2.0, with
a user from a local domain. Once the SmartX servers are upgraded to version
3.0, all users in the local or Enterprise Server domains have the same access
that they had in version 1.8, 1.9, or 2.0.
For more information, see section 4.14 “Domains” on page 101.

System Upgrade 04-30011-01-en, May 2019


32
3 System Upgrade
3.3 EcoStruxure Building Operation Software Requirements

3.3 EcoStruxure Building Operation


Software Requirements
To be able to install or upgrade the EcoStruxure Building Operation software
products, you need to make sure that you have a supported operating system
and the required additional software installed on the computer.

3.3.1 Operating Systems


The following table lists the supported operating system versions.

Table: Supported Operating Systems


Operating System WSa DAb LAc ECd ESe RSf

Microsoft Windows 7 (32- - - - - - -


bit)

Microsoft Windows 7 (64- X X X - X X


bit)

Microsoft Windows 8.1 (32- - - - - - -


bit)

Microsoft Windows 8.1 (64- X X X X X X


bit)

Microsoft Windows 10 (64- X X X X X X


bit)

Microsoft Windows Server X X X X X X


2008 R2 (64-bit)

Microsoft Windows Server X X X X X X


2012 (64-bit)

Microsoft Windows Server X X X X X X


2012 R2 (64-bit)

Microsoft Windows Server X X X X X X


2016

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

Microsoft Windows 7 editions


The following Microsoft Windows 7 editions are supported: Professional,
Enterprise, and Ultimate.

04-30011-01-en, May 2019 System Upgrade


33
3 System Upgrade
3.3 EcoStruxure Building Operation Software Requirements

Microsoft Windows 8.1 editions


The following Microsoft Windows 8.1 editions are supported: Pro, Pro N,
Enterprise, and Enterprise N.

Microsoft Windows 10 editions


The following Microsoft Windows 10 editions are supported: Pro and Enterprise.

Microsoft Windows Server 2008 R2 editions


The following Microsoft Windows Server 2008 R2 editions are supported:
Standard, Web, Enterprise, Datacenter, and Itanium.

Microsoft Windows Server 2012 and Microsoft Windows Server 2012


R2 editions
The following Microsoft Windows Server 2012 and Microsoft Windows Server
2012 R2 editions are supported: Datacenter, Standard, Essentials, and
Foundation.

Microsoft Windows Server 2016 editions


The following Microsoft Windows Server 2016 editions are supported:
Datacenter, Standard, and Essentials.

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

3.3.2 Microsoft .NET Framework versions


The following table lists the required Microsoft .NET Framework versions.

Table: Required Microsoft .NET Framework versions


Microsoft .NET Framework WSa DAb LAc ECd ESe RSf
version

Microsoft .NET Framework X - X X X X


4.7

Microsoft .NET Framework - X - - - -


4.5 or 4.6

System Upgrade 04-30011-01-en, May 2019


34
3 System Upgrade
3.3 EcoStruxure Building Operation Software Requirements

Continued
Microsoft .NET Framework WSa DAb LAc ECd ESe RSf
version

Microsoft .NET Framework X - - - - -


3.5 SP1 (WorkPlace Tech
Editor)

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

3.3.3 Microsoft SQL Servers


If the system you are upgrading includes Reports Server, you need to have a
supported Microsoft SQL Server installed.
The following table lists the supported Microsoft SQL Server versions.

Table: Supported Microsoft SQL Servers


Microsoft SQL Server Reports Server

Microsoft SQL Server 2008 R2 (64-bit) SP2 or SP3 X

Microsoft SQL Server 2012 (64 bit)* X

Microsoft SQL Server 2014 (64-bit), SP1 and SP2 X

Microsoft SQL Server 2016 (64-bit) SP1 X

* Microsoft SQL Server 2012 SP1, SP2, SP3, or SP4 is required if the operating
system Windows Server 2012 R2 is used

Microsoft SQL Server 2008 R2 and Microsoft SQL Server 2012


editions
The following Microsoft SQL Server 2008 R2 and Microsoft SQL Server 2012
editions are supported: Standard and Express with Advanced Services.

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.

04-30011-01-en, May 2019 System Upgrade


35
3 System Upgrade
3.3 EcoStruxure Building Operation Software Requirements

3.3.4 Microsoft Office Visio


If the system you are upgrading includes WorkPlace Tech Editor, you need to
have a supported version of Microsoft Office Visio installed.
The following table lists the supported Microsoft Office Visio versions.
Microsoft Office Visio WorkPlace Tech Editor

Microsoft Office Visio 2016 (32-bit) X

Microsoft Office Visio 2013 (32-bit) X

Microsoft Office Visio 2010 SP1 (32-bit) X

System Upgrade 04-30011-01-en, May 2019


36
3 System Upgrade
3.4 System Upgrade Workflows

3.4 System Upgrade Workflows


Using a workflow, you can upgrade a SmartX server system or an Enterprise
Server system. Select the workflow that meets the requirements of your site.

Figure: System upgrade workflows flowchart

3.4.1 Enterprise Server System Upgrade Workflow


Use this workflow to upgrade an Enterprise Server system. An Enterprise Server
system can include an Enterprise Server, one or more SmartX servers and
WorkStations, and supporting administrator software, such as Device
Administrator.

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.

3.4.2 SmartX Server System Upgrade Workflow


Use this workflow to upgrade a single SmartX server or a series of standalone
SmartX servers along with the accompanying software, WorkStation, Device
Administrator, License Administrator, and License Server.
For more information, see section 3.7 “SmartX Server System Upgrade
Workflow” on page 55.

04-30011-01-en, May 2019 System Upgrade


37
3 System Upgrade
3.4 System Upgrade Workflows

3.4.3 WebReports Upgrade Workflow


Use this workflow for upgrading WebReports as part of a system upgrade. You
must first upgrade the rest of the system, including WorkStations, Enterprise
Server, and SmartX servers.
For more information, see section 3.8 “WebReports Upgrade Workflow” on page
65.

System Upgrade 04-30011-01-en, May 2019


38
3 System Upgrade
3.5 Enterprise Central Upgrade Workflow

3.5 Enterprise Central Upgrade Workflow


Use this workflow to upgrade an Enterprise Central.

3.5.1 Prepare for Upgrade


Prior to upgrading a system, complete the tasks listed in the following flowchart.
Related information can be found in the sections after the flowchart.

Figure: Pre-upgrade flowchart

Stop Reporting Agent Windows service


If you are upgrading WebReports, stop the Reporting Agent Windows service.
For more information, see section 4.20 “Stopping the Reporting Agent Windows
Service ” on page 116.

Perform a system backup


Perform a new All data backup of the Enterprise Central.

04-30011-01-en, May 2019 System Upgrade


39
3 System Upgrade
3.5 Enterprise Central Upgrade Workflow

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.

Stop License Server Windows service


Use the Services tool to stop the License Server Windows service. For more
information, see section 4.21 “Stopping the License Server” on page 117.

3.5.2 Upgrade the EcoStruxure Building


Operation Software
The following flowchart shows the tasks for upgrading the EcoStruxure Building
Operation software. Related information can be found in the sections after the
flowchart.

Figure: General upgrade flowchart

System Upgrade 04-30011-01-en, May 2019


40
3 System Upgrade
3.5 Enterprise Central Upgrade Workflow

Upgrade License Server and License Administrator


Upgrade the License Server and License Administrator. For more information,
see section 4.23 “Upgrading the License Administrator and the License Server”
on page 119.

Upgrade the Enterprise Central Database


Install the Enterprise Central and select Upgrade current version to
to.

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.

Install WebStation language pack


If you want to use a language pack in WebStation, install the language pack and
change the language setting in WebStation.
For more information, see section 4.37 “Adding a Language in WebStation” on
page 140.
For more information, see section 4.38 “Changing the Language in WebStation”
on page 141.

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.

3.5.3 Reset and Confirm Server Functions


The following flowchart shows the tasks for confirming the functions of the
EcoStruxure BMS servers. Related information can be found in the sections after
the flowchart.

04-30011-01-en, May 2019 System Upgrade


41
3 System Upgrade
3.5 Enterprise Central Upgrade Workflow

Figure:

Verify control and monitoring operations


Use the Software Administrator (or the Services tool) to verify that the Enterprise
Central Windows service is running. For more information, see section 4.39
“Starting the Enterprise Server or Enterprise Central Windows Service” on page
142.
In WorkStation, verify that the control and monitoring operations of the Enterprise
Server are functioning normally per the guidelines specified for your site.

NOTICE
In the Security Certificate Risk dialog box, click Trust certificate to temporarily
trust the certificate and log on to the EcoStruxure BMS server.

Install and activate certificates


In WorkStation, generate, add, and activate certificates for the EcoStruxure BMS
servers.
For more information, see section 4.46 “Generating a Certificate” on page 150.
For more information, see section 4.47 “Adding a Certificate” on page 152.

System Upgrade 04-30011-01-en, May 2019


42
3 System Upgrade
3.5 Enterprise Central Upgrade Workflow

For more information, see section 4.48 “Activating a Certificate” on page 153.

04-30011-01-en, May 2019 System Upgrade


43
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

3.6 Enterprise Server System Upgrade


Workflow
Use this workflow to upgrade an Enterprise Server system. An Enterprise Server
system can include an Enterprise Server, one or more SmartX servers and
WorkStations, and supporting administrator software, such as Device
Administrator.
The workflow applies to upgrading a system from version 1.8, 1.9, or 2.0 to
version 3.0.

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.

3.6.1 Repair LonWorks Systems Running Version


1.8
The following flowchart shows the tasks for repairing LonWorks configurations in
all EcoStruxure BMS servers running version 1.8.1. The EcoStruxure BMS
servers need to be repaired before the upgrade from version 1.8.1 to version
3.0. Related information can be found in the sections after the flowchart.

System Upgrade 04-30011-01-en, May 2019


44
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Figure: Repair LonWorks systems running version 1.8 flowchart

Install WorkStation hotfix for version 1.8.1


If you upgrade a system with LonWorks devices from version 1.8.1 to version
3.0, install WorkStation hotfix v1.8.1.34000
v1.8.1.34000, or higher.

04-30011-01-en, May 2019 System Upgrade


45
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Install Enterprise Server hotfix for version 1.8.1


If you upgrade a system with LonWorks devices from version 1.8.1 to version
3.0, install Enterprise Server hotfix v1.8.1.34000
v1.8.1.34000, or higher.

Install SmartX server hotfix for version 1.8.1


If you upgrade a system with LonWorks devices from version 1.8.1 to version
3.0, install SmartX server hotfix v1.8.1.34000
v1.8.1.34000, or higher.
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.

Repair LonWorks configurations for version 1.8.1


In WorkStation, select the Enterprise Server and repair the LonWorks
configurations in the Enterprise Server and all online SmartX servers running
version v1.8.1.34000
v1.8.1.34000, or higher.

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.

For more information, see section 4.16 “Repairing LonWorks Configurations in


EcoStruxure BMS Servers Running Version 1.8.1 Before Upgrade” on page 112.

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.

Warm start repaired EcoStruxure BMS servers


Restart the repaired EcoStruxure BMS servers by running the warm start
command from WorkStation.
The list of repaired EcoStruxure BMS servers is obtained in the previous step,
when you repair the LonWorks configurations.
For more information, see section 4.17 “Warm Starting a SmartX Server ” on
page 113.
For more information, see section 4.18 “Warm Starting an Enterprise Server” on
page 114.

Delete obsolete LonWorks objects


Delete obsolete LonWorks objects from your EcoStruxure BMS servers to
increase available space.

NOTICE
Ensure that all EcoStruxure BMS servers in the configuration are updated to
version v1.8.1.34000, or later.

System Upgrade 04-30011-01-en, May 2019


46
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

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.

3.6.2 Prepare for Upgrade


Prior to upgrading a system, complete the tasks listed in the following flowchart.
Related information can be found in the sections after the flowchart.

Figure: Pre-upgrade flowchart

Stop Reporting Agent Windows service


If you are upgrading WebReports, stop the Reporting Agent Windows service.
For more information, see section 4.20 “Stopping the Reporting Agent Windows
Service ” on page 116.

04-30011-01-en, May 2019 System Upgrade


47
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Perform a system backup


Perform a new All data backup of the Enterprise Server and the SmartX servers
when backing up the system.
For more information, see section 4.19 “Backing Up EcoStruxure BMS Servers
Manually” on page 115.
For systems that include a Reports Server, back up the WebReports database.
For more information, see section 4.43 “Backing Up the WebReports Database”
on page 146.

Stop License Server Windows service


Use the Services tool to stop the License Server Windows service. For more
information, see section 4.21 “Stopping the License Server” on page 117.

3.6.3 Upgrade the EcoStruxure Building


Operation Software
The following flowchart shows the tasks for upgrading the EcoStruxure Building
Operation software, except SmartX servers. Related information can be found in
the sections after the flowchart.

System Upgrade 04-30011-01-en, May 2019


48
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Figure: General upgrade flowchart

Upgrade License Server and License Administrator


Upgrade the License Server and License Administrator. For more information,
see section 4.23 “Upgrading the License Administrator and the License Server”
on page 119.

Upgrade Device Administrator


Upgrade the Device Administrator. For more information, see section 4.26
“Upgrading the Device Administrator Installation” on page 126.

04-30011-01-en, May 2019 System Upgrade


49
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Upgrade the Enterprise Server database


Install the Enterprise Server and select Upgrade current version to
to. For more
information, see section 4.24 “Upgrading the Enterprise Server” on page 121.

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.

Install WebStation language pack


If you want to use a language pack in WebStation, install the language pack and
change the language setting in WebStation.
For more information, see section 4.37 “Adding a Language in WebStation” on
page 140.
For more information, see section 4.38 “Changing the Language in WebStation”
on page 141.

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.

3.6.4 Upgrade SmartX servers


The following flowchart shows the tasks for upgrading SmartX servers. Related
information can be found in the sections after the flowchart.

System Upgrade 04-30011-01-en, May 2019


50
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Figure: SmartX server upgrade flowchart

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.

04-30011-01-en, May 2019 System Upgrade


51
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

For more information, see section 4.27 “Device Administrator Certificate


Workflow” on page 127.
For more information, see section 4.28 “Device Administrator Licenses” on page
129.

Upgrade the SmartX server database


Use the upgraded Device Administrator to upgrade the databases of the SmartX
servers using the IP network or USB port. For more information, see section 4.29
“Uploading and Upgrading a SmartX Server” on page 131.
Open the Device Administrator upgrade log to get detailed information about the
SmartX server upgrade process. For more information, see section 4.33
“Opening the Upgrade Log” on page 136.

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.

Fix configuration issues in SmartX server


Determine if you can use the converted database for download or if you need to
fix configuration issues in the SmartX server and perform a new upgrade of the
SmartX server database.
For more information, see section 4.31 “Conversion Logs” on page 134.
For more information, see section 4.32 “Log Entry Interpretation” on page 135.

Download the upgraded database


When you are comfortable with the content of the high priority conversion log,
use Device Administrator to download the upgraded database to the SmartX
server.
For more information, see section 4.36 “Downloading an Upgraded Database to
a SmartX Server” on page 139.

3.6.5 Reset and Confirm Server Functions


The following flowchart shows the tasks for confirming the functions of the
EcoStruxure BMS servers. Related information can be found in the sections after
the flowchart.

System Upgrade 04-30011-01-en, May 2019


52
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

Figure:

Verify control and monitoring operations


Use the Software Administrator (or the Services tool) to verify that the Enterprise
Server Windows service is running. For more information, see section 4.39
“Starting the Enterprise Server or Enterprise Central Windows Service” on page
142.
In WorkStation, verify that the control and monitoring operations of the Enterprise
Server are functioning normally per the guidelines specified for your site.

04-30011-01-en, May 2019 System Upgrade


53
3 System Upgrade
3.6 Enterprise Server System Upgrade Workflow

NOTICE
In the Security Certificate Risk dialog box, click Trust certificate to temporarily
trust the certificate and log on to the EcoStruxure BMS server.

Check for invalid or unresolved bindings for each SmartX server


In Binding Diagnostics, check for invalid or unresolved bindings. For more
information, see section 4.40 “Checking the Status of Bindings” on page 143.
Replace any invalid or unresolved bindings with new bindings, using the
Bindings view. For more information, see section 4.42 “Bindings Management”
on page 145.

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.

Install and activate certificates


In WorkStation, generate, add, and activate certificates for the EcoStruxure BMS
servers.
For more information, see section 4.46 “Generating a Certificate” on page 150.
For more information, see section 4.47 “Adding a Certificate” on page 152.
For more information, see section 4.48 “Activating a Certificate” on page 153.

System Upgrade 04-30011-01-en, May 2019


54
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

3.7 SmartX Server System Upgrade


Workflow
Use this workflow to upgrade a single SmartX server or a series of standalone
SmartX servers along with the accompanying software, WorkStation, Device
Administrator, License Administrator, and License Server.
The workflow applies to upgrading a system from version 1.8, 1.9 or 2.0 to
version 3.x.

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.

3.7.1 Repair LonWorks Systems Running Version


1.8
The following flowchart shows the tasks for repairing LonWorks configurations in
all SmartX servers running version 1.8.1. The SmartX servers need to be
repaired before the upgrade from version 1.8.1 to version 3.0. Related
information can be found in the sections after the flowchart.

04-30011-01-en, May 2019 System Upgrade


55
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

Figure: Repair LonWorks systems running version 1.8 flowchart

Install WorkStation hotfix for version 1.8.1


If you upgrade a system with LonWorks devices from version 1.8.1 to version
3.0, install WorkStation hotfix v1.8.1.34000
v1.8.1.34000, or higher.

Install SmartX server hotfix for version 1.8.1


If you upgrade a system with LonWorks devices from version 1.8.1 to version
3.0, install SmartX server hotfix v1.8.1.34000
v1.8.1.34000, or higher.

System Upgrade 04-30011-01-en, May 2019


56
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

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.

Repair LonWorks configurations for version 1.8.1


Repair the LonWorks configuration in each SmartX server running version
v1.8.1.34000
v1.8.1.34000, or higher.

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.

For more information, see section 4.16 “Repairing LonWorks Configurations in


EcoStruxure BMS Servers Running Version 1.8.1 Before Upgrade” on page 112.

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.

Warm start repaired EcoStruxure BMS servers


Restart the repaired EcoStruxure BMS servers by running the warm start
command from WorkStation.
The list of repaired EcoStruxure BMS servers is obtained in the previous step,
when you repair the LonWorks configurations.
For more information, see section 4.17 “Warm Starting a SmartX Server ” on
page 113.
For more information, see section 4.18 “Warm Starting an Enterprise Server” on
page 114.

Delete obsolete LonWorks objects


Delete obsolete LonWorks objects from your EcoStruxure BMS servers to
increase available space.

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.

04-30011-01-en, May 2019 System Upgrade


57
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

3.7.2 Prepare for Upgrade


Prior to upgrading a system consisting of one or more SmartX servers, complete
the tasks listed in the following flowchart. Related information can be found in
the sections after the flowchart.

Figure: Pre-upgrade flowchart

Back up SmartX servers


In WorkStation, perform a manual All data backup of the SmartX servers. You
can do this by logging onto each SmartX server. For more information, see
section 4.19 “Backing Up EcoStruxure BMS Servers Manually” on page 115.

Stop License Server Windows service


Use the Services tool to stop the License Server Windows service. For more
information, see section 4.21 “Stopping the License Server” on page 117.

System Upgrade 04-30011-01-en, May 2019


58
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

3.7.3 Upgrade EcoStruxure Building Operation


Software Part 1
The following flowchart shows the tasks for upgrading the first part of the
EcoStruxure Building Operation software, except SmartX servers. Related
information can be found in the sections after the flowchart.

Figure: EcoStruxure Building Operation software upgrade part 1 flowchart

Upgrade License Server and License Administrator


Upgrade the License Server and License Administrator. For more information,
see section 4.23 “Upgrading the License Administrator and the License Server”
on page 119.

Upgrade Device Administrator


Upgrade the Device Administrator. For more information, see section 4.26
“Upgrading the Device Administrator Installation” on page 126.

3.7.4 Upgrade SmartX Servers


The following flowchart shows the tasks for upgrading one or more SmartX
servers. Related information can be found in the sections after the flowchart.

04-30011-01-en, May 2019 System Upgrade


59
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

Figure: SmartX server upgrade flowchart

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.

System Upgrade 04-30011-01-en, May 2019


60
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

For more information, see section 4.27 “Device Administrator Certificate


Workflow” on page 127.
For more information, see section 4.28 “Device Administrator Licenses” on page
129.

Upgrade the SmartX server database


Use the upgraded Device Administrator to upgrade the databases of the SmartX
servers using the IP network or USB port. For more information, see section 4.29
“Uploading and Upgrading a SmartX Server” on page 131.
Open the Device Administrator upgrade log to get detailed information about the
Smart server upgrade process. For more information, see section 4.33 “Opening
the Upgrade Log” on page 136.

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.

Fix configuration issues in SmartX server


Determine if you can use the converted database for download or if you need to
fix configuration issues in the SmartX server and perform a new upgrade of the
SmartX server database.
For more information, see section 4.31 “Conversion Logs” on page 134.
For more information, see section 4.32 “Log Entry Interpretation” on page 135.

Download the upgraded database


When you are comfortable with the content of the high priority conversion log,
use Device Administrator to download the upgraded database to the SmartX
server.
For more information, see section 4.36 “Downloading an Upgraded Database to
a SmartX Server” on page 139.

3.7.5 Upgrade EcoStruxure Building Operation


Software Part 2
The following flowchart shows the tasks for upgrading the second and last part
of the EcoStruxure Building Operation software. Related information can be
found in the sections after the flowchart.

04-30011-01-en, May 2019 System Upgrade


61
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

Figure: EcoStruxure Building Operation software upgrade part 2 flowchart

Install WebStation language pack


If you want to use a language pack in WebStation, install the language pack and
change the language setting in WebStation.
For more information, see section 4.37 “Adding a Language in WebStation” on
page 140.
For more information, see section 4.38 “Changing the Language in WebStation”
on page 141.

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.

3.7.6 Reset and Confirm Server Functions


The following flowchart shows the tasks for confirming the functions of the
SmartX servers. Related information can be found in the sections after the
flowchart.

System Upgrade 04-30011-01-en, May 2019


62
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

Figure: Server functions confirmation flowchart

Verify control and monitoring operations


In WorkStation, log on to each SmartX server and verify that the control and
monitoring operations are functioning normally per the guidelines specified for
your site.

NOTICE
In the Security Certificate Risk dialog box, click Trust certificate to temporarily
trust the certificate and log on to the SmartX server.

04-30011-01-en, May 2019 System Upgrade


63
3 System Upgrade
3.7 SmartX Server System Upgrade Workflow

Install and activate certificates


In WorkStation, generate, add, and activate certificates for Enterprise Server
and SmartX servers.
For more information, see section 4.46 “Generating a Certificate” on page 150.
For more information, see section 4.47 “Adding a Certificate” on page 152.
For more information, see section 4.48 “Activating a Certificate” on page 153.

System Upgrade 04-30011-01-en, May 2019


64
3 System Upgrade
3.8 WebReports Upgrade Workflow

3.8 WebReports Upgrade Workflow


Use this workflow for upgrading WebReports as part of a system upgrade. You
must first upgrade the rest of the system, including WorkStations, Enterprise
Server, and SmartX servers.
For more information, see section 3.4 “System Upgrade Workflows” on page 37.

Figure: WebReports upgrade flowchart

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.

Verify that the Reporting Agent Windows service is running


Verify that the Reporting Agent Windows service is running.
For more information, see section 4.45 “Starting the Reporting Agent Windows
Service ” on page 149.

04-30011-01-en, May 2019 System Upgrade


65
3 System Upgrade
3.9 Upgrade to Native MNB BACnet Devices

3.9 Upgrade to Native MNB BACnet


Devices
When an EcoStruxure Building Operation server is upgraded to version 2.0.4 or
later, all MNB devices contained in the BACnet network are automatically
upgraded:
• MNB devices modeled as generic BACnet devices are upgraded to native
MNB devices. As native MNB devices, these devices have dedicated
device objects and MNB application support in WorkPlace Tech Editor.
• MNB devices modeled as I/A Series devices are upgraded to native MNB
devices.
• BACnet objects in the Application folder under MNB devices are upgraded
to native MNB objects.

3.9.1 Upgrade MNB BACnet Devices Workflow


Use this workflow to upgrade MNB devices contained in a BACnet network to
native MNB BACnet devices, as part of an upgrade to EcoStruxure Building
Operation software version 2.0.4 or later.
For more information, see section 3.10 “Upgrade MNB BACnet Devices
Workflow” on page 67.

System Upgrade 04-30011-01-en, May 2019


66
3 System Upgrade
3.10 Upgrade MNB BACnet Devices Workflow

3.10 Upgrade MNB BACnet Devices


Workflow
Use this workflow to upgrade MNB devices contained in a BACnet network to
native MNB BACnet devices, as part of an upgrade to EcoStruxure Building
Operation software version 2.0.4 or later.
Complete the tasks listed in the following flowchart. Related information can be
found in the sections after the flowchart.

Figure: Upgrade MNB BACnet devices workflow flowchart

Upgrade EcoStruxure software to upgrade the MNB devices


Upgrade EcoStruxure Building Operation software to version 2.0.4 or later,
which automatically upgrades the MNB devices in the server database to native
MNB BACnet devices.
For more information, see section 3.4 “System Upgrade Workflows” on page 37.

NOTICE
Following the upgrade, each upgraded MNB BACnet device in the
WorkStation Device List indicates that a download is needed. This is normal.

Following the upgrade to native MNB BACnet devices, it is recommended that


you perform the remaining steps in this workflow to minimize the loss of data.

04-30011-01-en, May 2019 System Upgrade


67
3 System Upgrade
3.10 Upgrade MNB BACnet Devices Workflow

View invalid bindings


At the completion of the upgrade process, the progress bar in Device
Administrator indicates whether there are any invalid bindings:
• If the progress bar is green, there are no invalid bindings. No action is
needed.
• If the progress bar is yellow, some bindings are invalid. View the Upgrade
Report and then open the Conversion Log to view a list of invalid bindings.
For more information, see section 4.34 “Opening the Conversion Log” on
page 137.

Resolve invalid bindings


Resolve any invalid bindings.
For more information, see section 4.40 “Checking the Status of Bindings” on
page 143.
For more information, see section 4.41 “Binding Values Manually” on page 144.
For more information, see section 4.42 “Bindings Management” on page 145.

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.

Upload hosted objects


After upgrading the MNB BACnet devices, 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.

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.

Import MNB applications and assign applications to MNB devices


It is recommended that following the upgrade, applications relevant to the MNB
BACnet devices are imported into the database and then assigned to the
associated MNB devices. This task does not need to be done immediately, and
if desired, can be done at a later time.
For more information, see section 3.11 “Importing and Assigning MNB
Application Types After an Upgrade” on page 69.

System Upgrade 04-30011-01-en, May 2019


68
3 System Upgrade
3.11 Importing and Assigning MNB Application Types After an Upgrade

3.11 Importing and Assigning MNB


Application Types After an Upgrade
After the upgrade of MNB BACnet devices to native devices, you import the
relevant MNB application types into the EcoStruxure Building Operation
database and then assign them to the MNB devices.

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.

To import and assign MNB application types after an upgrade


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 WorkPlace tech editor
editor.

4. Click the Add an Application button .


5. In the device list box, select an MNB device model.
6. In WorkPlace Tech Editor, on the Application menu, click Import Wizard
Wizard.
7. On the Input File Selection page, read the information and then click Next
Next.
8. In the Select WorkPlace Tech File to Import dialog box, select the
application (.vsd) files to be imported.

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.

04-30011-01-en, May 2019 System Upgrade


69
3 System Upgrade
3.11 Importing and Assigning MNB Application Types After an Upgrade

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.

System Upgrade 04-30011-01-en, May 2019


70
4 Related Concepts and
Procedures

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

4.1 System Tree Pane


Use the System Tree Pane to view and manage the structure of the EcoStruxure
Building Operation database. In the System Tree pane you can view, create,
delete, copy, rename, and move objects.

Figure: System Tree pane

Table: System Tree Pane


Number Description

Show/Hide non-presentation objects


Toggle between showing and hiding non-
presentation objects, that is, objects
required when engineering the
EcoStruxure BMS.

Collapse all
Click to collapse the System Tree so that
only the EcoStruxure BMS server of the
EcoStruxure BMS is visible.

Click to customize how the System Tree


pane is displayed. For more information,
see the Customization topic on WebHelp.

Click to unpin the System Tree pane and


collapse it to the side.

04-30011-01-en, May 2019 System Upgrade


75
4 Related Concepts and Procedures
4.2 Search Overview

4.2 Search Overview


Use Search in WorkStation to find and view objects in the database.
There are two different ways to search in WorkStation, simple search and
search. A search can be done on, for example, conditions or objects types. A
search can be saved for further use.
Search is case insensitive, which means that search does not differ between
upper case and lower case. A search on "Fan"displays search results spelled
both "fan" and "Fan".

4.2.1 Simple Search


Use Simple Search to search for object names.
Use the Search view to search for names of properties. For more information,
see the Searching for Objects or Properties topic on WebHelp.
For more information, see the Simple Search topic on WebHelp.

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.

4.2.3 Saved Search


Frequently used searches including the settings can be saved and reused.
A saved search is displayed in the System Tree pane and the List View. To
perform the search, open the saved search from the System Tree pane or List
View. The search results are displayed in the work area (with collapsed search
criteria area).
A saved search can be changed, renamed, and deleted.

NOTICE
• When you save a search, only the setting for the search is saved. The search
result is never saved.

4.2.4 Relative or Locked Search Path


If you want to reuse your saved search object in similar folder structures, you
can enter a relative search path in your saved search object. You can reuse a
saved search object by using export and import or copy and paste special.
If you have configured your search object with a relative reference, the search
result is performed on a path relative to the location of the saved search object.

System Upgrade 04-30011-01-en, May 2019


76
4 Related Concepts and Procedures
4.2 Search Overview

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.

Table: Locked and Unlocked References


Path reference syntax Description

~ Locked reference
Searches in the configured folder or
container object

../.. Relative reference


Searches in a path relative to where the
search object is saved. For example,
entering '../../' in the folder path means that
the search is performed two levels up from
where the search object is saved.

04-30011-01-en, May 2019 System Upgrade


77
4 Related Concepts and Procedures
4.3 Alarm and Event Details

4.3 Alarm and Event Details


To quickly get all the details of a specific alarm or event in WorkStation, or an
alarm in WebStation, you can use a Detail view. The Detail view always displays
all properties that can be added and displayed in the Alarms pane, Events
pane, Alarm View or Event View.

4.3.1 Alarm and Event Details in WorkStation


In WorkStation, you use the Detail view to display all the properties and their
values for the selected alarm or event.
Use the Quick filter to limit the number of properties listed in the view.

Figure: The Alarm Detail view (to the right) in WorkStation

4.3.2 Alarm and Event Details in WebStation


In WebStation, you use the Detail view to display all the properties and their
values for the selected alarm or event.

System Upgrade 04-30011-01-en, May 2019


78
4 Related Concepts and Procedures
4.3 Alarm and Event Details

Figure: The Details dialog box in WebStation

04-30011-01-en, May 2019 System Upgrade


79
4 Related Concepts and Procedures
4.4 Trend Log Lists

4.4 Trend Log Lists


The trend log list numerically displays the records of a trend log or an extended
trend log. The records of the trend log can be processed by a calculation
method before they are presented in the trend log list.
The trend log list can only display one trend log at a time and must be manually
refreshed to display recently recorded values.

System Upgrade 04-30011-01-en, May 2019


80
4 Related Concepts and Procedures
4.4 Trend Log Lists

Figure: Trend log list, schematic

You can manually add records to a trend log list for any type of trend log.

04-30011-01-en, May 2019 System Upgrade


81
4 Related Concepts and Procedures
4.4 Trend Log Lists

4.4.1 Time Zone Modes in a Trend Log List


In a trend log list, you can present the records of a trend log in different time
zones: local time zone, EcoStruxure BMS server time zone, and UTC time zone.
For more information, see the Time Zone Modes in a Trend Log List topic on
WebHelp.

4.4.2 Calculation Methods


Use a calculation method to process the records of the trend log before
presenting them in a trend log list or a trend chart. The original records in the
trend log are not affected by the calculation method. The calculation method is
applied to the trend log records grouped by a specific time interval.
For more information, see the Calculation Methods topic on WebHelp.

4.4.3 Period Timestamps in Trend Charts and


Trend Log Lists
When a calculated value for a period is presented, the middle of the period is
used as the timestamp.
Example:
The calculated value for the period 8:00-9:00 is stamped 8:30. If there is a value
at 9:01, the next period is 9:00-10:00, which is stamped as 9:30. The full period
may not have passed yet, but the value can be presented even if parts of the
period are in the future.

4.4.4 Temporary Trend Log Lists


To display a trend log without creating a new trend log list or trend chart, the
trend log can be displayed in a temporary list or chart.
For more information, see the Temporary Trend Log Lists topic on WebHelp.

4.4.5 Floating Point Values NaN, INF, and -INF


In the EcoStruxure Building Operation software, the floating point values “Not a
Number”, positive infinity, or negative infinity may be displayed in the Basic
property tab, in a trend log list, or a trend chart.
For more information, see the Floating Point Values NaN, INF, and –INF topic on
WebHelp.

4.4.6

System Upgrade 04-30011-01-en, May 2019


82
4 Related Concepts and Procedures
4.5 Graphics Editor

4.5 Graphics Editor


You can use Graphics Editor to create and edit graphics representing a site and
the devices that make up the site.

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.

04-30011-01-en, May 2019 System Upgrade


83
4 Related Concepts and Procedures
4.5 Graphics Editor

Figure: Graphics Editor

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

System Upgrade 04-30011-01-en, May 2019


84
4 Related Concepts and Procedures
4.5 Graphics Editor

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.

Figure: Example of component categories

You can create and import components in several ways:


• Create a new component in Component mode of Graphics Editor
• Group and save as a component in Graphic mode of Graphics Editor
• Import components from an external source
In WorkStation, you can create graphics that you edit in Graphics Editor.
Graphics consist of one or several graphic objects. You can set properties for
the graphic objects to define their appearance and behavior.
You can create the graphic objects by using the drawing tools, by copying
objects from the work area, or by using instances of objects from the libraries
delivered with Graphics Editor.
All drawn objects belong to one of the following two groups:
• Graphics: free-form drawings
• Components: standardized graphics for defined reuse

04-30011-01-en, May 2019 System Upgrade


85
4 Related Concepts and Procedures
4.5 Graphics Editor

4.5.1 Graphics in WorkStation


Graphics are representations of a site or parts of a site. Graphics can be made
up of figures, text and imported pictures. They can also contain components
and functions.
For more information, see the Graphics in WorkStation topic on WebHelp.

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.4 Graphic Menus


You use a menu in a graphic to navigate from a graphic to other graphics or
objects in the system, for example trend charts or alarms.
For more information, see the Graphic Menus topic on WebHelp.

4.5.5 Graphics Editor Libraries


When Graphics Editor is installed, a library of brushes, components, and
snippets are included.
For more information, see the Graphics Editor Libraries topic on WebHelp.

4.5.6 Keyboard Shortcuts for Graphics Editor


You can acces most of the Graphics Editor commands by using keyboard
shortcuts.
For more information, see the Keyboard Shortcuts for Graphics Editor 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.

System Upgrade 04-30011-01-en, May 2019


86
4 Related Concepts and Procedures
4.5 Graphics Editor

4.5.8 Console
The console is used for testing and troubleshooting scripts.
For more information, see the Console topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


87
4 Related Concepts and Procedures
4.6 Watch Pane and Watch View

4.6 Watch Pane and Watch View


You can drag objects to the Watch pane or a Watch View to monitor their live
values and other properties, for example, to monitor the impact of a change you
are about to make in your system. Property changes are immediately displayed
in the Watch pane or Watch View. You can add and remove property columns in
the Watch pane or Watch View.
Dragging an object to the Watch pane or Watch View, you get different results
depending on whether you right-click and drag or left-click and drag:
• Right-click and drag the object to the Watch pane or Watch View. When you
choose this method, you can select the properties you want to monitor.
• Left-click and drag an object to the Watch pane or Watch View. When you
choose this method, the default property of the object is displayed.
The list of objects in the Watch pane is not saved when you log out of
WorkStation but you can save the lists of objects to the system and reopen it
from the System Tree. You can save the list of objects on the Watch View
toolbar. The saved Watch view is opened in the List View. You can right-click
any object in the Watch pane or a Watch View to view and edit the properties of
that object. The Properties dialog box displays the properties you have chosen
to monitor in the Watch pane or Watch View and also contains a link to the full
properties of the object.
You can right-click an object in the Watch pane or Watch View and view the
trends related to the object.

Figure: Watch Pane

System Upgrade 04-30011-01-en, May 2019


88
4 Related Concepts and Procedures
4.7 Variables

4.7 Variables
A variable is a run-time (dynamically changing) property of an object.
Script supports program, system, and runtime variables.

4.7.1 Program Variables


Variables are names that represent numbers, words, or dates and times. Unlike
a constant, a variable has a value that changes or varies.
For more information, see the Program Variables topic on WebHelp..

4.7.2 System Variables


System variables are objects that the system sets and updates automatically.
System variables are controlled by the system and cannot be changed by the
user.
For more information, see the System Variables topic on WebHelp.

4.7.3 System Variable Keywords


Values that change are represented by system variables. The controller
automatically updates the value of these variables.
For more information, see the System Variable Keywords topic on WebHelp.

4.7.4 Script Runtime Variables


Script runtime variables are read-only properties that display information about
the state of a program.
For more information, see the Script Runtime Variables topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


89
4 Related Concepts and Procedures
4.8 Server Values

4.8 Server Values


Server values are values created on a SmartX server. Server values are used to
control network traffic or to provide value configurations that are not available in
a program. Server values work as an interface or connector between a SmartX
server and another:
• A program on one SmartX server and a value on another SmartX server, for
example, a function block program on one SmartX server and a value on
another SmartX server.
• A field device value and a SmartX server, for example, an value from a
sensor and an alarm on a SmartX server.
Server values can provide value configurations that are not available in a
program, such as forcing a value in a function block program. In the server
value, you can set how often the value should be forced.

4.8.1 Minimizing the Transfer Interval Intensity


Server values help to control network traffic. By default, a subscription to a value
from one SmartX server to another or from a field device value to a SmartX
server occurs at the intensity defined by the consumer object. For example, a
program with a cycle time of 1000 ms subscribes every 1000 ms. To control the
intensity, you set a different transfer value interval in the binding properties of the
server value.
You can take a number of steps to minimize the transfer interval intensity and
thereby the network traffic:
• Avoid using alarms and change of value trend logs to monitor values
outside of the SmartX server where the alarm or trend log resides.
• Set the transfer interval for a SmartX server to SmartX server value to the
longest possible time. If possible, avoid intervals of 10 seconds or less.
• Create a server value object so that you can change the transfer interval
manually for a consuming object like a program.
If short update intervals are required, you need to monitor the CPU and memory
usage of the SmartX server where the value resides. If the CPU and memory
usage are high, limit the number of receivers of the value transfer. If you need to
transfer the value to many receivers, consider a cascading structure where the
SmartX server transfers the value to a few receivers and the few receivers, in
turn, transfer the value to a few receivers.

4.8.2 Server Value Workflow


Using a server value is a four-part process:
• Create a server value object on the SmartX server where the program
resides. For more information, see the Creating a SmartStruxure Server
Value topic on WebHelp.
• Bind the server value object to read the value from the other SmartX server.
For more information, see section 4.41 “Binding Values Manually” on page
144.

System Upgrade 04-30011-01-en, May 2019


90
4 Related Concepts and Procedures
4.8 Server Values

• 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.

04-30011-01-en, May 2019 System Upgrade


91
4 Related Concepts and Procedures
4.9 Forced Values

4.9 Forced Values


When you force a value, all input from the system is overridden. For example, a
schedule is set to start a fan at 09:00 but you want it to start at 08:00. In this
case, you can force the fan to start at 08:00.
You can manually release a forced value at any time or you can automate the
release, using a Timed Force utility object to specify the duration or end time of
the force. For more information, see the Timed Force Objects topic on WebHelp.
When you release a forced value, the value returns to its normal status.
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 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.

Indication in Function Block Graphics Viewer


A forced value is indicated by orange color in Function Block Graphics Viewer.
For more information, see the Forced Value Indication in Function Block
Graphics Viewer topic on WebHelp.

System Upgrade 04-30011-01-en, May 2019


92
4 Related Concepts and Procedures
4.10 Lead and Shadow Relationship

4.10 Lead and Shadow Relationship


For some objects on an EcoStruxure BMS server, for example the time zone
object and schedule object, you can establish a lead and shadow relationship to
the parent EcoStruxure BMS server. A shadow object automatically
synchronizes settings from its connected lead object. A lead and shadow
relationship can only be established between objects of the same kind.
For example, an Enterprise Server and three individual Automation Servers are
located in same time zone region. Instead of individually configuring all the
servers time zone, a lead and shadow relationship is established. The Enterprise
Server is the lead object and the three Automation Servers are shadow objects.
With this relationship, the Enterprise Server time zone settings are reflected and
used by the three Automation Servers.

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.

04-30011-01-en, May 2019 System Upgrade


93
4 Related Concepts and Procedures
4.10 Lead and Shadow Relationship

When you configure lead objects on an Enterprise Central, the shadow objects
on Enterprise Servers can, in turn, control objects on SmartX server.

4.10.1 Synchronize Network Time Settings


You can establish a lead and shadow relationship to synchronize the time on all
your EcoStruxure BMS servers with the same network time server. The Date and
Time object on the lead server contains the network time server addresses that
are inherited by shadow servers.
For more information, see the Synchronize Network Time Settings topic on
WebHelp.

4.10.2 Synchronize Time Zone Settings


You can establish a lead and shadow relationship to synchronize the time zone
settings on all your EcoStruxure BMS servers. The Time Zone object on the lead
server contains the time zone settings that are inherited by shadow servers.
For more information, see the Synchronize Time Zone Settings topic on
WebHelp.

4.10.3 Content Type Synchronization


When you have predefined content types that you want to use for specific types
of folders or container objects on an EcoStruxure BMS server, you can reuse the
content types on another EcoStruxure BMS server. You reuse the content types
by configuring a lead-shadow relationship on the shadow object.
For more information, see the Content Type Synchronization topic on WebHelp.

4.10.4 Schedule and Calendar Synchronization


When you configure a schedule that controls events in a single part of a
building, you might also want the same events to occur in other areas of the
building. You can establish a lead and shadow relationship to synchronize the
events in schedules and dates in calendars.
For more information, see the Schedule and Calendar Synchronization topic on
WebHelp.

4.10.5 Alarm Control Panel Synchronization


When you have predefined Alarm Control Panel objects, for example user
actions or alarm decorators, that you want to reuse on another EcoStruxure BMS
server, you configure a lead-shadow relationship on the shadow Alarm Control
Panel.
For more information, see the Alarm Control Panel Synchronization topic on
WebHelp.

System Upgrade 04-30011-01-en, May 2019


94
4 Related Concepts and Procedures
4.11 Security Overview

4.11 Security Overview


EcoStruxure Building Operation software has a number of features that helps
you increase the security in your system.

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.2 Password Policy


You can increase the password security by configuring a password policy that
defines how passwords must be created by the users.
For more information, see the Password Policy topic on WebHelp.

4.11.3 Embedded Content in WebStation


For security reasons, the default setting is for WebStation to not be embedded in
another web site and for other contents to not be embedded in WebStation.
However, you can change this security setting in WorkStation.
For more information, see the Embedded Content in WebStation topic on
WebHelp.

4.11.4 Automatic Log Off


The automatic logoff function makes it possible for the system to automatically
log off a user after a specified time of inactivity.
For more information, see the Automatic Logoff topic on WebHelp.

4.11.5 Security Banner


A security banner is displayed when a user enters a secure system. The security
banner notifies the user of the legal rights connected to the use of the
information in the secure system.
For more information, see the Security Banner topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


95
4 Related Concepts and Procedures
4.11 Security Overview

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.

4.11.7 Encrypted Communication


To increase the security of your data, you can disable incoming HTTP
communication and allow only high security communication.
For more information, see the Encrypted Communication topic on WebHelp.

4.11.8 Web Server Access Logging


You can log all web server HTTP access to the Enterprise Server and the
Enterprise Central.
For more information, see the Web Server Access Logging topic on WebHelp.

4.11.9 SmartX Server Remote System Logging


You can log all successful and unsuccessful attempt to log on to your SmartX
server.
For more information, see the SmartX Server Remote System Logging topic on
WebHelp.

4.11.10 Connect Agent


To prevent data transfer over the cloud server, you can disable the transfer of
system information and crash information of the Enterprise Central and the
Enterprise Server and its SmartX server.
For more information, see the Connect Agent Overview topic on WebHelp.

4.11.11 Document Policy


You can increase the security in your system by configuring the document
policy. The document policy controls which file types a user can open, save,
and import.
For more information, see the Document Policy topic on WebHelp.

System Upgrade 04-30011-01-en, May 2019


96
4 Related Concepts and Procedures
4.11 Security Overview

4.11.12 Disable SmartX Server Ports


You can disable port 22 and the USB ports on the SmartX server.
For more information, see the Disable SmartX Server Ports topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


97
4 Related Concepts and Procedures
4.12 Alarm Control Panel Objects in Multiple Servers

4.12 Alarm Control Panel Objects in Multiple


Servers
In a multi-server system, you create Alarm Control Panel objects, such as
checklists and actions notes, on the Enterprise Server or on the Enterprise
Central.
SmartX servers that are connected to that Enterprise Server inherit Alarm Control
Panel objects automatically. The copies on the connected SmartX servers are
read-only, so in order to edit them you must edit their source objects on the
Enterprise Server. One advantage with this is that you can display the objects
and their content on the SmartX servers even if the Enterprise Server goes
offline.
An Enterprise Server that is connected to the Enterprise Central will not
automatically inherit alarm objects.

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.

System Upgrade 04-30011-01-en, May 2019


98
4 Related Concepts and Procedures
4.13 Backup

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.13.1 Types of Data


The EcoStruxure Building Operation backup function enables you to back up
different types of data.
For more information, see the Types of Data topic on WebHelp.

4.13.2 Backup Sets


Backup sets are compressed backup files used for restoring data. The
EcoStruxure Building Operation software stores the local backup set for an
Enterprise Server or SmartX servers in the Local folder within the Backup sets
folder.
For more information, see the Backup Sets topic on WebHelp.

4.13.3 Scheduled Backups


A scheduled backup is an automated way to back up data on an EcoStruxure
BMS server. You can back up EcoStruxure BMS servers individually using each
EcoStruxure BMS server’s local backup rule. You can also use backup rules to
synchronize the backups of all the EcoStruxure BMS servers on your network.
For more information, see the Scheduled Backups topic on WebHelp.

4.13.4 Manual Backups


Manual Backup is a non-automated process of copying and storing data on a
selected EcoStruxure BMS server. You can use this option to create backups on
an as-needed basis. You can also manually restore the data at any time.
For more information, see the Manual Backups topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


99
4 Related Concepts and Procedures
4.13 Backup

4.13.5 Mass Backup


Mass backup is a method of performing a manual, simultaneous backup of all
the EcoStruxure BMS servers in the network, which is useful for capturing data at
a critical point, such as prior to an upgrade. You can choose which EcoStruxure
BMS servers you want to back up along with the type of data for each.
For more information, see the Mass Backup topic on WebHelp.

4.13.6 System Backup


Before upgrading the system, it is strongly recommended that you archive the
historical data and back up the EcoStruxure BMS servers to preserve the current
data and configurations. If you plan to upgrade WebReports, be sure to back up
the Reports database in SQL Server.
For more information, see the System Backup topic on WebHelp.

4.13.7 Backup Status


Backup Status displays the statuses of an EcoStruxure BMS server: Ready,
Backing up, or Backup succeeded.
For more information, see the Backup Status topic on WebHelp.

System Upgrade 04-30011-01-en, May 2019


100
4 Related Concepts and Procedures
4.14 Domains

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.

04-30011-01-en, May 2019 System Upgrade


101
4 Related Concepts and Procedures
4.14 Domains

Figure: EcoStruxure Building Operation domain and its components.

NOTICE
You cannot change the name of a domain that is shared between EcoStruxure
BMS servers.

If an Enterprise Server is a member of an Enterprise Central domain, you add


SmartX servers to the same domain from the Enterprise Server domain
membership.

4.14.1 Windows Active Directory Domain


If your domain controller is within a network that has a Windows Active Directory,
you can establish a connection between your EcoStruxure Building Operation
domain and the Windows Active Directory. This connection enables inherited
user account groups from the Windows Active Directory to EcoStruxure Building
Operation software, and allows users to log on to WorkStation with their
Windows user accounts.

System Upgrade 04-30011-01-en, May 2019


102
4 Related Concepts and Procedures
4.14 Domains

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.

EcoStruxure Building Operation software supports Fully Qualified Domain


Name (FQDN) and NetBIOS name. The NetBIOS name is displayed in the Log
on screen even if FQDN is used as a log on method.

4.14.2 Server Local Domain


By default, all servers have a local domain that includes a local administrator
account, administrator user account group, and administrator workspace. The
local domain of a server cannot hold an EcoStruxure Building Operation multi-
server system. When logging on to the local domain of a server, you access only
the unique server.
A local domain and its content cannot be deleted, edited or include other
EcoStruxure Building Operation servers.

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.14.3 Administration Accounts in Server Local


Domain
You can manage user accounts on a domain controller by logging on to the
local domain of the EcoStruxure BMS server, using the local administrator and
local reports administrator accounts.
For more information, see the Administration Accounts in EcoStruxure BMS
Server Local Domain topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


103
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

4.15 Replace Enterprise Server or


WebReports Computer Workflow
Use this workflow to change the operating system on the computer where the
Enterprise Server is installed. You can also use this workflow to migrate
WebReports or the Enterprise Server to another computer.

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.

Figure: Enterprise Server Replacement Preparation flowchart

System Upgrade 04-30011-01-en, May 2019


104
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Perform a system backup of EcoStruxure BMS servers


Before changing the operating system or replacing the computer, it is strongly
recommended that you archive the historical data and back up the EcoStruxure
BMS servers to preserve the current data and configurations. For more
information, see the System Backup topic on WebHelp.

Stop Enterprise Server Windows service


Use Software Administrator (or the Services tool) to stop the Enterprise Server
Windows service. For more information, see the Stopping the Enterprise Server
Windows Service topic on WebHelp.

Stop License Server Windows service


If you are upgrading the License Server, stop the License Server Windows
service. For more information, see section 4.21 “Stopping the License Server” on
page 117.

Stop Reporting Agent Windows service


If your system includes WebReports, stop the Reports Agent Windows service.
For more information, see section 4.20 “Stopping the Reporting Agent Windows
Service ” on page 116.

Replace operating system or migrate Enterprise Server


Complete one or more of the following tasks:
• Replace the operating system on the computer where the Enterprise Server
is installed. Refer to the Microsoft Windows documentation on installation or
upgrade instructions for the supported operating system. For more
information, see section 3.3 “EcoStruxure Building Operation Software
Requirements” on page 33.
• Migrate the Enterprise Server to another computer.
To install or migrate the Enterprise Server on the targeted operating system or
computer, you need to continue.

Start Reporting Agent Windows service


After replacing the operating system or migrating the Enterprise Server, start the
Reports Agent Windows service. For more information, see section 4.45
“Starting the Reporting Agent Windows Service ” on page 149.

4.15.2 Install EcoStruxure Building Operation


Software
The following flowchart shows the tasks for installing the Enterprise Server and
other Build Operation software on a replacement operating system or computer.
Related information can be found in the sections after the diagram.

04-30011-01-en, May 2019 System Upgrade


105
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Figure: Reinstall EcoStruxure Building Operation software flowchart

Install Enterprise Server


Install the Enterprise Server and Software Administrator, which is bundled with
the Enterprise Server software. For more information, see the Installing the
Enterprise Server topic on WebHelp.

Install other EcoStruxure Building Operation software


Install any other EcoStruxure Building Operation software, such as WorkStation.

4.15.3 Restore the Enterprise Server Database


The following flowchart shows the tasks for restoring the Enterprise Server
database. Related information can be found in the sections after the diagram.

System Upgrade 04-30011-01-en, May 2019


106
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Figure: Restore Enterprise Database flowchart

Stop Reporting Agent Windows service


If your system includes WebReports, stop the Reporting Agent Windows
service. For more information, see section 4.20 “Stopping the Reporting Agent
Windows Service ” on page 116.

04-30011-01-en, May 2019 System Upgrade


107
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Restore Enterprise Server database


In WorkStation, log on to the Enterprise Server and restore the server using the
previously saved backup set. For more information, see the Restoring the
SmartStruxure Server topic on WebHelp.

Verify TCP protocol and server communication


Use the Communications properties of the Enterprise Server to verify that TCP is
set as the communications protocol for the Automation Servers and Enterprise
Server, and the servers are communicating with each other. For more
information, see the Updating Communication Parameters topic on WebHelp.

Verify control and monitoring operations


Use Software Administrator (or the Services tool) to verify that the Enterprise
Server Windows service is running, which ensures that extended trend logging
restarts. For more information, see section 4.39 “Starting the Enterprise Server or
Enterprise Central Windows Service” on page 142.
In WorkStation, verify that the control and monitoring operations of the Enterprise
Server are functioning normally according to the guidelines specified for your
site.

Back up the EcoStruxure BMS servers


Perform a mass backup of all the EcoStruxure BMS servers. For more
information, see the System Backup topic on WebHelp.

Install WorkStation Language Pack


If you are using a language pack for WorkStation, install the language pack.
For more information, see the Installing a Language Pack topic on WebHelp.

Install WebStation Language Pack


If you want to use a language pack in WebStation, install the language pack and
change the language setting in WebStation.
For more information, see section 4.37 “Adding a Language in WebStation” on
page 140.
For more information, see section 4.38 “Changing the Language in WebStation”
on page 141.
The process of changing the operating system or replacing the computer is now
complete.

Migrate WebReports?
If you plan to migrate WebReports to another computer, you need to continue.

4.15.4 WebReports Migration Preparation


Prior to migrating WebReports, complete the tasks in the following flowchart.
Related information can be found in the sections after the diagram.

System Upgrade 04-30011-01-en, May 2019


108
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Figure: WebReports Migration Preparation flowchart

Detach WebReports database


To avoid a potential loss of data, detach the WebReports database and save the
file to a safe location. For more information, see the Detaching a WebReports
Database topic on WebHelp.

Export Reports schedules


Use Task Scheduler to export all the Reports schedules to a USB memory
device. For more information, see the Transferring Reports Schedules topic on
WebHelp.

4.15.5 Install WebReports


The following flowchart shows the tasks for installing WebReports on the
targeted computer. Related information can be found in the sections after the
diagram.

04-30011-01-en, May 2019 System Upgrade


109
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Figure: Reinstall WebReports flowchart

Configure Windows roles and features


Use the Windows Server Manager to configure the roles and features. For more
information, see the Configuring Windows Roles and Features topic on
WebHelp.

Install Microsoft SQL Server


Install a Microsoft SQL Server operating system on the targeted computer. For
more information, refer to the Microsoft SQL Server installation documentation.

Attach WebReports database


Use SQL Server Management Studio to attach the WebReports database. For
more information, see the Attaching a WebReports Database topic on WebHelp.

System Upgrade 04-30011-01-en, May 2019


110
4 Related Concepts and Procedures
4.15 Replace Enterprise Server or WebReports Computer Workflow

Confirm administrator role memberships for WebReports database


A WebReports installer must use an admin-level SQL Server Management
Studio user account to log on to a computer running WebReports. This installer
account also requires the addition of three database permissions that permit
access to and control of the WebReports database during installs or upgrades.
For example, an administrator can detach the database.
In SQL Server Management Studio, verify that the Login Properties for the
NTAuthority\IUSR and designated WebReports installer user accounts include
the db_datareader, db_datawriter, and db_owner database role memberships.

Install WebReports Installer


Run the WebReports installation package to install the WebReports Installer. For
more information, see the Installing the WebReports Installer topic on WebHelp.

Install WebReports and select upgrade option


Install WebReports and select the Install software (upgrade existing database)
option to install WebReports on a new computer or operating system and retain
the existing database. For more information, see the Installing WebReports topic
on WebHelp.

Import or recreate Reports schedules


Import or recreate the Reports schedules on the computer running WebReports.
For more information, see the Transferring Reports Schedules topic on
WebHelp.
The WebReports migration is now complete.

04-30011-01-en, May 2019 System Upgrade


111
4 Related Concepts and Procedures
4.16 Repairing LonWorks Configurations in EcoStruxure BMS Servers Running Version 1.8.1 Before Upgrade

4.16 Repairing LonWorks Configurations in


EcoStruxure BMS Servers Running
Version 1.8.1 Before Upgrade
You use this procedure to repair LonWorks configurations in Enterprise Server
and SmartX servers running version 1.8.1 before an upgrade to version 1.9.x or
later. This procedure is part of a system upgrade workflow.

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.

To repair LonWorks configurations in EcoStruxure BMS


servers running version 1.8.1 before upgrade
1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server that you want to repair.
2. On the Actions menu, click Advanced - Repair LonWorks configuration
configuration.
3. In the Repair LonWorks configuration wizard, click Next
Next.

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.

4. Click Copy to clipboard and save the information on the repaired


EcoStruxure BMS servers to a file for later use.
5. Click Finish
Finish.
You now warm start the repaired EcoStruxure BMS servers. For more
information, see section 4.17 “Warm Starting a SmartX Server ” on page 113.

System Upgrade 04-30011-01-en, May 2019


112
4 Related Concepts and Procedures
4.17 Warm Starting a SmartX Server

4.17 Warm Starting a SmartX Server


You warm start a SmartX server when you want the server to reset itself. When
you warm start a SmartX server, the server retains all configuration data, historic
data, and variable values according to the configured retain levels for the
variables.

To warm start a SmartX server


1. In Workstation, in the System Tree pane, select the SmartX server you want
to warm start.
2. On the Actions menu, click Warm start
start.

04-30011-01-en, May 2019 System Upgrade


113
4 Related Concepts and Procedures
4.18 Warm Starting an Enterprise Server

4.18 Warm Starting an Enterprise Server


You warm start an Enterprise Server when you want the server to reset itself.
When you warm start an Enterprise Server, the server retains all configuration
data, historic data, and variable values according to the configured retain levels
for the variables.

To warm start an Enterprise Server


1. In Workstation, in the System Tree pane, select the Enterprise Server you
want to warm start.
2. On the Actions menu, click Warm start
start.

System Upgrade 04-30011-01-en, May 2019


114
4 Related Concepts and Procedures
4.19 Backing Up EcoStruxure BMS Servers Manually

4.19 Backing Up EcoStruxure BMS Servers


Manually
You back up multiple EcoStruxure BMS servers manually to copy and store data
that is frequently updated.
For more information, see the Manual Backups topic on WebHelp.

To back up EcoStruxure BMS servers manually


1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server.
2. On the Actions menu, click Backup
Backup.
3. In the Backup Options dialog box, in the Backup set name prefix box, type
some text at the beginning of the file name that helps identify the backup
set.
4. In the Backup set name suffix box, type some text at the end of the file
name that helps identify the backup set.
5. In the Include column, select the EcoStruxure BMS servers that you want to

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.

04-30011-01-en, May 2019 System Upgrade


115
4 Related Concepts and Procedures
4.20 Stopping the Reporting Agent Windows Service

4.20 Stopping the Reporting Agent Windows


Service
You stop the Reporting Agent Windows service to stop collecting report data.
For more information, see the Reports Server Configuration topic on WebHelp.

To stop the Reporting Agent Windows service


1. On the Reports Server computer, open the Service management console.
2. Right-click Building Operation x.x WebReports Agent
Agent.
3. Select Stop
Stop.

System Upgrade 04-30011-01-en, May 2019


116
4 Related Concepts and Procedures
4.21 Stopping the License Server

4.21 Stopping the License Server


You manually stop the License Server, if the service is running.
For more information, see the License Server topic on WebHelp.

To stop the License Server


1. On the License Server computer, open the Service management console.
2. Right-click Building Operation License Server
Server.
3. Select Stop
Stop.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.

04-30011-01-en, May 2019 System Upgrade


117
4 Related Concepts and Procedures
4.22 Previewing the Enterprise Server or Enterprise Central Database Upgrade

4.22 Previewing the Enterprise Server or


Enterprise Central Database Upgrade
You preview the Enterprise Server or Enterprise Central database upgrade files
to check for any configuration related problems, such as unresolved references
or bindings.

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.

Preview the Enterprise Server or Enterprise Central database


upgrade
1. Run Device Administrator as an administrator in Windows.
2. In Device Administrator, on the Tools menu, click Add network device to
list
list.
3. In the Edit Connection dialog box, in the Device address box, type
"localhost".
4. Enter the user name and password.
5. Click OK
OK.

6. Click the Upgrade device(s) button.

7. When progress is completed, click the Open Conversion log button.


8. Check the Conversion log for errors and warnings during the upgrade.

System Upgrade 04-30011-01-en, May 2019


118
4 Related Concepts and Procedures
4.23 Upgrading the License Administrator and the License Server

4.23 Upgrading the License Administrator


and the License Server
You upgrade the License Administrator and License Server to access new
features or improve the performance.

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.

To upgrade the License Administrator and the License Server


1. On the computer running License Server, open the Service management
console.
2. Select Building Operation x.y License Server
Server.
3. Click Stop
Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
5. Click Yes
Yes.
6. Click Next
Next.
7. Make sure that you agree with the End User License Agreement (EULA)
and then click I Agree
Agree.
8. In the Program Files page, select the folder where you want the program to
be installed 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.

9. In the Choose Components page, select the components you want to


upgrade and then click Next
Next.

04-30011-01-en, May 2019 System Upgrade


119
4 Related Concepts and Procedures
4.23 Upgrading the License Administrator and the License Server

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.

11. Click Install


Install.
12. Click Next
Next.
13. Click Finish
Finish.

System Upgrade 04-30011-01-en, May 2019


120
4 Related Concepts and Procedures
4.24 Upgrading the Enterprise Server

4.24 Upgrading the Enterprise Server


You upgrade the Enterprise Server to access new features or improve the
performance of the product.

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.

To upgrade the Enterprise Server


1. Double-click on the Enterprise Server installation file to start the installation
wizard.
2. Click Yes to confirm that you want to run the Enterprise Server 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 Installation Type page, select Upgrade current version (x.x.x) to
x.x.x
x.x.x.
6. 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.

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.

04-30011-01-en, May 2019 System Upgrade


121
4 Related Concepts and Procedures
4.24 Upgrading the Enterprise Server

9. Select Perform a backup of Enterprise Server database and click Next


Next.
10. Click Next
Next.
11. Ensure that you have made pre-upgrade preparations and select Proceed
with upgrade
upgrade.
12. Click Next
Next.
13. In the Communication Ports page, in the HTTP Port box, type the port
number the Enterprise Server listens to when communicating through the
Hypertext Transfer Protocol.

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.

19. Click Next


Next.

System Upgrade 04-30011-01-en, May 2019


122
4 Related Concepts and Procedures
4.24 Upgrading the Enterprise Server

20. Revise the information on the Summary page and then click Install
Install.

NOTICE
The Enterprise Server Windows service stops automatically.

21. Click Next


Next.
22. Click Finish
Finish.

04-30011-01-en, May 2019 System Upgrade


123
4 Related Concepts and Procedures
4.25 Upgrading WorkStation and Client Tools Installation

4.25 Upgrading WorkStation and Client Tools


Installation
You upgrade the WorkStation to access new features or improve the
performance of the product.

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.

To upgrade WorkStation and client tools installation


1. Double-click on the WorkStation installation file to start the installation
wizard.

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.

System Upgrade 04-30011-01-en, May 2019


124
4 Related Concepts and Procedures
4.25 Upgrading WorkStation and Client Tools Installation

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.

7. In the WorkStation Installation Type page, select Upgrade current version


(x.x.x) to x.x.x.
8. Click Next
Next.
9. In the WorkStation page, click Next
Next.
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.

11. Click Next


Next.
12. Click Finish
Finish.

04-30011-01-en, May 2019 System Upgrade


125
4 Related Concepts and Procedures
4.26 Upgrading the Device Administrator Installation

4.26 Upgrading the Device Administrator


Installation
You upgrade the Device Administrator to access new features or improve the
performance of the product.
For more information, see section 3.6 “Enterprise Server System Upgrade
Workflow” on page 44.

NOTICE
To upgrade Device Administrator, you must have access to an installation
package with a higher number than the currently installed version.

To upgrade the Device Administrator installation


1. Double-click on the Device Administrator installation file to start the
installation wizard.
2. Click Yes
Yes, to confirm that you want to run Device Administrator installation
package.
3. In the Program files page, 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 Device Administrator Installation Type page, Select Upgrade current


version (x.x.x) to x.x.x
x.x.x.
7. Click Next
Next.
8. Click Install
Install.
9. Click Next
Next.
10. Click Finish
Finish.

System Upgrade 04-30011-01-en, May 2019


126
4 Related Concepts and Procedures
4.27 Device Administrator Certificate Workflow

4.27 Device Administrator Certificate


Workflow
Use this workflow to create a trusted chain between Device Administrator and
SmartX server using a self-signed certificate.

Figure: Device Administrator Certificate Workflow

Start the Device Administrator as an Administrator


You need to be an administrator to install the certificate in Windows trusted
storage. Refer to Windows for information on how to run a program as
administrator.

Generate an SSL root certificate


Generate the SSL root certificate that is to be installed in Windows.
For more information, see the Generating a Root Certificate topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


127
4 Related Concepts and Procedures
4.27 Device Administrator Certificate Workflow

Install the SSL root certificate in Windows trusted storage


Install the SSL root certificate in Windows trusted storage.
For more information, see the Installing an SSL Root Certificate to Windows
Trusted Root Certificate Storage topic on WebHelp.text

Generate an SSL certificate for each SmartX server


Generate an SSL certificate for each SmartX server.
For more information, see the Generating an SSL Certificate on a SmartX Server
topic on WebHelp.
If you have many SmartX servers in the list, you can use the Manage SSL
Certificate Template to add default values for every new SSL certificate you want
to generate.
For more information, see the Generating an SSL Certificate on a SmartX Server
topic on WebHelp.

Save the server list


You save the list after you have generated the certificates for each SmartX
server. It is recommended that you save the list after that you have generated
the certificate for each SmartX server.
For more information, see the Saving a List of SmartX Servers topic on
WebHelp.text

Transfer the SSL certificate to the SmartX server


Transfer the SSL certificate to all SmartX servers in the list. This must be done
manually for each server.
For more information, see the Transferring an SSL Certificate to SmartX Server
topic on WebHelp.

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.

System Upgrade 04-30011-01-en, May 2019


128
4 Related Concepts and Procedures
4.28 Device Administrator Licenses

4.28 Device Administrator Licenses


Device Administrator is used to manage and organize the licenses on SmartX
server.

4.28.1 Licenses on SmartX Servers


Licenses are needed with some of the features of a SmartX server.

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.2 Entitlements, Products, and Licenses


Licenses are bought as products and delivered in Entitlements. An Entitlement is
a container that can contain several products. The products contain the licenses
and they can differ in quantity and contents.
For more information, see the Entitlements, Products, and Licenses topic on
WebHelp.

4.28.3 Assign and Activate Licenses


When you have added the Entitlement to Device Administrator you must assign
and activate the licenses.
For more information, see the Assign and Activate Licenses topic on WebHelp.

04-30011-01-en, May 2019 System Upgrade


129
4 Related Concepts and Procedures
4.28 Device Administrator Licenses

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.

System Upgrade 04-30011-01-en, May 2019


130
4 Related Concepts and Procedures
4.29 Uploading and Upgrading a SmartX Server

4.29 Uploading and Upgrading a SmartX


Server
You upgrade the SmartX server with the upgraded Device Administrator to
install new version of software, or to empty the database.

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.

To upload and upgrade a SmartX server


1. In Device Administrator, click Server and then click Add Server
Server.
2. In the Connect to Server dialog box, in the Server address box, type the IP
address or the host name of the SmartX server. For more information, see
the Identifying the SmartX Server IP Address topic on WebHelp.
3. Enter the password in one of the following ways:
• Type the password for this SmartX server.
• Select Use site specific device password using the password
specified in the Device log on options dialog box.
4. Click OK
OK.
5. Repeat the four preceding steps until you have a list of all the SmartX
servers that you want to upgrade.
6. Select the the checkbox before the server name.
7. Click Upgrade server button.
8. In the Upgrade servers box, select one of the following options:
• Upgrade database to upgrade a database backup of the SmartX
server.
• New database to upgrade all software running on the SmartX server.

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.

04-30011-01-en, May 2019 System Upgrade


131
4 Related Concepts and Procedures
4.30 SmartX Server Upgrade

4.30 SmartX Server Upgrade


You use Device Administrator to upgrade the SmartX server. You must upgrade
Device Administrator before you upgrade the SmartX server.

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.1 Upgrade Process


Device Administrator uploads the backup set from the SmartX server to the
computer that is running Device Administrator. The database in the backup set
is converted to the new version.
You then 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. In WorkStation, fix the configuration issues in the SmartX server. In
Device Administrator, upload and convert the database again. Repeat this
process until you are comfortable with the contents of the Conversion Logs.
You download the converted database to the SmartX server. During this
download, the SmartX server is completely offline and not operational from a
controls perspective for up to 25 minutes.
You can choose to download the database immediately or at a later time.
However, if the converted database is older than 24 hours, you are notified that
the database might be out of date because the SmartX server has been online
collecting data while the backup set containing the database was converted.
The timeframe between the database upgrade and the actual download of the
database can cause the database to be out of date because the SmartX server
has been online collecting data, such as configurations and events, while the
backup set containing the database was converted. However, trendlog data is
always retained.

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.

System Upgrade 04-30011-01-en, May 2019


132
4 Related Concepts and Procedures
4.30 SmartX Server Upgrade

4.30.3 Conversion Logs


During conversion of the database, the EcoStruxure Building Operation software
creates two conversion logs that contain information about any issues that
occurred.
For more information, see section 4.31 “Conversion Logs” on page 134.

4.30.4 Log Entry Interpretation


When you examine a log to determine if any of the reported warnings require
attention prior to deployment, it is necessary to decipher the listed EcoStruxure
Building Operation configuration element path and then assess the nature of the
warning to determine if it requires attention.
For more information, see section 4.32 “Log Entry Interpretation” on page 135.

04-30011-01-en, May 2019 System Upgrade


133
4 Related Concepts and Procedures
4.31 Conversion Logs

4.31 Conversion Logs


During conversion of the database, the EcoStruxure Building Operation software
creates two conversion logs that contain information about any issues that
occurred.
The two conversion logs keep track of information about the database
conversion of SmartX servers:
• Conversion log: includes information about any errors, warnings, and
notices that occurred during the conversion of the database
For more information, see section 4.34 “Opening the Conversion Log” on
page 137.
• High priority conversion log: contains only the warnings that will most often
require some kind of user action
For more information, see section 4.35 “Opening the High Priority
Conversion Log” on page 138.

System Upgrade 04-30011-01-en, May 2019


134
4 Related Concepts and Procedures
4.32 Log Entry Interpretation

4.32 Log Entry Interpretation


When you examine a log to determine if any of the reported warnings require
attention prior to deployment, it is necessary to decipher the listed EcoStruxure
Building Operation configuration element path and then assess the nature of the
warning to determine if it requires attention.
Log entries follow one of two general formats:
• INFORMATION tagged entries:
Example: 2013-07-17 18:53:21 INFORMATION
These entries provide statistics and a basic framework to see that the
upgrade has processed information.
Occasionally there is also a warning message included in the entries, where
the upgraded target database will not contain precisely the same data as
the source database. However, this warning message rarely requires
modifications prior to upgrade.
• WARNING tagged entries:
Example: 2013-07-17 18:53:50 WARNING
These entries indicate that some part of the source database could not be
recreated in the target database.
Occasionally there is also the text 'Error' included in the entry, directly after
the warning tag. This error text is not as important as the tag that is in all
capital letters (WARNING).

04-30011-01-en, May 2019 System Upgrade


135
4 Related Concepts and Procedures
4.33 Opening the Upgrade Log

4.33 Opening the Upgrade Log


You open the Upgrade log to view information and warnings about all three parts
of the upgrade process of an SmartX server.
For more information, see the SmartX Server Device Administration topic on
WebHelp.

To open the upgrade log


1. In Device Administrator, click Servers and then click the SmartX server
name.
2. Click Upgrade log
log.

System Upgrade 04-30011-01-en, May 2019


136
4 Related Concepts and Procedures
4.34 Opening the Conversion Log

4.34 Opening the Conversion Log


You open the conversion log to view information and warnings about what went
wrong during the conversion of the SmartX server database. Open the
Conversion log of any SmartX server that has a yellow or red progress bar.
For more information, see the SmartX Server Device Administration topic on
WebHelp.

To open the conversion log


1. In Device Aministrator, click Servers and then click the SmartX server
name.
2. Click Conversion log
log.

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.

04-30011-01-en, May 2019 System Upgrade


137
4 Related Concepts and Procedures
4.35 Opening the High Priority Conversion Log

4.35 Opening the High Priority Conversion


Log
You use this procedure to open the High priority conversion log in a text editor.
For more information, see the SmartX Server Administration topic on WebHelp.

To open the High priority conversion log


1. In Windows, browse to the folder C:/ProgramData/Schneider Electric
EcoStruxure/Building Operation x.x/Device Administrator/Conversion
Logs
2. In a text editor, open the file [IP number/hostname]_only_hi_prio.txt
number/hostname]_only_hi_prio.txt, where
IP number/hostname is the host name or IP address of the SmartX server.
3. Determine if you can use the converted database for download or if you
need to fix configuration issues in the SmartX server.

NOTICE
Do not download the upgraded database until this log is empty, or nearly
empty and you are comfortable with the contents.

System Upgrade 04-30011-01-en, May 2019


138
4 Related Concepts and Procedures
4.36 Downloading an Upgraded Database to a SmartX Server

4.36 Downloading an Upgraded Database to


a SmartX Server
You download the SmartX server database after it has been upgraded.
For more information, see the SmartX Server Device Administration topic on
WebHelp.

To download an upgraded database to a SmartX server


1. In Device Administrator, click Servers
Servers.

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.

2. Select the server in the checkbox.


3. Click Download server
server.
4. In the Conform download dialog box, click OK
OK.

04-30011-01-en, May 2019 System Upgrade


139
4 Related Concepts and Procedures
4.37 Adding a Language in WebStation

4.37 Adding a Language in WebStation


You add a language to WebStation so that the user can change to this
language.

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.

For more information, see the Language Packages topic on WebHelp.

To add a language in WebStation


1. In WebStation, on the Settings menu, click Options
Options.
2. In the Add or remove languages dialog box, click Upload new language
language.
3. Browse to the language pack .zip file for the language you want to add.
4. Click Open
Open.

System Upgrade 04-30011-01-en, May 2019


140
4 Related Concepts and Procedures
4.38 Changing the Language in WebStation

4.38 Changing the Language in WebStation


You change the language in WebStation to adapt WebStation to a new region.
For more information, see the Regional Settings topic on WebHelp.

To change the language in WebStation


1. In WebStation, on the Settings menu, click Options
Options.
2. Click Change regional settings
settings.
3. In the Regional settings dialog box, select the language you want to use.
4. Click OK
OK.

04-30011-01-en, May 2019 System Upgrade


141
4 Related Concepts and Procedures
4.39 Starting the Enterprise Server or Enterprise Central Windows Service

4.39 Starting the Enterprise Server or


Enterprise Central Windows Service
You start the server manually in case you previously have stopped it.

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.

For more information, see the Software Administrator topic on WebHelp.

To start the Enterprise Server Enterprise Central Windows


service
1. In the Software Administrator
Administrator, click the tab of the Enterprise Server or the
Enterprise Central
Central.
2. Click Start Service
Service.

System Upgrade 04-30011-01-en, May 2019


142
4 Related Concepts and Procedures
4.40 Checking the Status of Bindings

4.40 Checking the Status of Bindings


You check the status of bindings to identify any unresolved or invalid bindings.
For more information, see section 4.42 “Bindings Management” on page 145.

To check the status of bindings


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 Bindings Diagnostics
Diagnostics.
4. In Binding Diagnostics
Diagnostics, in the Status column, view the status of the
bindings.

04-30011-01-en, May 2019 System Upgrade


143
4 Related Concepts and Procedures
4.41 Binding Values Manually

4.41 Binding Values Manually


You bind values to exchange data between objects.
For more information, see the Bindings Overview topic on WebHelp.

To bind values manually


1. In WorkStation, in the System Tree pane, select the object to which you
want to bind values.
2. On the Actions menu, click Edit bindings
bindings.
3. In Bindings View, in the binding Browser
Browser, drag a value to a property in the
binding list to create a binding.

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.

4. On the toolbar, click the Save button .

System Upgrade 04-30011-01-en, May 2019


144
4 Related Concepts and Procedures
4.42 Bindings Management

4.42 Bindings Management


You manage bindings so that information is not lost and the system works
efficiently. You can check the bindings in your database using Bindings
Diagnostics.
Faulty bindings can have two types of status:
• Invalid: The binding points to something that cannot be bound together,
such as an out of range alarm that is monitored by a digital value.
• Unresolved: The binding points to an object that is not in the database,
such as an object that you deleted.
If you delete an object and keep the bindings to the deleted object, you get an
unresolved binding. If you later replace the object in the same location and with
the same name, the binding is resolved. For more information, see the Bindings
Status Icons topic on WebHelp.
You can resolve invalid or unresolved bindings by editing the binding. For more
information, see section 4.41 “Binding Values Manually” on page 144.

04-30011-01-en, May 2019 System Upgrade


145
4 Related Concepts and Procedures
4.43 Backing Up the WebReports Database

4.43 Backing Up the WebReports Database


You back up the WebReports database as a precaution to ensure that you do
not lose data, such as during a WebReports software upgrade.
For more information, see the WebReports Installer and WebReports
Components topic on WebHelp.

To back up the WebReports database


1. In Windows Server 2012, open Start screen and then click SQL Server
Management Studio
Studio.
2. In the Connect to Server page, click Connect
Connect.
3. Expand the Databases folder.
4. Right-click StruxureWareReportsDB
StruxureWareReportsDB, point to Tasks
Tasks, and then click Back
Up
Up.
5. In the Back Up Database page, under Destination
Destination, ensure that an
appropriate backup destination is selected.

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.

System Upgrade 04-30011-01-en, May 2019


146
4 Related Concepts and Procedures
4.44 Upgrading WebReports

4.44 Upgrading WebReports


You upgrade WebReports to access new features or improve the performance
of the product.

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.

12. Click Yes


Yes.

04-30011-01-en, May 2019 System Upgrade


147
4 Related Concepts and Procedures
4.44 Upgrading WebReports

13. In the Installation page, click Next


Next.
14. Click Finish
Finish.
15. On the SQL Server Reporting Services Home page, verify that the Data
Sources
Sources, Production Reports
Reports, and Default Reports folders are present.
16. In the Production Reports folder, verify that the following reports are
present.

System Upgrade 04-30011-01-en, May 2019


148
4 Related Concepts and Procedures
4.45 Starting the Reporting Agent Windows Service

4.45 Starting the Reporting Agent Windows


Service
You start the Reporting Agent Windows service to resume collecting report data.
For more information, see the Reports Server Configuration topic on WebHelp.

To start the Reporting Agent Windows service


1. On the Reports Server computer, open the Service management console.
2. Right-click Building Operation x.x WebReports Agent
Agent.
3. Select Start
Start.

04-30011-01-en, May 2019 System Upgrade


149
4 Related Concepts and Procedures
4.46 Generating a Certificate

4.46 Generating a Certificate


Generate a self-signed certificate to improve the security in your system.
For more information, see the Certificates topic on WebHelp.

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

System Upgrade 04-30011-01-en, May 2019


150
4 Related Concepts and Procedures
4.46 Generating a Certificate

20. In the Confirm password box, type the password again.


21. 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.

04-30011-01-en, May 2019 System Upgrade


151
4 Related Concepts and Procedures
4.47 Adding a Certificate

4.47 Adding a Certificate


You add a certificate to your system to increase security.
For more information, see the Certificates topic on WebHelp.

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.

System Upgrade 04-30011-01-en, May 2019


152
4 Related Concepts and Procedures
4.48 Activating a Certificate

4.48 Activating a Certificate


You activate a certificate so it is in effect.
For more information, see the Certificates topic on WebHelp.

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.

8. Click the Save button .


The certificate is activated immediately after you save the setting.

04-30011-01-en, May 2019 System Upgrade


153
4 Related Concepts and Procedures
4.49 Delete Obsolete LonWorks Objects

4.49 Delete Obsolete LonWorks Objects


You delete obsolete LonWorks objects to increase the available space in your
Enterprise Server and SmartX servers. The operation is a part of a system
upgrade.
When you upgrade a system from version 1.5, 1.6, or 1.7 to version 1.8 or
higher, you must delete the obsolete LonWorks objects after all SmartX servers
have been upgraded.
After you have upgraded the last SmartX servers device in your system, the
system needs one or two hours to sort out and update reference bindings before
you delete the obsolete LonWorks objects.
You can delete obsolete LonWorks objects from a SmartX server system with
only one SmartX server or on an Enterprise Server system with one or more
SmartX servers.

Delete Obsolete LonWorks Objects from a SmartX Device System


On a SmartX device system with only one SmartX server, you delete the obsolete
LonWorks objects on the SmartX server, after the upgrade to version 1.8 or
higher.

Delete Obsolete LonWorks Objects from an Enterprise Server


System
On an Enterprise Server system, you perform the operation from the Enterprise
Server. All obsolete LonWorks objects on the Enterprise Server and on the
attached SmartX servers are deleted.
Deleting obsolete LonWorks objects on SmartX servers from an Enterprise
Server can only be done when all SmartX servers in the system are online and at
version 1.8.1.34000 or higher. If a SmartX server is offline, or is an older version
than 1.8.1, the operation fails and you get an error message.
If a SmartX server is offline, you can detach that server from the Enterprise
Server and delete the obsolete LonWorks objects on the SmartX server that are
online. When the SmartX server is online again, you can log on directly to that
SmartX server and delete obsolete LonWorks objects.

System Upgrade 04-30011-01-en, May 2019


154
4 Related Concepts and Procedures
4.50 Deleting Obsolete LonWorks Objects

4.50 Deleting Obsolete LonWorks Objects


You delete obsolete LonWorks objects to increase available space in your
EcoStruxure BMS server.
For more information, see section 4.49 “Delete Obsolete LonWorks Objects” on
page 154.

To delete obsolete LonWorks objects


1. In WorkStation, in the System Tree pane, select the EcoStruxure BMS
server.
2. On the Actions menu, point to LonWorks and then click Delete Obsolete
Lon Objects
Objects.
3. Click Close
Close.

04-30011-01-en, May 2019 System Upgrade


155
4 Related Concepts and Procedures
4.51 Uploading Hosted Objects to an EcoStruxure BMS Server

4.51 Uploading Hosted Objects to an


EcoStruxure BMS Server
After you host objects from an external BACnet device, you upload the hosted
objects on the represented BACnet device to update the properties in the
EcoStruxure BMS server database with those on the external device. Uploading
hosted BACnet objects preserves any objects created on the hosted device that
do not have corresponding objects in the external device.
For more information, see the BACnet Download and Upload Hosted Objects
topic on WebHelp.

To upload hosted objects to an EcoStruxure BMS server


1. In WorkStation, in the System Tree pane, expand the BACnet Interface
Interface.
2. Expand the network where the BACnet device resides.
3. Select the device.
4. On the Actions menu, click Upload hosted objects
objects.
5. In the Information box, consider the options and then click OK
OK.

NOTICE
This dialog box displays when there are no hosted objects for the device
in the EcoStruxure BMS server database.

System Upgrade 04-30011-01-en, May 2019


156
4 Related Concepts and Procedures
4.52 Assigning an MNL or MNB Application

4.52 Assigning an MNL or MNB Application


You assign an application to an MNL or MNB device to specify which
application type the device will use.
For more information, see the MNL and MNB Applications topic on WebHelp.

To assign an MNL or MNB application


1. In WorkStation, in the System Tree pane, select an MNL or MNB device.
2. On the Actions menu, point to MNL or Device and then click Assign
application
application.

NOTICE
The Assign application option is not available when you select multiple
MNL LonWorks or MNB BACnet devices.

3. When assigning an MNL-800 application, select Only show MNL-800


applications with the same program ID as the selected device to make it
easier to select an application that is appropriate for an MNL-800 device.
4. In the Naming the Object page, in the list of applications, select an
application.
5. In the Description box, type a description of the application.
6. Click Assign
Assign.

04-30011-01-en, May 2019 System Upgrade


157
4 Related Concepts and Procedures
4.53 Downloading an MNB BACnet Application Type

4.53 Downloading an MNB BACnet


Application Type
You download an application to an MNB BACnet device to load the device with
its assigned application type.

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.

To download an MNB BACnet application type


1. In WorkStation, in the System Tree pane, select the MNB BACnet device to
which you want to download the application.

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.

2. On the Actions menu, point to Device and then click Download


application
application.

3. In the Progress view


view, click the Details icon to check the status of the
downloaded objects.

System Upgrade 04-30011-01-en, May 2019


158
5 Installation User interface

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

5.1 Installation Wizard – Choose


Components Page
Use the Choose Components page to define which products to install.

Figure: Choose Components page

Table: Choose Components Page


Component Description

Device Administrator Select to install Device Administrator,


which you use to connect to SmartX
servers and upgrade them.

License Administrator Select to install the License Administrator,


which you use to configure and maintain
the license system.

License Server Select to install the license server, which


you use to manage network licenses.

WorkStation Select to install WorkStation, which you use


to configure and supervise your
EcoStruxure BMS.

Graphics Editor Select to install Graphics Editor, which you


use to create and edit graphics that
represent a site or device.

Script Editor Select to install Script Editor, which you


use to create custom script program for
your Building Automation System.

04-30011-01-en, May 2019 System Upgrade


161
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.

Continuum Conversion Tool Select to install the Continuum Conversion


Tool, which you use to move your Andover
Continuum legacy Building Management
System to EcoStruxure BMS.
For more information, see the Continuum
Conversion Overview topic on WebHelp.

Workplace Tech Editor Select to install Workplace Tech Editor,


which you use to program, modify, and
compile control applications for MNL
LonWorks devices.
The WorkPlace Tech Editor component
requires the installation of the appropriate
version of Microsoft Visio.
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.

Language Packs Select to install the languages available for


the user interface of the installed
components.

Enterprise Server Select to install Enterprise Server, which


you use to administer your EcoStruxure
BMS site. Software Administrator is also
installed.

System Upgrade 04-30011-01-en, May 2019


162
5 Installation User interface
5.2 Installation Wizard – Installation Type Page

5.2 Installation Wizard – Installation Type


Page
Use the Installation Type page to define which type of installation to perform
when corresponding product is already installed on your computer or server.

Figure: Installation Type

Table: Installation Type


Component Description

Uninstall current version before Select to uninstall your current installation


reinstalling before the installation of a fresh copy
starts.

Repair current version Select to repair your current installation.

Upgrade current version Select to upgrade your current installation


to a newer version.

Upgrade existing database Select to upgrade your current Enterprise


Server database to a newer version.

Install parallel to current version(s) Select to install the product on a computer


or server that already contains the product
with another major version number.

Replace database Select to replace your current Enterprise


Server database with an empty installation.

04-30011-01-en, May 2019 System Upgrade


163
5 Installation User interface
5.3 Installation Wizard – License Server Configuration Page

5.3 Installation Wizard – License Server


Configuration Page
Use the License Server Configuration page to configure the address to the
license server.

Figure: License server configuration page

Table: License Server Configuration Page


Component Description

License Server Address Type the address to the license server


where licenses are available for check out.
The address must begin with @. To define
the port number, if other than the default
port range 27000-27009, type the port
number in front of the @, Port-
number@Address. Use a semicolon to
separate addresses.

System Upgrade 04-30011-01-en, May 2019


164
5 Installation User interface
5.4 Server Installation Wizard – Configuration Page

5.4 Server Installation Wizard –


Configuration Page
Use the Configuration page to configure the port number the Enterprise Server
listens to when communicating through a specific protocol.

Figure: Configuration page

Table: Configuration Page


Component Description

HTTP Port Type the port number that the Enterprise


Server listens to when communicating
through the Hypertext Transfer Protocol.

HTTPS Port Type the port number that the Enterprise


Server Server listens to when
communicating through a secure version
of the Hypertext Transfer Protocol.

TCP Port Type the port number that the Enterprise


Server listens to when communicating
through the Transmission Control Protocol.

04-30011-01-en, May 2019 System Upgrade


165
5 Installation User interface
5.5 WebReports Upgrade Wizard – Installation Type Page

5.5 WebReports Upgrade Wizard –


Installation Type Page
Use the Installation Type page to upgrade WebReports to the newer version
when WebReports is already installed on your computer or server.

Figure: Installation type page

Table: Installation Type Page


Property Description

Upgrade Click to upgrade your current installation to


a newer version.

System Upgrade 04-30011-01-en, May 2019


166
5 Installation User interface
5.6 WebReports Upgrade Wizard – Installation Type: Installation Path Page

5.6 WebReports Upgrade Wizard –


Installation Type: Installation Path Page
Use the Installation Path page to view the path where WebReports is installed.

Figure: Installation type:Installation path page

Table: Installation Type:Installation Path page


Property Description

Installation path Dispalys the path where WebReports is


installed. Hover the mouse over the path to
view the complete path.

Virtual root Type the name for the virtual directory


path.

04-30011-01-en, May 2019 System Upgrade


167
5 Installation User interface
5.7 WebReports Upgrade Wizard - System Check Page

5.7 WebReports Upgrade Wizard - System


Check Page
Use the System Check page to determine if the recommended Operating
System, Internet Information Services, and required disk space are available.
You can also check if the Reporting Agent service is stopped. You can proceed
with upgrade operation only when Reporting Agent service is stopped.

Figure: System check page

Table: System Check Page


Component Description

Operating system Displays whether WebReports supports


the installed operating system.

Disk space Displays whether the required space for


installing WebReport is available or not.

IIS Displays whether IIS is configured


correctly. For more information, see the
Windows Roles and Features topic on
WebHelp.

System Upgrade 04-30011-01-en, May 2019


168
5 Installation User interface
5.7 WebReports Upgrade Wizard - System Check Page

Continued
Component Description

Stop Reporting Agent Service Displays whether the Reporting Agent


Service is stopped. You need to stop the
service for upgrading WebReports if the
service is not by the installer. For more
information, see section 4.20 “Stopping the
Reporting Agent Windows Service ” on
page 116.

04-30011-01-en, May 2019 System Upgrade


169
5 Installation User interface
5.8 WebReports Upgrade Wizard – Enterprise Server Page

5.8 WebReports Upgrade Wizard –


Enterprise Server Page
Use the Enterprise Server page to connect to the Enterprise Server through
your computer.

Figure: Enterprise Server page

Table: Enterprise Server Page


Property Description

Path Enter the path where Enterprise Server is


installed. The path URL should be
https://<Enterprise Server IP
address:HTTPS Port>

User Name Enter the user name that is used to access


the Enterprise Server. The user name is
your user account in WorkStation. The user
account must belong to the Reports
Administrators user group. For more
information, see the User Account – Group
Membership Tab topic on WebHelp.

Password Enter the password that is used to access


the Enterprise Server.

Domain Displays the domain of the Enterprise


Server.

System Upgrade 04-30011-01-en, May 2019


170
5 Installation User interface
5.9 WebReports Upgrade Wizard - SQL Configuration:Database Backup Page

5.9 WebReports Upgrade Wizard - SQL


Configuration:Database Backup Page
Use the Database Backup page to take the backup of the WebReports
database and save it.

Figure: SQL configuration:Database backup page

Table: SQL Configuration:Database Backup Page


Property Description

Backup database Select Yes to back up the database.

Backup path Enter the path where you want save the
backup.

04-30011-01-en, May 2019 System Upgrade


171
5 Installation User interface
5.10 Pre-upgrade LonWorks Configuration Wizard – Analyze Database Page

5.10 Pre-upgrade LonWorks Configuration


Wizard – Analyze Database Page
Use the Analyze database page to watch the progress of the database analysis
for LonWorks configuration preparation for a system upgrade, and to proceed
with LonWorks configuration preparation.

Figure: Analyze database page

Table: Pre-upgrade LonWorks Configuration Wizard - Analyze Database Page


Table
Component Description

Copy to clipboard Click to copy the information to the


clipboard.

System Upgrade 04-30011-01-en, May 2019


172
5 Installation User interface
5.11 Pre-upgrade LonWorks Configuration Wizard – Prepare LonWorks Configurations for Upgrade Page

5.11 Pre-upgrade LonWorks Configuration


Wizard – Prepare LonWorks
Configurations for Upgrade Page
Use the Prepare LonWorks configurations for upgrade page to follow the
progress of the LonWorks configuration preparation for a system upgrade.

Figure: Prepare LonWorks configurations for upgrade page

Table: Pre-upgrade LonWorks Configuration Wizard - Prepare Configurations for


Upgrade Page
Component Description

Copy to clipboard Click to copy the information to the


clipboard.

04-30011-01-en, May 2019 System Upgrade


173
5 Installation User interface
5.12 Repair LonWorks Configuration Wizard – Analyze Database Page

5.12 Repair LonWorks Configuration


Wizard – Analyze Database Page
Use the Analyze Database page to watch the progress of the database analysis
for the repair of the LonWorks configuration before a system upgrade from
version 1.8.1 to version 1.9.x or later, and to proceed with the repair of the
LonWorks configuration.

Figure: Repair LonWorks configuration wizard – Analyze Database page

Table: Repair LonWorks Configuration Wizard – Analyze Database Page


Component Description

Copy to clipboard Click to copy the information to the


clipboard.

System Upgrade 04-30011-01-en, May 2019


174
5 Installation User interface
5.13 Repair LonWorks Configuration Wizard – Repair Configurations Page

5.13 Repair LonWorks Configuration


Wizard – Repair Configurations Page
Use the Repair Configurations page to follow the progress of the repair of the
LonWorks configuration before a system upgrade from version 1.8.1 to version
1.9.x or later, and to get a list of the repaired EcoStruxure BMS servers.

Figure: Repair LonWorks configuration wizard – Repair Configurations page

Table: Repair LonWorks Configuration Wizard – Repair Configurations Page


Component Description

Copy to clipboard Click to copy the information to the


clipboard.

04-30011-01-en, May 2019 System Upgrade


175
Schneider Electric
www.schneider-electric.com/buildings

© 2019 Schneider Electric. All rights reserved.

04-30011-01-en
May 2019

You might also like