Professional Documents
Culture Documents
System
Reference Guide
04-13005-02-en
October 2012
StruxureWare Building Operation
System
Reference Guide
04-13005-02-en
October 2012
Copyright © 2012 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 ......................................................... 33
1.1 Purpose of This Guide ................................................................. 35
1.2 How This Guide is Organized ...................................................... 36
1.3 Typographical Conventions ......................................................... 37
Reference
3 Installation ................................................................... 45
3.1 Installation of Building Operation ................................................. 47
3.1.1 Installation Packages ................................................................ 47
3.1.2 Products ................................................................................... 47
3.1.3 Installation Example .................................................................. 47
3.1.4 Installation Reparation ............................................................... 47
3.1.5 Reinstall .................................................................................... 48
3.1.6 System Upgrade Overview ........................................................ 48
3.1.7 Uninstallation ............................................................................ 48
3.1.8 Version Numbers and Parallel Installations ................................. 48
3.1.9 Software Administrator .............................................................. 48
3.2 Products ..................................................................................... 49
3.2.1 WorkStation .............................................................................. 49
3.2.2 Graphics Editor ......................................................................... 49
3.2.3 Script Editor .............................................................................. 49
3.2.4 Menta Editor ............................................................................. 50
3.2.5 Function Block Editor ................................................................ 50
3.2.6 WorkPlace Tech ........................................................................ 50
3.2.7 Enterprise Server ...................................................................... 51
3.2.8 Software Administrator .............................................................. 51
3.2.9 Device Administrator ................................................................. 51
3.2.10 License Administrator ............................................................... 51
3.2.11 License Server .......................................................................... 51
Topics
Purpose of This Guide
How This Guide is Organized
Typographical Conventions
1 About This Guide
1.1 Purpose of This Guide
Introduction
The Introduction part contains information on the purpose of this guide, how this
guide is organized, where to find more information, and information on regulatory
notices.
Reference
The Reference part contains conceptual information, procedures, user interface
descriptions and troubleshooting information. If you want more information, see
WebHelp or the other Building Operation Reference Guides.
Tip
Helps you understand the benefits and capabilities of the product.
Note
Provides you with supplementary information.
Important
Alerts you to supplementary information that is essential to the completion of a
task.
Caution
Alerts you to a condition that can cause loss of data.
Warning
Alerts you to a condition that can cause product damage or physical harm.
Bold texts:
User interface items, such as property names and buttons, are written in bold, for
example "On the File menu, select New
New."
Topics
Where to Find Additional Information
Regulatory Notices
2 Additional Information
2.1 Where to Find Additional Information
UL 916 Listed products for the Unites States and Canada, Open
Class Energy Management Equipment.
Industry Canada
ICES-003
This is a Class B digital device that meets all requirements of the Canadian
Interference Causing Equipment Regulations.
Topics
Installation of Building Operation
Products
Installation Example
Version Numbers and Parallel Installations
Installing the License Administrator and the License Server
Installing WorkStation and Client Tools
Installing a Language Package
Installing the Enterprise Server
Installing the Device Administrator
3 Installation
3.1 Installation of Building Operation
3.1.2 Products
Depending on your needs, you can install all Building Operation products or a few
products, such a single Automation Server with a connected WorkStation.
For more information, see section 3.2 “Products” on page 49.
For more information, see section 4.1 “Installation Reparation” on page 79.
3.1.5 Reinstall
To replace your current version, you start with the installation package of the
product you want to reinstall. If the installation package recognizes an earlier
installation of the Building Operation product within the same major and minor
version number but lower maintenance number, the installation wizard asks if you
want to uninstall the current version before installing this package.
For more information, see section 5.1 “Reinstallation ” on page 105.
3.1.7 Uninstallation
To uninstall a Building Operation product you use the Windows Add Remove
Program tool. The Windows Add Remove Program tool permanently removes the
Building Operation product from the computer or server.
For more information, see section 7.1 “Uninstallation” on page 143.
3.2 Products
Depending on your needs, you can install all Building Operation products or a few
products, such a single Automation Server with a connected WorkStation.
3.2.1 WorkStation
WorkStation is the interface where you supervise your Building Operation system. In
WorkStation you can also create, modify, and delete some of the objects that are
used to build a Building Operation system.
Important
Ensure that you have a working and available WorkStation license. A working
license is required to log on to WorkStation. For more information, see section 9.6
“Licenses” on page 181.
When you install WorkStation, you have the option to install the bundled tools:
Graphics Editor, Script Editor, Menta Editor, Function Block Editor, and WorkPlace
Tech. WorkStation is required to run these client tools.
For more information, see section 46.1 “WorkStation” on page 1311.
Important
You have to have a valid Graphics Editor license to start the Graphics Editor. For
more information, see section 9.6 “Licenses” on page 181.
Important
Ensure that you have a working and available Script license. A working license is
required to start Script. For more information, see section 9.6 “Licenses” on page
181.
The installation of Script Editor is bundled into the WorkStation installation package.
For more information, see WebHelp.
Important
Ensure that you have a working and available Menta Editor license. A working
license is required to start the Menta Editor software. For more information, see
section 9.6 “Licenses” on page 181.
Important
Ensure that you have a working and available Function Block Editor license. A
working license is required to start the Function Block Editor software. For more
information, see section 9.6 “Licenses” on page 181.
The installation of Function Block Editor is bundled into the WorkStation installation
package.
For more information, see WebHelp.
Important
Ensure that you have a working and available WorkPlace Tech license. A working
license is required to start the WorkPlace Tech Editor or WorkPlace Tech Monitor
software. For more information, see section 9.6 “Licenses” on page 181.
Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 9.6 “Licenses” on page 181.
The License Server Installation is bundled into the License Administration installation
package.
3.2.12 WebReports
WebReports is a Web application that you use to create, view, and administer
reports. The reports provide information about alarms, trends, and user and system
activity. You use the reports to help manage your building automation system.
For more information, see WebHelp.
Note
• Plan the license management carefully and purchase network licenses early
to avoid unexpected operational stops caused by expired local licenses.
This work flow describes a Building Operation system where license server and
Enterprise Server are located on the same computer.
To install Building Operation smoothly use the following installation order:
If network licenses are not purchased or are missing, local licenses can be activated
from license files. Replace local licenses with purchased licenses before the local
licenses expire.
When installing a product with a higher version number than what is already
installed, the installation package asks you if you want to upgrade or replace your
current installation. When starting an installation package with the same version
number as the software that is already installed the installation package asks you
whether you want to repair or reinstall the installation.
Caution
Do not execute or run two different versions of a product simultaneously on your
server or computer. Running parallel installations can cause data loss or
corruption.
On the same computer or server, you can install products parallel to each other that
have different major or minor version numbers. For example, you can install
WorkStation 2.1.6.0 on a computer that already has version 1.2.1.0 installed.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
5. Select the components you want to install and then click Next
Next.
6. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
7. Click Install
Install.
8. Click Next
Next.
Note
Click Show details to follow the progress of the installation.
9. Click Finish
Finish.
It is recommended that you configure the license server recovery settings to ensure
that the license server restarts if it unexpectedly stops. For more information, see
section 12.12 “Configuring License Server Recovery Settings ” on page 253.
Important
Ensure that you have a working and available WorkStation, Graphics, Script, and
Menta / Function Block licenses. A working license for each product is required to
start and log on. For more information, see section 9.6 “Licenses” on page 181.
For more information, see section 3.1 “Installation of Building Operation” on page
47.
Important
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
Yes, to confirm that you want to run the Workstation installation pakage.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
5. Select the components that you want to install and then click Next
Next.
6. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
7. Click Install
Install.
Continued on next page
8. Click Next
Next.
9. Click Finish
Finish.
Note
Click Show details to follow the progress of the installation.
Note
• A WorkStation installation is a prerequisite to install additional language
packages.
• The version of the language package to install must correspond with your
Workstation version.
For more information, see section 3.1 “Installation of Building Operation” on page
47.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
5. Click Next
Next.
Note
Click Show details to follow the progress of the installation.
6. Click Finish
Finish.
Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 9.6 “Licenses” on page 181.
For more information, see section 3.1 “Installation of Building Operation” on page
47.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
6. In the Database Folder box, enter the path to the location where you want to
save the Enterprise Server database.
Important
• The database folder path can contain up to 140 characters
• The database folder path can only contain ASCII characters.
7. Click Next
Next.
Continued on next page
8. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol.
9. In the HTTPS Port box, type the port numer the Enterprise Server listens to
when communicating through the Hypertext Transfer Protocol Secure.
10. In the TCP Port box, type the port number the Enterprise Server listens to
when communicating through the Transmission Control Protocol.
11. Click Next
Next.
12. In the License Server Address box, type @ and then type the address to the
License Server.
Note
• 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.
Note
Click Show details to follow the progress of the installation.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
6. Click Next
Next.
Note
Click Show details to follow the progress of the installation.
7. Click Finish
Finish.
Topics
Installation Reparation
Repairing the License Administrator and the License Server
Repairing WorkStation and Client Tools Installation
Repairing the Enterprise Server
Repairing the Device Administrator Installation
4 Installation Repair
4.1 Installation Reparation
Note
Before repairing a License Server or Enterprise Server, you must stop related
Windows services.
Important
• To repair an installation, you must have access to the installation package
that was used to install the product.
Note
In Windows, open the Run dialog box and enter services.msc
3. Select Stop
Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
5. Click Yes
Yes, to confirm that you want to run the License Administrator
installation package.
6. Click Next
Next.
7. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
8. Select the components you want to repair and then click Next
Next.
13. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
Note
Click Show details to follow the progress of the installation.
Important
To repair an installation, you must have access to the installation package that
was used to install the product.
Note
During the reparation of WorkStation, additional language packages are removed.
For more information, see section 4.1 “Installation Reparation” on page 79.
Important
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
Yes, to confirm that you want to run the Workstation installation
package.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
5. Select the components that you want to repair and then click Next
Next.
7. Click Next
Next.
Continued on next page
8. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
9. Click Install
Install.
10. Click Next
Next.
Note
Click Show details to follow the progress of the installation.
Important
• To repair an installation, you must have access to the installation package
that was used to install the product.
For more information, see section 4.1 “Installation Reparation” on page 79.
8. Click Next
Next.
9. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
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.
Continued on next page
17. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
Note
Click Show details to follow the progress of the installation.
Important
To repair an installation, you must have access to the installation package that
was used to install the product.
For more information, see section 4.1 “Installation Reparation” on page 79.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
7. Click Next
Next.
8. Click Next
Next.
Note
Click Show details to follow the progress of the installation.
9. Click Finish
Finish.
Topics
Reinstallation
Reinstalling the License Administrator and the License
Server
Reinstalling WorkStation and Client Tools
Reinstalling the Enterprise Server
Reinstalling the Device Administrator Installation
5 Reinstallation
5.1 Reinstallation
5.1 Reinstallation
This is an additional solution instead of first manually uninstalling the current product
and then installing a new copy.
Caution
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see WebHelp.
To replace your current version, you start with the installation package of the
product you want to reinstall. If the installation package recognizes an earlier
installation of the Building Operation product within the same major and minor
version number but lower maintenance number, the installation wizard asks if you
want to uninstall the current version before installing this package.
Note
Before reinstalling a License Server or Enterprise Server, you must stop related
Windows services.
Note
In Windows, open the Run dialog box and enter services.msc
3. Select Stop
Stop.
4. Double-click on the License Administrator installation file to start the
installation wizard.
Continued on next page
5. Click Yes
Yes, to confirm that you want to run the License Administrator
installation package.
6. Click Next
Next.
7. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
8. Select the components you want to reinstall and then click Next
Next.
13. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
Note
Click Show details to follow the progress of the installation.
17. Click Uninstall to uninstall the current installation of License Server before the
new version is installed.
Important
For reinstallation, 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 section 9.6 “Licenses” on page 181.
Note
When reinstalling the WorkStation, additional language packages are removed.
Important
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
Yes, to confirm that you want to run Workstation installation pakage.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
5. Select the components that you want to reinstall and then click Next
Next.
7. Click Next
Next.
Continued on next page
8. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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.
9. Click Install
Install.
10. Click Uninstall to remove you current installation.
Note
Click Show details to follow the progress of the installation.
Important
• Before reinstalling the Enterprise Server, you must stop related Windows
services. For more information, see section 14.6 “Stopping the Enterprise
Server Windows Service” on page 282.
Caution
Back up the Enterprise Server before reinstalling the product. All user settings,
database information, and system files related to this product are erased and
replaced. For more information, see WebHelp.
9. Click Next
Next.
10. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
13. Select Uninstall current version before reinstalling and then click Next
Next.
14. In the HTTP Port box, type the port number the Enterprise Server listens to
when communicating through the 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.
Continued on next page
17. In the License Server Address box, type @ and then type the address to the
license server.
Note
• 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 Uninstall to uninstall the current installation of Enterprise Server before
the new version is installed.
Note
Click Show details to follow the progress of the installation.
3. Click Next
Next.
4. Make sure that you agree with the End User License Agreement (EULA) and
then click I Agree
Agree.
7. Click Next
Next.
8. Click Uninstall to remove you current installation.
9. Click Close
Close.
Note
Click Show details to follow the progress of the installation.
Topics
Replace Enterprise Server or WebReports Computer
Workflow
6 Computer Maintenance
6.1 Replace Enterprise Server or WebReports Computer Workflow
6.1.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.
Important
If you are using WebStation, you must add the language files for WebStation
again.
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.
Important
If you are using WebStation, you must add the language files for WebStation
again.
Topics
Uninstallation
Uninstalling the License Administrator
Uninstalling the License Server
Uninstalling WorkStation
Uninstalling Enterprise Server
Uninstalling the Device Administrator
7 Uninstallation
7.1 Uninstallation
7.1 Uninstallation
To uninstall a Building Operation product you use the Windows Add Remove
Program tool. The Windows Add Remove Program tool permanently removes the
Building Operation product from the computer or server.
Caution
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section 10.6
“Removing a Local License or Returning a Network License” on page 210.
Caution
Back up the Enterprise Server before uninstalling the product. All user settings,
database information, and system files related to this product are erased. Files
and backups created by the user remain and are not erased. For more
information, see WebHelp.
Client tools and language packages are uninstalled together with the uninstallation
of WorkStation.
Caution
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section 10.6
“Removing a Local License or Returning a Network License” on page 210.
4. Click Uninstall
Uninstall.
5. Click Close
Close.
Note
Click Show details to follow the progress of the installation.
Caution
Return all activated network licenses to the License Activation Server before
uninstalling the License Server and License Administrator. Licenses cannot be
returned without a License Administrator. For more information, see section 10.6
“Removing a Local License or Returning a Network License” on page 210.
Note
In Windows, open the Run dialog box and enter services.msc
4. Select Stop
Stop.
5. On the Windows toolbar, select Start
Start, and then click Control Panel
Panel.
Continued on next page
8. Click Uninstall
Uninstall.
9. Click Close
Close.
Note
Click Show details to follow the progress of the installation.
Note
• Client tools and language packages are uninstalled together with the
uninstallation of WorkStation.
To uninstall WorkStation
1. On the Windows toolbar, select Start
Start, and then click Control Panel
Panel.
2. Click Uninstall a program
program.
4. Click Uninstall
Uninstall.
5. Click Close
Close.
Note
Click Show details to follow the progress of the installation.
Caution
Back up the Enterprise Server before uninstalling the product. All user settings,
database information, and system files related to this product are erased. Files
and backups created by the user remain and are not erased. For more
information, see WebHelp.
Note
Click Show details to follow the progress of the installation.
4. Click Uninstall
Uninstall.
5. Click Close
Close.
Note
Click Show details to follow the progress of the installation.
Topics
Installation Wizard – Choose Components Page
Installation Wizard – Installation Type Page
Installation Wizard – License Server Configuration Page
Enterprise Server Installation Wizard – Configuration Page
8 Installation User interface
8.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
Automation Servers.
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.
Topics
Licensing Overview
License System
License Management
Service and Maintenance
License Maintenance
Licenses
Viewing Activated Licenses
Editing Registration Details
License Selection Process
Order Information Request
Lost License
License Repair
License Backup
Backing Up Licenses
Restoring Licenses
9 Licensing Introduction
9.1 Licensing Overview
Note
For security reasons, the Internet access can be disconnected when
communication with the License Activation Server is not needed.
9.2.4 Licenses
Building Operation uses two types of licenses: the network license and the local
license. Network licenses are the most common type of license in Building
Operation. With network licenses, only the number of licenses that are used at the
same time are required. The local license is often time limited and used to test and
run a system that is under construction.
For more information, see section 9.6 “Licenses” on page 181.
Figure: WorkStation system with license server and Enterprise Server on same computer
and WorkStation in separate computers, one computer with client tool.
9.4.3 Diagnostics
In License Administrator, Diagnostics view, you can view information about all local
licenses and network licenses located on the license server. This information is
essential for the product support service or when troubleshooting. To forward the
information to a troubleshooter who does not have access to your system, paste
the information in an e-mail message.
Figure: Diagnostic list with information about all licenses located on the License server,
WorkStation or Enterprise Server.
9.6 Licenses
Building Operation uses two types of licenses: the network license and the local
license. Network licenses are the most common type of license in Building
Operation. With network licenses, only the number of licenses that are used at the
same time are required. The local license is often time limited and used to test and
run a system that is under construction.
The Building Operation license policy consists of the following licenses:
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 10.10
“Local Licenses” on page 220.
For more information on how to order licenses, please contact your Building
Operation vendor.
Note
To avoid critical stops, purchase permanent licenses before the time limited-
licenses expire.
Note
To avoid critical stops, purchase permanent licenses before the time limited-
licenses expire.
All licenses activated on the license server, WorkStation, or Enterprise Server are
listed.
Note
• You need to enter the customer details before a licenses is activated.
• Only English letter are allowed in the license details.
For more information, see section 12.14 “License Administrator” on page 258.
2. In the License owner box, type the name of the organization that owns the
license.
3. In the Industry box, select the license owner’s field of business.
4. In the Type of project boxes, select the proposed field of application for the
license.
5. In the Name box, type the name of the account manager that supplied the
license.
6. In the E-mail box, type the e-mail address to the account manager that
supplied the license.
Continued on next page
7. In the Telephone number box, type the telephone number to the account
manager that supplied the license.
8. Click OK
OK.
9. Click Yes
Yes.
Any changes in the registration details updates all activated licenses on the license
server.
Note
• The customer details must be edited or updated individually on all license
servers.
Figure: The Building Operation selection process flow for which license to use, local or
network license.
The order information contains information about all licenses included in the
Entitlement Certificate.
Note
• Repairing a network license requires access to the Internet.
• You are only allowed to repair a license four times a year.
• All repair actions are registered by the Activation Server and are traceable.
To back up licenses
1. Close all Building Operation applications, such as License Administrator,
WorkStation, and Enterprise Server.
2. On the license server, browse to the the folder:
• Windows xp: \Documents and Settings\All Users\Application
Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet
• Windows Server 2008: \ProgramData\FLEXnet
3. Copy all files in the FLEX-net folder that start with taclic_ and paste the files
onto your external backup resource.
To restore licenses
1. Close all Building Operation applications, such as License Administrator,
WorkStation, and Enterprise Server.
2. On the license server, browse to the the folder:
• Windows xp: \Documents and Settings\All Users\Application
Data\FLEXnet
• Windows 7: \ProgramData\FLEXnet\
• Windows Server 2008: \ProgramData\FLEXnet\
3. Paste all your backed up files to the FLEX-net folder.
Note
• You may need to repair restored licenses before you check out
the restored licenses. For more information, see section 10.9
“Repairing a Network License ” on page 218.
You now restart the license server so you can check out the restored licenses. For
more information, see section 12.4 “Restarting the License Server” on page 240.
Topics
Network Licenses
Network License Management
Network Licenses Activation
Network License Return
Activating Network Licenses
Removing a Local License or Returning a Network License
Network License Upgrade
Upgrading Network Licenses
Repairing a Network License
Local Licenses
Local License Management
Activating a Local License
10 Type of Licenses
10.1 Network Licenses
Figure: A network license is activated on a license server and can be checked out by any
computer in the network.
To check out a network license from a license server, you have to define the license
server address where network licenses are available for checkout. You define the
address to the license server when installing the licensed product. You edit the
license server address either in the Windows registry or in License Administrator, on
the computer or server that hosts the licensed product.
A checked out network license is not physically moved to the client or server. The
checked out license is allocated in the license server until the license is released by
the client or server.
When a licensed WorkStation, Enterprise Server, or client tool starts and no local
licenses are activated, the WorkStation or Enterprise Server searches the license
server for an available network license. If an available network license is found, the
licensed product checks out the license and starts. If no licenses are available, the
licensed product does not start. When the application is closed, the license is
checked in on the licenses server.
Figure: The WorkStation checks out license from the license server.
Note
• On a server running both a license server and an Enterprise Server, use the
address @localhost so the Enterprise Server does not connect to the License
server through the network.
Figure: License server and Enterprise Server on same computer. The Enterprise Server
checks out license from the license server that is defined in the shared License
Administrator.
Figure: Activation of network license on license server by the License Activation Server
Use the License Administrator to activate a network license. When activating a
network license, the License Administrator on the receiving computer requests and
administrates the activation.
The activated licenses are now available on the license server. Before the license
server can distribute the network licenses, the license server has to be restarted.
Figure: Returning a license from license server to the License Activation Server
Table: Returning Licenses from License Server to the License Activation Server
Number Description
Note
• All licenses that were activated in same transaction are returned to the
License Activation Server.
Note
• This procedure requires that an order is placed and the entitlement certificate
is received. For more information on how to place an order, contact your
Building Operation vendor.
2. On the Licenses toolbar, click the Add license from entitlement ID button
.
Continued on next page
3. In the Enter license entitlement ID box, type the entitlement ID that contains
the licenses to activate.
Note
• The entitlement ID is printed on the entitlement certificate.
4. Click OK
OK.
5. In the Activate column, select the number of license to activate.
6. Click Activate
Activate.
Continued on next page
7. Click Close
Close.
8. Click Restart now to restart the license server and activate the network
license.
Note
You cannot reactivate a removed local license.
• When you return a license to the License Activation Server, all the licenses
that were activated in the same transaction with that license are also
returned.
4. Click Yes
Yes.
5. Click Close
Close.
Note
• You cannot reactivate a returned license that has an old version.
Continued
Number Description
2. On the Licenses toolbar, click the Add license from entitlement ID button
.
3. In the Enter license entitlement ID box, type the entitlement ID that contains
the licenses to upgrade.
Note
• The entitlement ID is printed on the entitlement certificate.
4. Click OK
OK.
Continued on next page
5. In the Activate column, select the number of licenses with the new version to
activate.
Note
• All licenses with old versions that are activated on the license
server with this entitlement ID are returned.
6. Click Activate
Activate.
7. Click Yes to confirm that all network licenses with the old version, included in
the entitlement, are returned to the License Activation Server.
8. Click Close
Close.
5. Click Close
Close.
Figure: A local license is activated on the computer that will use it and cannot be shared
with other computers.
License files to activate as time-limited local licenses are included in the installation
of Building Operation. The local license files are in the following paths:
• Windows XP: \Documents and Settings\All Users\Application Data\Schneider
Electric StruxureWare\Building Operation x.x\License Files\
• Windows server 2008: \ProgramData\Schneider Electric
StruxureWare\Building Operation x.x\License Files\
• Windows 7: \ProgramData\Schneider Electric StruxureWare\Building
Operation x.x\License Files\
The x.x represents the version number. For more information, see section 10.10
“Local Licenses” on page 220.
For more information on how to order additional licenses, please contact your
Schneider Electric vendor.
Note
After removing a local license, you must restart the computer or server before a
similar network license can be checked out.
Note
• Plan the license management carefully and purchase licenses early to avoid
unexpected operational stops caused by expired time limit.
• For more information on how to order local licenses for client tools, please
contact your Building Operation vendor.
2. On the Licenses toolbar, click the Add license from file button .
Continued on next page
4. Click Close
Close.
5. Click Restart now to restart the license server and activate the local license.
The local license is now activated and the WorkStation, client tool or Enterprise
Server can start.
Topics
Enterprise Server Address Configuration
WorkStation and Client Tools Address Configuration
Viewing Diagnostic Information
Copying Diagnostics to the Clipboard
11 Licensing Configuration and Diagnostics
11.1 Enterprise Server Address Configuration
Figure: Enterprise Server configuration and check out/in of Enterprise Server network
license
When the Enterprise Server starts, it automatically checks out an available network
license from a license server. A checked out network license is not physically
moved to or activated on the Enterprise Server. The license remains in the license
server but is allocated to the dedicated Enterprise Server. The license is therefore
not available for other servers to check out.
Note
• If the Enterprise Server does not start, refer to the Enterprise Server log for
more information. For more information, see section 14.9 “Viewing Enterprise
Server System Log” on page 286.
Figure: WorkStation configuration and check in/out of client station network license and
client tool network licenses
The diagnostics list is now populated with all licenses and license details located on
the license server, WorkStation, client tool, or Enterprise Server.
Topics
License Server
Starting the License Server
Stopping the License Server
Restarting the License Server
Flexnet License Administrator, License Server Manager
Accessing Flexnet lmadmin
Changing the lmadmin License Server Manager Port
Number
License Server Address
Configuring the Address to the License Server
License Server Reset
Resetting the License Server
Configuring License Server Recovery Settings
License Server Maintenance
License Administrator
Starting the License Administrator
12 License Server and License Administrator
12.1 License Server
Note
• In Windows, open the Run dialog box and type services.msc
services.msc.
3. Select Start
Start.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.
3. Select Stop
Stop.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.
Note
• In Windows, open the Run dialog box and type services.msc
services.msc.
3. Select Restart
Restart.
For more information about the Service management console, please refer to the
operating system manufacturer’s manual.
Note
• Flexnet lmadmin has the HTTP protocol through port 8888 set
as the default. For example: http://162.192.10.1:8888
The default user name and password is: admin
admin.
Note
• Before a WorkStation or Enterprise Server starts to check out network
licenses from a license server, the local license in use must be removed. For
more information, see section 10.6 “Removing a Local License or Returning a
Network License” on page 210.
For more information, see section 10.2 “Network License Management” on page
201.
2. In the License server address box, type @ and then type the address to the
server.
Note
• The address must begin with an @.
• If you use a port other than the default port of 27000, type the
port number in front of @. For example, 567@localhost.
• Use a semicolon to separate addresses to different license
servers.
3. Click Save
Save.
Next time a WorkStation, client tool, or Enterprise Server starts, it checks out
available network licenses from a defined license server.
Note
• The license server address is configured individually on all WorkStations and
Enterprise Servers.
Note
• If you delete the license server files, all activated network licenses are lost.
Caution
• Return all the licenses to the License Activation Server before you reset the
license server. Resetting the license server erases the licenses on the server.
For more information, see section 12.10 “License Server Reset” on page 250.
4. Click Yes
Yes.
5. Click Close
Close.
Note
In Windows, open the Run dialog box and type services.msc
services.msc.
3. Select Properties
Properties.
Continued on next page
Make sure that the new license server has the same network address as the former
server. If a new network address is assigned, update all WorkStations and
Enterprise Servers with the address to the new license server.
Note
Only English letters are allowed in the license details.
If you change the registration details, the changes are applied to all licenses located
on the license server.
Note
• To ensure that all the licenses have the same information, the registration
details must be updated on all license servers in the Building Operation
system.
Topics
Registration Details View
Licenses View
Licenses View Toolbar
Licenses View Icons
Licenses View Columns
Add License Dialog Box
License Activation Dialog Box
License Progress Dialog Box
License Server Address View
Diagnostics View
13 Licensing User Interface
13.1 Registration Details View
Note
Only English letters are allowed in the license details.
Continued
Component Description
Remove/return license
Click to remove local licenses or return
network licenses to the License Activation
Server.
Repair license
Click to repair a damaged network license.
Network License
Indicates that the license is a network license
located on a license server.
Local License
Indicates that the license is a local license
located on a server or computer.
Creation date Displays the date when the local license file
that was used to activate the local license
was created, or the date when the network
license was activated on the license server.
Network License
Indicates that network licenses are available
to activate on the license server.
Local License
Indicates that local licenses are available to
activate on the server or computer.
Continued
Component Description
Network License
Indicates that network licenses are activated
or returned.
Local License
Indicates that local licenses are activated or
removed.
License server address Type the address to the license server where
licenses are available for check out. The
address must begin with @. To define a port
number 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.
Copy to clipboard
Click to copy the diagnostics information to
the clipboard.
Topics
Software Administrator
Enterprise Server
Starting Software Administrator
Configuring Enterprise Server Port Settings
Starting the Enterprise Server Windows Service
Stopping the Enterprise Server Windows Service
Restarting the Enterprise Server Windows Service
Enterprise Server System Log
Viewing Enterprise Server System Log
Software Administrator – Enterprise Server View
14 Software Administrator
14.1 Software Administrator
14.1.1 Service
The Enterprise Server runs in the background as a Windows service. You start and
stop the Enterprise Server service through the Software Administrator or Windows
Service. Before shutting down the Enterprise Server, make sure the stop does not
negatively affect your site.
14.1.2 Ports
The Enterprise Server uses HTTP and TCP protocols to communicate with other
servers and clients. In the Software Administrator, you configure the port number of
each protocol the Enterprise Server listens to when communicating through a
specific protocol.
Note
To configure a protocol port number, you first have to stop the running Enterprise
Server service.
2. In the HTTP Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Protocol.
3. In the HTTPS Port box, type the port number that the server listens to when
communicating through the Hypertext Transfer Secure Protocol.
4. In the TCP Port box, type the port number that the server listens to when
communicating through the Transmission Control Protocol.
5. Click Apply
Apply.
6. Click Start Service
Service.
Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 9.6 “Licenses” on page 181.
Note
• The Enterprise Server is automatically started when installed or when the
server is restarted.
For more information, see section 14.1 “Software Administrator” on page 277.
Important
Ensure that you have a working and available Enterprise Server license. A working
license is required to start the Enterprise Server. For more information, see
section 9.6 “Licenses” on page 181.
For more information, see section 14.1 “Software Administrator” on page 277.
Continued
Component Description
Topics
Regional and Language Conventions
Configuring Regional Settings
Language Packages
Changing WorkStation Language
Adding a Language in WebStation
Changing the Language in WebStation
Value Presentation
Units
Adding or Changing a Unit and Prefix for a Value
Metric Prefixes
Precision Format
Adding a Unit Conversion Exception
Removing a Unit Conversion Exception
15 Localization Language and Units
15.1 Regional and Language Conventions
Note
When the Enterprise Server or Automation Server is upgraded, the language pack
in WebStation must be added once again.
Important
To add a language in WebStation, you must log on with an account connected to
a group that has access to the Automation Server web device configuration.
For more information, see section 15.3 “Language Packages” on page 293.
15.7.1 Units
Building Operation supports both the SI metric system and the US Customary
System for units of measurement. The operating system regional settings on which
WorkStation is installed determine whether SI units or US Imperial units are
displayed. The conversion between the two measurement systems is managed
automatically.
For more information, see section 15.8 “Units” on page 298.
15.8 Units
Building Operation supports both the SI metric system and the US Customary
System for units of measurement. The operating system regional settings on which
WorkStation is installed determine whether SI units or US Imperial units are
displayed. The conversion between the two measurement systems is managed
automatically.
For example, the temperature 42,82 °C is stored in Building Operation. A
WorkStation on an operating system with the US Customary System converts the
temperature and displays it as 109.08 °F.
To display the original unit of a value in WorkStation, open the Properties pane for
the value and go to the Unit selection dialog box.
Important
• Building Operation converts the unit of a variable independent of its context.
To correctly convert a delta temperature, the unit of the delta value must
belong to the unit category Temperature Diff.
- - - -
If a value has, for example, kilo as prefix, it is presented in WorkStation with the k-
prefix independent of the number of decimals. When conversion of a unit that has a
prefix, WorkStation removes the prefix and presents the converted value in the
operating system settings default measurement unit without the prefix.
For example, A value of 15 is created with the unit set to meter and with the milli
prefix (10-3), which gives 15 millimeter. A WorkStation on an operating system with
US Customary converts the value to 0.016 yards. This is because of the milli prefix
(10-3) is removed and the Building Operation US customary default length unit is
yard.
Note
• The rounded value is only a display value and is not used by Building
Operation in calculations or other operations.
If an integer value exceeds 12 digits (1012), both positive and negative numbers,
WorkStation displays the value in scientific notation. The number of digits for a
decimal number before it is displayed in scientific notation is decided by the regional
settings of the operating system settings where WorkStation is installed.
6. In the Unit Selection dialog box, select the unit for which you want a
conversion exception.
7. Click Select
Select.
8. In the SI Display Unit column, enter how the configured unit will be displayed
on an SI metric system.
9. In the US Display Unit column, enter how the configured unit will be displayed
on a US customary system.
Topics
Time and Time Zone
Lead and Shadow Relationship
Time and Time Zone Configuration in WorkStation
Time and Time Zone Configuration in Enterprise Server
Time and Time Zone Configuration in Automation Server
Changing the Time Zone of an Enterprise Server or
Automation Server
Creating a Custom Time Zone of an Enterprise Server or
Automation Server
Configuring Enterprise Server and WorkStation Date and
Time
Synchronizing the Automation Server Clock
Manually Changing the Automation Server Time and Date
Network Time
Synchronize Network Time Settings
Synchronizing Time Settings on Multiple Automation Servers
Synchronize Time Zone Settings
Synchronizing Time Zone Settings on Multiple Automation
Servers
16 Localization Time and Time Zone
16.1 Time and Time Zone
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
Automation Server object with an Enterprise Server object, you define the lead
object, in this case the Enterprise Server object, in the properties of the Automation
Server.
A server on a higher level, such as an Enterprise Server, typically acts as the lead.
However, a lead and shadow relationship can be established between two
Automation Servers.
Figure: WorkStation displays all times as local time, according to the operating system
settings on which WorkStation is installed.
For example, a WorkStation in Athens surveys a server in New York. WorkStation in
Athens has a Greek operating system, which is configured to Eastern European
Summer Time (UTC +2h) with +1h DST offset. The New York server triggers an
alarm at 07:43 Eastern time. WorkStation instantly reports the alarm but presents
the alarm with the timestamp 14:43 which is the local time in Greece.
Some features in WorkStation, such as trend log and schedule, allow you to change
the displayed time to UTC or server local time.
Figure: The Enterprise Server uses the operating system clock on which the server is
installed. Time zone offset and DST are then added by Building Operation to the UTC
time.
To adjust your operating system clock, refer to your manufacturer’s manual for the
operating system. The Enterprise Server time zone is configured on the Enterprise
Server through WorkStation
Note
• The Date and Time synchronization for Automation Server do not affect
the Enterprise Server clock. For more information, see section 16.12
“Synchronize Network Time Settings” on page 325.
Figure: The Automation Server uses the operating system clock to which Building
Operation adds the time zone offset and DST
Instead of configuring the time of each Automation Server, you can create a lead
and shadow relationship that makes it possible to configure several Automation
Servers through a single Enterprise Server.
4. Select Predefined time zone and then select the time zone the server is
located in.
Note
• The UTC offset is positive east of Greenwich. For example, the
time offset for Eastern Time is UTC -05:00 hours.
7. Select This custom time zone uses daylight saving time to have the time
zone automatically updated for daylight saving time.
8. In the Time adjustment box, select the daylight saving time offset in minutes.
9. In the Start column, select the month, week, day, and time the daylight saving
time starts.
10. In the End column, select the month, week, day, and time the daylight saving
time ends.
Note
The time zone settings for an Enterprise Server are configured through
WorkStation and not the operating system.
5. In the Primary time server box, type the address to the primary time server
that you want to synchronize the Automation server clock with.
6. In the Secondary time server box, type the address to the time server that
you want to synchronize the Automation Server clock with if the primary time
server is not available.
Note
• The Automation Server Date & Time view displays the local time in the
perspective of the Automation Server time zone settings and not in the
perspective of WorkStation.
For more information, see section 16.5 “Time and Time Zone Configuration in
Automation Server” on page 314.
4. In the Automation Server Date & time view, click Manually adjust date &
time
time.
5. In the Local date & time boxes, enter the date and time of the Automation
Server.
Figure: The Date and Time object is found in the server System, Time Settings folder.
The date and time lead object is configured through the Control Panel - Network
time and time zones on the Enterprise Server.
The Network time synchronization on shadow Automation Servers option on
the Enterprise Server contains the addresses that are inherited by all shadow
Automation Servers. If you disable this option, established shadow and lead
relationships consist but the shadow Automation Servers do not synchronize its
network time server addresses with the lead Enterprise Server. Instead, the
Automation Servers use their own time settings.
Note
• The addresses in the Automation Server - Date & Time do not affect the
Enterprise Server time and date settings. For more information, see section
16.11 “Network Time” on page 324.
5. In the Primary time server box, type the address to the time server that you
want to synchronize the shadow Automation Servers clocks with.
6. In the Secondary time server box, type the address to the time server that
you want to synchronize shadow Automation Servers clocks with if the
primary time server is not available.
7. On the File menu, click Save
Save.
8. In the Search box, type “Date and Time” to search for the date and time object
on all connected servers in your Building Operation system.
Topics
Unit Selection Dialog Box
Date and Time Properties – Basic Tab
Date and Time Properties – Time Tab
Time Zone Properties – Basic Tab
Time Zone Properties – Zone Info Tab
Enterprise Server – Date & Time View
Automation Server – Date & Time View
Add or Remove Languages Dialog Box
Unit Conversion Exceptions View
17 Localization User Interface
17.1 Unit Selection Dialog Box
Use external NTP server Select Enabled to define the primary and
secondary NTP server addresses for
connected shadow Automation Servers.
Lead object Enter the object that acts as the lead for this
object.
Time zone Select the time zone the server belongs to.
Lead object Enter the object that acts as the lead for this
object.
Continued
Component Description
GMT offset - hours Select the time difference the time zone has
from GMT in hours.
GMT offset - minutes Select the time difference the time zone has
from GMT in minutes.
Daylight saving time Select Enable if the custom time zone uses
daylight saving time.
DST Start Month Select the month that daylight saving time
starts.
DST Start Week Select the week of the month that daylight
saving time starts.
DST Start Day Select the day of the week that daylight
saving time starts.
DST Start Hour Select the hour of the day that daylight
saving time starts.
DST Start Minute Select the minute of the hour that daylight
saving time starts.
DST End Month Select the month that daylight saving time
ends.
DST End Week Select the week that daylight saving time
ends.
DST End Day Select the day of the week that daylight
saving time ends.
DST End Hour Select the hour of the day that daylight
saving time ends.
DST End Minute Select the minute of the hour that daylight
saving time ends.
Primary time server Type the address to the primary time server
to which the shadow Automation Servers
date and time object synchronizes its clock
against.
Continued
Component Description
Predefined time zone Select the time zone the server belongs to.
UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Primary time server Type the address to the primary time server
to which the Automation Server
synchronizes its clock against.
Manually adjust date & time Select to manually set the server clock.
Continued
Component Description
Local date & time Enter the date and time you want to set the
server clock to. This time is displayed in
server local time.
Predefined time zone Select the time zone the server belongs to.
UTC offset Select the time difference the time zone has
from UTC in the hours and minutes boxes.
This custom time zone uses daylight Select to enable the daylight saving time
saving time settings for the custom time zone.
Component Description
Note
Users in a domain become subjects to added unit conversion exceptions the next
time they log on.
Topics
User Account Management Overview
Opening the Account Management Control Panel
User Accounts and User Account Groups
Creating a User Account
Editing a User Account Profile
Renaming a User Account
Disabling a User Account
Enabling a Disabled User Account
Setting an Expiration Date for a User Account
Removing the Expiration Date for a User Account
Deleting a User Account
18 User Account Management
18.1 User Account Management Overview
Figure: To log on to a Building Operation server you have to use a valid user account that
is located in the same domain as the server.
Building Operation considers a user account valid when:
• The user account exists
• The user account is not disabled or expired
• The user account belongs to a user account group or mapped active directory
user group
• The user account group belongs to a domain
• The user account has defined software permissions, either defined on the
individual account or inherit from the user account group
18.1.2 Domains
A Building Operation domain contains user accounts, user account groups,
software permissions, workspaces, and one or several Building Operation servers.
The Building Operation server that host and administrates the domain is called the
domain controller.
For more information, see section 20.1 “Domains” on page 405.
18.1.5 Workspaces
The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted to users or user account groups different
tasks.
For more information, see WebHelp.
User Accounts
A user account uniquely identifies a user to the system. When setting up user
accounts, keep the following points in mind:
• Configure as few settings as possible at the user account level.
• Assign a required user name and password, which the system uses for
identification and authentication purposes. For more information, see section
22.1 “Password Administration” on page 453.
• The user account is unique within the domain it belongs to. For example, an
admin user account is located in Domain A. This account cannot be used to
administrate Domain B. For more information, see section 20.1 “Domains” on
page 405.
• Manage accounts at the domain level using a default administrator account.
For more information, see section 20.11 “Administration Accounts in Server
Local Domain” on page 426.
• Track user activity at the user-account level. For more information, see section
24.2 “Audit Trailing of User Activity” on page 512.
Figure: A user account belongs to a domain and is a member of one or more user account
groups
Note
• Although user accounts are members of user account groups, they are not
physically stored in user account groups. Instead, user accounts and user
account groups are parallel entities so that individual accounts can be
members of one or more groups.
4. In the Domain box, select the domain the account is to be created in.
10. In the Middle name box, type the user's middle name.
11. In the Last name box, type the user's last name.
12. In the Home E-mail address box, type the user's e-mail address.
13. In the Work E-mail address
address, type the users work e-mail address.
14. In the Expires on box, enter a date and time when the user account expires
or leave these fields empty if you do not want the user account to expire.
Continued on next page
5. In the User Accounts list box, select the user account you want to edit the
profile information.
6. Click Summary
Summary.
7. Click the Profile tab.
Continued on next page
8. Click OK
OK.
2. In the Server list, select the server containing the user account you want to
disable.
Continued on next page
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account you want to disable.
6. Click Summary
Summary.
7. In the Disabled box, select True to disable the account.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account.
6. Click Summary
Summary.
7. In the Disabled box, select False to enable the account.
4. In the Domain list, select the domain the user account belongs to.
4. In the Domain list, select the domain the user account belongs to.
4. In the Domain list box, select the domain the user account belongs to.
5. In the User Accounts list box, select the user account you want to delete.
Topics
Windows Active Directory User Groups
Creating a User Account Group
Editing the Description of a User Account Group
Adding a User Account to a User Account Group
Removing a User Account from a User Account Group
Reviewing the User Account Group Memberships for a User
Account
Adding a User Account Group to a User Account Group
Removing a User Account Group from another User Account
Group
Reviewing the User Account Group Memberships for a User
Account Group
Preventing a Group of Users from Exiting WorkStation
Enabling a Group of Users to Exit Workstation
Deleting a User Account Group
19 User Account Groups
19.1 Windows Active Directory User Groups
Note
• The Building Operation domain used to map the Windows Active Directory
user account groups must be a member of the Windows domain where the
Active Directory is located.
Windows Active Directory account groups can only be mapped on servers that
are based upon Microsoft Windows operating system. Other servers, for example
Automation Servers, cannot map Windows Active Directory groups.
For example, the Windows Active Directory user account groups Main Admin and
Main User are mapped to the Building Operation user account groups
Administrators and External Users. The External Users user account group is a
member of the Operator user account group. The Administrators account group,
which is a member of the External Users, inherits access to the Operator
workspace.
Figure: Windows Active Directory user account groups mapped to WorkStation user
account groups
4. In the Domain box, select the server where you want to create the user
account group.
7. In the Description box, type a description for the user account group.
8. Click Next
Next.
Continued on next page
9. In the Select from box, select a user account group to auto select the user
accounts belonging to that group in the Available User Accounts list.
10. In the Available User Account list, select the user accounts you want to add
to the user account group.
13. In the Select from box, select a user account group to auto select the
workspaces assigned to that group in the Selected Workspaces list box.
14. In the Selected Workspaces box, select the workspaces you want available
to the user account group.
17. Select Allow members to close WorkStation if you want the users in the
user account group to be able to close the WorkStation software.
18. Select Log user actions of group members if you want to activate logging
for the users in the user account group.
19. Select Allow members to change password if you want the users in the
user account group to be able to change their own passwords.
20. Select Allow members to access AS Web Configuration if you want the
users in the user account group to be able to log on to Automation Servers'
Web configuration sites.
21. Click the refresh button to populate the Windows group name box with
Windows Active Directory user account groups.
Note
To connect a Windows Active Directory user account group to a
Building Operation user account group, you need to establish the
connection between the Building Operation domain and Active
Directory Windows domain. For more information, see section 20.4
“Creating and Configuring a Domain” on page 410.
Windows Active Directory account groups can only be mapped on
servers that are based upon Microsoft Windows operating system.
Other servers, for example Automation Servers, cannot map
Windows Active Directory groups.
22. In the Windows group name box, select the Windows Active Directory user
account group you want to map to the Building Operation user account
group.
23. Click Create
Create.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group you want to
edit the description for.
6. Click Summary
Summary.
7. In the Description box, type a new description for the user account group.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account you wish to add to a user
account group.
6. Click Group membership
membership.
7. In the Available User Account Groups list, select a user account group and
4. In the Domain list, select the domain the user account belongs to.
4. In the Domain list, select the domain the user account belongs to.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Group membership
membership.
7. In the Available User Account Groups list, select the user account group you
want to add the user account group to and click the Add button .
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Group membership
membership.
7. In the Selected User Account Groups list, select the user account group you
are removing the user account group from and click the Remove button .
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Group Membership
Membership.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies
Policies.
7. Clear the May close User Interface box.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies
Policies.
7. Select the May close User Interface box.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group you want to
delete.
Topics
Domains
Log On Methods
Guest Log On in WebStation
Creating and Configuring a Domain
Editing the Windows Domain Name
Editing the Description of a Domain
Editing the Maximum Logon Attempts
Assigning a Server to a Domain
Removing a Server from a Domain
Deleting a Domain
Administration Accounts in Server Local Domain
20 Domains
20.1 Domains
20.1 Domains
A Building Operation domain contains user accounts, user account groups,
software permissions, workspaces, and one or several Building Operation servers.
The Building Operation server that host and administrates the domain is called the
domain controller.
A user or user account group that is a member of a domain which hosts several
Building Operation servers has access to all servers within the domain without
additional logon. Provided that the user account does not have any restricted path
permissions which prevent the user to access the servers.
You can set up domains in several ways. You can have a communication domain
that only contains Building Operation servers and one domain that contains users,
workspaces, and software permissions. Or you can have a combined domain that
manages both servers and users.
Note
A Building Operation server can belong to more than one domain.
For example, a Building Operation system consist of two domains, the Inner City
domain and the Outer city domain. The user Larry has a user account at 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, beside the shared Automation Server.
Note
You cannot change the name of a domain that is shared between servers.
Important
If the Windows Active Directory name is changed, you have to manually update
the change in Building Operation.
3. Click Domain
Domain.
4. Click Add
Add.
Note
• The Windows domain name box is case sensitive. The name
must be spelled exactly as the name of the Windows Active
Directory domain.
9. Click Next
Next.
10. In the Available Servers box, select the servers that you want to connect to
the domain.
Note
• The Domain Members page appears only if there are any
servers available to connect to the domain.
3. Click Domain
Domain.
4. In the Domains box, select the domain that you want to edit.
5. Click Summary
Summary.
Continued on next page
6. In the Windows domain name box, type the name of the customer's
Windows domain, using the same spelling as the name of the Windows Active
Directory domain you want to connect to.
3. Click Domain
Domain.
4. In the Domains box, select the domain for which you wish to edit the
description.
5. Click Summary
Summary.
Continued on next page
3. Click Domain
Domain.
4. In the Domains box, select the domain that you want to edit.
5. Click Policies
Policies.
Continued on next page
3. In the Domains list, select the domain you are adding a server to.
5. In the Available Servers list, select a server and click the Add button .
5. In the Selected Servers list, select the server, and click the Remove button
Note
• You cannot delete the default local domain that was installed with the system.
• You cannot restore a domain that you have deleted.
To delete a domain
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server list, select the server where the domain you are deleting is
located.
3. Click Domain
Domain.
4. In the Domain list, select the domain you are deleting.
Topics
Software Permissions
Software Permissions and User Account Groups
Software Permission Rules
Path Permissions
Command Permissions
Assigning Software Permissions to a User Account
Editing the Software Permissions of a User Account
Assigning Software Permissions to a User Account Group
Editing the Software Permissions of a User Account Group
21 Software Permissions
21.1 Software Permissions
Note
• When creating a new user account, the account has by default no
permissions to access Building Operation.
• Any changes to a software permission settings of a user or user group are
applied next time the user logs on.
For more information, see section 21.2 “Software Permissions and User Account
Groups” on page 431.
Figure: Users inherit the user account group permissions of which they are members
Paul and Susan are members of the Janitor user account group, which includes an
Operator workspace and a set of software permissions. The Janitor group is also a
member of the Operator group. Therefore, the Janitor group inherits the settings
and workspaces of the Operator group. In other words, Paul and Susan share the
software permissions of both the Janitor and the Operator groups, and have access
to the Operator and Janitor workspaces.
Figure: Software permissions and workspaces are assigned to user account groups
Note
The local admin account is always granted access on the local server. For more
information, see section 20.11 “Administration Accounts in Server Local Domain”
on page 426.
Figure: If you change the name of server or folder, you also have to configure the path
permission to the folder.
The System folder and its subfolder, beside the domain folder, are always
accessible by a user though the path permission for the folders are set to No
Access. This means that a user can always at least navigate and view the objects in
the System and its subfolder.
Note
The Domain folder is the only folder subordinated by the System folder that
restricts access to users with the path permission No Access.
Figure: The Domain folder is the only folder of the System subfolders that can be restricted
by the path permission.
Figure: The user account group has only permission to read and comment trend log
objects
Another example could be that a user account group has the path permission Full
Access to a folder that contains BacNet objects. To prevent the users in the user
account group from updating the BacNet firmware, you set the command
permission for this action to Deny. All other command permissions are set to No
Settings. Due to the Full Access path permission, the users can perform all
commands on BacNet devices, beside updating the firmware.
Figure: The user account group has full permission to open and modify BacNet objects,
beside performing firmware update
Building Operation software permissions follow a series of permission rules. You
can use these permission rules to manage the type of data and commands the user
has access to within a workspace, panel, or domain. For more information, see
section 21.1 “Software Permissions” on page 429.
Note
• To facilitate the administration of users and software permissions, it is
recommended that you assign software permissions to groups rather than to
individual user accounts.
• You cannot assign command permissions to an individual user, only path
permissions.
For more information, see section 21.1 “Software Permissions” on page 429.
4. In the Domain list, select the domain the user account belongs to.
5. In the User Accounts list, select the user account you wish to assign path
permissions.
6. Click Software Permissions
Permissions.
7. On the Software Permissions tab, in the path box, step-wise enter a path by
clicking the forward arrow and selecting a new branch in the tree view.
Note
• You cannot assign command permissions to an individual user, only path
permissions.
For more information, see section 21.1 “Software Permissions” on page 429.
4. In the Domain list box, select the domain the user account belongs to.
5. In the User Accounts list box, select the user account you wish to edit path
permissions.
6. Click Software permissions
permissions.
7. On the Software Permissions tab, in the path box, step-wise enter a path by
clicking the forward arrow and selecting a new branch in the tree view.
4. In the Domain box, select a domain for the user account group.
10. In the Category column, select a category that you want to configure
permissions for.
11. In the Command column, select a command.
12. In the Permission box for the command, select a permission level.
4. In the Domain box, select the domain the user account group belongs to.
5. In the User Account Groups box, select the user account group for which
you want to edit the software permissions.
6. Under User Account Groups
Groups, click Software permissions
permissions.
7. In the Path Permissions box, click the forward arrow and select a folder or an
object. Repeat until the folder or object for which you want to assign
permissions is selected.
10. In the Category column, select a category that you want to configure
permissions for.
11. In the Command column, select a command.
Continued on next page
12. In the Permission box for the command, select a permission level.
Topics
Password Administration
Editing a User Account Password
Allowing Users to Change their Password
Changing Your Password
Turning off Remember Me On This Computer
Forcing a User to Change the Password at Next Logon
Preventing Users from Changing Their Passwords
Resetting the Administrator Password
22 Login Configuration
22.1 Password Administration
Note
• If you are an administrator and have forgotten your password, contact the
Building Operation support team.
4. In the Domain list box, select the domain the user account to belongs to.
5. In the User Accounts list box, select the user account for which you wish to
change the password.
6. Click Summary
Summary.
7. On the Summary tab, in the Password box, type the new password.
4. In the Domain list, select the domain the user account group belongs to.
4. In the Domain list box, select the domain the user account belongs to.
4. In the Domain list box, select the domain the user account group belongs to.
5. In the User Account Groups list box, select the user account group.
6. Click Policies
Policies.
7. Clear the May change Password box.
Note
• To authenticate yourself to the Schneider Electric Buildings support team,
you must state your user name and password, the unique logon ID (from the
failed logon attempt), and the domain you tried to log on to.
Topics
Workspaces
Predefined Workspaces
Workspace Components and Customization
Workspace Component Customization
Workspace Content References
Panel Components
Creating a Workspace
Editing the Layout of a Workspace
Editing the Description of a Workspace
Adding a Component to a Workspace
Removing a Component from a Workspace
Editing a Workspace Component
Adding a Workspace to a User Account Group
Removing a Workspace from a User Account Group
Reviewing the Workspace Memberships for a User Account
Group
Creating a Panel
Editing a Panel
WebStation in Kiosk Mode
Configuring WebStation to Run in Kiosk Mode
23 Workspaces
23.1 Workspaces
23.1 Workspaces
The workspace defines the content and layout of WorkStation. The content and
layout of the workspace can be adapted to users or user account groups different
tasks.
You can create different workspaces for different user categories and link them to
user account groups. A user has access to all workspaces linked to the user
account groups to which the user is a member. This way, users can easily switch
workspaces during a work session. For example, Paul, a member of the
Administrators and Janitors user account groups, has access to the Administrator
workspace and Janitor workspace.
Figure: Users gain access to the workspaces linked to their user account groups
If a user account or user account group is assigned to more than one workspace,
WorkStation asks the user to select a default workspace at the first log on. Next
time you log on to Building Operation on the same computer, your default
workspace is automatically displayed. Once logged in you can change your default
workspace settings.
accessible only to that user. A user-modified layout overrides the default layout and
is displayed the next time the user logs on to WorkStation. Workspaces are task
oriented, which means that a user can switch workspaces during a single
WorkStation session.
For more information, see section 23.4 “Workspace Component Customization” on
page 472.
Note
A user customized workspace is locally stored on the computer. The user cannot
access the customized layout when logging on to WorkStation through another
computer.
Note
• A panel can not contain a System Tree.
• A maximum of six levels of panels are allowed in a single pane, the
recommendation for a good user experience is to only use three levels.
In a graphic or in the content of a pane or work area, you can create links that point
to a panel. By using panels you simply streamline the information you want to
present to the user. For example, you have a graphic that represents a room. In the
room illustration you add a fan symbol to which you link a panel containing panes
and a work area that displays the current room airflow and temperature.
To create a workspace
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where you want to create the workspace.
4. In the Domain box, select the server where you want to create the
workspace.
9. Select Visible to display the standard toolbars and menus in the workspace.
10. In the Root path (Applies to Address Bar and System Tree) box, type the
path to the folder that you want to be the root folder for the System Tree and
the Address bar.
11. Click Add to add panes to the workspace.
12. In the object type list, select the type of pane you want to add to the Work
area.
17. In the Default visibility box, select Hidden to make the pane available only
from the View menu and not open in the Work area.
18. In the Display name box, type the name to be displayed on the pane.
19. In the Initial path box, enter the path to the object you want to display in the
pane.
20. Click Create
Create.
21. In the Workspace wizard, click Create
Create.
4. In the Domain box, select the domain the workspace belongs to.
7. In the workspace, resize the frames and adjust the dock positions of the
panes.
8. On the File menu, click Save to save and exit the layout editor.
4. In the Domain box, select the domain the workspace belongs to.
14. In the Default visibility box, select Visible to display the graphic in the
workspace.
15. In the Display name box, type the name to be displayed on the pane.
16. In the Initial path box, select the System Tree location of the component to
add to the workspace.
17. Click Create
Create.
4. In the Domain box, select the domain the workspace belongs to.
8. Click Remove
Remove.
8. Click Edit
Edit.
9. Edit the workspace component properties.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group you want to
add a workspace to.
6. Click Workspaces
Workspaces.
7. In the Available Workspaces list, select the workspace you want to add to
4. In the Domain box, select the domain the workspace belongs to.
want to remove the workspace from, and click the Remove button .
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Workspaces
Workspaces.
To create a panel
1. In WorkStation, in the System Tree pane, select in the folder where you want
to create the panel.
2. On the File menu, click New
New, and then Panel
Panel.
3. In the Name box, type a name for the panel.
6. Click Add to add an object to the panel.you add an object to the panel.
7. In the object type list, select the type of panel component you want to add.
11. In the Show toolbar box, select Yes to show the toolbar of the component.
12. In the Default dock position box, select where the component should be
located.
13. In the Default visibility box, select Visible to show the component in the
panel by default.
14. In the Display name box, type the name to be displayed on the pane.
15. In the Initial path box, enter the path to the object you are adding to the
panel.
To edit of a panel
1. In WorkStation, in the System Tree pane, select the panel you want to edit.
2. Click Properties
Properties.
3. In the Properties pane, edit the properties of the panel.
4. Click OK
OK.
5. Click Close
Close.
Figure: The properties dialog for a shortcut opening WebStation in kiosk mode.
6. Click Next
Next.
7. In the Type name for this shortcut box, type the name, for example
WebStation in Kiosk Mode.
8. Click Finish
Finish.
9. Log on to WebStation using the same account as you want to use for the
kiosk mode.
10. Open the object you want WebStation to display in kiosk mode.
11. Copy the address in the address field.
12. Right-click the Shortcut and click Properties
Properties.
Continued on next page
15. Click OK
OK.
Topics
WorkStation Account Management
Audit Trailing of User Activity
Disabling Audit Trail for a Group of Users
Enabling Audit Trail for a Group of Users
Viewing an Audit Trail Log
WorkStation Account Validation
24 Audit Trails
24.1 WorkStation Account Management
Note
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.
Note
• The system retains a user's historic audit trail even if the user is deleted from
the system.
• Audit trailing is enabled by default.
For more information, see section 24.2 “Audit Trailing of User Activity” on page 512.
4. In the Domain list, select the domain the user account group belongs to.
5. In the User Account Groups list, select the user account group.
6. Click Policies
Policies.
7. Clear the Enable Audit Trailing box.
4. In the Domain list, select the domain the user account group belongs to.
4. In the Domain list, select the domain the user account belongs to.
Account Validation
When you log on to WorkStation you have to quote your user name and password
together with the domain and server you want to log on to. Building Operation
confirms that you are using a valid user account and verifies that correct password
is used. Building Operation also authenticates access to workspaces associated
with your user account group memberships. After validation, Building Operation
retrieves your software permissions and stores them in a user token, valid for this
log on session.
Note
User name, password, and domain name are case sensitive.
Topics
User Management System Tree Icons
Domain Properties
Profile Properties
Workspace Properties
Pane Properties
Panel Properties
Building Operation WorkStation Window
Domain Control Panel
Account Management Control Panel
Select Default Workspace Window
Change Password Dialog Box
Domain Wizard – Authentication Page
Domain Wizard – Domain Policies Page
Domain – Summary Tab
Domain – Policies Tab
Domain – Domain Members Tab
User Account – Summary Tab
User Account – Group Membership Tab
User Account – Profile Tab
User Account – Software Permissions Tab
User Account – Audit Trailing Events Tab
User Account Group Properties
User Account Properties
User Account Group Wizard – Users Belonging to this Group
Page
User Account Group Wizard – Workspaces Belonging to this
Group Page
User Account Group Wizard – Windows Group Name and
Group Polices Page
User Account Group – Summary Tab
User Account Group – Policies Tab
User Account Group – Group Membership Tab
User Account Group – Software Permissions Tab
User Account Group – Workspaces Tab
User Account Wizard – General Page
User Account Wizard – Member Of Page
User Account Management Folder Properties
Workspace Wizard – Workspace Configuration Page
Workspace Wizard – Pane Configuration Page
Workspace – Summary Tab
Workspace – Content Tab
Edit Layout Workspace
Workspace – Members Tab
Panel Wizard – Panel Configuration Page
Domain Wizard – Domain Members Page
Domains Properties
Local Properties
Work Area Window Properties
Create Work Area Window Wizard – Name Page
25 User Management User Interface
25.1 User Management System Tree Icons
Panel
Indicates the object is a panel. For more
information, see section 23.6 “Panel
Components” on page 475.
User Account
Indicates that the object is a user account.
For more information, see section 18.3 “User
Accounts and User Account Groups” on
page 351.
Domain
Indicates that the object is a domain. For
more information, see section 20.1
“Domains” on page 405.
Workspace
Indicates that the object is a workspace. For
more information, see WebHelp.
Work E-mail address Type the work e-mail address of the user.
Continued
Component Description
Show toolbar Select Yes to show the toolbars for the pane
component.
Continued
Component Description
Click here to learn more about Building Click to open the WebHelp home page. For
Operation more information, see WebHelp.
Add (user account) Click to add a new user account. For more
information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Continued
Component Description
Group membership (user account) Click to open the Group Membership tab
where you can edit the group membership of
the selected user account. For more
information, see section 25.18 “User
Account – Group Membership Tab” on page
546.
Software permissions (user account) Click to open the Software Permissions tab
where you can edit or assign individual
software permissions to the selected user
account. For more information, see section
25.20 “User Account – Software
Permissions Tab” on page 549.
Audit trailing events Click to open the Audit Trailing Events tab
where you can view the user triggered
events for the selected user account. For
more information, see section 25.21 “User
Account – Audit Trailing Events Tab” on
page 550.
Add (user account groups) Click to add a new user account group. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Delete (user account group) Click to delete a user account group. For
more information, see section 50.23
“Confirm Delete Dialog Box” on page 1438.
List groups (user account groups) Click to open the user account groups list
view where you can select a user account
group. For more information, see section
46.3 “List View” on page 1315.
Summary (user account groups) Click to open the user account groups
Summary tab where you can edit the
description of the group. For more
information, see section 25.27 “User
Account Group – Summary Tab” on page
559.
Group membership (user account Click to open the Group Membership tab
groups) where you can edit the groups membership
in other groups, and add and remove user
accounts. For more information, see section
25.29 “User Account Group – Group
Membership Tab” on page 561.
Continued
Component Description
Workspaces (user account groups) Click to open the Workspaces tab where
you edit the workspace membership
settings for a user account group. For more
information, see section 25.31 “User
Account Group – Workspaces Tab” on page
565.
User account groups (workspaces) Click to open the workspace Members tab
where you edit the group membership of the
workspace. For more information, see
section 25.40 “Workspace – Members Tab”
on page 577.
Edit layout Click to open the view where you edit the
layout of the workspace. For more
information, see section 25.39 “Edit Layout
Workspace” on page 576.
Servers that are members of this Domain List of all servers in the domain.
Add All
Click to add all available servers to the
domain.
Add
Click to add a server to the domain.
Remove
Click to remove a server from the domain.
Remove All
Click to remove all servers from the domain.
Available User Account Groups Lists available user account groups the
account can be a member of.
Selected User Account Groups Lists the user account groups the account is
a member of.
Add all
Click to connect all available user account
groups to the user account.
Add
Click to connect a user account group to the
user account.
Continued
Component Description
Remove
Click to remove a user account group from
the user account.
Remove all
Click to remove all user account groups from
the user account.
Work E-mail address Type the work e-mail address of the user.
Note
• To simplify the task of administering software permissions, it is recommended
that you assign software permissions to user account groups rather than user
accounts.
Delete
Click to remove a path you have selected.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Refresh
Click to refresh the Audit Trailing Events list..
Allow members to close WorkStation Select to let users log off and close
WorkStation.
Log user actions of group members Select to enable audit trailing for users
belonging to this group.
Allow members to access AS Web Select to enable users to access the Web
Configuration Configuration where you configure the
settings of an Automation Server.
Selected User Accounts Lists user accounts that are members of the
user account group.
Add all
Click to add all user accounts to the user
account group.
Add
Click to add a user account to the user
account group.
Remove
Click to remove a user account from the user
account group.
Continued
Component Description
Remove all
Click to remove all user accounts from the
user account group.
Add all
Click to add all available workspaces to the
user account group.
Add
Click to add a workspace to the user
account group.
Continued
Component Description
Remove
Click to remove a workspace from the user
account group.
Remove all
Click to remove all workspaces from the user
account group.
Note
• The default setting is that all options on the Policies page are selected.
Continued
Component Description
May close User Interface Select to let users log off and close
WorkStation.
May access web user interface Select to enable users to access the Web
Configuration where you configure the
settings of an Automation Server.
Selected User Accounts Lists user accounts that have been added to
the user account group.
Available User Account Groups Lists user account groups that can be added
to the user account group.
Selected User Account Groups Lists user account groups that have been
added to the user account group.
Add all
Click to add all available user accounts or
user account groups to the list of selected
user accounts or user account groups.
Continued
Component Description
Add
Click to add the user account or user
account group to the list of selected user
accounts or user account groups.
Remove
Click to remove the user account or user
account group from the list of selected user
accounts or user account groups.
Remove all
Click to remove all user accounts or user
account groups from the list of selected user
accounts or user account groups.
Add
Click to add the path to which you want to
add software permissions.
Continued
Component Description
Delete
Click to remove a path. For more
information, see section 50.23 “Confirm
Delete Dialog Box” on page 1438.
Add all
Click to add all available workspaces to the
user account group.
Add
Click to add a workspace to the user
account group.
Remove
Click to remove a workspace from the user
account group.
Remove all
Click to remove all workspaces from the user
account group.
Selected User Accounts Groups Lists user account groups that are
connected to the user account group.
Add all
Click to add all user account groups to the
user account.
Add
Click to add a user account group to the
user account.
Remove
Click to remove a user account group from
the user account.
Continued
Component Description
Remove all
Click to remove all user account groups from
the user account.
Root path (Applies to Address Bar and Enter the path to the workspace component.
System Tree)
Continued
Component Description
Root path (Applies to Address Bar and Displays the path to the workspace.
System Tree)
Continued
Component Description
Save
Click to store and close the workspace
layout.
Available User Account Groups Lists user account groups that are available
to be connected to the workspace.
Selected User Account Groups Lists user account groups that are
connected to the workspace.
Add all
Click to connect all available user account
groups to the workspace.
Add
Click to connect a user account group to the
workspace.
Remove
Click to disconnect a user account group
from the workspace.
Remove all
Click to disconnect all user account groups
from the workspace.
Initial path Click to enter the path for the Work Area
component.
Show toolbars Select Yes to show the toolbars for the Work
Area component.
Servers that are members of this Domain List of all servers in the domain.
Add All
Click to add all available servers to the
domain.
Add
Click to add a server to the domain.
Remove
Click to remove a server from the domain.
Remove All
Click to remove all servers from the domain.
Topics
Alarm Overview
Alarm States
Alarm Functions
Alarm Objects in Multiple Servers
Alarms Pane and Alarm View Customization
Styling the Alarm States in the Alarms Pane and Alarm
Views
Alarm Filter Conditions
Creating a Filtered Alarm View
Displaying Alarm View on an Alarm
26 Alarms Introduction
26.1 Alarm Overview
You can configure the alarm in different ways whether or not a user has to
acknowledge the alarm before it returns to normal state.
26.3.3 Deadband
Deadband is an area of the alarm range where no reset action occurs. The purpose
of the deadband is to prevent unintentional activation-deactivation cycles.
For more information, see section 28.5 “Deadband” on page 681.
26.3.5 Priority
When configuring an alarm, you define the priority of the alarm. The priority is used
to inform the operator of the importance of the triggered alarm. The priority is
displayed in the Alarms pane, Events pane, Alarm Views, and Event Views.
For more information, see section 28.8 “Priority” on page 684.
26.3.6 Categories
You can group together alarms in categories to simplify the identification of the
alarm. When the alarm is triggered, the category name is displayed together with
the alarm in the Alarms pane, Events pane, Alarm Views, and Event Views.
For more information, see section 28.10 “Categories” on page 686.
26.3.7 Acknowledgement
When an alarm is triggered, you acknowledge the alarm to indicate to other users
that you have responded to the alarm and intend to troubleshoot the problem that
caused the alarm. The name of the user that acknowledges the alarm is displayed
in the Alarms pane, Events pane, Alarm Views, and Event Views.
For more information, see section 28.14 “Acknowledgement” on page 692.
26.3.9 Notifications
User notifications are used for notifying users or user groups that a certain alarm
event has occurred in the system. The notification contains a prewritten message
that is either sent in an E-mail or written to a text file. When setting up the
notification, you write the message and then configure the conditions that execute
the writing or sending action.
For more information, see section 28.21 “Notifications” on page 700.
Note
You cannot define a unit to an alarm that monitors a unitless variable.
For more information, see section 28.28 “Unit of Measure in Alarms” on page 718.
26.3.12 Attachments
You can add attachments to alarm objects, except system information alarms. An
attachment is a link pointing to an object in the system, such as a report, a voice
message, or a trend chart. When an alarm is triggered that has an attachment, a
paperclip icon is displayed in the Alarms pane and Alarm Views. It is also possible to
configure the attachment to display when the alarm is triggered.
Note
When a top server is connected to a tier level server, all existing checklists, action
notes, cause notes, and categories on the tier level server are removed and
replaced with the objects from the top server.
To style the alarm states in the Alarms pane and Alarm Views
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Alarm appearance
appearance.
3. In the Alarm Styles view, double-click the alarm state you want to style.
5. Select the font, font style, and font size that you want to use in the Alarms
pane and Alarm Views.
6. Click OK
OK.
7. In the Background color box, click the Browse button.
Continued on next page
8. Select the color for the background of the alarm state row.
9. Click OK
OK.
10. In the Font color box
box, click the Browse button.
11. Select the color for the font of the alarm state text.
12. Click OK
OK.
Acknowledge time Select to filter by the time and date the alarm
was acknowledged.
Continued
Component Description
Continued
Component Description
Referenced bit string Select to filter alarms by the new value of the
referenced bit string property.
Continued
Component Description
11. Click the Add row button to add another condition of the same type.
12. Type the condition for the filter.
Tip
• You can add different condition types by clicking the Add
13. Click OK
OK.
4. Click OK
OK.
Topics
Alarm Types
Change of State Alarm
Creating a Change of State Alarm
Multistate Alarm
Creating a Multistate Alarm
Matching Text String Alarm
Creating a Matching Text String Alarm
Variable Status Alarm
Creating a Variable Status Alarm
Out of Range Alarm
Creating an Out of Range Alarm
Out of Reference Range Alarm
Creating an Out of Reference Range Alarm
Sum Alarm
Creating a Sum Alarm
Enumeration Alarm
Creating an Enumeration Alarm
System Information Alarms
Configuring the Description of an Alarm
Configuring Attachments of an Alarm
Removing Attachments from an Alarm
27 Alarm Types
27.1 Alarm Types
Figure: Change of state alarm when the monitored variable goes true
Figure: Change of state alarm when the monitored variable goes false
For example, you set up a change of state alarm that monitors a ventilation fan. If
the fan breaks or stops working, the alarm is triggered.
You can configure the change of state alarms using shunt variable and time delay.
For more information, see section 26.3 “Alarm Functions” on page 590.
7. Select the state of the monitored variable that triggers the alarm:
• Click True to trigger the alarm when the monitored variable is equal to
True
True.
• Click False to trigger the alarm when the monitored variable is equal to
False
False.
8. In the Monitored variable box, enter the variable that the alarm monitors.
9. In the Disable alarm box, select whether or not to create the alarm in disabled
mode.
10. Under Time delay and shunt variable
variable, in the Alarm delay box, enter the
time delay.
11. In the Reset delay box, enter the time delay.
Continued on next page
15. In the Reset message box, type the message to display when the alarm is
reset.
16. In the Alarm priority box, enter the priority for the alarm state.
Continued on next page
17. Select the Same priority check box to let the Reset priority box inherit the
value in the Alarm priority box.
18. In the Reset priority box, enter the priority for the reset state.
19. Under Category and Alerts
Alerts, in the Category box, enter a category for the
alarm.
20. Select the Flashing alert check box to make the alarm flash in the Alarms
pane and Alarm Views when it is triggered.
21. Select the Audible alert check box to make the alarm sound when it is
triggered.
24. In the Cause note group box, enter a cause note group that you want to
connect to the alarm.
25. In the Action note group box, enter an action note group that you want to
connect to the alarm.
26. In the Checklist box, enter a checklist that you want to connect to the alarm.
27. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
28. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
29. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
30. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
Continued on next page
34. In the Select Object dialog box, select the object you want to attach to the
alarm.
35. Click Select
Select.
36. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
Note
• The trigger values and the monitored variable must be integer.
Figure: Multistate alarm triggers an alarm when the monitored variable goes inside the
configured range or a single value.
For example, you have a function block program with an output variable that
generates integer values for different states. By using a multistate alarm, you can
monitor a specific value or several value ranges.
You can configure multistate alarms using shunt variable and time delay. For more
information, see section 26.3 “Alarm Functions” on page 590.
9. Click the Set unit button to add a unit to the alarm limits and deadband.
Note
• To define a unit of the alarm, the monitored variable must have a
defined unit.
21. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.
22. In the Reset message box, enter the message to display when the alarm is
reset.
23. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
24. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
25. In the Reset priority box, enter the priority of the alarm when it is reset.
26. In the Category box, enter the category that the alarm belongs to.
27. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
28. Select Audible alert to make the alarm sound when it is triggered.
29. Click Next
Next.
Continued on next page
31. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
32. In the Action note group box, select the action note group that you want to
connect to the alarm.
33. In the Checklist box, select the checklist that you want to connect to the
alarm.
34. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
35. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
Continued on next page
36. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
37. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
38. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to specify how the user should respond to the listed
actions.
39. Click Next
Next.
40. Click the Add attachment button to add an attachment to the alarm.
41. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
42. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
43. Click Create
Create.
Note
• The text string is case sensitive and must be written exactly as
the monitored variable text output.
15. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.
16. In the Reset message box, enter the message to display when the alarm is
reset.
17. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
18. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
19. In the Reset priority box, enter the priority of the alarm when it is reset.
20. In the Category box, enter the category that the alarm belongs to.
21. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
22. Select Audible alert to make the alarm sound when it is triggered.
23. Click Next
Next.
Continued on next page
25. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
26. In the Action note group box, select the action note group that you want to
connect to the alarm.
27. In the Checklist box, select the checklist that you want to connect to the
alarm.
28. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
Continued on next page
29. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
30. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
31. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
32. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
33. Click Next
Next.
34. Click the Add attachment button to add an attachment to the alarm.
35. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
36. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
37. Click Create
Create.
Figure: The text in the Monitored value column shows that the status of the variable is
forced
7. Select Forced to trigger the alarm when the monitored variable status
changes to force.
8. Select Overridden to trigger the alarm when the monitored variable status
changes to override.
9. In the Monitored variable box, enter the variable that the alarm monitors.
10. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
11. In the Alarm delay box, enter the time delay before the alarm is triggered.
12. In the Reset delay box, enter the time delay before the alarm is reset.
13. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
14. Click Next
Next.
Continued on next page
15. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.
16. In the Reset message box, enter the message to display when the alarm is
reset.
17. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
18. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
19. In the Reset priority box, enter the priority of the alarm when it is reset.
20. In the Category box, enter the category that the alarm belongs to.
21. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
22. Select Audible alert to make the alarm sound when it is triggered.
23. Click Next
Next.
Continued on next page
25. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
26. In the Action note group box, select the action note group that you want to
connect to the alarm.
27. In the Checklist box, select the checklist that you want to connect to the
alarm.
28. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
Continued on next page
29. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
30. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
31. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
32. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
33. Click Next
Next.
34. Click the Add attachment button to add an attachment to the alarm.
35. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
36. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
37. Click Create
Create.
Figure: Out of range alarm triggers an alarm when the monitored variable goes outside the
configured range.
For example, you set up an out of range alarm that monitors the temperature in a
server room. The alarm is triggered when the temperature goes outside the range of
20 °C to 25 °C (68 °F to 77 °F).
You can configure out of range alarms using shunt variable, time delay, and
deadband. For more information, see section 26.3 “Alarm Functions” on page 590.
7. In the Upper limit box, enter an upper limit for the alarm.
8. In the Lower limit box, enter a lower limit for the alarm.
9. In the Deadband box, enter a deadband for the alarm.
10. In the Monitored variable box, enter the variable that the alarm monitors.
11. Click the Set unit button to enter or change the unit of measure for the
alarm limits and deadband.
Note
• If the monitored value has a unit of measurement defined, the
alarm limits and deadband are assigned that unit by default.
18. In the Shunt variable box, enter the digital variable that enables or disables
the alarm.
21. In the Below lower limit message box, type the message to display when
the alarm falls below the lower limit.
Continued on next page
22. In the Reset message box, type the message to display when the alarm is
reset.
23. In the Priorities area, in the Above upper limit priority box, enter the priority
for the upper limit of the alarm state.
24. Select the Same priority check box to let all priorities inherit the value in the
Above upper limit priority box.
25. In the Below lower limit priority box, enter the priority for the lower limit of
the alarm state.
26. In the Reset priority box, enter the priority for the reset state.
27. Under Category and Alerts
Alerts, in the Category box, enter a category for the
alarm.
28. Select the Flashing alert check box to make the alarm flash in the Alarms
pane and Alarm Views when it is triggered.
29. Select the Audible alert check box to make the alarm sound when it is
triggered.
32. In the Cause note group box, enter the cause note group that you want to
connect to the alarm.
33. In the Action note group box, enter the action note group that you want to
connect to the alarm.
34. In the Checklist box, enter the checklist that you want to connect to the
alarm.
35. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
36. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
37. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
38. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
Continued on next page
42. In the Select Object dialog box, select the object you want to attach to the
alarm.
43. Click Select
Select.
44. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
Note
• An out of range alarm with upper deviation limit, lower deviation limit, and
deadband set to zero must meticulously follow the reference variable to not
trigger the alarm.
Figure: Out of reference alarm triggers an alarm when the monitored variable goes outside
the upper or lower deviation limit of the reference variable.
For example, you have a reference variable that is designed to follow the optimal
room temperature in a office. By connecting the reference variable and the variable
from a thermistor, placed in the office, to an out of reference range alarm, you can
set up the alarm to trigger when the temperature differs more than 5 °C (41°F) from
the reference variable.
You can configure out of reference range alarms using shunt variable, time delay,
and deadband. For more information, see section 26.3 “Alarm Functions” on page
590.
7. In the Upper deviation limit box, enter the upper limit the monitored variable
is allowed to deviate from the reference variable before the alarm is triggered.
8. In the Lower deviation limit box, enter the lower limit the monitored variable
is allowed to deviate from the reference variable before the alarm is triggered.
9. In the Deadband box, enter the range the monitored variable has to pass
within the normal range before the alarm is reset.
10. In the Monitored variable box, enter the variable that the alarm monitors.
11. Click the Set unit button to select the unit of measure for the alarm limits
and deadband.
Note
• If the monitored value has a unit of measurement defined, the
alarm limits and deadband are assigned that unit by default.
19. In the Shunt variable box, enter the digital variable that enables or disables
the alarm.
22. In the Below lower limit message box, type the message to display when
the monitored variable falls below the lower alarm limit.
23. In the Reset message box, type the message to display when the alarm is
reset.
24. In the Priorities area, in the Above upper limit priority box, enter the priority
of the alarm when the monitored variable exceeds the upper alarm limit.
25. Select the Same priority check box to let all priorities inherit the value in the
Above upper limit priority box.
26. In the Below lower limit priority box, enter the priority of the alarm when the
monitored variable falls bellow the lower alarm limit.
27. In the Reset priority box, enter the priority for alarm when it is reset.
28. Under Category and Alerts
Alerts, in the Category box, enter the category that the
alarm belongs to.
29. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
30. Select Audible alert to make a sound when the alarm is triggered.
33. In the Cause note group box, enter the cause note group that you want to
connect to the alarm.
34. In the Action note group box, enter the action note group that you want to
connect to the alarm.
35. In the Checklist box, enter the checklist that you want to connect to the
alarm.
36. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
37. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
38. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
39. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
Continued on next page
42. Click the Add attachment button to add an attachment to the alarm.
43. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
44. On the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
45. Click Create
Create.
7. Click the Add condition button to add a denominators that sort out the
alarms to monitor.
8. Enter the necessary information to specify the option that sorts out the alarms
to monitor.
9. In the Disable alarm box, select whether or not to create the alarm in disabled
mode.
10. In the Alarm delay box, enter the time delay before the alarm is triggered.
11. In the Reset delay box, enter the time delay before the alarm is reset.
12. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
13. Click Next
Next.
Continued on next page
14. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.
15. In the Reset message box, enter the message to display when the alarm is
reset.
16. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
17. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
18. In the Reset priority box, enter the priority of the alarm when it is reset.
19. In the Category box, enter the category that the alarm belongs to.
20. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
21. Select Audible alert to make the alarm sound when it is triggered.
22. Click Next
Next.
Continued on next page
24. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
25. In the Action note group box, select the action note group that you want to
connect to the alarm.
26. In the Checklist box, select the checklist that you want to connect to the
alarm.
27. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
Continued on next page
28. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
29. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
30. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
31. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
32. Click Next
Next.
33. Click the Add attachment button to add an attachment to the alarm.
34. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
35. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
36. Click Create
Create.
Figure: Alarm wizard example when creating an enumeration alarm that monitors the
reliability enumeration value of an I/O variable.
Enumeration alarms can be configured using shunt variable and time delay. For
more information, see section 26.3 “Alarm Functions” on page 590.
7. In the Monitored variable box, enter the object and its enumeration type that
the alarm monitors.
8. Under Trigger alarm when variable is is, select the enumeration options of the
enumeration type that triggers the alarm.
9. Click Select
Select.
10. In the Disable alarm box, select whether or not to create the alarm in
disabled mode.
11. In the Alarm delay box, enter the time delay before the alarm is triggered.
12. In the Reset delay box, enter the time delay before the alarm is reset.
13. In the Shunt variable box, enter the boolean variable that enables or disables
the alarm.
14. Click Next
Next.
Continued on next page
15. In the Alarm message box, enter the message to display when the monitored
variable goes with or is equal to the alarm limits.
16. In the Reset message box, enter the message to display when the alarm is
reset.
17. In the Alarm priority box, enter the priority of the alarm when the monitored
variable triggers the alarm.
18. Select the Same priority check box to let all priorities inherit the value in the
Alarm priority box.
19. In the Reset priority box, enter the priority of the alarm when it is reset.
20. In the Category box, enter the category that the alarm belongs to.
21. Select Flashing alert to make the alarm flash in the Alarms pane and Alarm
Views when it is triggered.
22. Select Audible alert to make the alarm sound when it is triggered.
23. Click Next
Next.
Continued on next page
25. In the Cause note group box, select the cause note group that you want to
connect to the alarm.
26. In the Action note group box, select the action note group that you want to
connect to the alarm.
27. In the Checklist box, select the checklist that you want to connect to the
alarm.
28. Select the When acknowledging an alarm: Comment check box to force
the user to add a comment to the alarm before the alarm can be
acknowledged.
Continued on next page
29. Select the When acknowledging an alarm: Cause note check box to force
the user to edit the connected cause note before the alarm can be
acknowledged.
30. Select the When acknowledging an alarm: Action note check box to force
the user to edit the connected action note before the alarm can be
acknowledged.
31. Select the When acknowledging an alarm: Checklist check box to force the
user to go through the connected checklist before the alarm can be
acknowledged.
32. Under Required user actions
actions, select the check boxes for Comment
Comment, Cause
note
note, and Action note to force the user to act on the listed actions.
33. Click Next
Next.
34. Click the Add attachment button to add an attachment to the alarm.
35. In the Select Object dialog box, select the object you want to attach to the
alarm and then click Select
Select.
36. In the Attachment page, in the Display on alarm column, select the check
box to automatically open the attachment when the alarm is triggered.
37. Click Create
Create.
Note
Note
Topics
Time Delay
Configuring the Delay Time of an Alarm
Shunt Variable
Editing the Shunt Variable
Deadband
Alarm Messages
Configuring the Alarm Message of an Alarm
Priority
Configuring the Priority of an Alarm
Categories
Creating a Category
Configuring the Category of an Alarm
Editing a Category
Acknowledgement
Configuring the Acknowledgement Type of an Alarm
Single Acknowledge
No Acknowledge
Extended Acknowledge
User Actions
Configuring Forced User Action
Notifications
Creating an E-mail Notification
Setting Up a Write to File Notification
Selecting the Schneider Electric E-mail Server for E-mail
Notifications
Substitution Codes for Notifications
Automatic Assignment
Creating an Automatic Assignment
Unit of Measure in Alarms
Configuring the Limits of an Alarm
Configuring the Flashing of an Alarm
Configuring the Audibility of an Alarm
28 Alarms Functions
28.1 Time Delay
4. In the Reset delay box, enter the time delay before an alarm is reset.
5. In the Changes have been made dialog box, click Yes to save the changes.
3. In the Changes have been made dialog box, click Yes to save the changes.
28.5 Deadband
Deadband is an area of the alarm range where no reset action occurs. The purpose
of the deadband is to prevent unintentional activation-deactivation cycles.
For example, an out of range alarm has an upper limit of 10 and the deadband is 2.
The monitored variable must be equal to or fall below 8 (10-2) before the triggered
alarm is reset.
Figure: The monitored variable has to reach the limit of the deadband before the alarm is
reset.
Deadband can be set for out of range alarms and out of reference range alarms.
For example, you create an alarm that is monitoring a temperature object named
T64. You write an alarm message that says: “The point @(O) is too hot.” When the
temperature value increases to 35, the alarm is triggered. The alarm with its alarm
message is presented in the Alarms pane and Alarm Views: “The point T64 is too
hot.”
4. In the Changes have been made dialog box, click Yes to save the changes.
28.8 Priority
When configuring an alarm, you define the priority of the alarm. The priority is used
to inform the operator of the importance of the triggered alarm. The priority is
displayed in the Alarms pane, Events pane, Alarm Views, and Event Views.
You can configure different priority levels for different states in the alarm. The default
priority number of an alarm is 100. However, you can change this number to any
integer between 0 and 999. You define what is high priority and what is low priority.
For example, you create two alarms, alarm A and B. Alarm A is more critical than
Alarm B. Therefore, it is given a higher priority level when the alarm is triggered but a
lower priority if the alarm is reset. When both alarms are triggered at the same time,
the priority levels of the alarms can guide the operator towards which alarm to work
with first. When the problem that triggered the alarm with highest priority is
corrected, the alarm goes to the reset state that has a lower priority than the
second alarm.
4. In the Priorities boxes, enter the priority for each alarm state.
5. In the Changes have been made dialog box, click Yes to save the changes.
28.10 Categories
You can group together alarms in categories to simplify the identification of the
alarm. When the alarm is triggered, the category name is displayed together with
the alarm in the Alarms pane, Events pane, Alarm Views, and Event Views.
For example, you create a category called “Building A” and add all alarms
represented in the building to this category. Another example could be that you
create a category called “Door alarm” and select this category for every door alarm
in the system.
To create a category
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. In the Server box, select the server where you want to create the category.
4. Click the Categories tab, and then click the Add category button .
Continued on next page
To edit a category
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Categories
Categories.
Note
• To permanently remove a category from the categories list, click
5. In the Edit Category dialog box, in the Name box, type a name for the
category.
28.14 Acknowledgement
When an alarm is triggered, you acknowledge the alarm to indicate to other users
that you have responded to the alarm and intend to troubleshoot the problem that
caused the alarm. The name of the user that acknowledges the alarm is displayed
in the Alarms pane, Events pane, Alarm Views, and Event Views.
Alarms can be configured to be acknowledged in different ways. The transition
between alarm states depends on the Basic evaluation property of the alarm.
28.14.2 No Acknowledge
The no acknowledge property means that a triggered alarm immediately returns to
normal state when the problem that triggered the alarm is corrected. You can still
acknowledge a triggered alarm to other users that you have responded to the
alarm, although this action is not mandatory or affects the alarm handling.
For more information, see section 28.17 “No Acknowledge” on page 695.
4. In the Changes have been made dialog box, click Yes to save the changes.
Figure: Single Acknowledge loop where the alarm is acknowledged either when the alarm
is Acknowledged or reset.
28.17 No Acknowledge
The no acknowledge property means that a triggered alarm immediately returns to
normal state when the problem that triggered the alarm is corrected. You can still
acknowledge a triggered alarm to other users that you have responded to the
alarm, although this action is not mandatory or affects the alarm handling.
Figure: No Acknowledge loop where the alarm does not have to be acknowledged before
the alarm returns to normal state.
Figure: Extended Acknowledge loop where the alarm reset state must be acknowledged
before the alarm returns to normal state
Note
When a top server is connected to a tier level server, all existing checklists, action
notes, cause notes, and categories on the tier level server are removed and
replaced with the objects from the top server.
28.19.1 Comments
Use comments to save written information about an alarm. Comments can be
added and viewed at any time. A comment is automatically tagged with the user
name and a time and date stamp. Useful comments could be the cause of the
alarm and how it was taken care of. Information like this can be of great help the
next time the same alarm is triggered.
For more information, see section 29.1 “Comments” on page 725.
28.19.4 Checklists
A checklist is a set of steps that guides the user to which action to take when an
alarm is triggered. If an alarm goes to normal state, the corresponding checklist is
also reset and each step has to be checked again.
For more information, see section 29.10 “Checklists” on page 738.
Cause Notes A predefined list of the Use the cause notes to easily
problems that can have report the cause that
caused the alarm. triggered the alarm.
Action Notes A predefined list of possible Use the action notes to easily
actions that can correct the report the actions that were
problem. taken to correct the problem
that triggered the alarm.
4. In the Changes have been made dialog box, click Yes to save the changes.
28.21 Notifications
User notifications are used for notifying users or user groups that a certain alarm
event has occurred in the system. The notification contains a prewritten message
that is either sent in an E-mail or written to a text file. When setting up the
notification, you write the message and then configure the conditions that execute
the writing or sending action.
Note
If the server fails to send an E-mail notification, this is indicated by a system
information alarm. For more information, see section 27.18 “System Information
Alarms” on page 671.
8. In the Notify on boxes, select the alarm status for when to generate the
notification.
9. In the E-mail address box, type the E-mail address of the recipient of the E-
mail messages.
10. In the Subject box, type the subject of the E-mail message.
11. In the Text box, type the notification message, which can include substitution
codes. For more information, see section 28.25 “Substitution Codes for
Notifications” on page 711.
Continued on next page
12. Click the Add condition button and select the condition type that is to
generate the E-mail notification.
14. Click the Add row button to add another condition of the same type.
15. Type the condition for the E-mail notification.
Tip
• You can add different condition types by clicking the Add
7. In the Status box, select Enable to activate the write to file notification.
8. In the Notify on boxes, select the alarm status for when to generate the
notification.
9. In the File name box, type the name of the file where the message is written.
Note
• If a file already exists with this name, the system writes the
message in the end of the file. If it does not exist, the system
creates a new file..
• The file is located in the database folder. For more information,
see section 14.1 “Software Administrator” on page 277.
10. In the Text box, type the message that is written to the notification file.
Note
• You can use substitution codes to let the system automatically
write system information in the notification message.
11. Click the Add condition button to set up the events that generate the writing
Note
• You can add several event categories to specify when to write
the notification.
13. Click the Add row button to add another condition of the same type.
14. Click Create
Create.
Note
• Any available SMTP server can be used to send E-mail notifications. For more
information, see WebHelp.
4. In the Select E-mail server box, select Schneider Electric E-mail Server to
use the SMTP server hosted by Schneider Electric.
5. In the Sender E-mail box, type a sender address for the E-mail messages
that are generated by this Building Operation server. The sender E-mail
address is the receiver of replies.
6. In the Maximum queue size box, enter the maximum number of E-mail
messages that is allowed in the queue.
7. In the Maximum retry count box, enter the number of attempts to send an E-
mail message that are performed before cancelling the E-mail message.
8. In the Retry time box, enter the number of minutes between each attempt.
9. In the Host box, confirm that the Schneider Electric E-mail Server address is
smtpservice.tac.com
smtpservice.tac.com.
10. In the SMTP port box, confirm that the port number is 25
25.
11. Click OK
OK.
Continued
Code Description
Continued
Code Description
Continued
Code Description
For example, you configure a write to file notification that is sent when an alarm is
triggered. For notification text, you write "The room became too hot at
@(TriggeredTimestamp)". If the alarm is triggered at the time 2015-02-12 13:51:36,
the notification file will contain the text: "The room became too hot at 2015-02-12
13:51:36."
7. In the Assigned to box, enter the user or user group that is the receiver of the
assignment request.
8. In the Active value box, enter the multistate value that activates the
assignment.
9. In the Schedule box, enter the schedule or other multistate variable that
contains the value that is used to activate the assignment.
10. Click the Add Condition button to set up the conditions that generate the
assignment.
11. Enter the settings of the condition.
Tip
You can add several assignment conditions to specify when to write
the assignment.
12. Click the Add row button to add another condition of the same condition
type.
13. Click Create
Create.
Note
You cannot define a unit to an alarm that monitors a unitless variable.
If the unit of a monitored variable is replaced by a unit within the same unit category
as the unit of the alarm, Building Operation automatically handles the conversion. If
the unit of the monitored variable is replaced by a unit that belongs to another unit
category, the alarm is disabled by Building Operation. Building Operation triggers a
system alarm to notify that the alarm is disabled due to an impossible unit
conversion.
4. In the Changes have been made dialog box, click Yes to save the changes.
Topics
Comments
Cause Notes
Creating a Cause Note
Editing a Cause Note
Adding a Cause Note to an Alarm
Action Notes
Creating an Action Note
Editing an Action Note
Adding an Action Note to an Alarm
Checklists
Creating a Checklist
Editing a Checklist
Adding a Checklist to an Alarm
29 User Actions
29.1 Comments
29.1 Comments
Use comments to save written information about an alarm. Comments can be
added and viewed at any time. A comment is automatically tagged with the user
name and a time and date stamp. Useful comments could be the cause of the
alarm and how it was taken care of. Information like this can be of great help the
next time the same alarm is triggered.
3. In the Cause notes view, click the Add cause note button .
4. In the Add Cause Note dialog box, in the Name box, type the name of the
new cause note.
5. In the Group name box, type a name to create a new group or select an
existing group that the new cause note belongs to.
6. In the Description box, type a description for the cause note.
7. Click OK
OK.
3. In the Cause notes view, select the cause note you want to edit.
Note
• To permanently remove a cause note from the cause notes list,
5. In the Edit Cause Note dialog box, in the Name box, type a name for the
cause note.
6. In the Group name box, type a name to create a new group or select an
existing group.
7. In the Description box, type a description for the cause note
8. Click OK
OK.
3. In the Action notes view, click the Add action note button .
4. In the Add Action Note dialog box, in the Name box, type the name of the
new action note.
5. In the Group name box, type a name to create a new group or select an
existing group.
6. In the Description box, type a description for the action note.
7. Click OK
OK.
3. In the Action notes view, select the action note you want to edit.
Note
• To permanently remove an action note from the action notes list,
5. In the Edit Action Note dialog box, in the Name box, type a name for the
action note.
6. In the Group name box, type a name to create a new group or select an
existing group.
7. In the Description box, type a description for the action note.
8. Click OK
OK.
29.10 Checklists
A checklist is a set of steps that guides the user to which action to take when an
alarm is triggered. If an alarm goes to normal state, the corresponding checklist is
also reset and each step has to be checked again.
To create a checklist
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Checklists
Checklists.
4. In the Add Checklist dialog box, in the Name box, type the name of the new
checklist.
8. Click OK.
Note
• You can add several steps to the checklist.
To edit a checklist
1. In WorkStation, on the Tools menu, click Control Panel
Panel.
2. On the Control Panel
Panel, click Checklists
Checklists.
Note
• To permanently remove a checklist, click the Remove checklist
button .
4. In the Edit Checklist dialog box, in the Name box, type the name of the new
checklist.
6. Select a step in the checklist and click the Edit step button to edit the
checklist step.
Note
• In the Edit checklist step dialog box you can add new steps to
7. In the Edit checklist step dialog box, in the Name box, type the new text for
the step.
8. Click OK
OK.
9. Select a step in the checklist and click the Move step up button to move
the step upwards in the checklist.
10. Select a step in the checklist and click the Move step down button to
move the step downwards in the checklist.
11. In the Edit Checklist dialog box, click OK
OK.
Topics
Alarms Pane and Alarm View
Alarms Pane and Alarm View Toolbar
Alarms Pane and Alarm View Icons
Alarm and Event Details View
Alarm System Tree Icons
Change of State Alarm Properties – Basic Tab
Change of State Alarm Properties – Advanced Tab
Multistate Alarm Properties – Basic Tab
Multistate Alarm Properties – Advanced Tab
Matching Text String Alarm Properties – Basic Tab
Matching Text String Alarm Properties – Advanced Tab
Out of Range Alarm Properties – Basic Tab
Out of Range Alarm Properties – Advanced Tab
Out of Reference Range Alarm Properties – Basic Tab
Out of Reference Range Alarm Properties – Advanced Tab
Sum Alarm Properties – Basic Tab
Sum Alarm Properties – Advanced Tab
Enumeration Alarm Properties – Basic Tab
Enumeration Alarm Properties – Advanced Tab
Variable Status Alarm Properties – Basic Tab
Variable Status Alarm Properties – Advanced Tab
Function Block Program Internal Alarm Properties - Basic
Tab
Function Block Program Internal Alarm Properties -
Advanced Tab
Create Alarm Wizard – Presentation Page
Create Alarm Wizard – User Action Page
Create Alarm Wizard – Attachment Page
Create Change of State Alarm Wizard – Alarm Trigger Page
Create Multistate Alarm Wizard – Alarm Trigger Page
Create Matching Text String Alarm Wizard – Alarm Trigger
Page
Create Out of Range Alarm Wizard – Alarm Trigger Page
Create Out of Reference Range Alarm Wizard – Alarm
Trigger Page
Create Sum Alarm Wizard – Alarm Trigger Page
Create Enumeration Alarm Wizard – Alarm Trigger Page
Create Variable Status Alarm Wizard – Alarm Trigger Page
Alarm Trigger Properties - Basic Tab
Alarm Trigger Properties – Range Tab
Alarm Trigger Properties – Value tab
Alarm Trigger Properties – Value tab
Attachment Properties
Alarm Control Panel Properties
User Action Properties
Alarm Styles View
Alarm Styles Properties
Acknowledged Style Properties
Alarm Style Properties
Disabled Style Properties
Fault Style Properties
Reset Style Properties
Alarm Control Panel – Categories View
Add Category Dialog Box
Edit Category Dialog Box
Category Properties
Categories Properties
Alarm Control Panel – Cause Notes View
Add Cause Note Dialog Box
Edit Cause Note Dialog Box
Cause Notes Properties
Cause Note Group Properties
Cause Note Properties
Alarm Control Panel – Action Notes View
Add Action Note Dialog Box
Edit Action Note Dialog Box
Action Notes Properties
Action Note Group Properties
Action Note Properties
Alarm Control Panel – Checklists View
Add Checklist Dialog Box
Edit Checklist Dialog Box
Add Checklist Step Dialog Box
Edit Checklist Step Dialog Box
Checklists Properties
Checklist Properties
Checklist Step Properties
Alarm – Basic Settings View
Select Conditions Dialog Box – Alarm Filter Properties
Create Email Notification Wizard – Email Notification Page
Email Notification View
E-Mail Notification Properties
Write to File Notification View
Write to File Notification Properties
Assignment View
Assignment Properties
Alarm Properties
Object Specific Event View Toolbar
Progress View
Alarm Handling Properties
Alarm Properties
30 Alarms User Interface
30.1 Alarms Pane and Alarm View
Acknowledge
Click to acknowledge alarm state or reset
state.
For more information, see WebHelp.
Enable alarm
Click to enable the alarm. If the alarm state
changed, for example, from alarm state to
normal state during the time the alarm was
disabled, the alarm is given the new state
once it is enabled.
For more information, see WebHelp.
Disable alarm
Click to disable the alarm. The alarm is
inactivated and cannot be acknowledged or
reset until it is enabled.
For more information, see WebHelp.
Unhide alarm
Click to show the alarm.
For more information, see WebHelp.
Hide alarm
Click to hide the alarm in the Alarms pane or
Alarm View. The alarm is still logged in the
Event log.
For more information, see WebHelp.
Add comment
Click to add a comment to the alarm.
For more information, see WebHelp.
Continued
Button Description
Checklist
Click to view the checklist for the alarm.
For more information, see WebHelp.
Show alarm
Click to open the settings of the alarm in the
Work Area.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Alarm filter
Click to select the conditions for the alarm
display in the Alarms pane. For more
information, see section 26.7 “Alarm Filter
Conditions” on page 598.
Detail view
Use the Detail view button to display detailed
information about all properties of a selected
event, in an added view. For more
information, see section 30.4 “Alarm and
Event Details View ” on page 753.
For more information, see WebHelp.
Normal
Indicates that the alarm is idle and the
variable the alarm monitors does not satisfy
the configured alarm criteria. For more
information, see section 26.2 “Alarm States”
on page 589.
Alarm
Indicates that an alarm is triggered. For more
information, see section 26.2 “Alarm States”
on page 589.
Acknowledged
Indicates that a user has acknowledged the
alarm. The problem that caused the alarm
has not been corrected. For more
information, see section 26.2 “Alarm States”
on page 589.
Reset
Indicates that the problem that caused the
alarm is corrected. A user needs to
acknowledge the alarm to change the alarm
state to normal. For more information, see
section 26.2 “Alarm States” on page 589.
Disabled
Indicates that the alarm is disabled by a
user. Disabled alarms are by default hidden
in the Alarms pane and Alarm View. For
more information, see section 26.2 “Alarm
States” on page 589.
Fault
Indicates that the value reported from
hardware, such as a BACnet device, is not
trustworthy. For more information, see
section 26.2 “Alarm States” on page 589.
Attachment
Indicates that the alarm has an object
attached. For more information, see
WebHelp.
Alarm handling
Indicates alarm handling objects that can be
connected to an alarm. For more
information, see section 26.3 “Alarm
Functions” on page 590.
Disabled alarm
Indicates that the alarm has been disabled.
The icon is displayed regardless of how the
larm got disabled. For more information, see
section 26.1 “Alarm Overview” on page 587.
Action note
Indicates the object is an action note. For
more information, see section 29.6 “Action
Notes” on page 732.
Category
Indicates the object is a category that you
can use to group together alarms. For more
information, see WebHelp.
Cause note
Indicates the object is a cause note. For
more information, see section 29.2 “Cause
Notes” on page 726.
Checklists
Indicates the object is a checklist. For more
information, see section 29.10 “Checklists”
on page 738.
Alarm style
Indicates the object controls the visual style
of an alarm state in the Alarms pane and
Alarm Views. For more information, see
section 26.5 “Alarms Pane and Alarm View
Customization” on page 594.
Continued
Icon Description
Assignment
Indicates the object is an assignment. For
more information, see section 28.26
“Automatic Assignment” on page 715.
Notification
Indicates the object is an E-mail notification
or a Write to file notification. For more
information, see section 28.21
“Notifications” on page 700.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Above upper limit message Type the message to display when the
variable exceeds the upper limit of the alarm.
Above upper limit priority Enter the priority level of the alarm when the
variable exceeds the upper limit.
Below lower limit message Type the message to display when the
variable falls below the lower limit.
Below lower limit priority Enter the priority level of the alarm when the
variable falls below the lower limit.
Continued
Component Description
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Above upper limit message Type the message to display when the
variable exceeds the upper limit of the alarm.
Above upper limit priority Enter the priority level of the alarm when the
variable exceeds the upper limit.
Below lower limit message Type the message to display when the
variable falls below the lower limit.
Below lower limit priority Enter the priority level of the alarm when the
variable falls below the lower limit.
Lower deviation limit Enter the lowest value the monitored variable
can decrease to before the alarm is
triggered.
Continued
Component Description
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Cause note group Enter the cause note group that is used by
the alarm.
Continued
Component Description
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Disabled caus
cause Displays the cause for the alarm being
disabled:
• Shunt variable means that the alarm
has been disabled by a shunt variable
• User means that the alarm has been
disabled by the user
• System means that the alarm has been
disabled by the system
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Reset delay (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Alarm delay (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action Requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action Requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Continued
Component Description
Delay to reset (s) Enter the time, in seconds, the alarm has to
be within the reset criteria before the alarm
state is changed from alarm to reset.
Delay to alarm (s) Enter the time, in seconds, the alarm has to
be within the alarm criteria before the alarm
is triggered.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Action note group Enter the action note group that is used by
the alarm.
Add (Action requirements) Click to open the Choosing the type and
naming the object dialog box where you
add a user action item to the alarm. For
more information, see section 50.20 “Create
Object Wizard – Naming the Object Page”
on page 1434.
Edit (Action requirements) Click to open the property of the user action
item where you edit the user action item. For
more information, see section 30.41 “User
Action Properties” on page 819.
Above upper limit message Type the message to display when the
variable exceeds the upper limit of the alarm.
Below lower limit message Type the message to display when the
variable falls below the lower limit.
Above upper limit priority Enter the priority level of the alarm when the
variable exceeds the upper limit.
Below lower limit priority Enter the priority level of the alarm when the
variable falls below the lower limit.
Continued
Component Description
Cause note group Enter the cause note group that is used by
the alarm.
Continued
Component Description
Action note group Enter the action note group that is used by
the alarm.
When acknowledging an alarm Select what actions the user has to perform
when acknowledging an alarm.
Required user action Select what actions the user has to perform
when any of the listed events occur.
Add attachment
Click to add an attachment to the alarm.
Remove attachment
Click to remove an attachment.
Navigate to
Click to open the attachment that is selected
in the attachment list.
Continued
Component Description
Remove
Remove alarm condition.
Set unit
Enter the unit of the alarm.
Continued
Component Description
Remove
Remove alarm condition.
Continued
Component Description
Set unit
Enter the unit of the alarm.
Upper deviation limit Enter the upper limit the monitored variable
is allowed to deviate from the reference
variable before the alarm is triggered.
Lower deviation limit Enter the lower limit the monitored variable is
allowed to deviate from the reference
variable before the alarm is triggered.
Continued
Component Description
Set unit
Enter the unit of the alarm.
Add condition
Select the alarm filter conditions for the
alarms you want to include.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.
Remove condition
Remove the alarm filter conditions for the
alarms you want exclude.
Add row
Click to add an additional row with the same
condition.
Remove row
Click to remove a condition row.
Continued
Component Description
Trigger alarm when variable is Select the enumeration values that trigger
the alarm.
Continued
Component Description
Continued
Component Description
Font color Enter the font color for disabled alarms in the
Alarms pane and Alarm Views.
Font color Enter the font color for faulty alarms in the
Alarms pane and Alarm Views.
Font color Enter the font color to use for reset alarms in
the Alarms pane and Alarm Views.
Add category
Click to open the Add category dialog box
where you define the name and description
for a new category. For more information,
see section 30.50 “Add Category Dialog
Box” on page 829.
Edit category
Click to open the Edit category dialog box
where you define the name and description
of an existing category. For more
information, see section 30.51 “Edit
Category Dialog Box” on page 830.
Remove category
Click to remove a category.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Collapse all
Click to collapse the groups in the list to hide
underlying items.
Expand all
Click to expand the groups in the list to
display underlaying items.
Group name Enter the cause note group the cause note
belongs to.
Group name Enter the group the cause note belongs to.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Collapse all
Click to collapse the groups in the list to hide
underlying items.
Expand all
Click to expand the groups in the list to
display underlaying items.
Group name Enter the action note group the action note
belongs to.
Group name Enter the action note group the action note
belongs to.
Add checklist
Click to open the Add checklist dialog box
where you define the checklist name,
description, and add or edit checklist steps.
For more information, see section 30.61
“Add Action Note Dialog Box” on page 840.
Edit checklist
Click to open the Edit checklist dialog box
where you edit the checklist name,
description, and add or edit checklist steps.
For more information, see section 30.68
“Edit Checklist Dialog Box” on page 848.
Remove checklist
Click to remove a checklist.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Add step
Click to open the Add checklist step dialog
box where you add a step to your checklist.
For more information, see section 30.69
“Add Checklist Step Dialog Box” on page
850.
Edit step
Click to open the Edit checklist step dialog
box where you edit a checklist step. For
more information, see section 30.70 “Edit
Checklist Step Dialog Box” on page 851.
Remove step
Click to remove the selected step from the
checklist.
Continued
Button Description
Move step up
Click to move the selected step upwards in
the list.
Add step
Click to open the Add checklist step dialog
box where you add a step to your checklist.
For more information, see section 30.69
“Add Checklist Step Dialog Box” on page
850.
Edit step
Click to open the Edit checklist step dialog
box where you edit a checklist step. For
more information, see section 30.70 “Edit
Checklist Step Dialog Box” on page 851.
Remove step
Click to remove the selected step from the
checklist.
Continued
Button Description
Move step up
Click to move the selected step upwards in
the list.
Continued
Component Description
Add condition
Click to add a condition that has to be met
for the email to be sent.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.
Remove condition
Click to remove a condition that has to be
met for the email notification to be sent.
Add row
Click to add a row to the condition.
Remove row
Click to remove the row from the condition.
Continued
Component Description
Add condition
Click to add a condition that has to be met
for the email to be sent.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.
Remove condition
Click to remove a condition that has to be
met for the email notification to be sent.
Add row
Click to add a row to the condition.
Remove row
Click to remove the row from the condition.
Continued
Component Description
Add condition
Click to add a condition that has to be met
for the notification to be written to the file.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.
Remove condition
Click to remove a condition that has to be
met for the notification to be written to the
file.
Add row
Click to add a row to the condition.
Remove row
Click to remove the row from the condition.
Add condition
Click to add conditions for when the alarm is
to be assigned.
For more information, see section 26.7
“Alarm Filter Conditions” on page 598.
Remove condition
Click to remove conditions for when the
alarm is to be assigned.
Continued
Component Description
Add row
Click to add a row to the condition.
Remove row
Click to remove the row from the condition.
Group box
Click to display the Show/Hide Group box to
group and sort objects. For more
information, see WebHelp.
Refresh
Click to refresh the event list with the latest
events.
Topics
How Events Work
Events Pane and Event View Customization
Styling a Certain Event in the Events Pane or Event View
Event Filter Conditions
Applying an Event Filter
Creating a Filtered Event View
31 Events
31.1 How Events Work
5. In the Select Conditions dialog box, click the Add condition button and
select an event category.
6. Enter the settings of the event category associated with the event you want to
style.
Note
• You can add several event categories to specify the event in
detail.
7. Click the Add row button to add another condition of the same type.
8. Click OK
OK.
9. In the Event Styles dialog box, in the Background color box, click the
Browse button.
10. Select the color for the background of the event row in the Events pane or
Event View.
11. Click OK
OK.
12. In the Font color box, click the Browse button.
13. Select the color for the font of the event in the Events pane or Event View.
14. Click OK
OK.
15. In the Font box, click the Browse button.
16. In the Font dialog box, select the font, font style and size that you want to
display the certain event text in.
17. Click OK
OK.
18. In the Event Styles dialog box, click OK
OK.
Continued
Component Description
Continued
Component Description
User action item Select to filter events of which the user has
edited checklist, cause note group, or action
note group items.
Continued
Component Description
3. In the Select Conditions dialog box, click the Add condition button and
select an event category.
4. Enter the settings of the event category that generate the writing action.
Note
• You can add multiple event types.
5. Click the Add row button to add another condition of the same type.
6. Click OK
OK.
The event filter has been created and is now applied to the Events pane or Event
View.
9. In the Select Conditions dialog box, click the Add Condition button and
select a condition.
Tip
You can add several event view conditions to specify when to write
the event view.
11. Click the Add row button to add another condition of the same type.
12. Click OK
OK.
Topics
Object Specific Event View
Event Styles Dialog Box
Event View Properties
Select Conditions Dialog Box – Events Filter Properties
Add/Remove Columns Dialog Box
32 Events User Interface
32.1 Object Specific Event View
Font color Enter the font color to use for events in the
Events pane and Event View that fulfill
configured conditions.
Number of records shown Enter the number of rows you want to list in
the Events pane or Event view. You can
enter any number between 1 and 5999.
Important
• By default, the latest 1000 event records are displayed in the Event View.
• Regardless of the number of event records in the database, you can display a
maximum of 5999 event records at a time in the Event View.
• You can use the filter to display a different set of event records, maximum
5999 records at a time.
Add condition
Click to customize the conditions to sort out
the events that are of interest.
For more information, see section 31.4
“Event Filter Conditions” on page 880.
Remove condition
Click to remove an added condition.
Acknowledge time Select to display the time and date when the
alarm was acknowledged. For more
information, see section 28.14
“Acknowledgement” on page 692.
Continued
Component Description
Disabled cause Select to display the cause for why the alarm
was disabled. An alarm can be disabled by
user, shunt variable and/or system (it’s
disabled by system if the alarm was
incorrectly configured).
Continued
Component Description
Continued
Component Description
Continued
Component Description
Topics
Trend Overview
Clearing a Trend Log
Editing or Commenting a Trend Log Record
Displaying the History of a Trend Log Record
Trend Units
Enabling a Trend Log
Disabling a Trend Log
Editing the Activation Method in a Trend Log
33 Trend Log Introduction
33.1 Trend Overview
Note
A trend log that monitors an enumeration records the enumeration value and not
the enumeration definition.
For more information, see section 48.15 “Event and Alarm Enumerations” on
page 1361.
For more information, see section 48.16 “Trend Log Enumerations” on page
1368.
Caution
Recorded values are lost when you move or copy a trend log to another server.
Caution
• Ensure that the recorded values are backed up or not needed. Clearing a
trend log permanently erases all records and events.
4. In the Clear log dialog box, click Yes to confirm that you want to clear the
trend log.
Note
• When editing an extended trend log record, the changes do not affect
corresponding record in the connected trend log.
For more information, see section 37.1 “Trend Log Lists” on page 1071.
3. Click Close
Close.
The dialog box displays all old values and which user that edited the record.
Figure: In this setup the variable has the temperature unit Kelvin, recorded trend log
values are stored in Fahrenheit, and are displayed in Celsius.
The trend log is now enabled and starts recording when its start condition is fulfilled.
4.
In the Activation method box, select the new activation method.
5. Click OK.
Topics
Trend Log Types
Interval Trend Logs
Interval Trend Log Delta
Creating an Interval Trend Log
Configuring an Interval Trend Log
Editing the Interval of an Interval Trend Log
Editing the Delta in an Interval Trend Log
Meter Trend Logs
Creating a Meter Trend Log and Associated Objects
Creating a Meter Trend Log
Managing Replacement of a Meter
Configuring a Meter Trend Log
Displaying Meter Change History
Change of Value Trend Logs
Creating a Change of Value Trend Log
Configuring a Change of Value Trend Log
Variable Triggered Trend Logs
Creating a Variable Triggered Trend Log
Configuring a Variable Triggered Trend Log
Manual Trend Logs
Creating a Manual Trend Log
Configuring a Manual Trend Log
Adding a Trend Log Record to a Manual Trend Log
Implicit Trend Logs
34 Trend Log Types
34.1 Trend Log Types
Note
• To log a variable only according to the time interval, set Delta to zero.
An interval trend log with delta can reduce the storage of similar records, and may
not fill up the storage capacity as fast as an interval trend log with no delta.
If an interval trend log has a delta and a calculation method that uses periods, make
sure the period contains the required amount of records to generate a correct
calculation. If the value does not differ from the previously logged value by more
than the delta within the period, then none or too few values are recorded for the
calculation.
Note
• Adapt the period so it contains the required amount of records to generate a
correct calculation.
• If a calculation method is connected to an interval trend log with delta, make
sure that the period and delta are adapted for the calculation.
An interval trend log with delta can reduce the storage of similar records, and may
not fill up the storage capacity as fast as an interval trend log with no delta.
If an interval trend log has a delta and a calculation method that uses periods, make
sure the period contains the required amount of records to generate a correct
calculation. If the value does not differ from the previously logged value by more
than the delta within the period, then none or too few values are recorded for the
calculation. If you want to calculate the required number of log records for a trend
log, you multiply the number of log records in one day with the number of days you
want to record. For example, the interval of the trend log is set to 1 hour, which
gives 24 recorded values per day. A trend log configured to record at least one
month records 31 days. The number of log records = 24 X 31 = 744.
Note
• Adapt the period so it contains the required amount of records to generate a
correct calculation.
• If a calculation method is connected to an interval trend log with delta, make
sure that the period and delta are adapted for the calculation.
6. Click Next
Next.
7. In the Logged variable box, enter the variable that you want to log.
8. In the Delta box, enter the minimum value change that triggers a new record.
14. In the Log size box, type the log size time to be stored before old values are
overwritten.
15. In the Clear when enabled box, select True to clear the trend log every time
the trend log is enabled.
Continued on next page
16. In the Activation method box, select the condition to start the trend log:
• Select Always active to start recording values immediately after the trend
log is created.
• Select Variable controlled and then enter a variable in the Activation
variable box to start recording values when the start variable is true.
• Select Start at activation time and then enter the time in the Activation
time box to specify an exact time for the recording to begin.
18. In the Extended Trend Log box, click the browse button to create an
extended trend log and connect it to the trend log.
19. In the Trend Log List box, click the browse button to create a trend log
list and connect it to the trend log.
20. In the Trend Chart box, click the browse button to either create a new
trend chart or connect the interval trend log to an existing trend chart.
21. Click Create
Create.
Clear when enabled Select True to clear the trend log when it
is enabled.
4. Click OK.
5. Click OK.
5. Click OK.
Figure: Manage replacement of meter dialog box where you enter the values of the new
and old meter.
Note
• In order for a meter rollover to be managed correctly in the meter trend log
and to ensure logging starts at the correct energy reading value, you enter
previous meter and new meter information in the Manage replacement of
meter dialog box. For more information, see section 34.11 “Managing
Replacement of a Meter ” on page 965.
6. Click Next
Next.
7. In the Logged variable box, enter the variable that you want to log.
8. In the Trigger variable box, enter the variable that triggers the log.
15. In the Clear when enabled box, select True to clear the trend log every time
the trend log is enabled.
18. In the Start value box, enter the value of the meter when it was installed.
19. In the Meter constant box, enter the constant of the meter.
20. In the Min value box, enter the first value of the meter when it rolls over.
Continued on next page
21. In the Max value box, enter the last value of the meter before it rolls over.
23. In the Extended Trend Log box, click the browse button to create an
extended trend log and connect it to the trend log.
25. In the Name box, type a name for the extended trend log.
26. In the Location box, enter the path where to store the extended trend log.
Continued on next page
27. In the Description box, type a description for the extended trend log.
30. In the Smart log box, select if you want to use smart log:
• Select True to enable Building Operation software to automatically
optimize the transfer rate of records from the monitored trend log to the
extended trend log.
• Select False to manually specify the percentage threshold at which the
trend log transfers its records to the extended trend log, and then select
the percentage in the Threshold box.
31. In the Maximum transfer interval box, select the maximum transfer rate.
32. In the Log records box, enter the number of records to be stored before old
ones are overwritten.
33. In the Include in reports? box, select True to make the extended trend log
available to WebReports, for example, to include the extended trend log in a
trend log comparison report.
34. In the Transfer trigger variable box, enter a trigger variable to force a transfer
of all records from the trend log to the extended trend log, for example, to
generate a complete report. For more information, see section 35.4 “Extended
Trend Logs” on page 1003.
36. In the Trend Log List box, click the browse button to create a trend log
list and connect it to the trend log.
37. Click Create
Create.
38. In the Name box, type a name for the trend log list.
39. In the Location box, enter the path where to store the trend log list.
40. In the Description box, type a description for the trend log list.
42. In the Display trend log box, confirm that the meter log is automatically
entered.
43. In the Log space (records) box, enter the maximum number of records to
display in the trend log.
45. In the Trend Chart box, click the browse button to create a new trend
chart and connect it to the existing trend log.
46. Click Create
Create.
47. In the Name box, type a name for the trend chart.
48. In the Location box, enter the path where to store the trend chart.
49. In the Description box, type a description for the trend chart.
51. In the Time mode box, select the time mode for the trend chart:
• Select Absolute (start and end time) and then enter a start time in the
Start time box and an end time in the End time box to manually specify
the x-axis start point and end point. For more information, see section
36.8 “Trend Chart Axes” on page 1039.
• Select Relative (to current time) and then type the time span in the Time
span box to automatically adapt the x-axis of the chart to display the
current time as the rightmost value. For more information, see section
36.8 “Trend Chart Axes” on page 1039.
52. In the Auto scale left y-axis box, select True to automatically adapt the y-
axis scale to the trend log series.
53. Click Add to display additional trend data in the trend chart.
54. In the object type list, select Trend Log Series or Real Time Trend Series
Series.
59. In the Weight box, enter the line weight of the series.
Continued on next page
60. In the Show markers box, select True to display a marker for each recorded
value.
7. In the Logged variable box, enter the variable that you want to log.
8. In the Trigger variable box, enter the variable that triggers the log.
18. In the Start value box, enter the value of the meter when it was installed.
19. In the Meter constant box, enter the constant of the meter.
20. In the Min value box, enter the first value of the meter when it rolls over.
21. In the Max value box, enter the last value of the meter before it rolls over.
22. Click Next
Next.
Continued on next page
23. In the Extended Trend Log box, click the Browse button to create an
extended trend log and connect it to the trend log.
24. In the Trend Log List box, click the Browse button to create a trend log
list and connect it to the trend log.
25. In the Trend Chart box, click the Browse button to either create a new
trend chart or connect the trend log to an existing trend chart.
26. Click Create
Create.
The meter trend log is created in the selected folder.
Note
• When a meter trend log is created, you need to add the current meter value.
4. In the End value box, type the value of the old meter when it was replaced.
5. In the Start time box, enter the time when the new meter is installed.
6. In the Start value box, type the current value of the new meter when it was
installed.
7. In the Meter constant box, type the constant of the new meter. For example,
if the meter counts in kilo (103) type 1000.
8. In the Min value box, type the first value of the new meter when it rolls over.
Continued on next page
9. In the Max value box, type the last value of the new meter before it rolls over.
10. Click OK
OK.
Clear when enabled Select True to clear the trend log when it
is enabled.
4. Click OK
OK.
Note
• The meter change history is only applicable for the meter trend log.
For more information, see section 34.8 “Meter Trend Logs” on page 940.
button .
3. Click OK
OK, to close the dialog box.
It is important that all meter changes are registered in the Manage replacement of
meter dialog box.
Note
• The change of value trend log is limited to 10 records per second.
• Do not set the delta too small since this can quickly fill up the trend log.
For example, in the figure below, the change of value trend log records a variable
every time the variable exceeds or falls below the delta of 3. The records are printed
in a trend chart. Notice that the change of value trend log records the values
without any time perspective between the records.
6. Click Next
Next.
7. In the Logged variable box, enter the variable you want to log.
8. In the Delta box, enter the minimum value change that triggers a new record.
15. In the Activation method box, select the condition to start the trend log:
• Select Always active to start recording values immediately after the trend
log is created.
• Select Variable controlled and then enter a variable in the Activation
variable box to start recording values when the start variable goes on.
• Select Activation at start time and then enter the time in the Activation
time box to specify an exact time for the recording to begin.
17. In the Extended Trend Log box, click the browse button to create an
extended trend log and connect it to the trend log.
18. In the Trend Log List box, click the browse button to create a trend log
list and connect it to the trend log.
19. In the Trend Chart box, click the browse button to either create a new
trend chart or connect the trend log to an existing trend chart.
20. Click Create
Create.
Clear when enabled Select True to clear the trend log when it
is enabled.
4. Click OK
OK.
7. In the Logged variable box, enter the variable you want to log.
8. In the Trigger variable box, enter the variable that triggers the log.
17. In the Extended Trend Log box, click the Browse button to create an
extended trend log and connect it to the trend log.
18. In the Trend Log List box, click the Browse button to create a trend log
list and connect it to the trend log.
19. In the Trend Chart box, click the Browse button to either create a new
trend chart or connect the trend log to an existing trend chart.
20. Click Create
Create.
The variable triggered trend log is created in the selected folder.
Clear when enabled Select True to clear the trend log when it
is enabled.
4. Click OK.
12. In the Extended Trend Log box, click the Browse button to create an
extended trend log and connect it to the trend log.
13. In the Trend Log List box, click the Browse button to create a trend log
list and connect it to the trend log.
14. In the Trend Chart box, click the Browse button to either create a new
trend chart or connect the trend log to an existing trend chart.
15. Click Create
Create.
The manual trend log is created in the selected folder. You have to manually add
the records to the manual trend log.
Log data Enter the unit the trend log stores the
records in.
4. Click OK
OK.
Note
• The Add trend log record dialog box is only applicable to manual trend logs.
5. In the Data type box, select Number if the value is an integer or decimal.
6. In the Value box, type the value.
7. In the Comment box, type a comment.
8. Click Add record
record.
9. Click Close
Close.
The record is now added to the trend log.
Note
• The implicit log is not manually created as with the other trend logs in
WorkStation.
The implicit trend log exists on all IO points. When a device is connected to an IO
port, the implicit trend log is automatically configured and starts recording values.
Voltage 0.2 V
Current 0.3 mA
Resistance 200 Ω
The implicit trend log stores approximately 500 records before old records are
overwritten.
Topics
Trend Log Functions
Log Record Storage
Activation Methods
Extended Trend Logs
Creating an Extended Trend Log
Configuring an Extended Trend Log
Editing the Threshold Property of an Extended Trend Log
Editing the Maximum Transfer Interval Property of an
Extended Trend Log
Editing the Number of Log Records for a Trend Log
Editing an Extended Trend Log to be Included in Reports
Manually Transferring Records to the Extended Trend Log
35 Trend Log Functions
35.1 Trend Log Functions
Figure: Start condition, Variable controlled that does not follow the start variable.
Or you can choose to have the trend log stop recording when the start variable,
such as a fan, goes off. For example, you can use this feature to log the effective
time a fan is on.
Figure: Start condition, Variable controlled that follows the start variable.
Important
• The extended trend log cannot log a variable.
• Do not connect more than one extended trend log to a trend log or another
extended trend log. If a trend log is connected to two or more extended trend
logs, critical conflicts can occur.
Figure: Never connect more than one extended trend log to a trend log or extended trend
log.
The extended trend log is often saved on a higher server level with more storage
capacity than the server of an ordinary trend log. This extra storage capacity
enables the server to store more records before it overwrites old ones. The
extended trend log can be viewed in a trend log list or a trend chart.
You can configure the extended trend log to transfer data several ways: Smart log,
percentage, time interval, or force transfer.
Figure: Extended trend log that transfers records from a trend log each time the trend log
exceeds a record volume of 20% or every hour.
When you edit a record in the extended trend log, the changes do not affect the
connected trend log. If you edit a record in the trend log, the changes are
transferred to the extended trend log next time a transfer occurs. You can edit both
the trend log and the corresponding record in the extended trend log, but the edit is
written twice in the extended trend log record in certain circumstances:
• the record in the extended trend log is manually updated
• the corresponding edit is transferred from the trend log to the extended trend
log
The trend log list or trend chart displays the last written value of an edited record.
Example 1: You edit a record in a trend log that is connected to an extended trend
log. The extended trend log is updated with the edited record. After the transfer,
you update the corresponding record in the extended trend log. The trend log list
and trend chart connected to the extended trend log display the last value of the
record, which in this case is the extended trend log edit.
Example 2: You edit a record in a trend log that is connected to an extended trend
log. Before the extended trend log is updated with the edited record, you edit the
corresponding record in the extended trend log. After a while the trend log transfers
its edited record to the extended trend log. The trend log list and trend chart
connected to the extended trend log display the edited trend log record value and
not the edited extended trend log record value. In this case, the trend log list and
trend chart display the last value that was written to the extended trend log, not the
last edited value.
You can view all edits, automatically transferred or manually added, in the record
history.
Important
If you import, export, copy, or paste an extended trend log connected to a trend
log, all references to the log point are lost.
4. In the Name box, type a name for the extended trend log.
Continued on next page
6. Click Next
Next.
7. In the Monitored trend log box, enter the trend log that you want to transfer
records from.
8. In the Smart log box, select if you want to use smart log:
• Select True to enable Building Operation software to automatically
optimize the transfer rate of records from the monitored trend log to the
extended trend log.
• Select False to manually specify the percentage threshold at which the
trend log transfers its records to the extended trend log, and then select
the percentage in the Threshold box.
9. In the Maximum transfer interval box, select the maximum transfer rate.
10. In the Log records box, enter the number of records to be stored before old
ones are overwritten.
11. In the Include in reports? box, select True to make the extended trend log
available to WebReports, for example, to include the extended trend log in a
trend log comparison report.
12. In the Transfer trigger variable box, enter a trigger variable to force a transfer
of all records from the trend log to the extended trend log, for example, to
generate a complete report. For more information, see section 35.4 “Extended
Trend Logs” on page 1003.
Monitored trend log Enter the trend log that you want to
transfer records from.
Log data Enter the unit the trend log stores the
records in.
4. Click OK
OK.
5. Click OK
OK.
5. Click OK
OK.
5. Click OK
OK.
The monitored trend log is now transferred to the extended trend log.
Topics
Trend Charts
Configuring a Trend Chart
Showing Trend Chart Grid Lines
Adding a Trend Log Series to a Trend Chart
Adding a Real-time Trend Series to a Trend Chart
Editing the Trend Chart Settings
Activating Trend Chart Live Update
Trend Chart Axes
Scroll the Trend Chart X-Axis to the Current Time
Configuring the X-Axis with a Relative Time Span
Configuring the X-Axis with an Absolute Time Span
Manually Configuring the Y-Axis Scale
Automatically Configuring the Y-Axis Scale
Assigning a Series to a Y-Axis
Real-time Plotting
Creating a Real-time Plot Trend Chart
Creating a Trend Chart that Monitors a Variable in Real-
Time
Trend Chart Series
Creating a Trend Chart that Monitors a Trend Log Series
Attaching a Calculation Method to a Trend Chart Series
Time Zone Modes in a Trend Chart
Configuring the Trend Chart Time Zone Mode
Temporary Trend Log Lists and Trend Charts
Opening a Trend Log in a Temporary Trend Chart
Saving a Temporary Trend Chart
36 Trend Charts
36.1 Trend Charts
Figure: An extended trend log, that presents in an opened live trend chart, frequently
transfers the latest records from the trend log to the extended trend log.
If two extended trend logs are connected between the trend log and the trend
chart, the transfer that occurs when a trend chart presents records live only
transfers the records from the nearest extended trend log. The transfer threshold
rate between the trend log and the first connected trend log remains unaffected.
Figure: Latest trend log record that does not present the same short latency in a live trend
chart when two extended trend logs are connected in a series between the trend log and
trend chart.
When waiting for a new record, the trend chart draws a dotted line from the last
recorded value and forward. When a new value is recorded, the dotted line
between the last and the new record is replaced by a solid series of lines.
Time zone Select the time zone of the trend log list.
The mode is the perspective in which the
trend log is displayed.
Show nearest information for all series Select True to show information on every
series along a diagonal line.
Auto scale left y-axis Select True to activate auto scale and
have the left y-axis adapt itself to the
displayed series.
Left y-axis minimum Enter the minimum value of the left y-axis.
Auto scale right y-axis Select True to activate auto scale and
have the right y-axis adapt itself to the
displayed series.
Show grid lines for X-axis Select True to show grid lines for the x-
axis.
Show grid lines for left Y-axis Select True to show gridlines for the left
y-axis originating from the y-axis scale.
Show grid lines for right Y-axis Select True to show gridlines for the right
y-axis originating from the y-axis scale.
2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. Below the Time zone box, select Show grid lines to show grid lines
originating from the x-axis scale.
4. Select Show left grid lines or Show right grid lines to show grid lines
originating from the y-axis scale.
5. Click OK
OK.
Grid lines are now shown in the trend chart. Repeat the procedure to hide the grid
lines.
2. In the System Tree pane, select the trend log you want to add.
3. Drag the trend log from the System Tree pane to the trend chart diagram.
4. Click Save
Save.
7. Click Next
Next.
Continued on next page
8. In the Display variable box, enter the path to the variable you want to display
in the trend chart.
12. Click OK
OK.
2. On the Trend Chart toolbar, click Open trend chart settings button .
3. Edit the trend chart settings.
4. Click OK
OK.
Note
To activate the live update requires that the trend chart is configured to local time
zone mode and presents a Building Operation trend log.
For more information, see section 36.1 “Trend Charts” on page 1019.
button .
The trend chart displays the trend chart with the client’s current time as the
rightmost x-axis point.
2. On the Trend Chart toolbar, click Open trend chart settings button .
3. In the Time mode box, select Relative (to current time)
time).
4. In the Time span box, type the length of the x-axis to display before the
current time.
5. Click OK
OK.
The x-axis is now configured with a relative time span.
2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. In the Time mode box, select Absolute (start and end time)
time).
4. In the Start time boxes, type the x-axis leftmost date and time.
5. In the End time boxes, type the x-axis rightmost date and time.
6. Click OK
OK.
The x-axis is now configured with an absolute time span.
2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. Clear Auto scale left y-axis and Auto scale right y-axis
y-axis.
4. In the Left y-axis minimum and Right y-axis minimum boxes, type the
minimum value of the y-axis.
5. In the Left y-axis maximum and Right y-axis maximum boxes, type the
maximum value of the y-axis.
6. Click OK
OK.
The y-axis is now set with a fixed scale.
2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. Select Auto Scale left y-axis and Auto Scale right y-axis
y-axis.
4. Click OK
OK.
The y-axis scale is now set automatically and updated with the presented series.
.
3. Click the Series tab.
4. In the Data series box, select the series you want to assign to either the left or
the right axis.
5. In the Assigned to y-axis box, select an axis.
6. Click OK
OK.
The series is now assigned to the left or right y-axis.
Note
• A real-time plot can only be displayed in a trend chart and not in a trend log
list
7. In the Time mode box, select Absolute to manually specify the x-axis start
and end point.
8. In the Start time box, type the absolute start time (the leftmost point of the x
axis).
9. In the End time box, type the absolute end time (the rightmost point of the x
axis).
10. In the Auto scale left y-axis box, select True so the y-axis adapts itself to
displayed series.
11. Click Add
Add.
Continued on next page
18. In the Show markers box, select True to display a marker for each recorded.
19. Click Create
Create.
20. In the Configure real-time trend series dialog box, click Create
Create.
The real-time trend series trend chart is created in the selected folder.
7. In the Time mode box, select Absolute to manually specify the x-axis start
and end point.
8. In the Start time box, type the absolute start time of the x-axis.
9. In the Time span box, type the relative time span of the x-axis in seconds.
10. In the Auto scale left y-axis box, select True so the y-axis adapts itself to the
displayed series.
11. Click Add
Add.
Continued on next page
18. In the Show markers box, select True to display a marker for each recorded
value.
19. In the Show events box, select True to display event symbols.
20. Click Create
Create.
21. In the Configure Trend Chart dialog box, click Create.
The trend log series trend chart is created in the selected folder.
2. On the Trend Chart toolbar, click Open trend chart settings button .
3. Click the Calculations tab.
4. In the Data series box, select the series you want to add a calculation method
to.
7. In the Period box, select the time span for which the calculation method is to
be executed.
Note
• If Custom is selected in the Period box, enter a custom time
span for which the calculation method is to be executed in the
Custom period box and the time when you want the custom
period to start in the Custom period alignment boxes.
• To calculate the required number of records for a trend log,
multiply the number of records in one day with the number of
days you want the trend log to record. For example, the interval
of the trend log is set to 1 hour, then this gives 24 recorded
values per day. The trend log should record at least one month
of recorded values equal to 31 days. For example, the number of
records = 24 x 31 = 744.
8. In the Custom period box, enter a custom time span for which the calculation
method is to be executed.
9. In the Custom period alignment boxes, enter the time when you want the
custom period to start.
10. Click OK
OK.
A calculation method is now attached to the series.
2. On the Trend Chart toolbar, click the Open trend chart settings button .
3. In the Time zone box, select a time zone to display the trend chart time
stamps in.
• Select Local to display the time stamps in real time from the perspective
of the client.
• Select Server to display the time stamps in real time from the perspective
of the server.
• Select UTC to display the time stamps in real time from the perspective of
UTC.
4. Click OK
OK.
The x-axis is now set according to the selected time zone mode.
Figure: Trend log displayed in a temporary trend log list and temporary trend chart.
Note
• The trend log list must be manually refreshed.
The trend chart is displayed in the work area under a generic name.
Topics
Trend Log Lists
Creating a Trend Log List
Configuring a Trend Log List
Time Zone Modes in a Trend Log List
Displaying the Trend Log List Time Stamps with Fractions
Configuring the Trend Log List Time Zone
Calculation Methods
Attaching a Calculation Method to a Trend Log List
Temporary Trend Log Lists and Trend Charts
Saving a Temporary Trend Log List
37 Trend Log Lists
37.1 Trend Log Lists
Tip
• If you are creating a trend log list from a trend log wizard, the procedure starts
when you name the trend log list.
For more information, see section 37.1 “Trend Log Lists” on page 1071.
4. In the Name box, type a name for the trend log list.
Continued on next page
5. In the Description box, type a description for the trend log list.
6. Click Next
Next.
7. In the Display trend log box, enter the trend log you want to display in the
trend log list.
8. In the Log space (records) box, enter the maximum number of rows to
display in the trend log.
9. Click Create
Create.
Display trend log Enter the trend log to display in the trend
log list.
4. Click OK
OK.
Figure: Trend log list displayed on a client with local time zone.
Figure: Trend log list displayed on a client with server time zone.
Figure: Trend log list displayed on a client with UTC time zone.
button .
The time stamps in the trend log list are now shown with hundredths. Repeat the
procedure to hide the fractions.
.
3. In the Time zone box, select a time zone to display the trend log list time
stamps in.
• Select Local to display the time stamps in real time from the perspective
of the client.
• Select Server to display the time stamps in real time from the perspective
of the server.
• Select UTC to display the time stamps in the real time in the perspective
of UTC.
4. Click OK
OK.
The records in the trend log are now displayed in the selected time zone mode.
Note
• Adapt the period so it contains the required amount of records to generate a
correct calculation.
• If a calculation method is connected to an interval trend log with delta, make
sure that the period and delta are adapted for the calculation.
37.7.1 Maximum
The maximum value of each period is presented.
Important
If the log point is offline or no value is produced during the interval, no value is
displayed.
37.7.2 Minimum
The minimum value of each period is presented.
Important
If the log point is offline or no value is produced during the interval, no value is
displayed.
37.7.3 Average
The average of the values in each period is calculated and presented.
Important
If the log point is offline or no value is produced during the interval, no value is
displayed.
37.7.4 Summary
The sum of the values in each period is calculated and presented.
37.7.5 Delta
The change to the previous value is calculated and presented.
.
3. In the Calculation method box, select a calculation.
4. In the Delta over period box, select True if the calculation method is a delta
calculation with periods.
Continued on next page
5. In the Period box, select the time span for which the calculation method is to
be executed.
Note
• If Custom is selected in the Period box, enter a custom time
span for which the calculation method is to be executed in the
Custom period box and the time when you want the custom
period to start in the Custom period alignment boxes.
• To calculate the required number of records for a trend log,
multiply the number of records in one day with the number of
days you want the trend log to record. For example, the interval
of the trend log is set to 1 hour, then this gives 24 recorded
values per day. The trend log should record at least one month
of recorded values equal to 31 days. For example, the number of
records = 24 x 31 = 744.
6. In the Custom period box, enter a custom time span for which the calculation
method is to be executed.
7. In the Custom period alignment boxes, enter the time when you want the
custom period to start.
8. Click OK
OK.
A calculation method is now attached to the trend log list.
Figure: Trend log displayed in a temporary trend log list and temporary trend chart.
Note
• The trend log list must be manually refreshed.
Topics
Trend Log System Tree Icons
Actions Menu – Activation Submenu
Actions Menu – View Submenu
Actions Menu - View Submenu - Trend Charts Submenu
Actions Menu - View Submenu - Trend Log Lists Submenu
Actions Menu – Modification Submenu
Interval Trend Log Properties
Meter Trend Log Properties
Change of Value Trend Log Properties
Variable Triggered Trend Log Properties
Manual Trend Log Properties
Extended Trend Log Properties
Trend Chart Properties
Trend Log List Properties
Manage Replacement of Meter Dialog Box
Meter Change History Dialog Box
Trend Chart View
Trend Chart Toolbar
Trend Chart Event Icons
Trend Chart Navigation Bar
Series Tab Shortcut Menu
Trend Chart Settings Dialog Box – Axes Tab
Trend Chart Settings Dialog Box – Series Tab
Trend Chart Settings Dialog Box – Calculation Tab
Trend Chart Series Properties
Real Time Trend Series Properties
Trend Log List View
Trend Log List Toolbar
Trend Log List Event Icons
Trend Log List – Log Info View
Trend Log List Shortcut Menu
Add Trend Log Record Dialog Box
Edit/Comment Trend Log Record Dialog Box
Create Trend Log Wizard – Configure Interval Trend Log
Page
Create Trend Log Wizard – Configure Meter Trend Log Page
Create Trend Log Wizard – Configure Change of Value
Trend Log Page
Create Trend Log Wizard – Configure Variable Triggered Trend
Log
Create Trend Log Wizard – Configure Manual Log Page
Create Trend Log Wizard – Configure Extended Trend Log Page
Create Trend Log Wizard – Configure Trend Chart Page
Create Trend Log Wizard – Configure Real-Time Trend Series
Page
Create Trend Log Wizard – Configure Trend Log Series Page
Create Trend Log Wizard – Configure Trend Log List Page
Create Trend Log Wizard – Connect Objects to the Trend Log
Page
Trend Log Wizard – Initial Meter Settings Page
38 Trends User interface
38.1 Trend Log System Tree Icons
Trend log
Indicates the object is a trend log. For more
information, see WebHelp.
Trend chart
Indicates the object is a trend chart. For
more information, see section 36.1 “Trend
Charts” on page 1019.
Enable trend log Click to enable the trend log. The trend log
starts when the start condition is fulfilled.
Disable trend log Click to disable the trend log and stop all
recording activity.
Clear trend log Click to clear all the records from the trend
log.
Trend log lists Use the Trend log lists submenu to open or
create a trend list. For more information, see
section 38.5 “Actions Menu - View Submenu
- Trend Log Lists Submenu” on page 1099.
New Trend chart Click to create a new trend chart. For more
information, see section 36.1 “Trend Charts”
on page 1019.
[Name of log list] Click to open one of the trend log lists in the
menu. For more information, see section
37.1 “Trend Log Lists” on page 1071.
New Trend log list Click to create a new trend log list. For more
information, see WebHelp.
Add log record Click to open the Add log record dialog box
where you add values and comments to a
manual trend log. For more information, see
section 34.23 “Adding a Trend Log Record
to a Manual Trend Log” on page 992.
Activation method Select the method for starting the trend log.
For more information, see section 35.3
“Activation Methods” on page 999.
Clear when enabled Select True to clear the trend log when it is
enabled.
Continued
Property Description
Clear when enabled Select True to clear the trend log when it is
enabled.
Trigger variable Enter the variable that triggers the trend log
to start recording.
Activation method Select the method for starting the trend log.
For more information, see section 35.3
“Activation Methods” on page 999.
Clear when enabled Select True to clear the trend log when it is
enabled.
Continued
Property Description
Clear when enabled Select True to clear the trend log when it is
enabled.
Trigger variable Enter the variable that triggers the trend log
to start recording.
Continued
Component Description
Log data Enter the unit the trend log stores the
records in.
Monitored trend log Enter the trend log that you want to transfer
records from.
Log data Enter the unit the trend log stores the
records in.
Continued
Component Description
Continued
Property Description
Time zone Select the time zone of the trend log list. The
mode is the perspective in which the trend
log is displayed.
Show nearest information for all series Select True to show information on every
series along a diagonal line.
Auto scale left y-axis Select True to activate auto scale and have
the left y-axis adapt itself to the displayed
series.
Left y-axis minimum Enter the minimum value of the left y-axis.
Left y-axis maximum Enter the maximum value of the left y-axis.
Auto scale right y-axis Select True to activate auto scale and have
the right y-axis adapt itself to the displayed
series.
Right y-axis minimum Enter the minimum value of the right y-axis.
Right y-axis maximum Enter the maximum value of the right y-axis.
Show grid lines for X-axis Select True to show grid lines for the x-axis.
Show grid lines for left Y-axis Select True to show gridlines for the left y-
axis originating from the y-axis scale.
Show grid lines for right Y-axis Select True to show gridlines for the right y-
axis originating from the y-axis scale.
Display trend log Enter the trend log to display in the trend log
list.
Continued
Component Description
Note
• The Manage replacement of meter dialog box only applies to meter trend
log.
End value Type the value the old meter has when it is
replaced.
Min value Type the first value of the new meter after
roll-over.
Continued
Component Description
Max value Type the last value of the new meter before
roll-over.
Note
• The Meter change history dialog box only applies to meter trend log.
End time Displays the time when the old meter was
replaced.
End value Displays the value the old meter had when it
was replaced.
Start time Displays the time when the new meter was
installed.
Min value Displays the first value of the new meter after
roll-over.
Continued
Component Description
Continued
Number Description
Reset zoom
Click to reset the trend chart to its original
size in the database.
Pointer
Click to point to log records in the trend
chart or to scroll vertically with the mouse
wheel.
Zoom in
Click to increase the scale of the trend chart
or drag to magnify an area in the trend chart.
Zoom out
Click to decrease the scale of the trend
chart.
Continued
Button Description
Continued
Icon Description
Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
WebHelp.
Forced
Indicates that the recorded value is forced by
the software and is not the measured value.
For more information, see WebHelp.
Scroll backwards
Click to scroll back.
Auto scroll
Click to have the trend chart automatically
adjust itself according to the latest trend log
record in WebStation.
Scroll forwards
Click to scroll forward.
Open trend chart settings Click to open the property dialog box for the
trend chart and its series.
Continued
Component Description
Auto scale left y-axis Select to activate auto scale. The scale of
the left y-axis adapts itself to the displayed
series.
Left y-axis minimum Type the minimum value of the left y-axis.
Left y-axis maximum Type the maximum value of the left y-axis.
Show left grid lines Select to show grid lines on the left y-axis.
Auto scale right y-axis Select to activate auto scale. The scale of
the right y-axis adapts itself to the displayed
series.
Right y-axis minimum Type the minimum value of the right y-axis.
Right y-axis maximum Type the maximum value of the right y-axis.
Show right grid lines Select to show grid lines on the right y-axis.
Display trend log Displays the path the trend log series is
connected to.
Continued
Component Description
Continued
Number Description
Events
Click to show or hide events in the trend log
list. This function does not hide events in the
list that contain a value or comment, such as
Record was addedadded, Record was edited,
and Record was commented
commented. For more
information, see section 38.29 “Trend Log
List Event Icons” on page 1138.
Continued
Button Description
Export to .XML
Click to open the Export dialog box.
Export to .CSV
Click to open the Export dialog box.
Continued
Icon Description
Override
Indicates that the recorded value is
overridden by the hardware and is not the
measured value. For more information, see
WebHelp.
Forced
Indicates that the recorded value is forced by
the software and is not the measured value.
For more information, see WebHelp.
Note
• The log info does not include records that are not displayed in the trend log
list. The log info data changes with the trend log when the trend log list is
refreshed or reopened.
Start time The time of the first record in the trend log
list.
Displayed trend log The trend log that is connected to the trend
log list.
Stop time The time of the last record in the trend log
list.
Note
• The Add trend log record dialog box is only applicable to manual trend logs.
Time stamp Enter the time and date of the new record.
Clear when enabled Select True to clear the trend log when it is
enabled.
Trigger variable Enter the variable that triggers the trend log
to start recording.
Clear when enabled Select True to clear the trend log when it is
enabled.
Clear when enabled Select True to clear the trend log when it is
enabled.
Activation method Select the method for starting the trend log.
For more information, see section 35.3
“Activation Methods” on page 999.
Trigger variable Enter the variable that triggers the trend log
to start recording.
Clear when enabled Select True to clear the trend log when it is
enabled.
Monitored trend log Enter the trend log that you want to transfer
records from.
Auto scale left y-axis Select to activate auto scale. The scale of
the left y-axis adapts itself to the displayed
series.
Continued
Component Description
Display trend log Enter the trend log you want to present as a
series in the trend chart.
Display trend log Enter the trend log you want to present in
the trend log list.
Extended Trend Log Click the browse button to start the wizard
to create an extended trend log and connect
it to the trend log.
Trend Log List Click the browse button to start the wizard
to create a trend log list and connect it to the
trend log.
Start time Displays the time when the new meter was
installed.
Min value Displays the first value of the new meter after
roll-over.
Topics
Mass Create
Mass Create Unit Managing
Object or Property Variable Type
Suffix and Prefix
Mass Create Resulting Location
Mass Creating Alarms
Mass Creating Alarms Using the Search Method
Mass Creating Trend Logs
Mass Creating Trend Logs Using the Search Method
Mass Creating Extended Trend Logs
Mass Creating Extended Trend Logs Using the Search
Method
Mass Create Object Wizard – Name Page
39 Mass Create Alarms and Trends
39.1 Mass Create
Figure: Objects and properties with no unit are given the unit that is defined for the other
objects.
Note
You can not mass create alarms or trend logs from objects or properties that
have different units.
Table: Suitable Alarms and Trend Logs for a Specific Variable Type
Type Alarm Trend Log
String variable • Matching text string A trend log can only monitor
alarm values, not text strings.
• Variable status alarm
Note
A trend log that monitors an enumeration records the enumeration value and not
the enumeration definition.
For more information, see section 48.15 “Event and Alarm Enumerations” on
page 1361.
For more information, see section 48.16 “Trend Log Enumerations” on page
1368.
3. In the object type list, select the alarm type you want to create.
4. In the Prefix box, type a label that is added in front of the name of the alarms.
Continued on next page
5. In the Suffix box, type a label that is added after the name of the alarms.
6. In the Description box, type a description for the alarms.
7. Select Use relative path if you want to use relative path addressing, that is, if
you want to create the different alarms in positions that all relate to their
respective objects with the same pattern of relative path addressing.
8. In the Location box, enter the location where you want to create the alarms. If
you use relative path, this location applies to the first object in the list, and its
path will work as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create will be disabled.
9. If you use relative path, verify that the additional two lines show the resulting
relative path pattern that you intend, and the way this pattern applies to an
example object in the list.
5. In the object type list, select the alarm type you want to create.
6. In the Prefix box, type a label that is added in front of the name of the alarms.
7. In the Suffix box, type a label that is added after the name of the alarms.
8. In the Description box, type a description for the alarms.
9. Select Use relative path if you want to use relative path addressing, that is, if
you want to create the different alarms in positions that all relate to their
respective objects with the same pattern of relative path addressing.
10. In the Location box, enter the location where you want to create the alarms. If
you use relative path, this location applies to the first object in the list, and its
path will work as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create will be disabled.
11. If you use relative path, verify that the additional two lines show the resulting
relative path pattern that you intend, and the way this pattern applies to an
example object in the list.
4. In the Prefix box, type a label that is added in front of the name of the trend
logs.
5. In the Suffix box, type a label that is added after the name of the trend logs.
6. In the Description box, type a description for the trend logs.
Continued on next page
7. Select Use relative path if you want to use relative path addressing, that is, if
you want to create the different trend logs in positions that all relate to their
respective objects with the same pattern of relative addressing.
8. In the Location box, enter the location where you want to create the trend
logs. If you use relative path, this location applies to the first object in the list,
and its path works as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.
9. Click Next
Next.
See the trend log procedures for detailed information on how to create and set up
your specific trend log type:
• For more information, see section 34.4 “Creating an Interval Trend Log ” on
page 931.
• For more information, see section 34.15 “Creating a Change of Value Trend
Log ” on page 972.
• For more information, see section 34.10 “Creating a Meter Trend Log ” on
page 961.
• For more information, see section 34.18 “Creating a Variable Triggered Trend
Log” on page 981.
3. In the Search view, select the objects or properties you want to create trend
logs for.
6. In the Prefix box, type a label that is added in front of the name of the trend
logs.
7. In the Suffix box, type a label that is added after the name of the trend logs.
8. In the Description box, type a description for the trend logs.
Continued on next page
9. Select Use relative path if you want to use relative path addressing, that is, if
you want to create the different trend logs in positions that all relate to their
respective objects with the same pattern of relative path addressing.
10. In the Location box, enter the location where you want to create the trend
logs. If you use relative path, this location applies to the first object in the list,
and its path works as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.
2. On the File menu, point to New and then click Extended Trend Log
Log.
3. In the Prefix box, type a label that is added in front of the name of the
extended trend logs.
4. In the Suffix box, type a label that is added after the name of the extended
trend logs.
5. In the Description box, type a description for the extended trend logs.
Continued on next page
6. Select Use relative path if you want to use relative path addressing, that is, if
you want to create the different trend logs in positions that all relate to their
respective objects with the same pattern of relative path addressing.
7. In the Location box, enter the location where you want to create the trend
logs. If you use relative path, this location applies to the first object in the list,
and its path works as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.
8. Click Next
Next.
• For more information, see section 35.5 “Creating an Extended Trend Log” on
page 1007.
4. On the File menu, point to New and then click Extended Trend Log
Log.
Continued on next page
5. In the Prefix box, type a label that is added in front of the name of the
extended trend logs.
6. In the Suffix box, type a label that is added after the name of the extended
trend logs.
7. In the Description box, type a description for the extended trend logs.
8. Select Use relative path if you want to use relative path addressing, that is, if
you want to create the different trend logs in positions that all relate to their
respective objects with the same pattern of relative addressing.
9. In the Location box, enter the location where you want to create the trend
logs. If you use relative path, this location applies to the first object in the list,
and its path works as a pattern for the relative path that is applied to all the
remaining objects.
Note
If the specified relative path pattern leads to an unavailable position
for any of the objects in the list, Next and Create are disabled.
Object type list Select the type of object you want to mass
create. For more information, see section
47.1 “Object Types” on page 1327.
Use relative path Select Use relative path to use relative path
addressing, that is, if you want to create the
different alarms or trends in positions that all
relate to their respective objects with the
same pattern of relative path addressing.
Continued
Property Description
Topics
Schedules Overview
Schedule Bindings
Configuring a Schedule as a Shadow
40 Schedules Introduction
40.1 Schedules Overview
40.1.4 Calendars
A calendar is a list of exception events. Rather than entering several exception
events in a schedule, you can reference a single calendar. The calendar provides
the schedule with the dates when the exception events shall occur.
For more information, see section 44.2 “Calendars in WorkStation” on page 1254.
4. Click OK
OK.
Topics
Schedule Editor Overview
Schedule Editor in WorkStation
Advanced View of the Schedule Editor
Time Zones
Priorities
Editing an Event Priority
Schedule Colors in WorkStation
41 Schedule Editor
41.1 Schedule Editor Overview
Default value
The default value takes control of the value
when there are no events scheduled.
Continued
Number Description
41.5 Priorities
Priority is a number that corresponds to a preassigned level of importance. When
used in schedules, priority numbers include 1 through 16. 1 is the most important
and highest priority. Exception events always take precedence over weekly events.
When two exception events conflict, there is a specific way to determine which
event takes precedence. For exception events you can assign priorities to
determine the order of their precedence. By default, all exception events have a
priority of 16, which is the lowest priority. You can change that number to a higher
priority from 1 to 15.
There are two possible scenarios with the priority of events:
• Two events can have different priority numbers. In this case, the highest priority
takes control of the schedule.
• Two exception events can have the same priority number. In this case, the
position in the exception list determines the order of priority.
Each exception event is associated with a value assigned to the event. If the time
periods of exception events overlap, event execution is determined by the priority
number. For example, a priority 13 event has a higher priority than a priority 14
event.
For example, two coinciding events are scheduled for Friday. The priority of each
event determines the event that takes control of the schedule. In the schedule, the
fan in the room is set to 0 for all day at a priority 14. However, from 09:00 to 11:00 a
scheduled meeting needs the fan to be at 2 and has a priority 12. The schedule
adjusts the fan for the meeting and ignores the priority 14 event until the priority 12
event ends.
Default value
The default value takes control of the value
when there are no events scheduled.
Continued
Number Description
edit.
6. Click Ok
Ok.
Events of the same type that are next to each other in the schedule are presented in
different intensities of the color so you can easily see the start and stop time of
these events. For example, the weekly event Drawing from 7:00 to 11:00 is dark
green and the weekly event Painting from 11:00 to 15:15 is in light green.
Topics
Schedule Types
Digital Schedules
Creating a Digital Schedule
Binding a Digital Value to a Digital Schedule
Multistate Schedules
Creating a Multistate Schedule
Binding a Multistate Value to a Multistate Schedule
Analog Schedules
Creating an Analog Schedule
Binding an Analog Value to an Analog Schedule
42 Schedule Types
42.1 Schedule Types
4. Select the digital schedule that you want to bind to the digital value.
Continued on next page
5. Drag the digital schedule to the Binding column for the digital value.
4. Select the multistate schedule that you want to bind to the multistate value.
5. Drag the multistate schedule to the Binding column for the multistate value.
4. Select the analog schedule that you want to bind to the analog value.
5. Drag the analog schedule to the Binding column for the analog value.
Topics
Schedule Events
Displaying Client Time and Server Time in a Schedule
Deleting a Date List Entry from a Calendar
Weekly Events in WorkStation
Exception Events in WorkStation
Editing a Date Exception Event
Editing a Date Range Exception Event
Editing a Calculated Exception Event
Adding a Date Range Exception Event
Adding a Calculated Exception Event
Adding a Weekly Event
Adding a Calendar Exception Event
Adding a Date Exception Event
43 Schedule Events
43.1 Schedule Events
43.1.5 Priorities
Priority is a number that corresponds to a preassigned level of importance. When
used in schedules, priority numbers include 1 through 16. 1 is the most important
and highest priority. Exception events always take precedence over weekly events.
When two exception events conflict, there is a specific way to determine which
event takes precedence. For exception events you can assign priorities to
determine the order of their precedence. By default, all exception events have a
priority of 16, which is the lowest priority. You can change that number to a higher
priority from 1 to 15.
For more information, see section 41.5 “Priorities” on page 1199.
Start Date
• Start year: Any year
• Start month: March
• Day of month: Last day
• Day of week: Any day
End Date
• Year: Any year
• Month: April
• Day of month: Last day
• Day of week: Any day
Component Description
6. Click Ok
Ok.
Property Description
6. Click Ok
Ok.
3. In the Event grid, select the calculated exception event you want to edit.
Property Description
6. Click Ok
Ok.
12. In the Day of month box, select a day of the month for the start date and end
date.
13. In the Day of week box, select a day of the week for the start date and end
date.
14. Click OK
OK.
events button .
4. In the grid, click the start time. Drag the cursor vertically to select the end time
and then horizontally to select all days for which the event should be valid.
.
Continued on next page
4. Click Exception
Exception.
5. Click Calendar
Calendar.
6. Select All Day if the exception event is to be on or off all day.
7. In the Start Time column, type a start time for the exception event.
8. In the End Time column, type an end time for the exception event.
9. In the Value column, select a value for the exception event.
10. In the Name box, type a name for the exception event.
11. In the Priority box, select a priority for the exception event to make it override
conflicting events with lower priorities.
Continued on next page
12. In the Calendar box, enter the calendar that you want to add.
13. Click OK
OK.
14. On the File menu, click Save
Save.
Note
• You cannot specify different times and values for each of the different dates.
All dates specified in the calendar must have the same times and values
assigned to them.
.
Continued on next page
4. Click Exception
Exception.
12. In the Year box, select the year for the single date.
13. In the Month box, select the month for the single date.
14. In the Day of month
month, select a day of month for the single date.
15. In the Day of week box, select a weekday for the single date.
16. Click OK
OK.
17. On the File menu, click Save
Save.
Topics
Calendar Editor Overview
Calendars in WorkStation
Calendar Events
Creating a Calendar
Adding a Date Calendar Event
Adding a Date Range Calendar Event
Adding a Calculated Date Calendar Event
Configuring a Calendar as a Shadow
Storing Expired Calendar Events
Editing a Date Calendar Event
Editing a Date Range Calendar Event
Editing a Calculated Date Calendar Event
Schedule and Calendar Synchronization
44 Calendars
44.1 Calendar Editor Overview
To create a calendar
1. In WorkStation, in the System Tree pane, select the folder or server where
you want to create the calendar.
2. On the File menu, point to New and then click Schedule
Schedule.
3. In the object type list, select Calendar
Calendar.
6. Click Create
Create.
Now you can add dates, date ranges, or calculated dates to the calendar.
8. In the Day of week box, select the weekday for the date.
9. Click OK
OK.
10. On the File menu, click Save
Save.
3. On the Calendar Editor toolbar, click the Add Date Range button .
4. In the Entry name box, type the name that you want to display on the date
list.
5. In the Start year box, select the year for the start date.
6. In the Start month box, select the month for the start date.
7. In the Day of month box, select the day for the start date.
8. In the Day of week box, select the weekday for the start date.
9. In the Year box, select the year for the end date.
10. In the Month box, select the month for the end date.
11. In the Day of month box, select the day for the end date.
Continued on next page
12. In the Day of week box, select the weekday for the end date.
13. Click OK
OK.
14. On the File menu, click Save
Save.
7. In the Day of week box, select a weekday for the calculated date.
8. Click OK
OK.
9. On the File menu, click Save
Save.
Note
• Schedules cannot refer to a calendar located on another Enterprise Server or
Automation Server. You need to create shadow calendars in all servers that
contain schedules that are to refer to the calendar.
For more information, see section 44.13 “Schedule and Calendar Synchronization”
on page 1274.
4. Click OK
OK.
3. In the date list, right-click the date calendar event you want to edit and click
Properties
Properties.
Continued on next page
Component Description
5. Click Ok.
Component Description
5. Click OK
OK.
Component Description
5. Click Ok
Ok.
Building Operation supports lead and shadow schedules where exception events,
weekly events, and other configuration properties are duplicated in the shadow
schedules.
Building Operation also supports lead and shadow calendars where the date list is
duplicated in the shadow calendars.
Topics
Schedule Editor – Basic View
Basic Schedule Editor Toolbar
Advanced Schedule Editor – Graphic View
Advanced Schedule Editor Toolbar
Edit Effective Period Dialog Box
Edit Exception Dialog Box
Edit Time Value Period Dialog Box
Snap To Menu
Show Client Time Zone
Schedule Properties – Basic Tab
Schedule Event Properties Dialog Box – Weekly View
Schedule Event Properties Dialog Box – Single Date
Exception View
Schedule Event Properties Dialog Box – Date Range
Exception View
Schedule Event Properties Dialog Box – Calculated
Exception View
Schedule Event Properties Dialog Box – Calendar
Reference View
Calendar Editor View
Calendar Editor Toolbar
Calendar Properties – Basic Tab
Edit Calendar Entry Dialog Box – Add Date
Edit Calendar Entry Dialog Box – Date Range
Edit Calendar Entry Dialog Box – Calculated Date
45 Schedules User Interface
45.1 Schedule Editor – Basic View
Calendar view
Displays the calendar with exception events
in blue.
Event grid
Displays weekly and exception events in
Graphic view.
Delete
Click to delete events in the schedule.
Continued
Number Description
Calendar overview
Displays in blue the dates that contain
exception events.
Edit Schedule
Click to enter edit mode.
Preview Events
Click to display all the configured events for
a selected day.
Delete
Click to delete events in the schedule.
Graphic View
Click to configure events in graphic mode.
Text View
Click to configure events in the textual mode.
Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.
Previous transition time Displays the date and time the value most
recently changed.
Time since previous transition (min) Displays the amount of time in minutes that
has elapsed since the value last changed,
rounded to the next minute.
Next transition time Displays the date and time the value will
change.
Continued
Component Description
Continued
Component Description
Days of week Select the days of the week that apply to this
schedule.
Figure: Schedule Event Properties dialog box - Single date exception view
Table: Schedule Event Properties Dialog Box – Single Date Exception View
Component Description
Continued
Component Description
Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.
Figure: Schedule Event Properties dialog box - Date range exception view
Table: Schedule Event Properties Dialog Box – Date Range Exception View
Component Description
Continued
Component Description
Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.
Continued
Component Description
Continued
Component Description
Add Date
Click to add an event that occurs on a single
day. For more information, see section 45.19
“Edit Calendar Entry Dialog Box – Add Date”
on page 1304.
Delete
Click to delete events in the schedule.
Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.
Day of month Select a value for the day of the month. You
can use Any Day and Last Day as valid
entries.
Continued
Component Description
Topics
WorkStation
System Tree Pane
List View
Control Panel
Opening Control Panel
Quick Filter
Hyperlinks
Creating a Hyperlink
Utilities
46 WorkStation
46.1 WorkStation
46.1 WorkStation
WorkStation is the interface where you supervise your Building Operation system. In
WorkStation you can also create, modify, and delete some of the objects that are
used to build a Building Operation system.
Important
Ensure that you have a working and available WorkStation license. A working
license is required to log on to WorkStation. For more information, see section 9.6
“Licenses” on page 181.
Figure: The Quick filter is used in, for example, the List View (upper right), in the Watch
pane (bottom left), and in the Add/Remove dialog box (center right).
46.7 Hyperlinks
Building Operation supports hyperlinks. Hyperlinks can be added and displayed in
WorkStation. Hyperlinks can also be added in, for example, a graphic that is
displayed in WorkStation. In WorkStation, you can navigate on the web page in
same way as in a web browser.
Building Operation uses Microsoft Internet Explorer to present web pages. Plug-ins,
for example Flash and Java, have to be installed to be able to correctly display
pages that use these plug-ins.
To crate a hyperlink
1. In WorkStation, in the System Tree pane, select the folder where you want to
create the hyperlink.
2. On the File menu, point to New and then click Hyperlink
Hyperlink.
3. In the Name box, type a name for the Hyperlink.
4. In the Description box, type a description for the hyperlink.
5. Click Next
Next.
6. In the URL box, enter the URL for the hyperlink.
7. Click OK
OK.
46.9 Utilities
Building Operation is equipped with two types of utilities, Signal Generators and
Simple Math Operators. The utilities are used for testing, for example, trend logs
and alarms.
Topics
Object Types
Object Names
Object Properties
Opening an Object in a New Window
Object Tab Display
Showing the Same Tab While Navigating Between Objects
Showing Non-Presentation Objects in the System Tree Pane
Multi-edit
Editing Multiple Objects
Move, Rename, and Delete
Deleting an Object
Renaming a Folder or Object
Creating a Folder
Copying a Folder or Object
47 Building Operation Objects
47.1 Object Types
Figure: A server object with three properties tabs (left) and a value with only the basic
properties tab.
A common tab for all objects is the Basic properties tab that contains general
properties as type, name and description.
47.8 Multi-edit
Use Multi-edit when you want to change a lot of property values at the same time.
For example, you want to change all setpoints from 22 to 20. You select all the
objects in the List View, open the Properties grid, and then change the value in the
Value box. After you click Save, the changes take effect.
Figure: Multi–editing
The objects do not need to be of the same type to be edited. However, the
properties you want to edit have to be of the same type.
Note
When changing the name of a folder or server, you also have to reconfigure users
and user groups path permissions to this server or folder. For more information,
see section 21.4 “Path Permissions” on page 434.
To delete an object
1. In WorkStation, in the System Tree pane, select the object you want to
delete.
2. On the Edit menu, click Delete
Delete.
3. In the Confirm Delete dialog box, click Yes
Yes.
Note
When changing the name of a folder or server, you also have to reconfigure users
and user groups path permissions to this server or folder. For more information,
see section 21.4 “Path Permissions” on page 434.
Note
You cannot change the name of a domain that is shared between servers.
For more information, see section 47.10 “Move, Rename, and Delete” on page
1337.
To create a folder
1. In WorkStation, in the System Tree pane, select the folder, server, or network
where you want to create the folder.
2. On the File menu, point to New and then click Folder
Folder.
3. In the Name box, type a name for the folder.
Topics
Archiving Overview
Manually Creating an Archive
Creating a Scheduled Archive
Selecting an Archive File Format
Including Trend Logs in the Archive
Removing Trend Logs from the Archive
Including Alarm Events in the Archive
Including User Events in the Archive
Including System Events in the Archive
Event Archive and Trend Log Archive
Archiving Formats
Archive Folders, Files, and Names
Enabling the Archiving Function and Defining the Archive
Folder
Manual and Scheduled Archiving
Event and Alarm Enumerations
Trend Log Enumerations
48 Archive
48.1 Archiving Overview
Important
Archiving is performed only on an Enterprise Server. If you want to archive a
Trend Log on an Automation Server, use an Extended Trend Log in the Enterprise
Server to collect data from the Trend Log in the Automation Server. Archiving
cannot be performed on a standalone Automation Server.
The Enterprise Server service runs under the local system account in Windows.
To be able to access the network drives for archiving, you need to change the
account for the services.
48.11.1 CSV
Comma Separated Values is a standard text file that stores spreadsheet or
database information in a simple table format. Each record is on a separate line and
each field within that record is separated by a delimiter, such as a comma.
48.11.2 XML
Extensible Markup Language is a markup language that defines a set of rules for
formatting documents. Primarily, XML is used to structure, transport and store data
rather than to display data.
Figure: Archive folders listed in the specified directory on the file system
6. In the Path box, type the path to the directory where you plan to store the
archive files.
7. Click Save
Save.
You designate a different archive directory by typing a new address in the Path box.
Tip
Use the Day (delay) function when you set up a new scheduled archive to ensure
that all values of a log are included. The delay can be set from 1 to 7 days.
For more information, see section 48.3 “Creating a Scheduled Archive” on page
1348.
0 Normal
1 Alarm
2 Acknowledged
3 Reset
4 Disabled
5 Fault
0 Unassigned
1 Assigned
2 Accepted
0 Change of bitstring
Continued
Enumeration Value Enumeration definition
1 Change of state
2 Change of value
3 Command failure
4 Floating limit
5 Out of range
9 Extended
10 Buffer ready
11 Unsigned range
0 False
1 True
1 Shunt variable
2 Command
4 System
0 Normal
1 Off-normal alarm
Continued
Enumeration value Enumeration definition
5 Faulty alarm
Table: Hidden
Enumeration value Enumeration definition
0 False
1 True
0 Normal
1 Alarm
2 Acknowledged
3 Reset
4 Disabled
5 Fault
0 False
1 True
0 Server restarted
1 IO module offline
Continued
Enumeration value Enumeration definition
9 Device offline
10 Signal alarm
27 Network offline
28 IP connection offline
29 Signal event
31 Parser failed
32 Unit is locked
Continued
Enumeration value Enumeration definition
33 Unit is unlocked
34 Logging started
35 Logging stopped
37 Log full
Continued
Enumeration value Enumeration definition
0 Server initialized
1 Server shutdown
2 User logged on
10 Password changed
11 Property changed
12 Command executed
13 IO module offline
14 IO module online
15 Object created
16 Object deleted
17 Objects imported
18 Objects deployed
19 Object moved
Continued
Enumeration value Enumeration description
20 Object renamed
23 Object changed
Table: Event
Enumeration value Enumeration definition
0 Undefined
1 Log started
2 Log stopped
3 Data cleared
5 Config updated
6 Missed upload
7 Time padding
8 Log unconfigured
10 Log status
11 Log interrupted
12 Null value
Table: Status
Enumeration value Enumeration definition
0 None
1 Offline
2 Forced
4 Invalid
8 Override
16 In alarm
32 Fault
64 Out of service
Topics
Search Overview
Simple Search
Performing a Search Using Simple Search
Saving a Search
Search View
Advanced Search
Search for Objects Using Advanced Search
Setpoint Search Example
Non-Validated Programs Search Example
49 Search
49.1 Search Overview
For more information, see section 49.5 “Search View” on page 1377.
Note
• When you save a search, only the setting for the search is saved. The search
result is never saved.
Note
The Search box can never be empty. To perform a search, you have to enter
something in the Search box. If you want to search for all objects in a folder, enter
an asterisk (*).
To save a search
Note
The Search box can never be empty. To perform a search, you have to enter
something in the Search box. If you want to search for all objects in a folder, enter
an asterisk (*).
For more information, see section 49.6 “Advanced Search” on page 1380.
Figure: The Select Conditions dialog box when no object type is selected in the Include
types dialog box.
If you choose to include one or more object types in the Select types dialog you get
the common properties for these object types. If no object types is selected in the
Select types dialog box, only the general properties for all objects types is available
in the Select Conditions dialog box.
Search is performed with “AND” between different types of properties but with “OR”
between properties of the same kind.
If you include only one object in the Select type dialog box you can choose between
all the properties for that objects. For example if you choose Alarm in the Select
types dialog you can choose from all alarm properties in the Selection dialog box.
For example, to search for disabled alarms, you select alarm object type and then
select alarm state in the property list.
Figure: The properties available in the Select Conditions dialog box when alarm is
selected in the Include types dialog box.
There are different condition formats depending on property type:
• Enumeric values (optional non-exclusive)
• Textual matching (wildcard support)
• Date interval
• Boolean (true or false)
• Numeric range
Note
Strings in the Select Conditions dialog box are case sensitive, that is they differ
between upper and lower case. A description condition for the text string
"temperature" is not the same as "Temperature".
button .
2. In the text box, type your search.
3. In the In folder box, select the folder where you want to start the search.
4. Select Include properties to include properties in the search.
5. Select Include subservers to include subservers in the search.
6. Select Stop if more than 1000 results to stop the search at 1,000 results.
7. In the Include types box, click the browser button if you want to include a
specified object type in your search.
Continued on next page
12. Click OK
OK.
Figure: The Search View when you want to search for the word temperature in all objects
in Unviversity X.
To avoid all other hits, for example graphics with links that are named "setpoint" you
have to filter on the object type Point. This is done in the Select types dialog box.
Figure: The Select types dialog box when you filter on Point.
If you perform a search now you find all object types that are Points and namned
"setpoints" in any way. To filter out only the setpoints with a value of 22 or more we
have to set up a condition using the Select Conditions dialog box. We set the value
to be between 22 and 100.
Figure: The Select Conditions dialog box when value is set to be between 22 and 100.
When all search criteria is set we perform the search. The result is presented in the
Search result list.
Figure:
To be able to use the search once again without going through all the settings once
agin we save the search with the name "Setpoints over 22".
Figure: The saved search "Setpoints over 22" in the System Tree pane.
Figure: The Search View when you have entered an asterisk (') that finds all objects in
University X.
To narrow you search so that only program, Plain English or Function Block is found
you have to add Programs in the Select types dialog box.
Figure: The Select types dialog box when all objet types of the categoires Plain English
and Function Block is selected.
Then you select the conditions for the search in the Select Conditions dialog box.
We only want to find non-validated programs. Therefore we choose Validation from
the Add condition list, and then we select None and Failed, and click OK.
Figure: The validation conditions None nad Failed is selected in the Select Condition
dialog box.
Then we perform the search.
Figure: The search result for all program in University X that are not validated sucessfully.
To be able to use the search again without going through all the settings once more
we save the search with the name "Non-Validated Program Search".
Topics
Basic Functionality Icons in the System Tree Pane
File Menu
File Menu – New Submenu
Edit Menu
Actions Menu
Actions Menu – Activation Submenu
Actions Menu – Advanced Submenu
Actions Menu – Advanced Commands Submenu
Actions Menu – Modification Submenu
Actions Menu – View Submenu
Actions Menu - View Submenu - Watch Submenu
Watch Select Property Dialog Box
Tools Menu
Options Dialog Box
Control Panel View
Progress View – Advanced
Progress View – Simple
Operation Details Dialog Box
Error Details – Progress View
Create Object Wizard – Naming the Object Page
List View Toolbar
System Tree Pane Toolbar
Confirm Delete Dialog Box
Confirm Rename Dialog Box
Rename Object Dialog Box
General and References Properties
Retain Level
Configure Dialog Box - Configuration Tab
Configure Dialog Box – Operation Tab
Archive Settings Icon
Archiving Settings Properties – Basic Tab
Archiving Settings Properties – Content Tab
Search Icons
Search View
Search View Toolbar
Search Toolbar
Select Folder Dialog Box
Select Types Dialog Box
Select Conditions Dialog Box
Event Archive File
Trend Log Archive File
Add/Remove Columns Dialog Box
Analog Value Properties
Digital Value Properties
Multistate Value Properties
String Value Properties
Signal Generator Dialog Box
Simple Math Operator Dialog Box
Create Hyperlink Wizard – URL Page
Path Type
Select Object Dialog Box
Select Object and Properties Dialog Box
Progress View
System Object Properties
System Control Panel Properties
Commit Page
50 WorkStation User Interface
50.1 Basic Functionality Icons in the System Tree Pane
Folder
Indicates a folder.
Server
Indicates an Enterprise Server or an
Automation Server. For more information,
see WebHelp.
System
Indicates the System folder in a server. For
more information, see WebHelp.
Tasks
Indicates a Task that is used to run a Script
program of a Function Block program. For
more information, see WebHelp.
Archive settings
Archive setting icon as it is displayed in the
System Tree pane. For more information,
see section 48.1 “Archiving Overview” on
page 1345.
Search query
Indicates a saved search in the System Tree
and in the List View. For more information,
see section 49.1 “Search Overview” on page
1371.
Command Description
Continued
Command Description
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Continued
Command Description
Edit Sum Alarm Condition Click to open the Select conditions dialog
box, where you configure the conditions that
determine which alarms the sum alarm
surveys. For more information, see section
30.75 “Select Conditions Dialog Box – Alarm
Filter Properties” on page 856.
Edit the style of associated events Click to open the Event styles dialog box
where you style the appearance of a specific
event in the Events pane. For more
information, see section 32.2 “Event Styles
Dialog Box” on page 892.
Learn BDT Table Click to open the Learn BDT Table dialog
box where you learn the BACnet Broadcast
Device Table from one BBMD to another
BBMD. For more information, see WebHelp.
LCM sync date time Sends the server's date and time to each
LCM device on the LCM network. For more
information, see WebHelp.
Continued
Command Description
Continued
Command Description
Update SubLAN device firmware Click to open an I/NET native editor, where
you can restore the programming in a device
that is connected to the selected I/NET
device' subLAN. For more information, see
WebHelp.
Continued
Command Description
Enable trend log Click to enable the trend log. The trend log
starts when the start condition is fulfilled.
Disable trend log Click to disable the trend log and stop all
recording activity.
Clear trend log Click to clear all the records from the trend
log.
Command Description
Rebind
Cold Start Click to restart the device and clear the RAM
memory. For more information, see
WebHelp.
Add log record Click to open the Add log record dialog box
where you add values and comments to a
manual trend log. For more information, see
section 34.23 “Adding a Trend Log Record
to a Manual Trend Log” on page 992.
Trend log lists Use the Trend log lists submenu to open or
create a trend list. For more information, see
section 38.5 “Actions Menu - View Submenu
- Trend Log Lists Submenu” on page 1099.
Command Description
Use default properties Click to use the default property when you
monitor the variable.
Component Description
Show same tab while navigating between Click to open the same tab at all times when
objects you navigate between objects. For more
information, see section 47.5 “Object Tab
Display” on page 1332.
Reset all user settings Click to reset your locally saved user setting.
For more information, see WebHelp.
Continued
Component Description
Network time and time zones Click to open Network time and time zones.
For more information, see section 16.1
“Time and Time Zone” on page 309.
Backup and Restore Manager Click to open Backup and Restore Manager.
For more information, see WebHelp.
Operation details Dislays the time and text for the operation.
(Object type list) Select the type of object you want to create.
For more information, see section 47.1
“Object Types” on page 1327.
Continued
Component Description
Parent folder
Click to move up one folder.
Create Folder
Click to create a new folder.
Filter
Click to show non-presentaion objects. For
more information, see section 46.2 “System
Tree Pane” on page 1313.
Collapse All
Click to collapse the tree structure.
Component Description
Continued
Component Description
Cold start command Default value a Variable retains the Variable retains last
last value set by value set by a user or
either a user or an default if never set by
application. user.
Warm start Default value Variable retains the Variable retains the
command last value set by last value set by
either a user or an either a user or an
application. application or default
if never set by user.
Exporting & Default value Variable retains the Variable retains the
Importing last value set by last value set by a
either a user or an user or default if
application. never set by user.
Viewing Variable in Shows the last value Shows the last value Shows the last value
Building Operation set by either a user or set by either a user or set by either a user or
user interface an application an application. an application, but
not what is in the
configuration
database. b
database
Backup & Restore Default value Variable retains the Variable retains last
last value set by value set by a user or
either a user or an default if never set by
application. user.
Power loss and Default value Variable retains the Variable retains the
restore last value set by last value set by
either a user or an either a user or an
application. application or default
if never set by user.
a) 1. Initial value is the value that a variable will have when it is first created. It was determined by the
Building Operation developers at design time
b) 2. The last value set by a user is not visible in the UI if an application is also setting the variable. This
could cause unintended control problems when there is an import, cold start, upgrade, or restore. It
is recommended that Warm start retain level should not be used in cases where users and
application need to set a variable. An example might be a temperture set point that is visible in a
graphic for a user to change but also is driven automatically from a program. In this case, a Cold
start retain level should be used instead.
Figure: Using the Configure dialog box and the Configuration tab you can change or set
units for values.
Component Description
Reference Read-only.
Using the Null checkbox, you can remove any value of a property. The Null
checkbox is available for all properties where the value can be removed. For
example, you can remove references from trend logs using the Null checkbox.
Values can be forced to a certain value. The true value from the system is displayed
in the Unforced value box.
Figure: The Operation tab displaying both the forced and unforced value
Component Description
Continued
Component Description
Search query
Indicates a saved search in the System Tree
pane and in the List View. For more
information, see section 49.1 “Search
Overview” on page 1371.
Figure: Search
Stop if more than 1000 results Select to stop the search when the result
exceed 1000.
Continued
Component Descriptions
Save Search
Click to save the search for future use.
Save Search as
Click to save the search with a new name for
future use.
Add type
Click to add the selected object type to the
search.
Selected object types Displays the object types that are included in
the search.
Find type Type the name of the object type you want
to include.
Figure: Select conditions dialog box with the common properties for all object types..
Continued
Column Description
Continued
Column Description
Continued
Column Description
Acknowledge time Select to display the time and date when the
alarm was acknowledged. For more
information, see section 28.14
“Acknowledgement” on page 692.
Continued
Component Description
Disabled cause Select to display the cause for why the alarm
was disabled. An alarm can be disabled by
user, shunt variable and/or system (it’s
disabled by system if the alarm was
incorrectly configured).
Continued
Component Description
Continued
Component Description
Continued
Component Description
Component Description
Component Description
[Progress
Progress bar
bar] Displays the progress indication.
Topics
Shortcuts Overview
Shortcut Functionality
User Access to Shortcuts and Targets
Shortcut Presentation
Viewing Shortcuts
Viewing Shortcut Properties
Shortcut Creation
Creating a Shortcut
Configuring the Target of a Shortcut
Editing Shortcuts
51 Shortcuts
51.1 Shortcuts Overview
Note
• For the purposes of this discussion, examples of objects in the System Tree
pane are servers, folders, graphics or points.
As an example, you might want to view, in one place, the open or closed state of
the security doors in all of six different buildings on a site. However, the digital input
objects representing door status (open/closed) are distributed throughout the
System Tree pane on a building-by-building basis. To implement the required view,
you could create a folder in a convenient place in the System Tree pane, and within
the folder, create shortcuts to all the (door status) digital input objects in all six
buildings.
As another example, you could create a shortcut to an existing server or folder
complete with its internal objects.
You can create shortcuts in any server or folder in the System Tree pane (except for
the System folder). You can also create shortcuts to other objects (such as graphic
objects) and points (such as analog and digital values).
Delete Shortcut
Copy Shortcut
Move Shortcut
Rename Shortcut
Cut/Paste Shortcut
Properties Target
Open Target
1. In the System Tree pane, click the Filter icon to open the filter menu.
2. Select Show non-presentation objects
objects.
You can now view the properties of the shortcut(s).
Note
• You cannot view the properties of a shortcut by selecting the Properties
command. You must select the Shortcut Properties command.
*Except for the highest level server where there is more than one server.
To create a shortcut
1. In WorkStation, in the System Tree pane, select the object you want to create
the shortcut for.
2. Right-click and drag the object to the server or folder where you want the
shortcut.
3. Click Create Shortcut
Shortcut.
4. In the Select Object dialog box, select a Path Type option (if required).
5. Click Select
Select.
6. Click OK
OK.
Topics
Shortcuts Icon
Create Shortcut Wizard – Shortcut Target Page
Shortcut Properties – Basic Tab
52 Shortcuts User Interface
52.1 Shortcuts Icon
Topics
Documents
Creating a Document in WorkStation
53 Documents
53.1 Documents
53.1 Documents
A Document is a container in which you can upload (copy) a file for use in Building
Operation. You can upload all types of files including reports, forms, images, and
video clips. When you open an uploaded document, Building Operation invokes the
installed editor or viewer associated with the file type. For example, you can open,
edit, and save documents associated with Microsoft Office Word.
Document creation
Creating a Document is a two-step process: creating the object and then uploading
the file. First, you create a Document in WorkStation. Second, you upload a file into
a Document container, which is stored on the Automation Server to which you are
logged onto in WorkStation. You can view and edit Documents in WorkStation.
7. In the Open dialog box, select the file and click Open
Open.
8. In the Import document dialog box, click Create
Create.
Important
• You can import any file type, including .doc, .jpg, .pdf, or text,
without size restrictions. However, importing files larger than 17
MB to an Automation Server can produce an Insufficient Memory
error.
Topics
Document Properties – Basic Tab
New Document Wizard – Import Document Page
54 Documents User Interface
54.1 Document Properties – Basic Tab
04-13005-02-en
October 2012