PME EBO Integration Solution Guide
PME EBO Integration Solution Guide
PME/EBO Integration
Solution Guide
7EN02-0464-00
05/2021
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its subsidiaries
referred to in this guide are the property of Schneider Electric SE or its subsidiaries. All other brands
may be trademarks of their respective owners.
This guide and its content are protected under applicable copyright laws and furnished for
informational use only. No part of this guide may be reproduced or transmitted in any form or by any
means (electronic, mechanical, photocopying, recording, or otherwise), for any purpose, without the
prior written permission of Schneider Electric.
Schneider Electric does not grant any right or license for commercial use of the guide or its content,
except for a non-exclusive and personal license to consult it on an "as is" basis. Schneider Electric
products and equipment should be installed, operated, serviced, and maintained only by qualified
personnel.
As standards, specifications, and designs change from time to time, information contained in this
guide may be subject to change without notice.
DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.
WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.
CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.
NOTICE
NOTICE is used to address practices not related to physical injury.
Please Note
Electrical equipment should be installed, operated, serviced and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out of
the use of this material.
A qualified person is one who has skills and knowledge related to the construction, installation, and
operation of electrical equipment and has received safety training to recognize and avoid the
hazards involved.
Safety Information EcoStruxure™ PME/EBO Integration Solution Guide
Contents
Safety Information 3
Safety Precautions 8
Overview 9
About This Document 10
Applicability 10
Target Audience 10
Solution Components 11
Building Operation 3.2.3 11
Power Monitoring Expert 2021 11
EcoStruxure™ Web Services (EWS) 11
SmartWidgets 11
Extract Transform Load (ETL) Tool 11
Solution Limitations 12
Resources 13
Supporting Documentation 13
Other 13
Design 14
1. Software compatibility 15
Building Operation and PME version compatibility 15
Operating Environment 16
Port Settings 17
2. Computer hardware 19
PME 19
Building Operation 24
PME and Building Operation on the same computer 24
3. Solution architectures 25
Architecture 1 – Devices Connected to Building Operation 26
Architecture 2 – Devices Connected to PME 26
Real-time Data Flow 27
Alarms Data Flow 27
Historical Data Flow 27
4. Guidance on choosing an architecture 29
Data Collection 29
User experience 32
Commissioning time 34
IT Considerations 34
5. Communications and data transfer 35
Architecture 1 35
Architecture 2 36
6. Commissioning time 43
Architecture 1 43
Architecture 2 44
Estimation Guidelines 45
Installing 46
1. Downloading the PME/EBO Integration Toolkit 47
2. Installing Building Operation 48
3. Installing the components, snippets, and binding template 50
Installing Components and Snippets 50
Importing the Binding Template 50
4. Installing PME 51
Installing the PME software 51
Activating the licenses for PME 51
5. Installing ETL (only for Architecture 1 solutions) 53
Configuring 54
1. Configuring server settings 55
PME server 55
Building Operation server 55
2. Configuring Communications 56
Architecture 1 56
Architecture 2 64
3. Configuring PME Web Applications 72
4. Integrating PME Web applications in Building Operation 73
Prerequisites 73
Configuring web applications and generating the configuration import file for Building
Operation 73
Importing the configuration file into Building Operation 75
Setting up EWS credentials in PME (server) and Building Operation (client) 76
Enabling embedded content in PME and Building Operation 77
5. Setting up Graphics in Building Operation 80
Building Operation Components and Snippets 80
Setting up Electrical Network Graphics 81
Binding Graphics to measurements 83
6. Configuring Dashboards and Slideshows 85
Adding a new dashboard 86
Editing a dashboard 87
Sharing a dashboard 88
Moving a dashboard 89
Deleting a dashboard 89
Set default options for a dashboard 90
Configuring a slideshow 91
Adding a gadget to a dashboard 93
Editing a gadget 94
Moving or resizing a gadget on a dashboard 94
Operating 96
1. Accessing Dashboards and Slideshows 97
Viewing Dashboards 97
Dashboard Slideshows 98
Playing a Slideshow 98
2. Accessing Reports 99
Report templates 100
Subscriptions 100
Generating a report 100
Downloading a report 100
3. Accessing Alarms 102
4. Accessing EWS real-time values (only for Architecture 2 solutions) 103
5. Accessing device diagrams (only for Architecture 2 solutions) 105
Reference 107
Add-on device drivers for PME 108
Advanced ETL Configuration References 109
Position Counters 109
Logging setup 110
Extract task: Setting parameters and recommended values 111
Transform task: Setting parameters and recommended values 113
Load task: Setting parameters and recommended values 114
Manage ETL jobs 116
Tips for working with mappings 117
Measurement mapping for ETL 119
ETL tips and tricks 134
Measurement mapping for ETL 139
Configuring the PME EWS server for HTTPS 155
Configuring the PME EWS server regional setting 156
Database growth calculations 157
Factory default measurement logging 157
Custom measurement logging 157
Power quality event logging 157
Default device type support 159
Deploying and configuring a Multi-input Setpoint Display Bar graphic component 165
Deploying and configuring a Single-input Thermometer graphic component 168
Exposing custom device driver measurements through EWS 171
Manual integration steps without using the web application Integration Utility settings 173
Creating PME users for Building Operation 173
Creating Diagrams, Reports, and Dashboards links in Building Operation 173
Hosting EWS values in Building Operation 174
PME IP Ports 181
Setting SQL Server memory options 183
Terms and definitions 185
Time synchronization for ION meters 187
Enabling and configuring time synchronization 187
Using Table gadget in Slideshow 188
Safety Precautions
During installation or use of this software, pay attention to all safety messages that occur in the
software and that are included in the documentation. The following safety messages apply to this
software in its entirety.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software or devices for critical control or protection applications where human
or equipment safety relies on the operation of the control action.
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices to help prevent unauthorized access to the software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Work with facility IT System Administrators to ensure that the system adheres to the site-specific
cybersecurity policies.
Overview
The integration of PME with EBO – hereafter referred to as PME/EBO Integration solution – is an
engineered solution that embeds features of EcoStruxure™ Power Monitoring Expert (PME) into
EcoStruxure™ Building Operation (Building Operation).
The PME/EBO Integration solution provides access to PME Dashboards, Reports, Diagrams,
alarm and real-time data through Building Operation, for a seamless user experience.
PME/EBO Integration solution is intended for large buildings, such as high-rise commercial office
buildings, shopping malls, and university campuses. It provides easy to understand energy
information for building managers with limited electrical systems knowledge.
Target Audience
This guide is intended for Application Engineers, third-party integrators, and other qualified
personnel who are responsible for installing and integrating PME with Building Operation.
The deployment of the PME/EBO Integration solution requires application engineering expertise in
installing and configuring Building Operation and PME.
Solution Components
The PME/EBO Integration solution includes the following components:
SmartWidgets
SmartWidgets are device driver packages for Building Operation. SmartWidgets make it fast and
easy for you to add devices like Power Meters to the software. They are easy to install, and they
provide Modbus register mappings for the common measurements for a given device type. They
also provide Building Operation graphics components for consistent visualization and interaction
with devices.
Solution Limitations
Only the PME features that are embedded in Building Operation and that are described in this
document are available in the PME/EBO Integration solution.
The following additional features are available in a fully licensed version of the PME software:
• Power Quality Analysis Features such as Waveform Viewer, Harmonics Analysis, Phasor
Diagram, and so on
Only the PME Standalone Architecture installation type, where the PME application server and the
database server are installed on the same computer, is supported by the PME/EBO Integration
solution. The PME Distributed Database architecture installation type is not supported. See the
EcoStruxure™ Power Monitoring Expert System Guide for more information on PME installation
architectures.
Resources
Supporting Documentation
• EcoStruxure™ Power Monitoring Expert 2021 System Guide
Other
• PME Device Driver Summary Spreadsheet (shows native and downloadable drivers; includes
links to downloadable drivers)
• PME Device Driver downloads (SE, LE- Enter the device name in the search box to find the
driver)
Design
This chapter includes the following topics:
1. Software compatibility
2. Computer hardware
3. Solution architectures
6. Commissioning time
1. Software compatibility
This section describes the PME/EBO Integration solution software compatibility as well as the
operating environment requirements.
NOTICE
LOSS OF COMMUNICATION
• Activate product and component licenses prior to the expiry of the trial license.
• Activate sufficient licenses for the servers and devices in your system.
• Export the existing hierarchy template out of Power Monitoring Expert before importing a new
template. The new template can overwrite the existing template, which can permanently
remove all information contained in the original.
• Backup or archive any SQL Server database data before adjusting any database memory
options.
• Only personnel with advanced knowledge of SQL Server databases should make database
parameter changes.
Failure to follow these instructions can result in loss of data.
NOTICE
UNAUTHORIZED OR UNINTENDED ACCESS TO CUSTOMER DATA
• Personnel setting up the PME/EBO Integration third-party authentication must be aware that
links to data are not secure.
• Do not setup access links to sensitive or secure data.
Failure to follow these instructions can result in unauthorized or unintended access to
sensitive or secure customer data.
Operating Environment
PME
PME supports the following environments and software:
NOTE: The operating system and SQL Server combination you choose must be supported by
Microsoft. This applies to edition, version, and 32-/64-bit.
** PME includes a free version of SQL Server Express. You have the option to install this Express
version during the installation of PME, if you don't want to use a different SQL Server.
*** You must configure virtual environments with a supported Windows operating system and SQL
Server edition. It is possible to mix virtual and non-virtual environments for PME server and clients.
NOTE: Apply the latest updates to the OS and SQL Server before installing or upgrading PME.
Building Operation
Refer to EcoStruxure™ Building Operation Information Technology System Planning Guide for
supported operating systems and SQL Server versions.
Integration requirements
• For deployments where Building Operation and PME are installed on the same server, the
operating environment must be supported by both systems.
• The following browsers are supported when using PME Web Applications in Building Operation
WebStation:
Microsoft Edge
Google Chrome
Mozilla Firefox
• Installing PME and Building Operation Report Server on the same computer is NOT supported.
• Sharing SQL Server between PME and Building Operation Report Server is NOT supported.
Port Settings
PME
See PME IP Ports for more information.
Building Operation
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. Refer to the IT System Planning
Guide - EcoStruxure Building Management for a full list of required open ports.
Therefore, during the design phase, the IT policy needs to be checked to make sure this is
acceptable. If it is not, PME and the Enterprise Server should not be installed on the same computer
and should instead be installed on separate servers.
2. Computer hardware
PME
Choosing Computer Type, CPU, and RAM
The computer type, CPU, and RAM determine the overall performance and reliability of the system.
CPU is important for device communications and RAM affects SQL Server performance.
As a starting point for the selection of these components, we are defining two different system
categories, Basic Systems and Advanced Systems. Decide which category best describes your
system needs and then use the information provided in the tables below to define your computer
hardware specifications.
Basic Systems
A basic system is defined by any of the following characteristics:
• No custom applications
Desktop
Small ≤ 100 ≤5 Intel Core i5 (4 core)*
8 GB (RAM)
Workstation
≤ 250 ≤ 10 Intel Xeon Bronze (6 core)*
16 GB (RAM)
Medium
Server
≤ 600 ≤ 10 Intel Xeon Bronze (8 core)*
24 GB (RAM)
Server
Large ≤ 2500 ≤ 10 Intel Xeon Silver (10 core)*
32 GB (RAM)
Advanced Systems
An advanced system is defined by any of the following characteristics:
• Large scale data exchange with third party systems (for example through OPC, ETL, or EWS)
RAM
Distributed
Distributed
Database
System OPC Computer Database
Devices Users Standalone architecture
Size Tags Hardware architecture
architecture -
- Database
Application
Server
Server
Workstation
Small ≤ 100 ≤ 15 5000 Intel Xeon W- 16 GB 16 GB 16 GB
21xx (4 Core)*
Server
Intel Xeon
≤ 250 ≤ 20 10000 24 GB 16 GB 24 GB
Bronze (8
core)*
Medium
Server
Intel Xeon
≤ 600 ≤ 35 30000 32 GB 24 GB 32 GB
Silver (10
core)*
Server
Intel Xeon
Large ≤ 2500 ≤ 50 50000 64 GB 32 GB 64 GB
Silver (12
core)*
Storage Size
The data storage must have enough space for the different programs and applications that are
running on the computer. This includes space for the historical data that is recorded by the system
and some free space as a buffer.
The following table shows the estimated storage space that is required, without the historical data
logs. The estimates are rounded up and allow for updates and system maintenance.
Component Storage Space
Windows Operating System software 100 GB
Microsoft SQL Server software 2 GB
PME software 5 GB
PME system databases 5 GB
PME historical database (see below)
Free space 30% of the storage size
The storage space that is required for the historical database (ION_Data), is equal to five times the
size of the main database file (ION_data.mdf):
Storage Space for ION_Data (GB) = 5x .mdf (GB)
It can be broken down into the following components, where ION_data.mdf size is the estimated
maximum size when PME is in steady-state:
Component Storage Space
Main database file (.mdf) (1x) ION_data.mdf size
Transaction log file (.ldf) (1x) ION_data.mdf size
Last two full backups (2x) ION_data.mdf size
Free Space for Backups or tempDB (1x) ION_data.mdf size
Total (5x) ION_data.mdf size
Optionally, the component can include storage of archive database when data archive and / or trim
strategy is performed. For medium to large systems (250-2,500 devices), we recommend you to
perform data archive and / or trim strategy to support healthy database. See Archive and Trim
strategy for more information.
NOTE: Use the Database Growth Calculator tool to estimate the database size for 'n' years of
archive data. The tool is available through the Exchange Community. See Resources for link
information.
• The .ldf file is typically just 10% of the .mdf size, but occasionally expands to 100% during
normal operation.
• 100% of the .mdf size is required for free space. The tempDB will occasionally expand to 100%
of the total .mdf size, but not at the same time as a backup. If the backups and tempDB are on
different hard drive groups, each of them require x1 .mdf in hard drive space.
Unlike the system software, the historical database size is continuously growing. Its size and
growth can be estimated based on the amount of:
Also, the database is configured to automatically grow by 10% when required to create room for
additional measurements. This growth operation can occur at any time and you need to consider it in
the database size calculations.
NOTE: Use the Database Growth Calculator tool to estimate the database growth for your
system. The tool is available through the Exchange Community. See Resources for link
information.
For optimum performance, minimize database auto-growth by configuring the database container to
the estimated maximum size after growth. During commissioning, use the Database Growth
Calculator tool to estimate the maximum ION_Data database size based on your data retention
policy, and configure the database container to the estimated maximum value. For example, if the
ION_data database file is estimated for 2 TB and above in container size then split the database in
to multiple files. For more details on how to set database container size and / or to add new files to
be database, see Increase the Size of a Database. You can view the size of the ION_Data
database using the Database Manager tool.
Storage Type
The two main storage solutions that are available are Hard Disk Drives (HDD) and Solid-State
Drives (SSD). HDDs are good at providing cheap, bulk storage for non-performance critical data.
SSDs are good at providing strategic storage for high performance data. We recommend that you
use SSDs for the Microsoft Message Queuing (MSMQ) storage in medium, large, and extra large
PME systems.
Storage Configuration
Storage drives can be configured as single drives or a number of separate drives. For a small Basic
Systems, a single drive is sufficient. For all other systems, we recommend that you divide the data
storage into different drives.
RAID Systems
In addition to separating the software components into different drive groups, redundant arrays
(RAID) can be used to improve performance and add simple redundancy. In a RAID 1 configuration,
one drive is a complete copy of a second drive. If either of the two drives stops operating, the other
takes over without any data loss. The faulty drive can then be replaced to restore the RAID
configuration.
Group 0
Component
Drive 1+2
OS ü
tempDB ü
MDF ü
LDF ü
Backups and archive ü
4x Drive
Group 0 Group 1
Component
Drive 1+2 Drive 3+4
OS ü
tempDB ü
MDF ü
LDF ü
Backups and archive ü
6x Drive
8x Drive
NOTE: Plan for system growth by having a computer with space for additional drives. This makes
it easy to add additional storage as the system grows.
NOTE: It is possible to use other RAID configurations, such as RAID 0 or RAID 5. These
configurations are not discussed in this document.
Building Operation
For information on Building Operation hardware specifications, see the IT System Planning Guide -
EcoStruxure Building Management.
HDD
To install PME and Building Operation on the same server, add 2 GB to the required PME HDD
space for the Building Operation application and additional space for historical data in Building
Operation.
3. Solution architectures
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software or devices for critical control or protection applications where human
or equipment safety relies on the operation of the control action.
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
NOTE: Hybrid versions of the architectures are possible, to meet specific application needs.
• Historical data (Trend Logs), for display in Dashboards and Reports, is copied from Building
Operation to PME using the ETL.
NOTE: (Optional) Historical data for simple trending can be displayed directly through Building
Operation Trend objects.
• PME serves up historical data views in its Web Applications (Dashboards, Reports) to Building
Operation through its secured Web Server.
NOTE: (Optional) Historical data for simple trending can be copied to Building Operation via
EWS and displayed through Trend objects.
• Real-time data and alarm data are provided to Building Operation via EWS
• PME serves up historical data views in its Web Applications (Dashboards, Reports) to Building
Operation through its Web Server
Architecture 1
Building Operation collects the real-time data from the devices through an Automation Server or
Enterprise Server.
Architecture 2
PME collects the real-time data and provides it to Building Operation through EWS.
In Architecture 1, all alarm data is logged directly to the Building Operation database. You must
configure power alarms in Building Operation, manually, or through existing alarms in the
SmartWidget.
In Architecture 2, power alarm data is first logged to the PME database and then copied to the
Building Operation database using EWS. You must configure device based or software-based
power alarms in PME.
Architecture 1
Architecture 2
PME collects the historical data and copies it to Building Operation via EWS.
NOTE: The data transfer interval can be set to the PME logging interval, for example 15 minutes,
or to a longer interval, such as once per day, to transfer a larger set of data per connection.
Architecture 1
Building Operation collects the historical data and copies it to PME, using the ETL tool.
Architecture 2
• Data Collection
• User experience
• Commissioning time
• IT Considerations
NOTE: Hybrid versions of the architectures are possible, to meet specific application needs.
Data Collection
To decide which architecture is best for data collection, consider the following:
C. Device location
A. Device Type
Which types of power devices are used in the system is the most important aspect to consider
when selecting an architecture.
Use the flow chart below to help you with the decision-making process:
Descriptions:
SE (Schneider Electric) device
Most of the SE meters and circuit breakers are supported in PME by default. In addition, a large
number of add-on device drivers for PME can be downloaded from the Exchange community. For
those device types that are not supported by existing drivers, you can create custom drivers with
tools provided by PME. The commissioning time is reduced when there are pre-existing drivers for
your device types in PME.
Building Operation has SmartWidgets for some of the SE power devices. For those device types
that are not supported, you must perform manual mapping in order to communicate to the device.
The commissioning time is reduced when there is a SmartWidget for your device.
NOTE: If the device uses a protocol other than Modbus, further investigation on gateways might
be needed before choosing a communication architecture.
ION meter
ION meters use ION protocol, which is supported by PME but not by Building Operation. Therefore,
it is required to connect these meters to PME (à Architecture 2).
NOTE: Most of the ION meters also support Modbus protocol. However, advanced functions,
such as waveforms, on-board logging or on-board alarms, are not available through Modbus
communication. Therefore, connecting an ION meter through Modbus is not recommended.
Multi-address device
A Multi-address device is a Modbus device that has multiple Modbus IDs, such as the Masterpact.
Multi-address devices are supported in PME but not in Building Operation. In Building Operation,
multiple Modbus devices need to be created for each multi-address device, because each Building
Operation device can only have one Modbus ID. This increases the complexity of the system tree
structure and requires more commissioning time and effort as compared to PME (à Architecture 2).
PQ (Power Quality) functions
If the devices have PQ functions and you want to make use of these functions, Architecture 2 is
recommended because PME provides access to events, waveforms, reports, and all other power
quality related information (à Architecture 2).
On-board logging
If the devices have on-board logging functions, Architecture 2 is recommended because PME can
retrieve the on-board logs instead of doing software-based logging, like Building Operation (à
Architecture 2).
NOTE: On-board data logging is typically more reliable and more accurate than software-based
logging.
On-board alarming
If the devices have on-board alarming functions, Architecture 2 is recommended because PME can
retrieve the on-board alarms instead of monitoring the values and generating alarms in the software,
like Building Operation (à Architecture 2).
NOTE: On-board alarming is typically more reliable and more accurate than software-based
alarming, which is particularly important for power failure root cause analysis.
Conclusion:
For many applications, Architecture 2 is the better choice with regards to power monitoring device
types. However, when only low-end power meters, energy meters, or pulse meters are used, there
is no difference between the two architectures.
However, if many measurements are needed for each power device, we recommend you use
Architecture 2 to keep communication of the power devices separated from the building automation
devices.
C. Device Location
Consider the device location and communication network layout when choosing an architecture. If
all power devices are located together in the electrical room, then we recommend you use
communication gateways, such as the Link150, to connect them with dedicated daisy chains.
However, when a limited number of devices is located close to an Automation Server, it might be to
connect them directly to that server.
TIP: Since you can combine the two architectures, choose the most convenient way to connect to
the devices.
User experience
The user experience differs between the two architectures in two ways:
Architecture 1
Real-time data is collected and displayed directly by Building Operation. If there is a SmartWidget
available for a device type in Building Operation, users can use the pre-built graphics in the
SmartWidget. If there is no SmartWidget for the device, users must build their own graphics based
on their needs.
Architecture 2
Real-time data is collected by PME and then transferred to Building Operation through EWS. This
real-time data can then be displayed in the same way as in Architecture 1.
However, it is also possible to use the native PME diagrams to display the data, and then integrated
the diagrams into Building Operation through the PME Web Applications. This provides much more
detailed electrical views with more electrical information.
Unlike Building Operation, PME has native support for many types of power devices. Using the
diagrams in PME provides electrical views with more detailed information, reducing commissioning
time. However, for simple power devices with only a few registers, the extended diagrams from
PME become less valuable.
NOTE: If a device type is not natively supported by PME, additional commissioning time is
needed for creating a custom device type and diagrams.
Architecture 1
In Architecture 1, Building Operation polls the devices directly. The update rate of the real-time
values in the user interface depends on the following:
Architecture 2
In Architecture 2, PME polls the devices directly and then transfers the data to Building Operation
through EWS. The update rate of the real-time value in user interface depends on the following:
Because of the added communication layers, and the available real-time data bandwidth in PME,
the update rate for a real-time value for architecture 2 is typically slower than Architecture 1. Refer
to 5. Communications and data transfer for more information.
Conclusion
If the real-time update rate is your top priority and only a small number of registers are needed,
choose Architecture 1. Otherwise, choose Architecture 2 to make use of all the functions of your
power devices.
Commissioning time
The engineering time required for the integration varies for different architectures. See the 6.
Commissioning time section for details.
IT Considerations
The server recommendations are different for Architecture 1 and Architecture 2. See 2. Computer
hardware for more information.
Architecture 1
Device Communications
In Architecture 1, device communications are handled by Building Operation (Enterprise Server,
Automation Server, or any other BMS field-level devices).
Refer to the Architectural Guidelines - EcoStruxure Building Management document and relevant
device documentation for more communication design information.
NOTE: When logging data in Building Operation, it is recommended to use interval trend log to log
the raw data from meters. The cumulative raw data is then inserted into the PME database by the
ETL tool. PME Dashboards and Reports have an aggregation mechanism to make use of the data.
Hourly, daily, and monthly usage does not need to be calculated in Building Operation for PME
use.
If both Trendlog and Extended Trendlog are used, it is recommended to send the data in the
Trendlog to PME (via ETL) to avoid the lagging between Extended Trendlog and Trendlog.
It is recommended to plan the variables to be logged during the design phase so that the size of the
Trendlog files can be forecast. Also, it is important to plan which Trendlogs are to be transferred to
PME in order to forecast the size and growth of the database.
ETL Jobs
An ETL job is a set of task definitions that the ETL engine follows in order to Extract, Transform, and
Load data from one data source to another. An ETL job contains an extract task to pull the data, a
transform task to manipulate the data, and a load task that applies the data to the new location.
After the job is set up, you can set the job to run as a service. When set to run as a service, a job
automatically runs at set times based on the settings you input in the Job tab. The Sleep Time
Between Execution value (in seconds) allows you to define the frequency with a default value of
3600 seconds. The value defines when new data can be displayed in the Dashboards and Reports.
You can use a smaller value if you want the job to run more frequently. For meter interval data, 900
seconds is usually fast enough for the updates. When increasing this value, consider the Building
Operation Trendlog size to make sure it can be covered before being overwritten in order to prevent
missing TrendLogs.
ETL does not use any of the PME processes, so this has little impact on PME performance while
loading. SQL supports multi-threading and will serve both ETL and PME needs. If SQL is
overloaded, the data buffer handles it.
Architecture 2
Real-time Communication
The following flow chart shows the detail of the real-time data flow in PME when integrating with
Building Operation under Architecture 2.
EWS Communication
There are two configurable settings that control the EWS communication and that you can use to
optimize system performance: Value Poll Interval, in Building Operation, and Real-time Refresh
Rate, in PME.
Communication Performance
The following shows the results of an EWS server performance test in PME:
NOTE: This test was performed on an earlier version of the PME/EBO Integration solution, called
Power Manager at that time.
NOTE: The EWS response time is independent of the measurement and device type, as long as
the number of measurements, and the number of devices they were distributed across, remains
the same.
The chart below shows a graphical representation of the EWS response time vs. Number of tags in
an EWS request:
As discussed previously, the EWS request is sent from Building Operation only when there is a
need, for example a graphic is open. Therefore, typically an EWS request from Building Operation to
PME contains less than 1000 tags. For example, if 100 devices are shown in one graphic, and each
has four bound values, then an EWS request for the 400 values (tags) is sent to the PME EWS
Server when the graphic is opened in Building Operation. In case, based on the above test results,
the EWS response time is about three seconds. This provides plenty of buffer time with a 20 second
value polling setting in Building Operation as the default.
NOTE: Consider the impact on other parts of the Building Operation system, when tuning the
polling rate to achieve faster refresh.
Alarm Communication
In Architecture 1, alarms are created in Building Operation, Automation Server or Enterprise Server.
In Architecture 2, technically the alarms can be created in both systems, PME or Building
Operation. A proper design of the alarm generation logic and communication is important for a
successful solution.
PME Alarms
PME alarm data is transferred to Building Operation using EWS. It is important to understand the
two possible sources of an alarm in the PME system:
• On-board alarm – Generated and logged in the device (meter, circuit breaker, and so on)
• Software-based alarm – Generated by the PME software and logged in the computer cache.
On-board Alarms
For important alarms, such as circuit breaker trips, power outage, or over current, try to use the
device on-board alarms in circuit breakers or meters. Even for a less important alarms, on-board
alarms are recommended to use to gain higher system reliability and also to make use of the device
functionality.
If the device does not have on-board alarming, or additional alarms need to be created, it is
recommended to create the alarm in Software Alarms in PME, rather than create an alarm in
Building Operation based on real-time values read via EWS.
PME alarms are polled only if the Alarm Polling is enabled for the EWS interface in Building
Operation.
A filter can be configured to poll only the alarms that are needed.
The priority of an alarm or event can be configured in the PME system. The typical PME alarm
priority categorization is:
• Information: 0 - 63.
NOTE: Any alarm priority setting greater than 255, in Building Operation, will be set to 255 for
PME.
When a user acknowledges EWS alarms in Building Operation, the corresponding alarms in the
PME system are also acknowledged automatically.
With the default software settings, an on-board alarm event is expected to be seen, in Building
Operation within 90s on average. The settings can be tuned to achieve faster performance. Using
the same concept, for a software-based alarm, the latency depends on the Building Operation EWS
polling rate and the alarm polling rate defined for the alarm.
NOTE: Consider the impact on other parts of the system, such as the real-time data performance
when tuning the polling rate to achieve a faster alarm refresh rate.
When choosing Architecture 2, it is not recommended to create Building Operation alarms based on
real-time values read via EWS. For real-time values, EWS communication only takes place when
there is a need, for instance, a graphic is opened by the user. In contrast, if an alarm is created
based on an EWS tag, then the EWS real-time subscription for this value will be constantly active.
However, in Building Operation, the EWS alarm object is not the same as a regular alarm object. If
there are requirements for consistent alarm messages, alarm priority, and user action associations,
which EWS alarms may not meet, it is recommended to use the Building Operation Sum Alarm
function to create a new alarm on top of one or more EWS alarms. Then the newly created Building
Operation alarm can be managed consistently with other Building Operation alarms. Refer to
Building Operation online help for more information about the Sum Alarm function.
6. Commissioning time
The engineering time required for the integration varies for different architectures. Typically, it is
faster to deploy Architecture 2 than Architecture 1 for the following reasons:
• When the power devices are supported by PME, it is faster to configure the devices in
Architecture 2 than in Architecture 1, even when there are SmartWidgets available in Building
Operation. When no SmartWidgets are available, the time for creating the Modbus map in
Building Operation can be considerable.
• Configuring the ETL to setup the historical data transfer from Building Operation to PME, which
is required for Architecture 1, can add considerable deployment time.
Architecture 1
Below are commissioning time estimates for PME/EBO Integration solutions for Architecture 1:
Standard
Average
Architecture 1 Configuration Workflow Deviation
Time (min)
(min)
Installing and licensing Building Operation *
1.1 Installing and licensing License Server
1.2 Installing Enterprise Server
1.3 Installing Workstation
1 16.7 1.5
Installing Building Operation Connector
1.4
components, snippets, and binding template
Single-server install only: Changing Building
1.5
Operation ports
Installing and licensing PME *
2.1 Installing PME
2 54.7 18.4
2.2 Activating PME licenses
2.3 Single-server install only: Changing PME ports
Configure the devices in Building Operation with
SmartWidgets
3.1 Configuring Modbus Master Interface
3 3.2 Importing SmartWidgets 81.7 36.6
3.3 Modifying SmartWidgets graphic
3.4 Creating trend logs for SmartWidgets
3.5 Copy, paste and edit to have the full system
ETL
4.1 Installing ETL
4.2 Creating ETL job
4 40.3 30.3
4.3 Adding and configuring the tasks
4.4 Configuring the mapping
4.5 Run job once and then register as a service
Architecture 2
Below are commissioning time estimates for PME/EBO Integration solutions for Architecture 2:
Standard
Average
Architecture 2 Configuration Workflow Deviation
Time (min)
(min)
Installing and licensing Building Operation *
1.1 Installing and licensing License Server
1.2 Installing Enterprise Server
1.3 Installing Workstation
1 14.0 6.1
Installing Building Operation Connector
1.4
components, snippets, and binding template
Single-server install only: Changing Building
1.5
Operation ports
Installing and licensing PME *
2.1 Installing PME
2 41.0 8.2
2.2 Activating PME licenses
2.3 Single-server install only: Changing PME ports
Configure the devices in PME
3.1 Adding Devices in PME
3 23.0 9.0
3.2 Generating a Vista Network Diagram
3.3 Update EWS Server
Web Application Integration Utility Settings and
Building Operation Import
4 4.1 Configuring web applications 15.3 7.8
4.2 Exporting the XML
4.3 Importing the XML
Estimation Guidelines
Below are guidelines for estimating the engineering time required to set up the key components of
an PME/EBO Integration solution.
Software Installation
The installation and licensing of the solution does not vary based on the size of the system.
Device Configuration
The time required to configure the devices varies greatly based on the device types and their native
support in the system. Do not simply multiply the amount of time provided in our commissioning
time estimates by the number of devices in your system. Use the estimates only as a general
guideline for the engineering time that might be required.
ETL
Configuring the ETL to setup the historical data transfer from Building Operation to PME is an
additional task for Architecture 1, which takes a considerable amount of time. The required effort
depends on the number of devices, device types, and the number of logs and measurement types.
The use of batch editing, when configuring the Mapping in the ETL, can significantly reduce the
configuration time.
• The time it takes to export the XML will vary somewhat based on size of the system.
• The export and import in Building Operation takes slightly longer for larger systems.
Setting up Graphics
For the graphics configuration (Electrical Network Graphics) the time recorded was the time to build
them from scratch. The default Electric One Line Diagram ANSI/IEC and default Electrical Health
Summary Screen is part of the reference system package. Time can be saved by modifying the
default diagrams rather than building them from scratch.
Installing
Installing the PME/EBO Integration solution includes the following steps:
4. Installing PME
• The Toolkit contains ETL only. To get the toolkit, download the PME_EBO Integration
Tools.zip file from the Exchange Extranet (see Resources for link information). Extract the
files in the zip archive to the location on the Building Operation server, where you want to run
the tools.
• The Building Operation components, snippets, and binding template are available in PME ISO
under EBO Integration Files folder. Copy this folder to the location on the Building Operation
server, where you want to run the tools.
• The Integration Utility is a Web application settings in PME. Open the Settings page from the
SETTINGS link in the Web Applications banner and navigate to Security -> Integrations->
Integration Utility.
NOTICE
LOSS OF COMMUNICATION
• Activate product and component licenses prior to the expiry of the trial license.
• Activate sufficient licenses for the servers and devices in your system.
Failure to follow these instructions can result in loss of data.
3. Install Workstation.
3. Under Communication Ports, change the values for the server ports, for example change the
HTTP Port to 8080 and the HTTPS Port to 446.
NOTE: For the HTTP server port, do not use the value 80, and for the HTTPS server port, do
not use the value 443—these values are reserved for PME.
4. Click Start Service, allow time for the service to start, and then click OK to exit.
After you changed the server port settings, you must modify the Building Operation Workstation
login.
1. Open Workstation.
2. Add ":446" (the HTTPS port defined above) to the server information. For example, if your
server name is "Standalone", make it appear as "Standalone:446".
3. Provide your user name and password credentials and click Log on.
Components are standardized, predefined graphics that represent features in a live system. They
are located in dedicated libraries, and are displayed in the Components pane. You add components
to a graphic instead of drawing all the drawing objects yourself to simplify the graphics creation
process.
Snippets are standardized, predefined functions that typically represent a feature in a live system.
They are located in dedicated libraries, and are displayed in the Snippets pane.
The binding template is used to automatically bind EcoStruxure Web Services (EWS)
measurements or SmartWidget values to corresponding measurements in Building Operation
graphics library objects. Using the binding template, you create bindings between the Automation
Server program variables, internal values, and I/O points.
NOTE: Before you install these tools, close the Building Operation Graphics Editor.
2. Navigate to the EBO Integration Files > Graphics Editor > Components folder.
3. Double-click each file in the Components folder. The components (ANSI Symbols, Generic
Components, IEC Symbols, and Meter Graphics) are installed in the Graphics Editor and
appear in the Components pane at the left.
4. Navigate to the EBO Integration Files > Graphics Editor > Snippets folder.
5. Double-click the file in the Snippets folder. The snippets are installed and appear in the
Snippets pane at the left.
3. Right-click Binding Templates and select Import from the list. The Open dialog appears.
4. Navigate to EBO Integration Files > WorkStation and select Power Manager - Binding
Template.xml.
6. Click Import.
4. Installing PME
The following describes the installation and licensing of PME.
NOTE:
If possible, log on to your Windows system using the built-in local Administrator account for
installing PME. If that is not possible, use an account that is a member of the Administrators
group. Permissions for the Administrators group can be restricted by system policies which might
affect the PME installation. The built-in Administrator account does not have such limitations.
Starting with Microsoft Windows 10 and Windows Server 2016, the Administrator account cannot
be used for software installation. For these operating systems use an account that is a member of
the Administrators group
1. Insert the PME DVD or mount the PME ISO. Double-click MainSetup.exe to begin the
installation. The installation dialog appears.
2. Select a language from the drop down list, and click Next. Follow the install pages and
instructions until you get to the Setup Type page.
3. For Setup Type, select Standalone Server. The other Setup Types are not supported for the
PME/EBO Integration solution. Click Next.
4. Follow the install pages and instructions, using the default settings where possible, until you
get to the Supervisor Account page.
5. For the Supervisor Account, set a strong password for the supervisor user. Click Next.
6. Follow the install pages and instructions, using the default settings where possible, until you
have completed the installation.
For more details on installing PME, see the EcoStruxure™ Power Monitoring Expert System Guide.
NOTICE
LOSS OF COMMUNICATION
• Activate product and component licenses prior to the expiry of the trial license.
• Activate sufficient licenses for the servers and devices in your system.
Failure to follow these instructions can result in loss of data.
NOTE: Licenses can also be activated using offline method. For offline activation steps, see the
EcoStruxure™ Power Monitoring Expert System Guide.
1. On the PME server, open the License Configuration Tool, and click Activate License.
NOTE: You can access the License Configuration in the install location within
....\Schneider Electric\Power Monitoring Expert\License
Configuration Tool.
3. On the Activate License page, enter the Activation ID, and then click Activate.
5. Open the PME Management Console and login with the supervisor account to confirm that the
license is working.
NOTE: Device licenses are required for all the devices connected to PME under Architecture
2. The Trial license for PME includes unlimited device license for the first 90 days.
For further instructions on the purchase and activation of licenses, see the EcoStruxure™ Power
Monitoring Expert System Guide.
NOTE: On Windows Operating Systems with restricted permissions, the ETL tool might not
initialize and load its plugins on start up. This is due to limited write permission on the ETL default
install folder (...\Program Files\...). A possible solution is to install ETL to a custom folder
with write permission (for example, C:\ETL).
1. In File Explorer, navigate to where you extracted the PME/EBO Integration Toolkit.
2. Navigate to PME_EBO Integration Tools, and run the ETL.exe to open the installer.
3. Follow the install pages and instructions, using the default settings where possible, until you
have completed the installation.
Configuring
Configuring the PME/EBO Integration solution includes the following steps:
2. Configuring communications
NOTE: These steps are required for both solution architectures, unless specifically called out in
the workflow steps.
A security certificate must be installed on the PME server and must be bound to the Default Web
Site, which is used by PME. By default, if no bound certificate is detected, PME is installed with a
self-signed certificate.
RECOMMENDATION: We strongly recommend that you replace the self-signed certificate with
an authority issued certificate.
NOTE: Setting the SQL Server memory options applies only to full, standard editions of SQL
Server. It does not apply to SQL Server Express editions.
See the EcoStruxure™ Power Monitoring Expert System Guide for additional recommended post-
installation configuration steps.
When installing on separate servers, you must configure Internet Explorer on the Building Operation
computer to add the PME server URL as a Trusted site.
1. Open Internet Explorer and navigate to Tools > Internet Options, then click Security.
2. Select Local intranet, and then click Sites. The Local intranet dialog appears.
4. In the Add this website to the zone field, enter your PME server site address, and then click
Add. Your PME server site is now added as a Local intranet site zone.
5. Click OK. Your system can now authenticate your Power Monitoring Expert server.
2. Configuring Communications
The configuration of the software and device communications is dependent on the solution
architecture. The following describes the configuration required for Architecture 1 and 2.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Architecture 1
Configuring communications for Architecture 1 includes the following steps:
Confirm that:
We recommended you setup a dedicated ETLUser account for EWS in Building Operation.
To create an account:
• An Extract task to read out the data from a server (in this case, Building Operation)
• A Load task to write the data to the new location (in this case, the PME database).
TIP: When creating a new job in ETL, you can clone an existing job, rather than making a job from
scratch. To clone a job, select an existing job from the Job Management drop down and click Edit.
In the Job tab, change the name to reflect the new job. Click the Task tab and edit the new job as
necessary. Click Apply or OK from any tab location to save the job with the new name.
The following sections describe how to configure an ETL Job for the PME/EBO Integration solution,
Architecture 1 implementation.
Prerequisites
Before configuring the ETL, confirm that:
• Trend logs and Extended Trend logs are setup and ready to use in Building Operation. For
information regarding Trend logs, refer to the "Trend log" section in the EcoStruxure Building
Operation System Reference Guide
1. On your desktop, double-click the shortcut EcoStruxure ETL (Building Operation to PME) -
ETL Administration Tool. The ETL Engine Job Configuration Tool dialog appears.
3. Enter the name of the job in the Name field. If you are running the job as a service, review and
change the Sleep Time Between Execution value, if necessary. This value determines the
length of time between jobs when a job is run as a service. The default value is 3600 seconds.
TIP: See ETL tips and tricks for information such as batch edits, sorting and searching data grids,
running a job manually or as a service, editing job tasks.
2. From the Select Type drop-down, select EBO EWS Extract Task, and then click Add. The
EBO EWS Extract Task appears in the pane below.
3. Select the task to show the task settings in the right pane.
4. Complete all fields as necessary for the task. Complete at least the following fields:
Web Service User Name – The Building Operation EWS user name (for example: admin)
Web Service URL – Replace localhost:8080 with your <server name>:<http port
number>
NOTE: The ETL does not support secure HTTP (HTTPS) URLs. Do not use HTTPS URLs with
the Building Operation EWS server.
NOTE: The ETL does not support the SHA-256 Cryptographic Hash Algorithm for authentication.
You must enable the MD5 Cryptographic Hash Algorithm for authentication in Building Operation
for the PME/EBO Integration solution. The option can be found in WorkStation Control Panel >
Security Settings > Disable MD5 Hash.
To test your EWS connection, click the Web Service URL row to display an ellipsis button. Click
the ellipsis button. Enter your Web Service URL and then click Test.
Refer to Extract task: Setting parameters and recommended values in the Reference section to see
a complete list of parameters and recommended values for each setting.
Below is an example of a 15-minute interval data log with irregular timestamps, before and after the
transform:
NOTE: The transform only corrects the timestamps, not the logged data values for the intervals.
This can introduce inaccuracies in the logged data.
• when timestamp consistency between the data in Building Operation and PME is important
2. from the Select Type drop-down, select IntervalizeDataTransformTask and then click Add.
The Intervalize Transform Task appears in the pane below.
3. Select the task to show the task settings in the right pane.
4. Complete all fields as necessary for the task. Complete at least the following field:
Target Reading Interval – Set this value to your Trend log logging interval (default is
fifteen minutes).
Refer to Transform task: Setting parameters and recommended values in the Reference section to
see a complete list of parameters and recommended values for each setting.
2. Select Power Monitoring Expert Load Task from the Select Type drop-down menu, and then
click Add. The Power Monitoring Expert Load Task appears in the pane below.
3. Select the task to show the task settings in the right pane.
4. Complete all fields as necessary for the task. Complete at least the following fields:
Database Settings – Make sure all 3 database settings are correct.
NOTE: If you plan to use the Energy Cost Report or Load Profile Report, review the Enable
Recorder and Channel Creation setting in Load task: Setting parameters and
recommended values.
5. After you finish configuring all necessary tasks, click Apply to save your changes without
exiting the job, or click OK to save and exit the job.
Refer to Load task: Setting parameters and recommended values in the Reference section to see a
complete list of parameters and recommended values for each setting.
TIP: See ETL tips and tricks for information such as batch edits, sorting and searching data grids,
running a job manually or as a service, editing job tasks.
1. In the ETL tool, select the job you created for the PME/EBO Integration solution.
3. Click Load Sources. Trend logs from Building Operation load and appear in the Mappings
pane.
Depending on the size and the design of your system, the Trend logs may take some time (up
to 30 minutes) to load.
After you click Load Sources, the Client status details appear at the lower left of the dialog and
show the number of tags loaded and folders searched.
4. Once loaded, identify the rows containing the Trend logs that you want to import into PME.
NOTE:
If you create a new device, your new device name must match the PME naming
convention. The following limitations apply:
Names cannot contain spaces or the following characters: \ / : * ? " < > { } . , ' & @ |
%#
Do not use names such as CON, AUX, COM1, and LPT1 when naming sites and
devices.
Complete the Target Measurement field by selecting an existing measurement from the
drop-down list.
Refer to Measurement mapping for ETL in the Reference section to learn about the most
common, supported measurements used in PME and how to link to typical Building
Management tags.
Select the checkbox in the Included column at the left to include the Trend log in this job.
6. After you have mapped all desired Trend logs, click Apply to save the job.
• Missing bindings: Values that have not been bound to the graphics.
• Trend log status is not Started: If the Trend log status is not “Started” in Building Operation
through the EWS server, the Trend logs will not be exposed in the ETL tool, and therefore, those
Trend logs will not be returned or displayed in the ETL tool. All Trend logs should be exposed in
the ETL tool and appear in the Mappings tab when you click Load Sources. Before you run an
ETL job, in Building Operation, check to make sure that the Trend log status is set to “Started”;
• Meters/servers offline: The Trend logs are connected to devices or servers that are offline.
• Extended Trend log link not broken: Trend logs that are being monitored by Extended Trend logs
where the connection is not broken.
Architecture 2
Configuring communications for Architecture 2 includes the following steps:
NOTE: Device licenses are required for all devices connected to PME. The PME trial license, that
is part of the PME/EBO Integration solution, includes an unlimited device license for the first 90
days. You must activate valid purchased licenses within 90 days, otherwise some software
functionality is disabled.
NOTICE
LOSS OF COMMUNICATION
• Activate product and component licenses prior to the expiry of the trial license.
• Activate sufficient licenses for the servers and devices in your system.
Failure to follow these instructions can result in loss of data.
Use Management Console in PME to add, remove or configure system components, such as
Ethernet or serial metering devices, in your system.
NOTE: Run Management Console as Administrator user. To do this, right-click the Management
Console program icon and select Run as administrator from the context menu. If you do not run
it as Administrator, then certain tools such as Update EWS Server are not functional.
NOTE: Access to this application or function is controlled by user privileges. See Default User
Access Level Privileges in Web Applications help, and Customizing Access Level Privileges
in User Manager help for details.
NOTICE
NETWORK INOPERABILITY
Do not make unauthorized changes in the network configuration.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
NOTICE
NETWORK INOPERABILITY
Do not make unauthorized changes in the network configuration.
The Primary Server contains all the Power Monitoring Expert programs and it controls the overall
operation of your energy management system. The primary server is displayed on the Server screen
when you first start Management Console.
To start building your system, add and configure your sites and devices.
Overview
• Names cannot contain spaces or the following characters: \ / : * ? " < > { } . , ' & @ | % #
• The maximum length for a Group.Device name is 99 characters (+ 1 for the period
separation).
• Do not use names such as CON, AUX, COM1, and LPT1 for sites and devices.
• All characters must exist in the system's Windows code pages. For example. on an English
Windows operating system, certain non-English language characters are not supported.
1. In the System Setup pane, select the icon for the type of item that you want to add ( Site,
Device, or Dial Out Modem).
2. Right-click the display window, select New, and then select the specific type of network
component from the shortcut menu to open the Configuration dialog.
The options differ depending on which system setup icon you selected.
3. Use the fields and drop-down menus to configure properties. Mandatory items are highlighted
in red. To configure advanced properties, right-click the dialog and select Advanced
Properties. For more shortcut menu options, see Configuration Dialog shortcut menus,
below.
• Property Details: This opens a window that contains information on the selected property,
including minimum and maximum allowable values, if applicable.
• Advanced Properties: This exposes all the property fields that are hidden in the default (basic)
view. For further information about the Time synchronization option. see Time synchronization
for ION meters for further information.
Adding a server
Click the Servers icon, right-click the display window and select New > Computer. Fill in the
mandatory Name field.
Adding devices
• Group: Type a name for the group or select an existing group from the list.
• Unit ID: Type the Unit ID of the device; the range is 1-9999 for ION devices or 1-247 for
Modbus RTU devices.
• Time Zone: Select the timezone you want the device data to be displayed in, in the software.
This setting is only used for the display of timestamped data in the software. It does not affect
the configuration of the monitoring device itself.
Complete the Name, IP Address or Host Name and TCP/IP Port fields. (The IP address can be
IPv4 or IPv6.) The TCP/IP Port identifies which communications port is used to connect to the
serial devices. The port you use depends on the type of Ethernet gateway you want to set up (use
7801 for an EtherGate gateway via COM1 or use port 502 for a Modbus gateway).
• Group: Type a name for the group or select an existing group from the list.
• Unit ID: Type the Unit ID of the device; the range is 1-9999 for ION devices or 1-247 for
Modbus devices.
• Site: Select the Ethernet gateway site you previously set up.
• Time Zone: Select the timezone you want the device data to be displayed in, in the software.
This setting is only used for the display of timestamped data in the software. It does not affect
the configuration of the monitoring device itself.
NOTE: For the Time Zone field, select the timezone you want the device data to be displayed in,
in the software. This setting is only used for the display of timestamped data in the software. It
does not affect the configuration of the monitoring device itself.
Make sure you follow the correct syntax when typing in the address for the OPC site. Select the
Address field to see an example address in the Property Description section (near the bottom of the
OPC Site Configuration dialog).
NOTE: At least one OPC Device Type needs to be preconfigured before an OPC Device can be
created in Management Console. Contact Technical Support for assistance.
Click the Devices icon. Right-click the display window and select New > OPC Device. Fill in the
Group, Name, Device Type, Site (select the OPC site you previously set up), and Time Zone.
Configure the other fields as you require.
NOTE: For the Time Zone field, select the timezone you want the device data to be displayed in,
in the software. This setting is only used for the display of timestamped data in the software. It
does not affect the configuration of the monitoring device itself.
Adding a modem
1. Click the Dial Out Modems icon, right-click the display window and select New, then select
either Serial Modem (hardware modem) or WinModem (Windows modem).
3. Click OK.
1. In Microsoft Windows, click Start > Settings > Control Panel, then double-click Phone and
Modem Options.
2. Click the Modems tab, select your WinModem, then click Properties.
4. Set Port speed to match the baud rate that is used between the meter and the modem on the
remote end of the connection (both modems must be set to the same baud rate).
NOTE: You may need to restart your computer for the settings to take effect.
1. Click the icon in the System Setup pane for the type of component you want to edit.
2. In the display window, right-click the network component you want to edit and select
Configure <Network Component> (with <Network Component> being the type of
component you want to edit).
You can rename devices or groups displayed in the Devices pane without selecting the
Configure option. See Power Monitoring Expert – System Guide for more information.
NOTE: If you rename a group or device, the data that is already stored in the database is
associated with the new group or device name. New data will be added to the database using
the new name.
3. Make the required changes. To display all configurable fields, right-click the Configuration
dialog and select Advanced Properties.
1. Click the System Setup icon for the type of component you want to delete.
2. In the display window, right-click the network component you want to delete and select Delete
(or select the item and press the DELETE key).
NOTE: When you delete a Site or a Server, all devices associated with it are also deleted.
NOTE: Run Management Console as Administrator user. To do this, right-click the Management
Console program icon and select Run as administrator from the context menu. If you do not run
it as Administrator, then certain tools such as Update EWS Server are not functional.
To update EWS Server:
2. Select Tools > System > Update EWS Server. A dialog box appears indicating that the
update to the EWS server configuration was successful.
• Personal Preferences
• Report Theme
• System Language
• System Theme
• Registration
• Login Options
• Session Timeout
• Authorized Hosts
• Billing Rates
• Device Manager
• Hierarchies
• Modeling
• System Log
• User Manager
• Configuring Dashboard, Diagrams, Trends, Alarms, Reports, and EWS measurements and
generate the import file with the web application Integration Utility settings.
Prerequisites
Before using the PME/EBO Integration Utility, complete the following tasks:
• (Optional) Configure PME and Building Operation to use Windows Active Directory users and
user groups.
• (Optional) Install and configure an authority issued security certificate on the PME server.
Configuring web applications and generating the configuration import file for
Building Operation
You use the PME Web application Integration Utility settings, on the PME server, to configure
Dashboard, Diagrams, Trends, Alarms, Reports, and EWS measurements for integration into
Building Operation. As a result of the configuration, the utility creates a configuration file, that is then
imported into Building Operation.
NOTE: The Integration Utility is a Web application settings in PME. You need to configure using
this utility on the PME computer. If Building Operation and PME are installed on separate
computers, then configure in the PME computer and extract its contents. See 1. Downloading the
PME/EBO Integration Toolkit for more information.
To configure Dashboard, Diagrams, Trends, Alarms, Reports, and EWS measurements and to
generate import file:
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
1. Open Web Applications from the EcoStruxure Power Monitoring Expert folder on your
desktop, the Schneider Electric folder on the Start Screen, or by entering the PME server URL
into your browser Address bar, e.g. http://srv1.MyCompany.com/Web
4. Under Authentication Method, select the desired user type for authentication:
NOTICE
UNAUTHORIZED OR UNINTENDED ACCESS TO CUSTOMER DATA
• Personnel setting up the PME/EBO Integration third-party authentication must be aware
that links to data are not secure.
• Do not setup access links to sensitive or secure data.
Failure to follow these instructions can result in unauthorized or unintended access
to sensitive or secure customer data.
NOTE: Links for Windows users contain no user information. Windows users accessing
the link must have permission to access the PME system and be authenticated with
Windows. One-click login must be enabled to use the Windows user authenticated links.
See Login Options for information for enabling one-click login.
Add the Windows account that is used for Windows Authentication to PME as a
Windows user with Operator access level or higher.
For information on setting up user authentication with Windows Active Directory in PME,
see Adding a Windows user and Adding a Windows group.
For information on Building Operation and Active Directory, see Setting Up User
Authentication with Windows Active Directory in Building Operation.
Select Standard User, select the desired PMEUser Name and enter the Password.
NOTE: Links for standard users embed the user's account information. Take care on
usage of these links. Links cannot be generated for standard users with supervisor
access level.
Links generated for standard users are pre-authenticated based on the access level of the
selected users. If you want to disable the pre-authentication, then Under Pre-
Authentication for Standard Users, turn Enable pre-authentication to off.
5. Under Generate Links For, select from the following web applications for which you want to
generate link:
Dashboards
Trends
Alarms
Reports
NOTE: (Optional) Select HTML to generate an HTML page of links. Use this option to verify
the links. The download HTML link must be opened in a different browser to test the links.
The configuration import file in .xml format is downloaded to the default download location of
the browser.
2. Right-click the Enterprise server (the highest level in the System Tree) and select Import....
4. Click Import. The file import process completes. A new folder called “PME/EBO Integration”
appears in the System Tree.
NOTE: You can use the web application Integration Utility settings more than once. However,
importing the configuration file multiple times without deleting the previously imported folder will
create a duplicate entry in the target Building Operation system.
1. Open PME Web Applications and select SETTINGS > Integrations > EWS Login.
TIP: Access Web Applications through the Web Applications shortcut in the Power
Monitoring Expert desktop folder on the PME server. Or, to go directly to the
EWS configuration page, open the following URL: https://<server_
name>/Web/#Settings/Ews
2. Click Change Credentials or Set Credentials, if this is the first time the account is
configured and enter a User name and Password.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices for password creation and management.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access - such as least privilege,
separation of duties - vary from site to site. Work with the facility IT System Administrator to
ensure that user access adheres to the site-specific cybersecurity policies.
3. Click Save.
4. Click OK.
To allow Building Operation to receive and embed web content from PME:
1. Log into Building Operation Workstation and select Tools > Control Panel > Security and
Communication > Security Settings.
1. Open PME Web Applications and select SETTINGS > Security > Authorized Hosts.
2. Add the Building Operation server URL to the Hosts That Can Frame list.
Below is an example for a Building Operation server host URL of
https://localhost:446
3. Click Save.
NOTE: These components and snippets were installed on the Building Operation server in a
previous step. See 3. Installing the components, snippets, and binding template for details.
Components
Animated Components for ANSI and IEC
The EBO integration files folder in PME ISO includes a set of animated Components that are
based on the American National Standards Institute (ANSI) and International Electrotechnical
Commission (IEC) symbol standards. These can be used by the Building Operation Graphics
Editor.
NOTE: Device images are available for: a). meters that are bound and show data, and b). meters
that are not bound and show no data. Choose the device images that best represent your system.
Snippets
The EBO integration files folder in PME ISO includes a Building Operation snippet that is
designed to be used with the ANSI and IEC components.
• Font size
• Font color
• Measurements to show
Example of an Electrical Health Summary graphic, created with the Building Operation Graphics
Editor:
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
2. Create an electrical network diagram by dragging and dropping graphics onto your new file
from the imported graphics libraries (meter graphics, symbols, controls, and so on) in the left
pane.
3. For the components that you drag and drop into the graphic, select the component, and then
modify the component Name, in the General section of the Properties pane. The Name must
match the PME “GroupName.DeviceName” or the SmartWidget Name of the device for which
you want to display data.
NOTE: This Name is used by the binding template for measurement binding. See Binding
Graphics to measurements for details.
For more details on how to use the Graphics Editor, see the EcoStruxure Building Operation
Technical Reference Guide and the Building Operation Graphics Editor Web help.
When you create the EWS interface in Building Operation Workstation, a connection is made
between Building Operation and PME. The PME/EBO Integration folder in Building Operation
Workstation then contains all the device names and measurements from PME. Any graphics
components that have the correct PME device name set up will be bound to their device counterpart
when the binding template is applied. Since the binding template also contains the Modbus Point
name often used in SmartWidgets, it can also be used to bind graphics to values from the
SmartWidgets.
NOTE: This binding template was installed on the Building Operation server in a previous step.
See 3. Installing the components, snippets, and binding template for details.
Prerequisites
Before applying the binding template, confirm the following:
• The components in the Building Operation Graphics Editor diagram have been correctly
configured
• The binding template has been imported into Building Operation Workstation
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
1. In Building Operation Workstation, in the System Tree pane, right-click the graphic item for
which you want to use the binding template.
2. Select Edit Bindings from the list. The Binding point list appears in the work area.
3. Drag and drop the PME/EBO Integration folder or the folder that contains the SmartWidgets to
the PME- Basic binding template. The Confirm Binding dialog appears.
NOTE: The PME/EBO Integration binding template can only be used for an English version of the
PME/EBO Integration solution. For non-English systems, you need to manually bind the EWS
values or create a custom binding template.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Power Monitoring Expert (PME) does not provide any pre-configured dashboards or slideshows.
Configure your own dashboards, gadgets, and slideshows to meet your needs.
Open the Dashboards application from the Dashboards link in the Web Applications banner.
For information on how to configure the Dashboards application, see:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
For more information on this feature, see the EcoStruxure™ Power Monitoring Expert 2021 System
Guide.
1. In Dashboards, open the Dashboard Library and navigate to the folder where you want to
create the dashboard.
2. (Optional) Add a new folder by clicking Add Folder at the bottom of the library panel, or
by clicking Add Folder in the Options menu at the top of the library.
3. In the Dashboard Library, at the bottom of the panel, click Add Dashboard . This creates
a new dashboard and opens the Dashboard Settings.
4. In Dashboard Settings, enter a dashboard name, select a location and set the access
permissions to Public or Private.
NOTE: A public item is visible to all users in your user group. A private item is visible to you
and any user in your user group with Edit permissions on this item type. See Default User
Access Level Privileges and Customizing Access Level Privileges in User Manager help
for details.
5. (Optional) Click Styling to open the Dashboard Styling window. In Dashboard Styling, select
a background image or background color for the dashboard and set the default opacity for the
gadgets.
6. (Optional) You can add gadgets to the dashboard now or save the empty dashboard and add
gadgets later. See Adding a gadget to a dashboard for more details.
1. In Dashboards, open the Dashboard Library and navigate to the dashboard you want to copy.
(Optional) Add a new folder by clicking Add Folder at the bottom of the library panel, or
by clicking Add Folder in the Options menu at the top of the library.
2. Right-click the dashboard name or click Options for this dashboard and select Duplicate to
create a copy in the same folder. Select Copy To to create a copy in a different folder.
3. (Optional) In the Dashboard Library, select the new dashboard, right-click the dashboard name
or click Options for this dashboard, and select Edit to open the Dashboard Settings.
Change the dashboard name, Location, and access permissions.
NOTE: A public item is visible to all users in your user group. A private item is visible to you
and any user in your user group with Edit permissions on this item type. See Default User
Access Level Privileges and Customizing Access Level Privileges in User Manager help
for details.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Editing a dashboard
Edit dashboards to update the dashboard name, add new gadgets, change the dashboard styling,
change the access permissions or change the location of the dashboard in the Dashboard Library.
To edit a dashboard:
1. In Dashboards, open the Dashboard Library and navigate to the dashboard you want to edit.
2. Right-click the dashboard name or click Options for this dashboard and select Edit to open
the Dashboard Settings. Change the dashboard name, add gadgets, change the dashboard
styling, change the access permissions, or change the location of the dashboard in the
Library.
NOTE: A public item is visible to all users in your user group. A private item is visible to you
and any user in your user group with Edit permissions on this item type. See Default User
Access Level Privileges and Customizing Access Level Privileges in User Manager help
for details.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Sharing a dashboard
Share dashboards with other User Groups.
NOTE: For Sharing to be enabled, at least one user group, in addition to the Global group, must be
configured. To share an item with another user group, you must be a member of that group. The
item to be shared must be marked as Public, not Private.
To share a dashboard:
1. In Dashboards, open the Dashboard Library and navigate to the dashboard you want to share.
2. Right-click the dashboard name or click Options for this dashboard and select Share. This
opens the Share Dashboard window.
3. In Share Dashboard, select the User Groups you want to share this dashboard with.
4. (Optional) Specify a name for the shared dashboard. The groups you are sharing this
dashboard with will see this name. The name of the original dashboard remains unchanged.
NOTE: When you share an item with another user group, it appears in the Shared folder of this
group. You cannot share a shared item.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Moving a dashboard
Move dashboards to a different location in the Dashboard Library to make them easier to find or
easier to manage.
To move a dashboard:
1. In Dashboards, open the Dashboard Library and navigate to the dashboard you want to move.
(Optional) Add a new folder by clicking Add Folder at the bottom of the library panel, or
by clicking Add Folder in the Options menu at the top of the library.
2. Right-click the dashboard name or click Options for this dashboard and select Move To....
This opens the Select Location window.
3. In Select Location, select the location where you want to move this dashboard.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Deleting a dashboard
Delete dashboards that are no longer needed.
To delete a dashboard:
1. In Dashboards, open the Dashboard Library and navigate to the dashboard you want to delete.
2. Right-click the dashboard name or click Options for this dashboard, and select Delete
3. In Delete Content, click Yes, to delete the dashboard from the Dashboard Library.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
NOTE: For each user, Set as my default supersedes Set as system default. For example, if a
user with supervisor-level access sets a dashboard as the system default dashboard, and another
user sets a different dashboard as their default dashboard, that user's default dashboard takes
priority over the system default dashboard, but only for them.
1. In Dashboards, open the Dashboard Library and navigate to the dashboard you want to set as
default.
2. Right-click the dashboard name or click Options for this dashboard and select Set as
default to open the Configure Default Item dialog.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Configuring a slideshow
Use the Slideshow Manager to create, edit, or delete a slideshow.
NOTE: Anyone with access to the PME web server can view a slideshow using the slideshow
URL. No user authentication is required, except when using a Table gadget (See Using Table
gadget in Slideshow for more information). Restrict network access and access to the URL to
authorized users for slideshows containing confidential information.
NOTE: If you create a Dashboard that contains multiple gadgets, use the scroll bar to view all the
gadgets. But, if you use this Dashboard in a Slideshow, you do not have access to scroll bar to
view all the gadgets. It is recommended that you consider this condition when choosing which
Dashboard to include in a Slideshow.
Creating a slideshow
To create a slideshow:
1. In Dashboards, open the Dashboard Library, and click Slideshow Manager in the Settings
menu at the top of the library
2. In Slideshow Manager, click Add Slideshow to open the Add New Slideshow dialog.
4. Click any of the dashboards in the Shared Dashboards list to add them to the Dashboard
Playlist area on the right. Alternatively, begin typing in the Search field to filter the list for
selection.
The dashboards are listed in the Playlist area in the order that you selected them.
5. To modify the list of dashboards in the Dashboard Playlist, click the dashboard name to
display the edit options, then:
a. Click the Delete icon to remove the dashboard from the Playlist.
b. Click the Up or Down arrow to move the dashboard to an earlier or later sequence in the
Playlist, respectively.
6. Select the speed for the transition from dashboard to dashboard in the Select Transition
Time list.
1. In Dashboards, open the Dashboard Library, and click Slideshow Manager in the Settings
menu at the top of the library
2. In Slideshow Manager, click the slideshow you want to edit, then click Edit to open the Edit
Slideshow dialog.
3. Change the name of slideshow, modify the dashboards in the play list, change the slide
caption for the slideshow, or adjust the slide transition time.
Deleting a slideshow
To delete a slideshow:
1. In Dashboards, open the Dashboard Library, and click Slideshow Manager in the Settings
menu at the top of the library
2. In Slideshow Manager, click the slideshow you want to delete, then click Delete to open the
Delete Slideshow dialog.
3. Click OK to permanently delete the slideshow and to return to the Slideshow Manager.
Sharing a slideshow
To share a slideshow:
1. In Dashboards, open the Dashboard Library, and click Slideshow Manager in the Settings
menu at the top of the library
2. In Slideshow Manager, click the slideshow you want to share, then click Share to open the
Share Slideshow URL dialog.
The dialog includes the URL for the slideshow, which you can copy and distribute so that
others can access the slideshow.
NOTE: The client browser must have access to the URL to view the slideshow.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
NOTE: Gadgets that require special licensing only appear in the list after the correct licensing has
been installed.
2. Select the gadget that you want to add to the dashboard and click Next.
Gadget settings are specific to each gadget. For example, some gadgets require a data series
consisting of sources and measurements, while other gadgets have no such requirement.
3. Click Next to proceed through the pages of the Gadget Setup dialog.
4. Click Finish to close the Gadget Setup dialog and to add the gadget to the dashboard.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Editing a gadget
To edit the settings for a gadget:
1. Click Settings in the gadget and select Edit to open the Gadget Setup.
3. Click Save to update the gadget settings and to close the Gadget Setup dialog.
TIP: In gadgets where a time range has been specified when the gadgets are configured, the time
range selection is included on the gadgets in the dashboard. You can quickly change the time
range for the gadget by selecting another period of time from the list in the time range field. The
time range is applied to the gadget only while you continue to view the dashboard. If you navigate
to another dashboard and then come back to this dashboard, the time range on the gadget reverts
to the value that you set when you configured the gadget.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Moving a gadget
1. Right-click a dashboard name in the Dashboard Library, then click Edit in the menu.
2. Position the mouse pointer in the title area of the gadget that you want to move.
The pointer changes to the Move shape (an image with 4 arrows).
Resizing a gadget
1. Right-click a dashboard name in the Dashboard Library, then click Edit in the menu.
2. Position the mouse pointer at the lower right corner of the gadget.
A small triangular shape indicates that you can drag the corner.
Related topics:
Dashboards:
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Editing a gadget
Operating
This chapter includes the following topics:
2. Accessing Reports
3. Accessing Alarms
NOTE: For these applications to display correctly in Building Operation WebStation, you must use
a supported Web browser version. See Operating Environment for details.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Use the Dashboards application to view high level historical and real-time data, for example Key
Performance Indicators (KPIs). The information in the Dashboards application is accessed through
dashboards with gadgets. Dashboards are saved in the Dashboard Library. In addition to viewing
individual dashboards, you can create slideshows to automatically display a sequence of
dashboards.
TIP: You can open the Dashboards application from the Dashboards link in the Web Applications
banner.
• Viewing Dashboards
• Dashboard Slideshows
• Playing a Slideshow
For more information on this feature, see the EcoStruxure™ Power Monitoring Expert 2021 System
Guide.
Viewing Dashboards
View Dashboards to monitor key performance indicators, historical trends, and other high-level
information for the monitored power system. Dashboards are one of the main applications for
viewing power system information.
To view a Dashboard:
1. In Dashboards, open an existing Dashboard from the Dashboard Library or add a new
Dashboard.
Related topics:
• Viewing Dashboards
• Dashboard Slideshows
• Playing a Slideshow
Dashboard Slideshows
Use slideshows to create collections of dashboards that are displayed in sequence without user
interaction. A slideshow displays each of its dashboards for a short period of time and then displays
the next dashboard. When it reaches the end, it starts over again with the first dashboard. It
continuously cycles through all its dashboards in this way. Slideshows are a good option for
unattended, kiosk type displays. See Configuring a slideshow for more details.
Related topics:
• Viewing Dashboards
• Dashboard Slideshows
• Playing a Slideshow
Playing a Slideshow
Slideshows are a good option for unattended, kiosk type displays.
NOTE: Anyone with access to the PME web server can view a slideshow using the slideshow
URL. No user authentication is required, except when using a Table gadget (See Using Table
gadget in Slideshow for more information). Restrict network access and access to the URL to
authorized users for slideshows containing confidential information.
NOTE: If you create a Dashboard that contains multiple gadgets, use the scroll bar to view all the
gadgets. But, if you use this Dashboard in a Slideshow, you do not have access to scroll bar to
view all the gadgets. It is recommended that you consider this condition when choosing which
Dashboard to include in a Slideshow.
To play a Slideshow:
1. In Dashboards, open the Dashboards Library, and click Slideshow Manager in the Options
menu at the top of the Dashboard Library. This opens the Slideshow Manager window.
2. In Slideshow Manager, select the slideshow you want to view, and click Play. This opens a
new browser window, playing the slideshow.
3. Return to the original browser window and click Close in the Slideshow Manager to close it.
The slideshow continues to play in the new browser window until you close that window.
Related topics:
• Viewing Dashboards
• Dashboard Slideshows
• Playing a Slideshow
2. Accessing Reports
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Use the Reports application to generate historical data reports. You can view the reports in PME or
download them in different formats for sharing or storing externally. To generate a report, you can
either run it manually, setup an automatic schedule, or define trigger events such as a system
disturbance.
Reports are based on historical data that is stored in the PME database. A report can simply display
the historical data, or it can process data to show patterns and relationships. The Tabular Report is
an example of a simple report that shows data in a table. The Energy Modeling report is an example
of a report that processes different types of input data to produce predictions and comparisons
displayed in chart and diagram formats.
Reports are generated based on report templates. PME provides a wide range of default templates.
You can change the colors and logo used for these templates. To customize the types of inputs or
outputs of the default templates you need to create custom templates. Creating custom templates
requires engineering work outside of PME.
The Reports user interface (UI) has two main areas: Report Library and Reports Display. To see a
report in the Reports Display, you select the report in the Report Library.
TIP: You can open Reports from the REPORTS link in the Web Applications banner.
• Generating a report
• Downloading a report
Report templates
The default PME report templates cover a wide range of applications. The templates are grouped
into categories based on application. Choose the templates that best meet your reporting needs.
See the EcoStruxure™ Power Monitoring Expert System Guide for more information on Report
templates.
NOTE: Some report templates are part of add-on software modules for PME. Those reports are
enabled through the module licenses.
Subscriptions
Subscribe to a report to have it generated automatically based on a schedule or on a trigger event.
For example, you can subscribe to a report and have it generated daily at a certain time, or monthly
on a certain day and time. A trigger event can be any event in the system, for example a device
setpoint going active, or a breaker tripping.
For more information on this feature, see the EcoStruxure™ Power Monitoring Expert 2021 System
Guide.
Generating a report
Generate a report to view power monitoring system information.
To generate a report:
1. In Reports, open the Report Library and navigate to the report you want to generate.
2. Click the report name to display the report in the Reports Display pane.
3. Set the input parameters for the report and click Generate Report.
NOTE: Saved input parameters are preset to their saved values. Not saved input parameters
have generic default values.
Related topics:
• Generating a report
• Downloading a report
Downloading a report
Download a report in one of the supported formats (PDF, Excel, Tiff Image) to share the report
output with others, or to save it externally
To download a report:
2. In the Reports Display pane, view the generated report and click Download report as on the
toolbar immediately above the report output. Choose the format you want to download the
report in.
Related topics:
• Generating a report
• Downloading a report
3. Accessing Alarms
Alarms are automatically transferred from PME to Building Operation through EWS, and appear with
all other alarms in the Alarms pane, when both the Interface and the Alarm Polling are enabled.
NOTE: To verify that the Interface and the Alarm Polling are enabled: In the System Tree, right-
click on the PME/EBO Integration > EWS Client folder, and then select Properties.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
2. Scroll down to the Alarms viewer pane at the bottom of the dialog to see all active alarms,
The Building Operation “Sum Alarm” is an ideal way to leverage alarms flowing from EWS. It allows
the users to create actions and notifications on filtered PME alarms. See the EcoStruxure Building
Operation System Reference Guide for more information.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
2. In the System Tree, navigate to the PME/EBO Integration folder and click the EWS Client
folder. The EWS Client tab appears.
3. Click the “+” icon next to each subfolder in the System Tree to expand the contents of each,
and then click on an item in the subfolder. The List View appears in the right pane and shows a
list of measurements for that item.
4. Double-click a device to view the complete list of measurements for that device.
5. In the EWS Client pane, right-click on a column heading, and then select Add/Remove
Columns.
6. Select the check box next to Value and EWS State. Now, the two new columns with data
appear.
NOTE: The default refresh rate for EWS values is set to 20 seconds.
NOTE: If you find that some measurements for a device are missing from the list of
measurements, do the following:
Confirm that all of the measurements you want for that device are exposed. See Modifying which
measurements EWS Server exposes by default for details. If all of the measurements you want for
the device are exposed but still do not appear in the list of measurements, repeat the procedure to
create and host the EWS interface. (PME takes some time between enabling the EWS server and
when the EWS client shows the exposed measurements.) See Creating and hosting the EWS
interface in Building Operation Workstation for details.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
2. In the System Tree, navigate to PME/EBO Integration and click the Diagram Links folder. You
will find a list of Web Diagram links in the Diagram Links pane at the right for the default Web
Diagrams that you selected and exported with the web application Integration Utility settings.
3. In the Diagram Links tab, double-click a Web Diagram file. The Web Diagram graphic opens
for this device.
4. Select the different tabs in the Web Diagram screen to view other data values for this device.
Reference
This chapter contains specific information on technical details related to the PME/EBO Integration
solution. This information is referenced in the other sections of this document.
Use the links below to find the item you are looking for:
For devices, for which default drivers or downloadable add-on drivers do not exist, you can use the
Device Type Editor (DTE) tool in PME to create custom device drivers. For more information on this
feature, see the EcoStruxure™ Power Monitoring Expert 2021 System Guide.
Position Counters
Logging setup
Extract task: Setting parameters and recommended values
Transform task: Setting parameters and recommended values
Load task: Setting parameters and recommended values
Manage ETL jobs
Tips for working with mappings
ETL tips and tricks
Measurement mapping for ETL
Position Counters
Position counters keep track of the data that is extracted from EBO and then loaded into PME. Each
Trend log specified in ETL has a position counter associated with it. The position counter represents
a timestamp of the most recent data point loaded for each Trend log. When ETL is run, only data
after this timestamp value is extracted from the EBO Trend log.
• Click the Positions tab. The Positions tab appears showing the position counters.
To reset and resend the data for the mapped Trend logs:
1. Enter a specific value in the text box to set all position counters.
2. Click Initialize. Mapped Trend logs appear with associated timestamp data for each.
Now, the next time you run ETL, only data after the given timestamp is loaded.
Logging setup
The Logging feature allows you to enable the various logs where ETL writes the information
regarding the status of your ETL job. These logs can help when searching for the cause of an
unsuccessful ETL job.
1. Select the applicable job in ETL from the dropdown menu and click Edit.
3. Select the Enabled checkbox for the Trace Log, Error Log, Customer Log, and Windows Event
Log as required.
4. Provide the location for the log file in the Log File field or leave at the default location.
5. Set the Maximum Log File Size and Maximum Log Files for each log or leave at the default
settings.
6. If required, select the Enabled checkbox for Email Notifications and complete the fields for To
Email Address, From Email Address, and SMTP Server Address.
http://localhost:8080/EcoStruxure/DataExchange.
Replace “localhost:8080” with your web server
address and port as needed.
The URL of the
NOTE: For HTTPS EcoStruxure Web Service
Web Service EcoStruxure Web
connections, with a self-signed certificate, the
URL Service called by this
certificate validation must be disabled for ETL.
task.
To disable certificate validation, set
<IsServerCertificateValidationCheckEnabled>
to false in the ETL job file.
You can find the job file in <ETL installation
folder>\Jobs\
Communication Options
When set to True, ETL
will reuse digest
Enable the
authentication tokens
Digest
for communicating with
Authentication Set to 'True'
the EWS server. This
Token Reuse
can improve
Feature
communication
performance.
Reading Interval
When set to True,
allows the extract task
Interval Length to determine the reading
Set to 'True'
Discovery interval for each pair
based on each pair's
data.
Record State
Filter
Setting Parameters /
Setting Name Description
Recommended Values
Transform
Specifies the method used when
Intervalization Use default 'Last Known Value'
converting the values from an irregular
Method setting
interval into a regular interval.
When set to True, the data is
intervalized up to the current system
Intervalize to
time. If set to false, the data is Set value to “False”
present time
intervalized up to the most recent data
point.
Interval value in minutes. Select a
Target Reading Data is intervalized to a reading value from the dropdown list. Default
Interval (minutes) interval specified in this field. value of 15 minutes is suitable in most
cases.
NOTE: You must set the Enable Recorder and Channel Creation parameter to ‘True’ in order for
some Energy-related reports to run:
Setting Parameters /
Setting Name Description
Recommended Values
Database Settings
Time in seconds before stopping a
Default value is 3600 seconds (1
SQL Command Timeout SQL command attempt and
hour).
generating a message.
Provide connection information to
Application Modules database for
Database Settings Connection string to the
your system. Information can be
(Application Modules) Application Modules database
found through SQL Management
Studio.
Provide connection information to
Database Settings Connection string to the ION_ ION_Data database for your
(ION_Data) Data database system. Information can be found
through SQL Management Studio.
Connection string to the ION_
Network_Database where source Provide connection information to
Database Settings information should be loaded. ION_Network database for your
(ION_Network) Only applicable if the Enable system. Information can be found
Network Database Source through SQL Management Studio.
Creation setting is True.
Group Name Settings
When set to 'True', the task adds
Add the 'Group Name' a group name prefix to all sources
Prefix to Sources if that do not already have one. Set to 'False'.
Needed When set to 'False', a group name
prefix will not be added.
The name provided in this setting If the previous setting is 'False',
Group Name is used as the Group Name prefix this setting does not need to be
setting described above. filled in.
Mapping Options – Source and Quantity End Names
Populate Button –
Automatically Set
Set to ‘False’.
Quantity ‘End Names’ to
‘Start Names’
Setting Parameters /
Setting Name Description
Recommended Values
Populate Button –
Automatically Set
Set to ‘False’.
Source ‘End Names’ to
‘Start Names’
Null Values
When set to 'False' the task
ignores any null values. When set
Allow Null Values Set to 'False'.
to 'True', null values in the data
set are inserted into the database.
Overwrite Values
Allow existing values to
Set to ‘False’.
be overwritten.
Recommended Source-Quantity Pairs Settings
Limit Recommended
Pairs to Known Set to ‘True’.
Quantities
Recorders and Channels
When set to 'False', the task does
not create recorders and channels
Enable Recorder and
while inserting data. Some reports Set to ‘True’.
Channel Creation
require that the parameter is set to
‘True’ to run.
Set the
ISCurrentConfiguration
Leave this default setting to ‘True’.
Flag to False for New
Channels
Source and Quantity Creation Settings
When set to 'False' disables
Enable Quantity
creating quantities if they are not Set to 'False'.
Creation
already in the database.
When set to 'True', the setting
Enable Source Creation enables the creation of sources
Set to 'True'.
in ION_Data that are not already in the ION_
Data database.
When set to 'True', the setting
Enable Source Creation enables the creation of sources
Set to 'True'.
in ION_Network that are not already in the ION_
Network database.
Setting Parameters /
Setting Name Description
Recommended Values
Set Active Flag for All When set to 'True', all new
Set to 'True'.
New Sources sources are marked as Active.
When set to 'True', enables
Set Measurement
setting the descriptive name of Set to 'True'.
Descriptive Name
new measurements.
When set to 'True', enables
Set Measurement
setting the engineering name of Set to 'True'.
Engineering Name
new measurements.
Source Namespace Settings
Namespace given to all sources
Source Namespace that do not have a namespace or
IONEnterprise
Override that are created during the Load
Task.
Source Type Settings
When set to 'True', enables the
Override Source Type use of the Source Type Override Set to 'True'.
value when creating sources.
The source type to use when
Source Type Override Presumed downstream device.
creating sources.
3. Highlight the task that you want to remove from the left pane.
4. Click Delete
Highlighting rows
Highlighting a source row lets you work with that source. When you highlight a row you can copy,
include or exclude the row from the ETL job, or perform a batch edit on the row.
To highlight a row:
Batch Edits
NOTE: You have to complete the Target Device and Target Measurement fields before you
can select Included for the row.
4. While the rows are still highlighted, right-click and click Include Selected Mapping(s). The
Included check box is checked for the selected rows and these devices are included in the
job.
5. Click OK, and then click Apply to save the changes to the job. The Batch Edit values appear
for the selected rows.
1. Right-click a column heading and from the sort menu choose to sort column contents by
ascending or descending order.
Searching by column
To search by column:
1. Click in the Auto Filter Row (search field below a column heading.)
2. Begin typing characters. Column contents appear based on the search criteria you enter. Note
that characters are not case sensitive.
1. Click the filter symbol to the right of the column heading, and then choose (Custom), (Blanks),
(Non blanks), Checked, Unchecked, or a specific device.
2. If you choose (Custom), you can define a unique filter, based on your input, in the Custom
AutoFilter dialog. Complete the fields in the dialog and then click OK.
1. Right-click the column header you want to filter and select Filter Editor.
You must complete the Target Device and Target Measurement fields before you can select
Included for the row.
3. Click Apply.
The sources are filtered based on the filtering criteria you enter.
You can select and copy one or more devices and paste that data into a document, such as a text
editor or a spreadsheet.
To copy and paste devices into a document:
3. Open your document and place the cursor where you want to paste.
Absolute voltage in dB
dBuV
AbsoluteHumidityMass
kg/kg
lb/lb
Acceleration
pH
Angle
radian rad
grad
Angular momentum
joule second Js
Area
square meter m²
acre a.
Capacitance
farad F
Compressibility
Conductance
siemens S
Conductivity
Corrosion Rate
m/yr
in/yr
Currency
currency2
currency3
currency4
currency5
currency6
currency7
currency8
currency9
currency10
Current
Current Phase
Average
Current Phase A
A Current Phase B
Current Phase C
Neutral Current
Ground Current
Current Density
Density
Diffusivity
Dipole Moment
debye
coulombmeter
V/m
Energy
cal
thermal
tonh
Energy Apparent
Apparent Energy
Received (KVAh)
Vah
Apparent Energy
Delivered-Received (KVAh)
Energy Reactive
Reactive Energy
Delivered (kvarh)
Reactive Energy
Varh
Received (kvarh)
Reactive Energy
Delivered-Received (kvarh)
Enthalpy
Btu/lb dry air Specific Enthalpy Dry Air (BTU 59/lb av)
Entropy
J/K
Flow
g/s
lb/s
oz/s
g/min
g/h
lb/min
Uston/h
Force
lbf
Frequency
Frequency (Hz)
Frequency (MHz)
Hz
Frequency (kHz)
Frequency (MHz)
cycles/min
cycles/h
/s
/min
/h
%/s
Grammage (GSM)
Heat Capacity
Heat Flux
W/m²
Btu/(s·ft²)
W/ft²
Humidity
Illuminance
Illuminance (lx)
Illuminance (Mlx)
Illuminance (Klx)
Illuminance (Mlx)
lux lx Global Horizontal Illuminance (Hour
Interval)
Direct Normal Illuminance (Hour Interval)
Diffuse Horizontal Illuminance (Hour
Interval)
ft·cd
Illuminance (H)
Illuminance (mH)
Candelas per sq. meter H
Illuminance (kH)
Illuminance (MH)
Inductance
henry H
Length
meter m
inch in
foot ft
yard yd
mile mile
Linear Momentum
Newton Second Ns
Luminance
Luminous Flux
lm
Luminous Intensity
cd
A·m²
A/m
Magnetic Flux
Wb
Mass
gram g
pound lb
ounce oz
carat
grains
USTon
(mol/(s·m²))/
(mol/m³)
(mol/(s·ft²))/
(mol/ft³)
Mass Velocity
g/(s·m²)
lb/(s·ft²)
Moles
mole mol
lbmol
Moment of Inertia
g/m²
lb/ft²
Momentum
g·m/s
lb·ft/s
NoCategory
NoUnit
Percent Obscuration
%/m
%/ft
Percentage
ppb
Phase
deg
Power
Btu/s
hp
tons refrig
Power Factor
Power Reactive
Pressure
Resistance
ohm Ω Resistance
Resistivity
ohm meter Ωm
Specific Entropy
J(g·K)
Btu/(lb·R)
J/(kg·K)
Specific Humidity
Specific Volume
m³/g
ft³/lb
J/m²
J/ft²
W/(h·m²)
W/(h·ft²)
Surface Tension
N/m²
lbf/ft
Temperature
Temperature Diff
ΔK
K/min
K/h
Thermal Conductance
W/(m²·K)
Thermal Conductivity
m/C
in/F
ft/F
Thermal Pressure
psi/oF
m³/C
in³/F
ft³/F
Thermoelectric Power
V/K
Time
year
month
week
day
min
Time Accuracy
s/h
Torque
Nm
lbf·in
lbf·ft
Turbidity
NTU
Velocity
Velocity Angular
Voltage
Volume
in³
1. Highlight multiple rows in the Mappings tab by clicking and dragging downward the handles to
the left of the rows. To select all rows, press Ctrl+A.
2. Right-click and select Batch Edit. The Batch Edit Mappings dialog appears.
You must complete the Target Device and Target Measurement fields before you can select
Included for the row.
4. While the rows are still highlighted, right-click and select Include Selected Mapping(s). The
Included check box is now checked for the selected rows and these Trend logs are now
included in the job.
5. Click OK, and then click Apply to save the changes to the job. The Batch Edit values now
appear for the selected rows.
See Measurement mapping for ETL to learn about the most common, supported measurements in
used in PME and how to link to typical Building Management tags.
• Right-click a column heading and choose from the sort menu to sort column contents by
ascending or descending order.
2. Begin typing characters. Only column contents appear based on the search criteria you enter.
Note that characters are not case sensitive.
2. Begin typing characters. Only column contents appear based on the search criteria you enter.
Note that characters are not case sensitive.
See Measurement mapping for ETL to learn about the most common, supported measurements in
use in PME.
1. Click the filter symbol to the right of the column heading, and then choose (All), (Custom),
(Blanks), (Non blanks), or a specific Trend log.
2. If you choose (Custom), you can define a unique filter, based on your input, in the Custom
AutoFilter dialog. Complete the fields in the dialog and click OK.
3. Open your document and place the cursor where you want to paste.
1. From the document created in the previous step Copy Source Tag(s) from the list.
3. Press Ctrl + V or right-click and choose Paste, and then press Enter. The Trend log opens.
3. Click Run Once, and then click OK in the dialog when it appears. Wait until the output dialog
box appears (depending on your system size, this could take up to a few hours).
NOTE: To confirm the ETL job, look to see that the job executed successfully.
If the ETL Engine returns a Job execution failed message, click Open Log Folder in the dialog and
open the error log. Locate the timestamp that corresponds to your job and review the log. Based on
this information, make the appropriate changes to the job and then run the job again.
NOTE: If the ETL is installed in its default location, C:\Program Files\..., then the
Windows user must have Administrator access.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices for password creation and management.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access - such as least privilege,
separation of duties - vary from site to site. Work with the facility IT System Administrator to
ensure that user access adheres to the site-specific cybersecurity policies.
2. Add the Windows user account to the PME SQL database server with db_owner rights to the
ION_Data and ION_Network databases.
1. In the ETL Configuration Job Configuration Tool screen, select a job to run from the Job
Management drop-down list.
3. Click Register. ETL creates a registered service under the job name. Click OK in the dialog
when it appears. This option is available only after running a job successfully at least once.
4. Open Windows Services and change the Log On account for the service to the dedicated
Windows account.
6. Click Stop to stop the service or click Unregister to unregister the service for this job.
3. Click Edit.
3. Highlight the task you want to move from the left pane.
3. Highlight the task you want to remove from the left pane.
4. Click the Delete icon. The task is removed from the pane.
Absolute voltage in dB
dBuV
AbsoluteHumidityMass
kg/kg
lb/lb
Acceleration
pH
Angle
radian rad
grad
Angular momentum
joule second Js
Area
square meter m²
acre a.
Capacitance
farad F
Compressibility
Conductance
siemens S
Conductivity
Corrosion Rate
m/yr
in/yr
Currency
Energy Cost
Energy Cost AUD
currency1 Energy Cost EUR
Energy Cost GBP
Energy Cost CNY
currency2
currency3
currency4
currency5
currency6
currency7
currency8
currency9
currency10
Current
Current Phase
Average
Current Phase A
A Current Phase B
Current Phase C
Neutral Current
Ground Current
Current Density
Density
Diffusivity
Dipole Moment
debye
coulombmeter
V/m
Energy
cal
thermal
tonh
Energy Apparent
Apparent Energy
Received (KVAh)
Vah
Apparent Energy
Delivered-Received (KVAh)
Energy Reactive
Reactive Energy
Delivered (kvarh)
Reactive Energy
Varh
Received (kvarh)
Reactive Energy
Delivered-Received (kvarh)
Enthalpy
Btu/lb dry air Specific Enthalpy Dry Air (BTU 59/lb av)
Entropy
J/K
Flow
g/s
lb/s
oz/s
g/min
g/h
lb/min
Uston/h
Force
lbf
Frequency
Frequency (Hz)
Frequency (MHz)
Hz
Frequency (kHz)
Frequency (MHz)
cycles/min
cycles/h
/s
/min
/h
%/s
Grammage (GSM)
Heat Capacity
Heat Flux
W/m²
Btu/(s·ft²)
W/ft²
Humidity
Illuminance
ft·cd
Illuminance (H)
Illuminance (mH)
Candelas per sq. meter H
Illuminance (kH)
Illuminance (MH)
Inductance
henry H
Length
meter m
inch in
foot ft
yard yd
mile mile
Linear Momentum
Newton Second Ns
Luminance
Luminous Flux
lm
Luminous Intensity
cd
A·m²
A/m
Magnetic Flux
Wb
Mass
gram g
pound lb
ounce oz
carat
grains
USTon
(mol/(s·m²))/
(mol/m³)
(mol/(s·ft²))/
(mol/ft³)
Mass Velocity
g/(s·m²)
lb/(s·ft²)
Moles
mole mol
lbmol
Moment of Inertia
g/m²
lb/ft²
Momentum
g·m/s
lb·ft/s
NoCategory
NoUnit
Percent Obscuration
%/m
%/ft
Percentage
ppb
Phase
deg
Power
Btu/s
hp
tons refrig
Power Factor
Power Reactive
Pressure
Resistance
ohm Ω Resistance
Resistivity
ohm meter Ωm
Specific Entropy
J(g·K)
Btu/(lb·R)
J/(kg·K)
Specific Humidity
Specific Volume
m³/g
ft³/lb
J/m²
J/ft²
W/(h·m²)
W/(h·ft²)
Surface Tension
N/m²
lbf/ft
Temperature
Temperature Diff
ΔK
K/min
K/h
Thermal Conductance
W/(m²·K)
Thermal Conductivity
m/C
in/F
ft/F
Thermal Pressure
psi/oF
m³/C
in³/F
ft³/F
Thermoelectric Power
V/K
Time
year
month
week
day
min
Time Accuracy
s/h
Torque
Nm
lbf·in
lbf·ft
Turbidity
NTU
Velocity
Velocity Angular
Voltage
Volume
in³
1. On the PME server, open the web.config file for editing, for example in Notepad. You can
find this file in ...\Power Monitoring Expert\applications\EWS.
NOTE: For system to system data exchange using EWS, set the regional setting to INVARIANT.
1. On the PME server, open the web.config file for editing, for example in Notepad. You can
find this file in ...\Power Monitoring Expert\applications\EWS.
2. Search for the <add key="RegionalSetting" value="" /> element in the file.
3. Set the value property to a valid regional setting (for example en-US, en-CA, fr-FR, de-DE,
and so on), or to INVARIANT.
Example
NOTE: Use the Database Growth Calculator tool to estimate the database growth for your
system. The tool is available through the Exchange Community. See Resources for link
information.
The following shows the database growth estimate for logging of a single measurement every 15
minutes:
NOTE: Use the Database Growth Calculator tool to estimate the database growth for your
system. The tool is available through the Exchange Community. See Resources for link
information.
NOTE: Use the Database Growth Calculator tool to estimate the database growth for your
system. The tool is available through the Exchange Community. See Resources for link
information.
NOTE: The license types (E, M, S) are for locales (countries other than the US, Canada, and
India) where individual licenses are sold. For locales (the US, Canada, India) where license
bundles are sold, a device license is valid for any device type.
NOTE: Drivers created with the Device Type Editor require mid-range (M) type device licenses.
(*) The license multiplier indicates the fraction of a license each device of this type uses. For
example, a multiplier of 0.01 means that 100 devices of this type can share one full license.
NOTE: PME assigns a higher range license to a device, if an appropriate lower range license is not
available. For example, if a system has a ION7350 device, which requires a Mid-Range license,
PME will assign a free High-End license to this device, if a Mid-Range license is not available.
1. Navigate to:
<Extract path>\EBO Integration Files\Graphics Editor\Components\
and double-click the " PME- Generic Components" file. The new thermometer graphic
component is added to the Building Operation Graphics Editor library.
3. From the PME– Generic Components category at the left, drag the Power Measurement
Display Bar component onto a new page. The Multi-input Setpoint Display Bar component
appears.
4. Select the component. In the Properties pane at the lower right, change the parameter settings
as needed (name, min/max, setpoint values, and so on). Make sure that the settings make
logical sense (for example, all setpoints are within the min/max range and in the following
order: SP4>SP3>SP2>SP1).
2. In the System Tree, select a Server, and then choose File > New > Graphic, enter a name for
the file, and click Create. The new graphic file name appears in the System Tree.
3. In the System Tree, right-click the graphic file name and select Properties.
4. In the Basic tab, click the button next to the File field and navigate to the .tgml file, select the
file, click Open and then OK. The Multi-input Setpoint Display Bar now appears in the Building
Operation Workstation.
5. In the System Tree, select the Server, and then choose New > Value. The Create Object
dialog appears. Repeat the above steps four times to create four new values.
6. Select Analog Value and complete the fields for Name, Location, and Description as needed,
and then click Create for each new value. The four new Analog Values now appear.
7. For each value, double-click the name after adding it. Click the up or down arrows to select a
number, and then click the Value button to select Forced or Force value for the object. Click
Yes to save the object.
8. To bind the graphic object to the value you just created, in the System Tree, right-click the
graphic file name and select Properties.
9. In the Bindings tab, enter the location of the graphic object in the object value field and click
OK. The Multi-input Setpoint Display Bar now shows the preset setpoint values and bound
values. The reading bar height and color change accordingly.
1. In the System Tree, right-click on the new graphic file name and click Edit. The Graphics
Editor opens.
2. Revise some graphic component parameters (for example, min/max, setpoint values, or
colors), save the file, and return to Building Operation Workstation. Your changes appear on
the Graphics page in Building Operation Workstation.
1. Navigate to:
<Extract path>\EBO Integration Files\Graphics Editor\Components\
and double-click the "PME- Generic Components" file. The new thermometer graphic
component is added to the Building Operation Graphics Editor library.
3. From the PME– Generic Components category at the left, drag the Setpoint Display Bar
component onto a new page. The Single-input Thermometer bar component appears.
4. Select the component. In the Properties pane at the lower right, change the parameter settings
as needed (name, min/max, setpoint values, and so on). Make sure that the settings make
logical sense (for example, all setpoints are within the min/max range and in the following
order: SP4>SP3>SP2>SP1).
2. In the System Tree, select a Server, and then choose File > New > Graphic, enter a name for
the file, and click Create. The new graphic file name appears in the System Tree.
3. In the System Tree, right-click the graphic file name and select Properties.
4. In the Basic tab, click the button next to the File field and navigate to the .tgml file, select the
file, click Open and then OK. The Single-input Thermometer bar now appears in the Building
Operation Workstation.
5. In the System Tree, select the Server, and then choose New > Value. The Create Object
dialog appears.
6. Select Analog Value and complete the fields for Name, Location, and Description as needed,
and then click Create. The Analog Value now appears.
7. Double-click the value name after adding it. Click the up or down arrows to select a number,
and then click the Value button to select Forced or Force value for the object. Click Yes to
save the object.
8. To bind the graphic object to the value you just created, in the System Tree, right-click the
graphic file name and select Properties.
9. In the Bindings tab, enter the location of the graphic object in the object value field and click
OK. The Single-input Thermometer bar now shows the preset setpoint values and bound
values. The reading bar height and color change accordingly.
1. In the System Tree, right-click on the new graphic file name and click Edit. The Graphics
Editor opens.
2. Revise some graphic component parameters (for example, min/max, setpoint values, or
colors), save the file, and return to Building Operation Workstation. Your changes appear on
the Graphics page in Building Operation Workstation.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
1. Create a DTE driver. In this example, a driver file was created for “My_DTE” device with two
registers, “My_Label_1” and “My_Label_2”.
3. Select any XML file (for example: “Types_Measurements_8000.xml”), copy and paste it to the
same folder. Rename it to the newly created DTE "Device Type" name, “My_DTE.xml”
4. Open the XML file with a file editor. The structure of the XML resembles the following:
<?xml version="1.0"?>
<MeasurementStores xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Store
Name="8000" DisplayName="PM8000" Type="8000" SubType="Common">
...
...
<Measurement IONReferenceName="Active Energy Delivered"
MeasurementName="Real Energy Into the Load" MeasurementUnit="kWh"
Exposed="true" IsManual="false" Handle="22704" Format="double" />
<Measurement IONReferenceName="Active Energy Delivered Interval"
MeasurementName="Real Energy Into the Load Interval"
MeasurementUnit="kWh" Exposed="false" IsManual="false"
Handle="24483" Format="double" />
...
...
</Store>
</MeasurementStores>
5. Modify the bold sections like the following to match your "Device Type" name as well as your
Register "Label". Make sure to change all the bold ones to what fits the new DTE, delete the
"Handle" section and specify the format as necessary.
<?xml version="1.0"?>
<MeasurementStores xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <Store
Name="My_DTE" DisplayName="My_DTE" Type="My_DTE" SubType="Common">
...
...
<Measurement IONReferenceName="My_Label_1" MeasurementName="My_
Label_1" MeasurementUnit="My_Unit_1" Exposed="true"
IsManual="false" Format="Boolean" /> <Measurement
IONReferenceName="My_Label_2" MeasurementName="My_Label_2"
MeasurementUnit="My_Unit_2" Exposed="true" IsManual="false"
Format="double" />
...
...
</Store>
</MeasurementStores>
NOTE: When editing the XML file, format “Boolean” should be used for all Boolean values
and format “Double” for all analog values.
6. After completing the new xml file, go to Management Console > Tools > System and click
Update EWS Server. It will take some time for the server to propagate the change via web
service. An IIS and/or computer restart might even be required.
7. The custom registers/measurements are now expose via EWS. See Hosting EWS values in
Building Operation for information on this topic.
NOTE: The manual steps cannot fully replace the web application Integration Utility settings for an
PME/EBO Integration deployment. When deploying the PME/EBO Integration, you must use the
web application Integration Utility settings to create the Diagram links.
2. A user for the Building Operation connection to the PME Web applications (Dashboards and
Reports).
For information on how to create the EWS user, see Setting up EWS credentials.
For information on how to create the user to access the Web Applications, see "Adding a standard
user" in the EcoStruxure™ Power Monitoring Expert System Guide or the PME Web Applications
Help.
1. On the PME database server, open Microsoft SQL Server Management Studio.
4. Provide supervisor-level login information in the dialog and click OK. This opens the Generate
Authentication URL page.
Automatic Authentication: Provide the PME account login for an Operator level user
account in the User name and Password fields.
Windows Authentication: Use the current Windows user account as a login. You must add
this Windows user to PME. See User Manager for details on how to add a user in PME.
Destination Host Name: Enter the PME server name here. Use the fully-qualified server
domain name.
Destination URL:
/Web for the PMEWeb Applications Settings page.
/Dashboard for the PME Dashboards page.
/Reporter for the PME Web Reports page.
8. In Building Operation Workstation, create a new hyperlink for the URL generated in step 6
above.
3. Search for <add key="EWSEnabled" value="0" /> and change the value from "0" to
"1". (Conversely, to disable the EWS service, change the value from "1" to "0".)
4. Search for <add key="RealTimeRefreshRate" value="20" /> and make sure the
value is set to "20".
5. Save and close >Web.config. The EWS service is now enabled and with the correct refresh
rate. (The service can be enabled or disabled at any time by editing the Web.config file.)
NOTE: Run Management Console as Administrator user. To do this, right-click the Management
Console program icon and select Run as administrator from the context menu. If you do not run
it as Administrator, then certain tools such as Update EWS Server are not functional.
2. Select Tools > System > Update EWS Server. A dialog box appears, indicating that the
update to EWS server configuration is successful.
3. Click OK.
NOTE: For any changes in the PME Management Console, such as adding a new device or
renaming an existing device, you must 1) update the EWS server, and 2) regenerate a Vista
Diagram before using the Integration Utility.
NOTE: The following step is optional, however, it becomes necessary if you want to change the
list of measurements that the EWS server exposes by default.
The EWS Server relies on two control files to define which devices are exposed and which
measurements are exposed for those devices.
If you do not want a device to be exposed, delete the complete line of an entry.
• The following file contains the list of measurement exposed for all supported devices types:
...\<Power Monitoring Expert
Folder>\config\WebServices\Types.Measurements.xml
To expose or un-expose a specific measurement for a specific device type, do the following:
a. Browse to that specific device type.
If you do not set “IsManual” to true, the next time you run Update EWS Server from the
Management Console, your configuration will be overwritten by the system default.
e. When you finish, select Tools > System > Update EWS Server to make the changes.
2. In the System Tree, right-click on Server, and then click New > Interface.
3. Enter a name and description for the new web interface in the respective fields and click Next.
The Connection Information dialog appears.
4. Enter the server name or the IP address where PME is hosted in the EWS Server field.
5. Leave unchanged the values for Protocol and EWS Communication Port.
7. Enter the same User name and Password that you created for EWS.
8. Click Create. The new web service now appears in the System Tree. Next, proceed to host
the new web service.
2. Expand, and then select the newly-created interface for which you want to host values.
3. Right-click Root or any underlying level/devices and choose Host EWS Objects. The Select
EWS Interface dialog appears.
The web service is now hosted and appears in the System Tree.
5. After the hosting completes, click the new EWS web service and browse the values in the List
View tab at the right.
1. In the List View tab, right-click on the Name/Description heading and select Add/Remove
columns.
2. Select the check box next to any column type you want to add to the List View, and then click
OK. The new column types and their respective values now appear in the List View tab.
NOTE: If you find that some measurements for a device are missing from the list of
measurements, do the following:
Check to make sure that all of the measurements you want for that device are exposed; refer to
“Modifying which measurements EWS Server exposes by default”.
If all of the measurements you want for the device are exposed but still do not appear in the list of
measurements, and then you will need to repeat the procedure to create and host the EWS
interface. (PME takes some time between enabling the EWS server and when the EWS client
shows the exposed measurements.) See “Creating and hosting the EWS interface in Building
Operation Workstation”.
NOTE: If you find that EWS measurements are displayed in an incorrect format, check and edit
the EWS regional setting. See Configuring the PME EWS server regional setting for more
information.
Configuring Alarms
1. Log in to Building Operation.
2. Alarms for Architecture 2 are automatically enabled after they are imported and can be viewed
along with all other alarms within the Alarms pane at the bottom of the dialog.
3. To configure the alarms associated with the devices for the EWS Client, in the System Tree,
right click on EWS Client and select Properties. The EWS Client dialog appears.
4. Complete the various fields and select the options you want on this dialog, and then click OK.
The system saves your configuration changes.
The Building Operation “Sum Alarm” is an ideal way to leverage alarms flowing from EWS. It allows
the users to create actions and notifications on filtered PME alarms. Refer to the EcoStruxure
Building Operation System Reference Guide for more information.
PME IP Ports
The following table lists the ports used by PME for the communication between its components and
the connected devices:
139/445 NetBIOS/SMB PME Server Engineering client (File and Printer Sharing) No
13667 TCP PME Server Diagnostics Viewer (Server access from client machine) No
13666
13670 TCP PME Server Services (Vista and Designer access from client machines) No
13671
• Do not set the SQL Server maximum memory to less than 1GB.
• Where only SQL Server is running on the host server, set the SQL Server maximum memory at
the system physical memory less at least 2GB for the Windows operating system. For
example, if your server has 8GB of memory, set the SQL Server maximum memory to no more
than 6GB. This leaves at least 2GB for the operating system.
• Where the SQL Server is sharing the host server with other server processes, including Internet
Information Services (IIS) and ION services, set the SQL Server maximum memory to no more
than half the physical memory on the server. For example, if your server has 8GB of memory,
set the SQL Server memory to no more than 4GB. This leaves at least 4GB for the operating
system and all other server processes.
In addition to setting the maximum memory option, consult with your site administrator to determine
whether or not to enable the Lock pages in memory permission setting in Windows for the SQL
service account on all SQL Server instances.
NOTICE
LOSS OF DATA
Back up or archive any SQL Server database data before adjusting any database memory
options.
Only personnel with advanced knowledge of SQL Server databases should make database
parameter changes.
1. Start SQL Server Management Studio and log in to your SQL Server instance.
2. Right-click the SQL Server name and click Properties in the menu to open the Server
Properties dialog.
3. Select Memory in the left pane and adjust the value in the Maximum server memory field.
1. Click Start > Run and type gpedit.msc in the Run dialog to open the Local Group Policy
Editor.
2. In the left pane, navigate to Computer Configuration > Windows Settings > Security
Settings > Local Policies.
4. Locate Lock pages in memory in the list and then double click the policy name to open the
Lock pages in memory Properties dialog.
6. Add an account with the privileges to run sqlserver.exe and then click OK to close the dialog.
American National Standards Institute (ANSI): The primary organization for the development of
technology standards in the United States. ANSI works with industry groups and is the U.S.
member of the International Organization for Standardization (ISO) and the International
Electrotechnical Commission (IEC).
Entitlement ID: A new entitlement is generated for each Purchase Order. The entitlement is sent
by email and includes the Activation ID.
HTTP: This protocol is not secure and is subject to “man-in-the-middle” and eavesdropping attacks
that can allow attackers to gain access to website accounts and sensitive information.
HTTPS: This protocol provides secure communication over a computer network, with especially
wide deployment on the Internet. It results from layering the Hypertext Transfer Protocol (HTTP) on
top of the SSL/TLS protocol, thus adding the security capabilities of SSL/TLS to standard HTTP
communications. HTTPS provides authentication of the website and associated web server with
which one is communicating and thereby protects against “man-in-the-middle” attacks. Additionally,
HTTPS provides bidirectional encryption of communications between a client and server. HTTPS
creates a secure channel over insecure, unencrypted networks, such as Wi-Fi networks. HTTPS is
designed to withstand attacks and is considered secure against attacks (with the exception of older
deprecated versions of SSL). The encryption within HTTPS is intended to provide benefits like
confidentiality, integrity and identity. Your information remains confidential because only your
browser and your server can decrypt the traffic. Integrity protects the data from being modified
without your knowledge.
International Electrotechnical Commission (IEC): The primary organization for the development
of International Standards and Conformity Assessment for all electrical, electronic and related
technologies.
License Configuration Tool: All Power Monitoring Expert licenses are activated here. The
License Configuration Tool will also indicate the current state of trial and purchased licenses.
License Returns: Once activated, a license is “locked” to its host computer (physical or virtual),
and therefore can only be activated on one machine at a time. Returning the license simply means
reversing the activation process that is, “unlocking” the license from its host, thereby making it
available to be activated again, either on another host or the same host.
Management Console “About” Box: This is the first place to check to help ensure that the
licensing components are functioning correctly. It will indicate which modules are licensed or made
available through the Trial.
Power Monitoring Expert: A power management software solution for energy suppliers and
consumers. It allows you to manage energy information from metering and control devices installed
in your facility or other remote locations. The product offers control capabilities and comprehensive
power quality and reliability analysis to help you reduce energy-related costs.
NOTE: This information is specific to ION devices. It is not applicable to devices that are not
based on ION architecture.
Time synchronization signals are broadcast periodically over the network; each meter continually
assesses its ability to remain synchronized with the incoming broadcasts. Over a brief period, each
meter learns how its internal timing differs from that of the broadcast source and adjusts its
timekeeping to compensate. Very accurate time synchronization is achieved with this method.
Meters at modem sites are synchronized each time they are connected. The longer the duration
between connections, the larger the error in time synchronization. In the extreme case, this can
result in missing or duplicated logs. If this occurs, you can increase the frequency of connections
through the Power Monitoring Expert software connection.
NOTE: This information assumes that you are using the time synchronization function in Power
Monitoring Expert. Although other methods of time synchronization are available, such as with
ION Setup, a Network Time Protocol (NTP) server, a Global Positioning System (GPS) receiver,
or 3rd party protocols, it is important that you use only one method of time synchronization on each
network. If you use multiple methods, the timestamps will differ for the sites and devices that are
using separate time synchronizing methods.
Before you configure time synchronization on your network, you should familiarize yourself with the
Clock module settings. Once you have done this, you can decide which synchronization method
you want to use.
When reviewing time synchronization messages in the system log, remember that the time in the
message is not the time to which the meter was time synced, but rather it is the time the message
was posted to the system log. The message is posted after the meter is time synced.
Note that ION time synchronization only uses the UTC setting; the LOCAL setting cannot be used.
Time synchronization values are set when sites or Ethernet devices are defined in a Power
Monitoring Expert network. Enable time synchronization or set custom intervals for supported
devices in any site through Management Console as follows:
3. Right-click the device or site and select Configure Device or Configure Site to open the
related configuration dialog.
5. Configure the Time Synch ION Enabled or Time Synch Ethernet Enabled, and Time
Synch Interval Ethernet fields as required for your system.
NOTE: You need appropriate permissions to configure meters on your network. Refer to the ION
System Security technical note for details on software and meter security.
The table gadget slideshow displays the real-time data from devices in the system.
NOTE: The session timeout of the PME web application is enabled by default (See Session
Timeout for more information). After the timeout period, the slideshow display does not retrieve the
real-time data. You must login to the PME web application every time after the timeout period.
Related topics:
Dashboards:
• Configuring a slideshow
• Playing a Slideshow
• Session Timeout
TIP: You can open the Settings page from the SETTINGS link in the Web Applications banner.
Use the Settings page to access web application settings and configuration tools.
NOTE: Access to this application or function is controlled by user privileges. See Default User
Access Level Privileges in Web Applications help, and Customizing Access Level Privileges
in User Manager help for details.
TIP: Use Search, in the Settings Library, to find the settings and tools you are looking for based on
keywords.
The Settings page consists of a Settings Library and a configuration area. The Settings Library
provides access to the following settings and tools:
Category Settings/Tools
Personal Preferences
Report Theme
Personalization
System Language
System Theme
Diagnostics and Usage
Registration & Analytics
Registration
Diagrams Control Options
Security Login Options
Session Timeout
Integrations (Note: This
Authorized Hosts
setting is a sub category
Integration Utility
under Security.)
Billing Rates (tool)
Device Manager (tool)
System Hierarchies (tool)
Modeling (tool)
System Log (tool)
Users User Manager (tool)
NOTE: The availability of the Billing Rates (Rate Editor) and Modeling are subject to licensing.
EcoStruxure Web Services (EWS) appears in the Settings pane only if it is enabled in the system.
NOTE: You can customize the web application navigation links (Dashboards, Diagrams, Trends,
and so on) in the banner. For example, you can add custom links, hide/unhide/delete links, and re-
order links. For details see Customizing the Web Applications links
Personal Preferences
Use the personal preferences settings to update or edit your user profile details, change your
account password, set your personal localization preferences, and choose your personal theme
color.
NOTE: Your personal localization settings overrule the system localization settings for your user
account. By default, your personal localization settings are the same as the system localization
settings. See System and personal localization settings for details on the behavior of these
settings.
NOTE: Your personal localization settings also apply to the Vista and Designer applications.
NOTE: The profile details settings and change password option are only available for standard
accounts. For Windows accounts, this information is managed through Windows.
NOTE: The profile details and account password are the same as the ones configured for your
account with User Manager.
1. Edit the fields or select the options you want from the drop-down lists.
Report Theme
Change the Report theme to customize the Reports colors and the Reports logo.
To change the Reports colors:
1. Under Report Colors, select Use Theme Colors or Override Theme Colors.
TIP: The system theme colors are defined by the System Theme settings for the Web
Applications. See System Theme for more information.
2. If you choose Override Theme Colors, then set the colors for the Report Title, Section Header,
Table Header, Summary, Row Shading, and Section Title, using the drop-down selectors.
2. Under Report Logo, click Select to open the Select Report Logo Image dialog.
NOTE: You can use GIF, JPG, JPEG, or PNG image formats. The recommended file size is 250 x
100 pixels. Images are automatically re-sized to fit the logo area in Reports.
System Language
Use these system localization settings to select the language, region, and currency symbol. The
setting for Region determines date, time, number, and currency formats.
NOTE: Your personal localization settings overrule the system localization settings for your user
account. By default, your personal localization settings are the same as the system localization
settings. See System and personal localization settings for details on the behavior of these
settings.
NOTE: The system localization settings also apply to the diagrams displayed in the Vista
application.
System Theme
Use the system theme settings to:
• Specify if you want to display the vendor logo in the top right corner of the Web applications
window.
• Change the image and text that is displayed in the top left corner of the Web Applications
window.
• Choose a theme color for the borders and other elements of the user interface. You can enable
high contrast mode which uses a dark background color for the application.
• Choose the location of the library panel to be on the right or left side of the user interface.
NOTE: Compact navigation replaces the main navigation bar at the top of the Web
Applications user interface with an options button . The options button is displayed at the
top left corner of the banner. When you click the button, the navigation links to the different
Web applications are shown. Compact mode is used for small displays, such as on mobile
devices. The Web Applications user interfaces switches to compact mode automatically
when the browser size is reduced below a certain size. Turning on the Always use compact
mode for Navigation setting forces this mode regardless of browser size.
• Set the colors for the waveform and bust data plots.
NOTE: With the Default Theme all color, image, and logo options are set to the factory
defaults. You can change the location of the navigation panel, choose to always use
compact mode, and you can customize the colors for the waveform and burst data plots.
2. Turn on Show Vendor logo to display the logo or turn off Show Vendor logo to hide the
logo, in the top right corner of the Web Applications window.
3. In Select Image, select the image you want, or if the image is not in the Image Library,
Click Upload Image and either choose an image file available on your system by clicking
Choose Files or drag an image file into the application area.
The image file name is shown under Image. The image is updated on the banner when you
save your settings. You can use GIF, JPG, JPEG, or PNG image formats. The maximum file
size is 2MB. Images are automatically resized to fit the logo area on the banner.
5. Use the Text field to change the text beside the logo in the banner. The text is updated when
you save your settings.
2. Under Theme Color, select from several preset color themes or create your own using the
color selector that opens when you click the color theme icon on the right. When you
click a preset color, it is temporarily applied to the interface to show you the effect of the
change.
TIP: Enable high contrast mode to create a dark mode type theme with dark backgrounds.
1. Under Waveform and Burst Data, set the color that is used to display the different
measurement types.
NOTE: Click Reset to Default to set the colors to the system default.
The diagnostics and usage service collects and sends data to Schneider Electric weekly on
Monday at 2:00 a.m. (server time), over HTTPS at port 443. Each time the service runs, it creates a
log file in the system\bin folder in the Power Monitoring Expert install location.
NOTE: All diagnostics and usage data are sent to Schneider Electric anonymously. None of the
collected information identifies you or your company. For more information on the Schneider
Electric Privacy Policy, see the Schneider Data Privacy and Cookie Policy.
• City or region
• Screen DPI
1. Open Web Applications and click Settings > Registration & Analytics > Diagnostics and
Services.
2. Select Disable in the dropdown list and click Save to apply the change.
Registration
Connected Services
Connected Services lets you share the operational data that is collected by Power Monitoring
Expert with Schneider Electric. The collected energy and power data can then be used by
connected services – such as EcoStruxure™ Power Advisor and EcoStruxure™ Asset Advisor – to
help identify gaps or issues in your power management system. It can also help identify power
quality issues within your electrical distribution system.
The collected data depends on the specific services that the customer receives from Schneider
Electric. For more information on Connected Services, see the Power Advisor User Guide.
To disable the collecting of operational data, select Disable in the drop-down list and click Save to
apply the change.
Software registration
Registration information is used by Schneider Electric to help provide support and to enhance the
service we provide to you. Schneider Electric will never sell or share this information.
By registering you acknowledge that your registration information will be shared with Schneider
Electric and you consent to receiving occasional communications about your product. Product
communication includes new features, service pack releases, and recommended cybersecurity
updates.
You can edit the registration information at any time through the web application settings.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
You can enable or disable the ability to perform manual control actions in Diagrams. Manual control
actions include actions such as resetting values on devices or changing device configuration
settings. You can also set the confirmation method that is used by the software to confirm a control
action request before carrying it out.
NOTE: The required user access permissions for performing a control action are configured
individually for each control object in a diagram. This is done at design time in Vista. However, to
perform any control action in Diagrams you need at least controller-level access or higher
(operator-level, supervisor-level). This is true even if the permissions for a control object in a
diagram are set to user-level or view only-level. Only through Vista can users with user-level or
view only-level access perform control actions on such a control object. To view or change the
permissions on a control object, open the diagram in Vista. See Controlling system functions in
Vista help for information on control object configuration.
NOTE: Control in Diagrams is only available when a HTTPS connection is used between the PME
server and the Web Applications client.
1. Open the Settings page from the SETTINGS link in the Web Applications banner.
NOTE: Only supervisor-level users can access the Diagrams Control Options settings.
4. Click Save.
NOTE: Control in Diagrams must be enabled for the confirmation method settings to be displayed.
1. Open the Settings page from the SETTINGS link in the Web Applications banner.
NOTE: Only supervisor-level users can access the Diagrams Control Options settings.
3. In Diagrams Control Options, select the confirmation method - Dialog Box without
Password or Dialog Box with Password.
NOTE: Control objects in diagrams can be configured, at design time, to always require
password confirmation. This configuration has priority over the confirmation method settings
above. See Controlling system functions in Vista help for information on control object
configuration.
4. Click Save.
Login Options
Use the login options settings to define how Windows users can log into the software. You can also
disallow login for standard users and only allow login for Windows users.
You can choose the following login options for Windows users:
Windows users can log into the system by manually entering credentials on the login page.
Windows users can log into the system by clicking a hyperlink on the login page.
Windows users can log into the system by manually entering credentials, or by clicking a
hyperlink on the login page.
NOTE: Standard users, if allowed to log in, always have to enter their credentials manually.
If you only want to allow Windows user accounts to log into the software, you can disable standard
user login. For these options to be available, your system must have at least one Windows user
with supervisor-level access.
Session Timeout
Use the session timeout settings to define the timeout behavior of the software web applications
and Windows applications clients.
You have to following options:
• You can enable and set a timeout for the web applications.
• You can enable and set a timeout for the Windows applications.
NOTE: You can enter a timeout value from 1 minute to 1440 minutes (1 day)
When a session timeout is configured, web application clients are logged out and Windows
application clients (Vista, Designer, Management Console) are locked after a period of inactivity.
The default timeout for both client types is 20 minutes. To restart or unlock the session you must
enter the login credentials.
A session is considered inactive when none of the following actions are detected for the duration of
the timeout period:
• Mouse movement
• Mouse clicks
• Keyboard activity
Authorized Hosts
Use the authorized hosts settings to define third-party web resources that are allowed to either
embed (frame) the PME web applications, or to which the PME web applications can redirect
requests.
To define a third-party web resource as a Hosts That Can Frame, add the Uniform Resource
Locator (URL) of that resource to the list, for example https://localhost:446.
NOTE: Add all the names (URLs) that might be used for a host, for example the server name,
"localhost", the IP address, and so on.
To define a third-party web resource as Hosts That Can Be Redirected To, add the hostname (no
protocol, no port number) of that resource to the list, for example localhost.
NOTE: Reset Internet Information Services (IIS) on the PME server after updating the Authorized
Hosts settings.
An example for an application that requires an entry in the Hosts That Can Frame list is the
integration of PME with EcoStruxure Building Operation. As part of that integration, PME Web
Applications are embedded in Building Operation. For this to work, the Building Operation server
URL must be added to the list of hosts that can frame.
Integration Utility
Use the integration utility settings to generate pre-authenticated links to PME resources. Use these
links to integrate web applications (Dashboard, Diagrams, Trends, Alarms, Reports, and EWS
measurements) into third-party systems. You can authenticate the link using standard users or
Windows users.
To generate links:
1. Under Authentication Method, select the desired user type for authentication:
NOTICE
UNAUTHORIZED OR UNINTENDED ACCESS TO CONFIDENTIAL DATA
• Personnel generating the pre-authenticated links for integration into third-party systems
must be aware that links to data are not secure.
• Do not setup access links to sensitive or secure data.
Failure to follow these instructions can result in unauthorized or unintended access
to sensitive or secure data.
NOTE: Links for Windows users contain no user information. Windows users accessing
the link must have permission to access the PME system and be authenticated with
Windows. One-click login must be enabled to use the Windows user authenticated links.
See Login Options for information for enabling one-click login.
Select Standard User, select the desired PME User Name and enter the Password.
NOTE: Links for standard users embed the user's account information. Take care on
usage of these links. Links cannot be generated for standard users with supervisor
access level.
2. Under Generate Links For, select the web applications for which you want to generate link.
Select XML to generate an XML file of links. Use this option to generate links that can be
imported into applications like EcoStruxure Building Operation.
Select HTML to generate an HTML page of links. Use this option to verify the links.
NOTE: The download HTML link must be opened in a different browser to test the links.
An XML or HTML file is downloaded to the default download location of the browser.
An example for an application that requires the generated link is the integration of PME with Building
Operation. As part of that integration, PME Web Applications are embedded in Building Operation.
For this to work, the generated links are imported in to Building Operation.
Rate Editor
Rate Editor is a Web-based application that lets you change cost values for items included in a
billing report.
Open Rate Editor from Web Applications Settings > System > Billing Rates. You can also open
Rate Editor from Management Console Tools > Web Tools.
The Rate File list on the left lists all of the rate files contained in the ratelibrary folder in the Power
Monitoring Expert install location under applications\config\reports\billing report.
When you add rate files to the folder, they are included in the Rate File list.
1. Click the unit cost value that you want to change to enable editing.
2. Type the new value and press Enter to complete the update.
The rate files included in the product are examples of various billing scenarios. The files are
intended to be copied and modified to meet your specific requirements. For further information about
creating or modifying rate files, see the documentation, tutorials, and examples included in the
Billing Module Toolkit (available in the Power Monitoring Expert Exchange).
Device Manager
TIP: You can open Device Manager from SETTINGS > System > Device Manager in the Web
Applications banner.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is functioning
correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of communications
links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and status
feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
NOTICE
NETWORK INOPERABILITY
Do not make unauthorized changes in the network configuration.
• Import device and site configurations from other applications, such as ION Setup.
• Export device and site configuration in CSV format for use in another PME system.
• Import device and site configuration in CSV format for efficient configuration of large systems.
and devices. Management Console offers additional configuration functions, such as modem
configuration or setting up connection schedules. Management Console also provides access to
maintenance and programming tools.
NOTE: You cannot add direct serial sites or modem sites with Device Manager. Use Management
Console to add these sites.
For more information and details on network configuration, see Management Console help.
Definitions
Sites
A site is a group of devices in the system that share a common communications link. A site can be
a direct site, a modem site, an Ethernet gateway site, or an OPC site.
Devices
A device is a meter or other component that communicates and gathers data and is installed on a
network.
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Adding a device
Add a device to make this device and its data available for monitoring and analysis in PME. You can
add one device at a time using the Device Manager user interface. You can also import many
devices at once using configuration import.
To add a device using the Device Manager user interface:
1. In Device Manager, select the Devices tab, and then click Add Ethernet Device or click the
down arrow next to it to add a serial or OPC device. This opens the New Device dialog.
TIP: The right-click context menu for a device in the table has a Duplicate Device option to
create a copy of an existing device.
2. In New Device, enter the required information such as group name, device name, device type
and IP address.
TIP: Click Show Advanced to access advanced configuration settings. These settings
have factory defaults and only need to be changed for specific application needs.
4. Click OK.
TIP: To add a device directly to a site, go to the Sites tab and right-click the site to open the
context menu.
1. In Device Manager, click Import. This opens the Import Devices and Sites dialog.
2. In Import Devices and Sites, download the configuration import template CSV file.
3. Open the downloaded configuration import template in a text editor and add the configuration
information for the devices you want to add.
5. Return to the Device Manager Import Devices and Sites dialog and click Next.
6. Click Upload Files. This opens the Upload new files dialog.
7. In Upload new files, click Choose Files and find the configuration import template CSV file.
Click Open. Click Finish.
TIP: You can also drag and drop the configuration import file into the designated area in
Upload new files.
8. Follow the steps in the import wizard to complete the configuration import.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Editing a device
Edit a device to update its group name or name, or to change its configuration settings. You can edit
devices using the Device Manager user interface or configuration import.
To edit a single device using the Device Manager user interface:
2. In the devices table, select the row of the device you want to edit, then right-click in the row
and select Edit Device in the context menu. This opens the Device Configuration dialog.
4. Click OK.
2. In the devices table, select the rows of the devices you want to edit, then right-click in the
selected row area and select Edit <number> Devices in the context menu. This opens the
Device Configuration dialog.
TIP: Use Ctrl+Click to select individual devices. Use Shift+click to select a block of
devices.
NOTE: Only those settings that are common to all selected devices can be configured at the
same time.
4. Click OK.
3. Open the exported configuration file in a text editor and edit the configuration information for
the devices as needed.
6. Follow the steps in the import wizard to complete the configuration import.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Deleting a device
Delete a device if it is no longer needed, for example if the device has been removed from service.
NOTE: When a device is deleted in Device Manager it is marked as Historical device in the
system and removed from the default view of the devices table. All historical data associated with
the deleted device remains in the system and is still available for analysis and reporting.
TIP: Adjust the filter options in the devices grid in Device Manager to see Historical devices in the
system. See Device Manager user interface for details on the Devices filter.
To delete a device:
2. In the devices table, select the row of the device you want to delete, then right-click in the row
and select Delete Device in the context menu. This opens the Delete Device confirmation
dialog.
2. In the devices table, select the rows of the devices you want to delete, then right-click in the
selected row area and select Delete <number> Devices in the context menu. This opens the
Delete Device confirmation dialog.
TIP: Use Ctrl+Click to select individual devices, use Shift+click to select a block of
devices.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
2. In the devices table, select the row of the device you want to connect.
3. Right-click in the row and select Connect Ethernet Device in the context menu.
TIP: Inspect the Communication Status column for the device in the devices table to
confirm that the device is connected. Note that there can be a time delay until the
communication status is updated in the table.
2. In the devices table, select the rows of the devices you want to connect.
TIP: Use Ctrl+Click to select individual devices, use Shift+click to select a block of
devices.
3. Right-click in the selected row area and select Connect <number> Ethernet Devices in the
context menu.
TIP: Inspect the Communication Status column for the devices in the devices table to
confirm that the devices are connected. Note that there can be a time delay until the
communication status is updated in the table.
2. In the devices table, select the row of the device you want to disconnect.
3. Right-click in the row and select Disconnect Ethernet Device in the context menu.
TIP: Inspect the Communication Status column for the device in the devices table to
confirm that the device is disconnected. Note that there can be a time delay until the
communication status is updated in the table.
2. In the devices table, select the rows of the devices you want to disconnect.
TIP: Use Ctrl+Click to select individual devices, use Shift+click to select a block of
devices.
3. Right-click in the selected row area and select Disconnect <number> Ethernet Devices in
the context menu.
TIP: Inspect the Communication Status column for the devices in the devices table to
confirm that the devices are disconnected. Note that there can be a time delay until the
communication status is updated in the table.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
2. In the devices table, select the row of the device you want to enable.
3. Right-click in the row and select Enable Device in the context menu.
TIP: Inspect the Communication Status column for the device in the devices table to
confirm that the device is enabled. Note that there can be a time delay until the
communication status is updated in the table.
2. In the devices table, select the rows of the devices you want to enable.
TIP: Use Ctrl+Click to select individual devices, use Shift+click to select a block of
devices.
3. Right-click in the selected row area and select Enable <number> Devices in the context
menu.
TIP: Inspect the Communication Status column for the devices in the devices table to
confirm that the devices are enabled. Note that there can be a time delay until the
communication status is updated in the table.
2. In the devices table, select the row of the device you want to disable.
3. Right-click in the row and select Disable Device in the context menu.
TIP: Inspect the Communication Status column for the device in the devices table to
confirm that the device is disabled. Note that there can be a time delay until the
communication status is updated in the table.
2. In the devices table, select the rows of the devices you want to disable.
TIP: Use Ctrl+Click to select individual devices, use Shift+click to select a block of
devices.
3. Right-click in the selected row area and select Disable <number> Devices in the context
menu.
TIP: Inspect the Communication Status column for the devices in the devices table to
confirm that the devices are disabled. Note that there can be a time delay until the
communication status is updated in the table.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
NOTE: To see data in a diagram, the device must be connected to and communicating with PME.
2. In the devices table, select the row of the device for which you want to open the diagram, then
right-click in the row and select View Device Diagram in the context menu. This opens the
device type specific diagram for this device in a new tab in your browser.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Adding a site
A site is a gateway to establish a connection between the software and a group of devices. Add
sites to connect devices with serial communication or to connect OPC devices.
NOTE: You do not add sites for Ethernet devices. You add Ethernet devices directly to the
system. See Adding a device for details. The software automatically sets up an internal site for
each Ethernet device. These internal sites are not visible in Device Manager.
NOTE: You cannot add direct serial sites or modem sites with Device Manager. Use Management
Console to add these sites.
You can add sites through the Device Manager user interface, one site at a time. You can also add
one or more sites at the same time through importing site configuration information.
To add a site through the Device Manager user interface:
1. In Device Manager, select the Sites tab, and then click Add Ethernet Gateway or click the
down arrow next to it to add an OPC site. This opens the New Site dialog.
TIP: The right-click context menu for a site in the table has a Duplicate Site option to create
a copy of an existing site.
2. In New Site, enter the required information such as name, IP address, and so on.
TIP: Click Show Advanced to access advanced configuration settings. These settings
have factory defaults and only need to be changed for specific application needs.
4. Click OK.
1. In Device Manager, click Import. This opens the Import Devices and Sites dialog.
2. In Import Devices and Sites, download the configuration import template CSV file.
3. Open the downloaded configuration import template in a text editor and add the configuration
information for the sites you want to add.
5. Return to the Device Manager Import Devices and Sites dialog and click Next.
6. Click Upload Files. This opens the Upload new files dialog.
7. In Upload new files, click Choose Files and find the configuration import template CSV file.
Click Open. Click Finish.
TIP: You can also drag and drop the configuration import file into the designated area in
Upload new files.
8. Follow the steps in the import wizard to complete the configuration import.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Editing a site
Edit a site to update its name or to change its configuration settings. You can edit sites through the
Device Manager user interface or through exporting, editing, and then re-importing the site
configuration.
To edit a single site through the Device Manager user interface:
2. In the sites table, select the row of the site you want to edit, then right-click in the row and
select Edit Site in the context menu. This opens the Site Configuration dialog.
TIP: You can also double-click a row to open the Site Configuration dialog.
4. Click OK.
2. In the sites table, select the rows of the sites you want to edit, then right-click in the selected
row area and select Edit <number> Sites in the context menu. This opens the Site
Configuration dialog.
TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a block of
sites.
NOTE: Only those settings that are common to all selected sites can be configured at the
same time.
4. Click OK.
3. Open the exported configuration file in a text editor and edit the configuration information for
the sites as needed.
6. Follow the steps in the import wizard to complete the configuration import.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Deleting a site
Delete a site if this site is no longer needed, for example if all the devices connected to the site have
been removed from service.
To delete a site:
2. In the sites table, select the row of the site you want to delete, then right-click in the row and
select Delete Site in the context menu. This opens the Delete Site confirmation dialog.
2. In the sites table, select the rows of the sites you want to delete, then right-click in the
selected row area and select Delete <number> Sites in the context menu. This opens the
Delete Site confirmation dialog.
TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a block of
sites.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
2. In the sites table, select the row of the site you want to connect.
3. Right-click in the row and select Connect Site in the context menu.
TIP: Inspect the Communication Status column for the site in the sites table to confirm that
the site is connected. Note that there can be a time delay until the communication status is
updated in the table.
2. In the sites table, select the rows of the sites you want to connect.
TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a block of
sites.
3. Right-click in the selected row area and select Connect <number> Sites in the context
menu.
TIP: Inspect the Communication Status column for the sites in the sites table to confirm
that the sites are connected. Note that there can be a time delay until the communication
status is updated in the table.
2. In the sites table, select the row of the site you want to disconnect.
3. Right-click in the row and select Disconnect Site in the context menu.
TIP: Inspect the Communication Status column for the site in the sites table to confirm that
the site is disconnected. Note that there can be a time delay until the communication status
is updated in the table.
2. In the sites table, select the rows of the sites you want to disconnect.
TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a block of
sites.
3. Right-click in the selected row area and select Disconnect <number> Sites in the context
menu.
TIP: Inspect the Communication Status column for the sites in the sites table to confirm
that the sites are disconnected. Note that there can be a time delay until the communication
status is updated in the table.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
2. In the sites table, select the row of the site you want to enable.
3. Right-click in the row and select Enable Site in the context menu.
TIP: Inspect the Communication Status column for the site in the sites table to confirm that
the site is enabled. Note that there can be a time delay until the communication status is
updated in the table.
2. In the sites table, select the rows of the sites you want to enable.
TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a block of
sites.
3. Right-click in the selected row area and select Enable <number> Sites in the context menu.
TIP: Inspect the Communication Status column for the sites in the sites table to confirm
that the sites are enabled. Note that there can be a time delay until the communication status
is updated in the table.
2. In the sites table, select the row of the site you want to disable.
3. Right-click in the row and select Disable Site in the context menu.
TIP: Inspect the Communication Status column for the site in the sites table to confirm that
the site is disabled. Note that there can be a time delay until the communication status is
updated in the table.
2. In the sites table, select the rows of the sites you want to disable.
TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a block of
sites.
3. Right-click in the selected row area and select Disable <number> Sites in the context menu.
TIP: Inspect the Communication Status column for the sites in the sites table to confirm
that the sites are disabled. Note that there can be a time delay until the communication
status is updated in the table.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
NOTE: You cannot import the configuration back into the same system from which it was
exported.
2. Click Options in the top right corner of the display pane, and then click Export Network
Configuration for Use in a Different System in the options menu. This exports the
configuration and saves it in CSV file format to your local Downloads folder.
4. Import the configuration file into the target system. See Importing network configuration from a
different system for details.
NOTE: Keep the configuration file secure during and after the transfer to prevent unauthorized
access.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices to help prevent unauthorized access to the software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Work with facility IT System Administrators to ensure that the system adheres to the site-specific
cybersecurity policies.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Setup.
NOTE: You cannot import the configuration back into the same system from which it was
exported.
2. Follow the steps in the import wizard. Select the configuration file from the other system when
prompted by the wizard to upload the import file.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
NOTICE
LOSS OF COMMUNICATION
• Activate product and component licenses prior to the expiry of the trial license.
• Activate sufficient licenses for the servers and devices in your system.
Failure to follow these instructions can result in loss of data.
2. Click Options in the top right corner of the display pane, and then click View Device
Licenses in the options menu. This opens the Device License Information dialog.
Related topics:
Devices
• Adding a device
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Device Manager
Use the links below to find the content you are looking for:
Main UI
Selection tabs
1
Select a tab to see information related to Devices or Sites.
Help
2
Click Help to open the Device Manager online help.
Number of displayed items
10
Shows the number of items visible on this page, and the total number in the system.
Page selector
11 Use the page selector to navigate between pages of information. Set the number of items
that are displayed on a page.
Devices tab
NOTE: To add serial devices that are directly connected to the system, for example through
a RS485 converter, or to add Logical Devices, use Management Console.
Import
Use the import wizard to import device or site configuration into the system. You can import
4 configuration from a different system, from configuration tools, or edited configuration from
the same system. See Importing network configuration from a different system and Editing a
device, Editing a site for more details.
Devices filter
5 Use the devices filter to customize which devices are displayed in the devices table. You can
filter by Communication Status, Type, and Enabled State.
Options menu
The Options menu contains the following options:
- Show/Hide Columns
- Clear Filter
8
- View Device Licenses
- Export Devices Configuration for Editing
- Export Network Configuration for Use in a Different System
- Refresh
Devices table
9 The devices table shows devices that are configured in the system. Which devices are
displayed in the table is controlled by the devices filter, see 5 above.
Sites tab
Refresh
Click Refresh to update the table content and show changes to the site configuration that
might have been done through Management Console.
5
NOTE: The Communication Status indicator in the table is updated automatically every 10
seconds. To update the configuration information use Refresh.
Options menu
The Options menu contains the following options:
- Show/Hide Columns
6 - Clear Filter
- Export Sites Configuration for Editing
- Export Network Configuration for Use in a Different System
- Refresh
Sites table
7 The sites table shows sites that are configured in the system. Which sites are displayed in
the table is controlled by the sites filter, see 3 above.
Hierarchy Manager
Depending on the number of devices you are currently monitoring, organizing the data coming from
those devices can be a difficult task. Hierarchy Manager allows you to organize the devices in
EcoStruxure™ Power Monitoring Expert into recognizable views by defining their relationships as
parts of a system model. Once the model has been created, energy data associated with the
hierarchy can be grouped, aggregated, and used by other components of Power Monitoring Expert.
The Hierarchy Manager views are intended to represent the real world electrical, physical, and
business characteristics of your organization. The items contained in a view, and how those items
relate to each other are specified using a template approach. There are several example templates
included in the product to help you create the views applicable to your organization. One of these
templates is configured when Power Monitoring Expert is first installed.
Open the Hierarchy Manager from Settings > System > Hierarchies in the Web Applications
banner. You can also open Hierarchy Manager from the Tools > Web Tools menu in the
Management Console.
The following topics provide specific information regarding the features and use of the Hierarchy
Manager application:
• Hierarchy templates
Nodes
Node properties
• Creating a hierarchy
• Dynamic hierarchy
• Meter apportionment
• Virtual meter
After you have configured the views of the hierarchy structure, you can use them in different areas
of Power Monitoring Expert.
NOTE: Before using Hierarchy Manager, ensure that devices, logical devices, or managed circuits
have been added to Power Monitoring Expert through the Management Console component.
Hierarchy templates
When the Hierarchy Manager application opens, everything displayed in the application is based on
the hierarchy template defined in the system. This template defines the parameters of the model. If
you were to describe the physical layout of a building for example, you could describe the name of
the building, each floor of the building, and the rooms or areas that each floor contains. The
hierarchy template for a building's physical layout does the same thing, using Nodes to represent
the different aspects of the model.
Note that a Virtual Meter Node is included in the hierarchy template. You can define virtual meters
without associating them with a hierarchy, or you can include virtual meters in a hierarchy the same
way that you include devices. You can select virtual meters for many of the reports in the Reports
application.
Each Node contains instances of that particular Node type, which in turn are defined by a set of
properties. These properties not only define the different parts of the model, they also define the
relationships that exist between the different Nodes. This is useful when aggregating the device
data used in other parts of Power Monitoring Expert.
Once the model has been created, the devices that are collecting data can be associated with the
different levels of the hierarchy that are defined in the template.
Nodes
A Node can be described as the building block of a hierarchy. Nodes are used to model a customer
system and can represent:
• Electrical equipment
• Logical concepts
• Physical locations
Nodes are displayed in Hierarchy Manager as a set of tabs. Each tab is labeled with the name of the
part of the model it represents. Each Node displays a number of Node instances in a grid format. In
Hierarchy Manager, a Node can be described as the type of object required to model a system,
while Node instances can be thought of as the reference to the real-world objects in that system.
For example, if 'Car' is used as an example of a Node, then 'my Corvette' could describe an
instance of the Car Node.
A hierarchy that represents the physical layout of a company's industrial site might have a Site
Node, a Building Node, and an Areas Node. Each of those Nodes can contain instances of that
Node type. Under the Building Node for example, you could list the different buildings located in a
particular site. The Properties of each of these Nodes are specified by the user.
Each Node instance is represented in the system as a set of properties that define the
characteristics of that instance. These properties can be further broken down into Attributes and
References.
Node properties
Attributes and References can be used to describe the properties of a Node, and their relationships
to other Nodes. These properties provide the context that helps to describe the different parts of the
model. For example, a Node called Floors might contain attributes such as floor number, and
references such as the association between the Floors Node and the Building Node, or the
association between Floors and Areas.
Attributes
The Attributes of a Node describe the properties of that Node, such as its name and characteristics.
These Attributes could include the breaker rating of an electrical panel or contact information of a
tenant. For example, a Node called Buildings that is part of a physical layout hierarchy could have
an Attribute such as the building name.
Attributes are configurable by entering information into an Attribute field. To add Attribute content to
a new Node instance, select a tab and click Add. To edit existing Attribute content, double-click a
Node instance, or highlight it and click Edit. When the Properties dialog opens, select an attribute
field by clicking in the applicable field and entering the necessary information. Click OK when you
finish specifying all of the necessary attributes for the Node.
References
References describe how a Node in a hierarchy is associated with other Nodes. For example, in a
hierarchy that describes the physical layout of a company's building, a Node called Floor could have
a reference that describes its association with a Node called Areas. These references indicate
which offices are part of each floor. In this example, since a Floor can contain many offices, it is
considered a one-to-many association. Since an office can only be associated with a single floor, it
is considered a one-to-one association. By making these connections between the Nodes, the
hierarchy structure of the model begins to take shape.
Reference fields require clicking Add, Edit, or Delete. To add reference content to a Node instance,
click Add for the reference, then select the appropriate entry from the list that appears. You can also
enter dynamic hierarchy time ranges in this section.
To edit existing reference content, double-click the entry in the grid, or highlight it and click Edit, and
then make the necessary changes. In most cases, this change would involve either the start or end
dates of the particular reference.
To delete existing reference content, select an entry from the applicable reference type and click
Delete.
NOTE: The Delete button should not be used to end an association with a particular Node
instance. When a relationship between two Node instances ends after a certain date, the ideal
solution is to edit the references and change the To field to a specific end date that defines the
time range for the relationship. See Creating a hierarchy for more information.
Hierarchy Manager has a series of tabs across the top of the page. These tabs are the
representation of the Nodes. Clicking on any of these tabs displays the instances of the Node types
in a grid format.
The process involved with creating an instance of a Node type is the same for most hierarchy
templates. To create a new instance, select the applicable tab and click Add. The Properties
window opens, containing fields that represent the properties for that particular Node instance. Any
required fields are identified with a Required message. Click in the attribute fields and enter the
necessary information. Reference fields are selected from a grid and can also have a time
dimension associated with them (see Dynamic hierarchy for additional information). Click Add to
open the Select dialog and select the applicable item from the grid. If there are no items to choose
from, you might need to create a new instance for that Node type.
To edit an instance of a Node type, click the applicable tab, double-click an instance in the grid, or
select it and click Edit. Make the changes to the applicable fields in the Properties dialog and click
OK.
To delete an existing instance of a Node type, select the applicable tab, select an instance on that
tab and click Delete. After you confirm the delete action, the instance disappears from the grid, and
any reference information regarding the deleted instance is removed from all affected Node
instances.
Tree View
Displaying the views of a template is also similar for most template types. You can see the view of
a hierarchy by clicking the Show Views link. The view shows the different levels of the hierarchy,
and the date range for each entry of the hierarchy.
Date Range: Use the To and From fields to select the date range to display the hierarchy.
Available Views: Use this section to switch between different views if there is more than one view
available. The available views are determined by the hierarchy template. Click Update when you
change the date range, the scale, or view.
Scale: Select Days or Months to provide the appropriate scale to the hierarchy view.
Beside each hierarchy level is a bar that indicates when in the date range the Node was part of the
hierarchy. If the bar has a rounded edge, the Node reference has an end date within the date range.
If the bar has a square edge, the Node reference continues beyond the date range.
You can click the pencil (edit) icon to the left of the bars to open and edit the properties for the
related item.
If you do not see a node in the hierarchy view, make sure the date range includes the date that Node
was part of the hierarchy. You can view the date range for a hierarchy entry by hovering the pointer
on it.
Creating a hierarchy
The following example uses the default hierarchy template (with Site, Buildings, and Areas nodes)
to illustrate the basic functionality of Hierarchy Manager.
In this scenario, we are the facility manager for Faber College. The college includes three buildings,
two of which have already been added to Hierarchy Manager. Building Three has just been
completed, and we must add this building to our hierarchy using Hierarchy Manager. This involves
creating a new building and areas entries, and adding devices to the areas, all beginning on a
specific date.
At the same time, renovations to Building Two have just been completed which include the
replacement of a meter. We need to swap the old device with the new one in our hierarchy by setting
the end date for the existing device and the start date for the new device. The new device must be
associated with the correct area.
NOTE: Access to this application or function is controlled by user privileges. See Default User
Access Level Privileges in Web Applications help, and Customizing Access Level Privileges
in User Manager help for details.
From Management Console Tools > Web Tools > Hierarchy Manager.
2. Type a user name and password in the Log In dialog, if required, and click OK to open
Hierarchy Manager.
NOTE: In the following steps, devices have already been added to the system, and the
hierarchy has been populated with site, building, and area information.
The Buildings grid includes Building One and Two, the site they are associated with, and the
areas defined for each building.
2. To add Building Three, click Add above the Buildings grid to open the Properties dialog for the
Buildings node, then enter the building name in the Name field.
3. Click Add above the Site grid, in the properties dialog, to open the Add Site References
dialog and select the Faber College site name in the grid. Then click the From date field or
click the calendar icon beside it at the bottom of the dialog. Select a start date in the calendar.
4. Confirm that the date has changed in the Start Date column under Sites, then click OK.
A new area needs to be created, Area 3. Associate this area with the new building, assign a
device to the area, and set the start date.
2. Click Add above the Areas grid to open the Properties dialog for the Areas node, then type
Area 3 in the Name field.
3. Click Add above the Building grid to open the Add Building References dialog.
5. Click the From field or click the calendar icon and select a start date.
6. Confirm that the date has changed in the From field under Building, then click OK.
7. Click Add above the Device grid to open the Add Device References dialog.
8. Select a device.
9. Click the From field or click the calendar icon and select a start date.
10. Confirm that the date has changed in the Start Date column under Device, then click OK.
The following image shows the complete set of entries on the Areas tab.
• The minus sign beside an entry to collapse that part of the hierarchy.
• The pencil (edit) icon to open and edit the properties for the related item.
• The bar for each entry to see the Node name and the effective date range for that entry.
The device that you are replacing is associated with Area 2 in Building Two.
When this task is complete:
• The entry for the old device is dimmed and italicized in the hierarchy if the End Date is the
current date or earlier.
• Any reports that include the area only include data collected by the device up to this new end
date.
NOTE: Date ranges extend from start of day to start of day. This means that the end date does not
include data collected for that day.
2. Double-click Area 2 in the grid or select it and click Edit to open the properties dialog.
3. Double-click Campus.Library device in the Device grid, or select it and click Edit to open the
Edit Device References dialog.
4. Click the To field, or click the calendar icon beside it, and select the end date.
5. Confirm that the date has changed in the End Date column under Device, then click OK.
6. Click Add above the Device grid to open the Add Device References dialog.
8. Click the From field or click the calendar icon beside it. Select the start date.
9. Confirm that the date has changed in the Start Date column under Device, then click OK.
When you complete these tasks, any reports that include this area with a date range that extends
beyond the device start date includes data collected by the new device as of their start date. The
reports do not include any data for the removed device as of their end date.
2. Select the area for which you want to create an apportioned meter and click Edit to open the
properties dialog.
3. In the area properties dialog, under Devices, select the device and click Edit. This opens the
Edit Device References dialog.
5. If required, click the From or To fields to change the start and end dates for the apportioned
meter.
6. Click OK.
Add: Selecting Add opens the Properties dialog. Type a name for the virtual meter and click Add in
the Devices area to select devices to attach to it. You can attach a device, a previously created
virtual meter, or an apportioned meter in the same way you attach a device to a hierarchy node.
Time intervals for start and end dates work the same as on meters attached to hierarchy nodes.
Edit: Editing a virtual meter is like editing the relationship between a hierarchy node and a device.
You can add, edit, or delete virtual meters but you need to ensure that your changes respect time
intervals.
For example, if you are replacing a meter, you need to update the End Date for it, and you need to
specify an appropriate Start Date for the new meter. Do not delete the original meter as this
removes the meter historically.
Delete: You can delete a virtual meter, but you need to take care when doing so. When you delete a
virtual meter, the relationships between all hierarchy nodes and the virtual meter are removed.
Dynamic hierarchy
Another feature of Hierarchy Manager is the ability to assign devices or Node instances for discrete
units of time. Instead of devices existing in either an assigned or unassigned state independent of
time, a device can be assigned to one Node instance for a specific length of time, then assigned to
another instance for another length of time.
With this time dimension, Hierarchy Manager can be used by organizations that require an ever-
changing representation of their system. If one tenant moves out and another moves in, that change
can be reflected in the hierarchy. Energy and power usage can be tracked for each tenant over time,
and billing information can be collected, aggregated, and displayed in a report.
NOTE: If your hierarchy does not change over time you do not need to set the date ranges for the
various devices or Node instances. In Power Monitoring Expert, these static hierarchies exist from
the date when the system was first commissioned (system start), to the farthest date the system
recognizes (end of time).
Dynamic hierarchies are established when you create or edit the properties of a Node instance that
is associated with a device. For example, if Customer A is set to lease a rack from a data center,
you can assign the racks and circuits to that customer on a specific date. When tenant A's lease
expires, you can remove the assignment of the racks and circuits on the expiration date and
reallocate them to tenant B.
See Creating a hierarchy for details on how to use the dynamic hierarchies function.
Meter apportionment
Meter apportionment allows you to assign a percentage of a device that has been assigned to an
area. For example, if a common area is monitored by a single meter but shared by two tenants, for
billing purposes you might want to allocate only a portion of the meter to each tenant. If tenant 1
uses 60% of the common area and tenant 2 uses 40%, you can attach 60% of a meter's reading to
the tenant 1 area node and the other 40% to the tenant 2 area node.
Virtual meter
A virtual meter allows you to aggregate measurements from any combination of devices,
apportioned meters, or other virtual meters available in Hierarchy Manager. The newly created
virtual meter can be assigned to a node in Hierarchy Manager just like any other device and appears
in dialogs that have a Views selection. You can even create an apportioned meter from a virtual
meter.
Examples:
• Assume that there are several feeder meters connected to the main power bus and you want to
calculate the total power usage. You can create a virtual meter that includes each of the feeder
meters. Then you can choose one of the reports supporting virtual meters to generate a report
showing the total power usage for the virtual meter.
• Assume that there is a large area monitored by a single meter (M1). Within that area is a single
room that is monitored by a separate meter (M2). Tenant 1 is using the small room and Tenant 2
is using the remaining area. To calculate Tenant 2's power usage, the readings from M2 must
be subtracted from the readings of M1. This can be accomplished by assigning M1 and an
apportioned meter of M2 with an allocation of -100%, removing M2's readings from Tenant 2's
power usage calculation.
The alternative is to create a virtual meter. For example, create a new virtual meter Tenant_2_
Net_Meter, and assign the two devices, M1 and M2 (-100%), to the virtual meter. The virtual
meter is assigned to Tenant 2's node. If at some time in the future a new meter is added, you
can edit the virtual meter to include the new meter.
The starting point for the aggregation in the Hierarchy is a device node. The Hierarchy will not
include measurements from nodes below the device node in the aggregation.
Example: Device nodes are the beginning of the aggregation.
Building [14kWh]
(aggregated)
Floor 1 [2kWh] (aggregated)
Device - 2kWh (measured)
Area 1 [7kWh] (aggregated)
By associating a device with the Floor 1 node, this node becomes the starting point for the
aggregation. The measurements of the child nodes Area 1 and Area 2 are ignored. Only the device
measurement associated with Floor 1 is included in the aggregation.
NOTE: Not all Hierarchy nodes can have devices associated with them. If devices can be
associated with a certain node level in a hierarchy or not, is defined in the template for this
hierarchy.
• Dashboards
• Reports
• Trends
In the Dashboards application, you can use hierarchies in the gadget data series selector to select
data from a source based on its location in the hierarchy. Selecting a hierarchy View allows you to
group device data at different aggregation points in the hierarchy. For example, it is possible to
create a dashboard that depicts the energy usage of a single floor in a building as a single data
series even though there are multiple meters monitoring different circuits.
You can also use hierarchies in several of the reports available in the Reports application. You can
use the source selector for these reports to select items from the hierarchy to include in the report.
As in the Dashboards application, a hierarchy View groups device data at different aggregation
points, which are then displayed in a report. In addition to the default reports, hierarchies can also be
used in custom reports that have been created for use in different solutions.
You can use hierarchies in the Trends application to select data from a source based on its location
in the hierarchy.
Log Viewer
TIP: You can open Log Viewer from the SETTINGS > System > System Log page in Web
Applications.
Use Log Viewer to view PME system events. System events are logged by the software and its
components to record certain system activities. Examples of system events include a user logging
on, a user logging off, time synchronization sent from the system to the devices, system warnings,
and so on.
NOTE: The Log Viewer only shows system events, it does not show device-based events or
historical data.
Filter log entries in the system log table view based on the area of the software where they
4 originated.
The available options are: All, Application (= web application components), System (=
platform components).
Category Filter.
Filter log entries in the system log table view based on the component or function they relate
5 to.
The large number of different category options is available for this filter.
TIP: Selecting the Audit category shows user login and logoff activity.
Location Filter.
6 Enter a filter string into the text box to filter the system log table view based on the Location
column information.
Message Filter.
7 Enter a filter string into the text box to filter the system log table view based on the Message
column information.
Details Filter.
8 Enter a filter string into the text box to filter the system log table view based on the Details
column information.
Column Selector.
9
Select which columns are displayed in the system log table.
Refresh.
10
Reload the content of the system log table.
Copy Selection to Clipboard.
Copy the content of selected system log table entries to the clipboard, for use in another
application. Information for all possible columns is included in the copied details, regardless
11
if the columns are displayed in the table view or not.
TIP: Use Shift + click or Ctrl + click to select multiple rows in the table.
Export
Export the content of selected system log table entries in .csv file format, for use in another
12 application. Information for all possible columns is included in the copied details, regardless
if the columns are displayed in the table view or not.
TIP: Use Shift + click or Ctrl + click to select multiple rows in the table.
Search Logs
13 Enter a filter string into the text box to filter the system log table view based on the Details
column information.
System log table
The System log table shows system events for the selected time range and filter settings.
See 1-8 above.
14
TIP: Double-click a row in the table or select a row and hit Enter to view details for this log
entry.
1. Run the Create Model report with an initial set of parameters and analyze the results. Select
No for the Save Model Configuration input parameter.
TIP: Consider choosing a reporting period with normal consumption behavior to create your
model. For example, a good period could be "Last Year".
3. Re-run the Create Model report using sub-models, exception periods, and modified input
parameters and analyze the results.
4. Repeat steps 2 and 3 until you are satisfied with the accuracy of the model.
5. Run the Create Model report one more time, select Yes for the Save Model Configuration
and enter a meaningful model name. This saves your model to the database.
6. Run the Use Model report with the model you created. Ensure that the sub-models and
exception periods are correctly defined for the reporting period.
7. (Optional) Setup a subscription to run the Use Model report on a regular basis. Select Yes for
the Insert Date input parameter. This saves the model output data to the database. You can
use this data in the Trends and Dashboards applications.
Defining a sub-model
Sub-models are used to improve the accuracy of the overall model by recognizing time intervals or
operating conditions with different consumption characteristics. For example, using a sub-model
that differentiates between weekdays and weekend days can be more accurate for processes that
are influenced by a workweek pattern, than using a single model for all days. Which sub-model
works best depends on the nature of the facility or process.
Sub-models are defined with the Modeling Configuration tool in the Settings > System >
Modeling area of the Web Applications. Use one of the pre-defined sub-models or create your own.
To define a sub-model:
2. Click Insert in the top right corner of the window to switch to insert mode.
3. Enter a Sub-Model Name, select a Minimum Aggregation Interval, and enter a Desired
Label, and Condition in the input boxes at the top of the main display grid.
4. Click Insert to the right of the input boxes to insert the new sub-model definition. The
definition is moved to the bottom of the main display grid, below any pre-existing sub-model
definitions.
5. Click Search in the top right corner of the window to switch back to search mode.
6. (Optional) To edit an existing definition, click Edit to the right of the definition in the display
grid, or click any of the fields of the definition in the grid. To update the definition, after editing
it, click Update , to cancel click Cancel . To delete a sub-model definition, click Delete
.
You can either choose to model these exception periods separately, which means they will become
a sub-model, or you can choose to exclude them from the model completely.
Exception periods override sub-model definitions if they cover the same time period. For example,
you could define a holiday, a day your facility was in shutdown, or a day when you performed
system tests, as an exception period. If that day was a weekend day and you are using a sub-model
to differentiate between weekdays and weekend days, then the exception period overrides the sub-
model, which means that special day will be modeled differently than a regular weekend day.
Exception periods are defined with the Modeling Configuration tool in the Settings > System >
Modeling area of the Web Applications.
To define exception periods:
2. Click Insert in the top right corner of the window to switch to insert mode.
3. Enter an Exception Period Name, select a Source and Measurement, enter a Desired
Label, and Condition in the input boxes at the top of the main display grid.
NOTE: The Desired Label is used to control if the exception period is excluded from the
model, or if it is treated as a sub-model. Enter the text Delete as Desired Label if you want to
exclude that period from the model. Enter any other text, for example a descriptive text such
as Holiday, if you want to sub-model the exception period. An excluded exception period will
be blank in the final model output graphic.
4. Click Insert to the right of the input boxes to insert the new exception period definition. The
definition is moved to the bottom of the main display grid, below any pre-existing exception
period definitions.
5. Click Search in the top right corner of the window to switch back to search mode.
6. (Optional) To edit an existing definition, click Edit to the right of the definition in the display
grid, or click any of the fields of the definition in the grid. To update the definition, after editing
it, click Update , to cancel click Cancel . To delete an exception definition, click Delete
.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a separate
license.
Summary
The Create Model Report is used to create a model of your facility or process. The model is then
used in the Use Model Report to compare expected consumption to actual consumption. You only
use the Create Model Report during configuration. After you created the model, you do not need to
run this report again, unless you want to create a new model.
Details
Prerequisites
To use this report, the data for the independent variables and for the dependent variable must be
available in the Power Monitoring Expert database for the reporting period. If you want to use sub-
models and exception periods, then these must be defined.
Report inputs:
Title
The dependent variable is the measurement you want to model. For example, if you are modeling
the energy consumption of a building based on outside temperature, then the energy is the
dependent variable.
1. Click Select Source and select a device from the Devices list or a Hierarchy node from the
Views list.
3. Select an aggregation method for the measurement from the Aggregation Method drop down
list.
NOTE: If you are using a Hierarchy node as a source for the dependent variable and you are using
a cumulative measurement, such as Real Energy (kWh), you must use SUM as aggregation
method. This is because the hierarchy converts the cumulative measurement into interval
measurements.
Independent Variable(s)
The independent variable is the driver that influences the measurement you want to model. For
example, if you are modeling the energy consumption of a building based on outside temperature,
then the outside temperature is the independent variable. You can specify one or more independent
variables.
1. Click Select Source and select a source from the list. Hierarchies are not supported for
independent variables.
3. Select an aggregation method for the measurement from the Aggregation Method drop down
list.
For CDD or HDD, enter the base temperature in the Degree Days Base Temperature input
box that is displayed when one of these options is selected.
To add additional variables, click the + sign next to the Select Source button. Click - to remove a
variable. To enable or disable a variable, select or clear the check box next to the Select Source
button.
Reporting Period
Use this input to select the timeframe for the data you want to view in the report.
Select the reporting period from the dropdown list. The timeframe options in the timeframe dropdown
are relative to the date the report is run. To run a report that starts and ends in the past, select the
fixed date option. Type a start and end date in the date boxes or click the arrows beside the dates to
display a pop-up calendar and select a date. Type a time in the time boxes or click the up and down
arrows beside the time to adjust the hours or minutes up or down.
Select the sub model from the Sub Model drop-down list. The options in this drop-down list depend
on the selected Interval and the sub models that have been defined in Settings > System >
Modeling.
The Database Driven option is used to define operating conditions instead of time periods for sub-
modeling. For example, you could define the condition of Power Factor < 0.8. That means that one
sub-model is used when the Power Factor is < 0.8 and a different one when it is >= 0.8. This is
similar to sub-modeling based on weekdays versus weekend days, just that the Power Factor value
is used as a condition instead of the day of the week.
When you select Database Driven, additional input boxes are displayed to select the Source,
Measurement, Key, and Value. The Key is the condition, for example for Power Factory < 0.8,
enter <0.8 in the Key input box. The Value box is just a label to identify the condition, so you could
enter Low PF for low Power Factor.
You can add one or more conditions. Click the + icon to add additional conditions.
NOTE: Conditions are applied in the order in which they are defined in the report.
Use Exception Periods
Choose to use exception periods or not by selecting Yes or No for Use Exception Periods.
Show Detailed Results
Choose to include details in the report or not by selecting Yes or No for Show Detailed Results.
Details include the calculated formulas and individual relationship between each driver and the sub
model data.
Save Model Configuration
Choose to save the created model to the database or not by selecting Yes or No for Safe Model
Configuration.
For saving the model, enter the model name in the Model Name input box that is displayed when
Yes is selected for Safe Model Configuration.
Example:
See Model creation example
To calculate the models, PME uses the Accord Framework Library which can be found at:
http://accord-framework.net/index.html.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a separate
license.
Summary
The Use Model Report shows the expected consumption of your facility or process, based on a
model created with the Create Model Report. The report shows modeled data, the measured data,
and the delta between the two. Use this report to find unexpected changes in your consumption, or
to find actual savings as a result of energy management measures.
NOTE: The report is not limited to energy consumption modeling. You can use it to model any
quantity that is dependent on drivers, for example you can model Power Factor based on power
demand.
Prerequisites
To use this report, at least one model must have been defined for your facility or process. The data
for the independent variables must be available in the Power Monitoring Expert database for the
reporting period.
Report inputs:
Title
Select the model you want to use for the report from the Model drop-down list.
Select the aggregation interval you want to use for the report from the Reporting Aggregation
Interval drop-down list. The options available in this drop-down list depend on the selected model.
Display Mode
Select in which form you would like to see the report output from the Display Mode drop-down list.
Forecast: Compare the model output for the reporting period to the actually measured data for that
period, where the model was created for a baseline period in the past.
Backcast: Compare the model output for a past period to the actually measured data for that
period, where the model was created for the reporting period in the present time.
Reporting Period
Use this input to select the timeframe for the data you want to view in the report.
Select the reporting period from the dropdown list. The timeframe options in the timeframe dropdown
are relative to the date the report is run. To run a report that starts and ends in the past, select the
fixed date option. Type a start and end date in the date boxes or click the arrows beside the dates to
display a pop-up calendar and select a date. Type a time in the time boxes or click the up and down
arrows beside the time to adjust the hours or minutes up or down.
Choose to include the actual data with the modeled data or not by selecting Yes or No for Include
Measured Data.
Enter an optional coefficient in % to be applied on the modeled data
(Optional) Enter coefficients that are applied to the modeled data to adjust the model output based
on known or expected changes.
For example, if you implemented an energy conservation measure on June 1, 2016 for which you
are expecting an energy saving of 15%, enter -15 as a coefficient and June 1, 2016 as the start date
from which to apply it on. All modeled data, starting with that date, will be adjusted by -15%. You
can add multiple coefficients at multiple dates. Coefficients are applied cumulatively, on top of any
previously applied coefficients.
To specify a coefficient,
1. Enter the coefficient value in percent, including the sign, in the text box.
2. Enter the date on which this coefficient takes effect into the date box.
To add additional coefficients, click the + sign next to the coefficient text box. Click - to remove a
coefficient.
Insert Data
You can save the output of the model report into the Power Monitoring Expert database and use it
for display in Dashboards and Trends. The source name created for this data in the database is
Modeled_Data.<model name>. The following measurements will be recorded for this source:
To save the data into the database, select Yes for Insert Data.
TIP: Setup a subscription to run the model report weekly for the last 7 days and save the output
into the database. This will ensure you have a complete data set for modeled data for use in
Dashboards and Trends.
Example:
TIP: Move your pointer over the chart line to see tooltips with measurement details.
NOTE: This example only shows selected content from the report, it does not show the entire
report.
To calculate the models, PME uses the Accord Framework Library which can be found at:
http://accord-framework.net/index.html
In this example we use the report to model the HVAC related electrical energy consumption of a
building. Our goal is to create a daily model for energy consumption based on outside temperature
and humidity. We use consumption data for the year 2017 to create the model.
For the first run we choose an interval of Week, only to see if there is a strong relationship between
consumption and the independent variables. Later we change this to Day to get a Daily Model.
Results:
TIP: Move your pointer over the chart line to see tooltips with measurement details.
The model accuracy, measured by the R² value, is pretty high, which show that the model is a good
match for the correlation between the energy consumption and the outside temperature as well as
humidity.
Results:
The R² has dropped and the visual correlation is not very high. The charts show that there is a big
difference in consumption between weekdays and weekends. This difference cannot be explained
by outside temperature or humidity alone. For the next run we use sub-models for weekdays and
weekends.
Results:
The R² has much improved. There is a good correlation between outside temperature and humidity
and consumption. There are still a few days with a large negative residual value. Upon closer
inspection we find that most of these days are holidays. For the next run we use exception periods
to account for the holidays.
Results:
We have again improved the model. In our example, the building is cooled electrically, which means
the greatest impact of outside temperature on energy consumption is during the cooling season. To
account for that, we change the Aggregation Method for outside temperature to Cooling Degree
Days (CDD) for the next run.
Results:
We now have a pretty accurate model of our energy consumption based on outside temperature and
humidity.
Select Yes for Show Detailed Results in the Report Inputs to include information on the modeling
formulas and the relationship between the drivers and the sub model data. The following are
selected examples of the type of details you can get.
Statistical information:
Weekday sub-model data driven by outside temperature with influence of humidity removed vs
measured data:
Next Step:
Run the Create Model report one last time with the Save Model Configuration parameter set to
Yes. This saves the model into the database and makes it available for use with the Use Model
Report.
User Manager
TIP: You can open User Manager from SETTINGS > Users > User Manager in the Web
Applications banner. You can also open User Manager from Management Console > Tools >
Web Tools > User Manager.
NOTE: You must have supervisor-level access to use User Manager, otherwise the link on the
SETTINGS page is not available.
PME does not provide any pre-configured user accounts or user groups. One supervisor account is
created with a user defined password during the installation of the software. Create user accounts
and groups to meet your needs.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices when configuring user access.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access – such as least privilege and
separation of duties – vary from site to site. Work with the facility IT System Administrator to ensure
that user access adheres to the site-specific cyber security policies.
RECOMMENDATION: Use Windows users instead of standard users in your PME system to
improve cybersecurity. Windows offers advanced user management functions, such as enforcing
password strength and limiting the number of invalid login attempts. These functions are required
for IEC 62443 compliance, the global standard for industrial automation control system security.
NOTE: To only use Windows users, replace any existing standard users in the system with
Windows users. Disallow logins for standard users in Web Applications, this disables the
supervisor user.
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
Users
A user is an account in Power Monitoring Expert (PME) that provides access to the system. A user
has a username, which must be unique, and a password. You use the username and password to
log into PME.
PME supports 3 different types of users - standard users, Windows users, and Windows groups.
The following table shows the characteristics of each user type:
Each user has an access level, which is set in User Manager. The access level determines which
actions the user is allowed to take in PME.
There are 5 different access levels. The highest level is Supervisor, the lowest level is Observer.
All Windows users that are a member of a Windows group in PME have the same access level as
the one set for the Windows group. For details on the permissions granted by the different access
levels see Default User Access Level Privileges.
Each user is a member of at least one user group. The user group determines which sources and
applications the user can access. By default, users are assigned to the Global user group which has
access to all sources and applications in the system. See user groups for details on how to
configure groups and assign users to groups.
Rules
The following rule applies to users in PME:
• A Windows user that is a member of multiple Windows groups with different access levels in
PME, gets the highest access level of any of the groups.
Example:
Windows user BillG is a member of Windows group A with observer access level in PME.
Windows user BillG is also a member of Windows group B with operator access level in PME.
As a result, BillG has operator access level in PME.
Limitations
The following limitations exist for standard PME users:
• Usernames cannot contain any of the following characters: whitespace character, < > : " / \ | ? *
, ; @ # % ' ^ & ( ) ! = + - ~ . $
• Email addresses are not checked for the correct format. Any leading or trailing whitespace
characters are removed.
• First name, last name, and organization must be between 0-50 characters long. Any leading or
trailing whitespace characters are removed.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices when configuring user access.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access – such as least privilege and
separation of duties – vary from site to site. Work with the facility IT System Administrator to ensure
that user access adheres to the site-specific cyber security policies.
RECOMMENDATION: Use Windows users instead of standard users in your PME system to
improve cybersecurity. Windows offers advanced user management functions, such as enforcing
password strength and limiting the number of invalid login attempts. These functions are required
for IEC 62443 compliance, the global standard for industrial automation control system security.
1. In User Manager, select the Users tab, and then click Add Standard User.
2. In Add Standard User, enter a username and password, and assign an access level.
4. Click Add.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices when configuring user access.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access – such as least privilege and
separation of duties – vary from site to site. Work with the facility IT System Administrator to ensure
that user access adheres to the site-specific cyber security policies.
1. In User Manager, select the Users tab, and then click Add Windows User
Use a Windows domain name to add a user from an Active Directory. Use the local
computer name or use localhost to add a user from the local list of Windows users.
b. To find the Windows user you want, (optional) enter a keyword into the Available
Windows Users search box, and then click Find.
The search result includes all usernames that match all or part of the keyword string.
c. In the search result table, select the Windows user you want to add, and then click Next.
3. In Add Windows User - Details, assign an access level, and then click Finish.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices when configuring user access.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access – such as least privilege and
separation of duties – vary from site to site. Work with the facility IT System Administrator to ensure
that user access adheres to the site-specific cyber security policies.
1. In User Manager, select the Users tab, and then click Add Windows Group
Use a Windows domain name to add a group from an Active Directory. Use the local
computer name or use localhost to add a group from the local list of Windows groups.
b. To find the Windows group you want, (optional) enter a keyword into the Available
Windows Groups search box, and then click Find.
The search result includes all groups that match all or part of the keyword string.
c. In the search result table, select the Window group you want to add, and then click Next.
(Optional) Click on View Windows Users in this Windows Group to see the Windows
users that are members of the group.
4. Click Finish.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
Changing a username
Change a username to give the user a better or more meaningful name.
NOTE: You can only change the name of a standard user in User Manager. You cannot change the
name of a Windows user or group.
To change a username:
2. In the users table, select the row of the user for which you want to change the name, and then
click Edit in this row.
3. In Edit Standard User, change the name under Username to the new name, and then click
Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
NOTE: You can only change the password for a standard user in User Manager. You cannot
change the password for a Windows user.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices for password creation and management.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access - such as least privilege, separation of
duties - vary from site to site. Work with the facility IT System Administrator to ensure that user
access adheres to the site-specific cybersecurity policies.
To change a user password:
2. In the users table, select the row of the user for which you want to change the password, and
then click Edit in this row.
3. In Edit Standard User, enter the new password under Password and under Confirm
Password, and then click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices when configuring user access.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Cybersecurity policies that govern user accounts and access – such as least privilege and
separation of duties – vary from site to site. Work with the facility IT System Administrator to ensure
that user access adheres to the site-specific cyber security policies.
NOTE: When a user access level is changed, this change will be applied automatically by the
system to logged in users, after a short period of time.
2. In the users table, select the row of the user for which you want to change the access level,
and then click Edit in this row.
3. In the Edit window, choose the new access level under Access Level, and then click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
NOTE: You can only change the details of a standard user in User Manager. You cannot change
the details of a Windows user or group.
2. In the users table, select the row of the user for which you want to change the details, and then
click Edit in this row.
3. In Edit Standard User, change the details information under Details, and then click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
Deleting a user
Delete a user if this user is no longer needed, for example if someone no longer needs access to
PME.
NOTE: Windows users or groups are only removed from PME. The group or user is not deleted
from Windows.
NOTE: When a user is deleted, this user will be logged out automatically by the system after a
short period of time, if they are logged in.
To delete a user:
2. In the users table, select the row of the user you want to delete, and then click Delete in this
row.
3. In the confirmation dialog box, click Delete for a standard user, or Remove for a Windows
user or group.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
User Groups
User groups determine which sources and applications users can access in Power Monitoring
Expert (PME). Each user is a member of at least one user group.
PME has two built-in groups, the Global group and the Unassigned group. Members of the Global
group can access all sources and applications in the system. Members of the Unassigned group
can access none of the sources and applications in the system. Members of the Unassigned group
are also not allowed to log into PME Web Applications.
In addition to the built-in groups, you can create any number of custom user groups in PME. Use
User Manager to create a custom group and define which sources and applications its members can
access.
NOTE: User group membership determines which sources and applications are visible to a user.
User groups do not set the user access level for the group members. Access levels are set for
each user individually as part of the user account settings.
The user group feature only applies to the Dashboards, Diagrams, Trends, Alarms, and Reports
applications in PME. For all other applications users have full access to all sources regardless of
their group membership.
Rules
The following rules apply to group membership in PME:
• If a member of the Global group is added to another group, it is automatically removed from the
Global group.
• If a user is removed from the Global group without being added to a custom group, it is
automatically added to the Unassigned group.
• If a user is removed from its last custom group, or this group is deleted, the user is
automatically added to the Unassigned group.
• If a member of a custom group is added to the Global group, it is automatically removed from all
custom groups.
• If the last custom group is deleted, all of its members are moved to the Global group.
• A user that is a member of multiple groups can access the sources of each group.
• If a member of a custom group is deleted or removed from the group, then this user's public
content, such as dashboards or reports, remains available to the group.
• If a member of a custom group is deleted or removed from the group, then this user's private
content, such as dashboards or reports, is only available to users in that group who have Edit
permissions on this item type.
• If a member of a custom group is removed from the group, then this user has no longer access
to any of its content, such as dashboards or reports, that was created during its group
membership.
Limitations
The following limitations exist for user groups in PME:
• The default settings for which sources and applications can be accessed in the Global and
Unassigned user groups cannot be changed.
• User group names must be between 1-255 characters long. Any leading or trailing whitespace
characters are removed.
• If a user group name contains a ] (left angle bracket), the bracket must be followed by a space
or be at the end of the name.
• If a user group name contains a & (ampersand), the ampersand must not be followed by a #
(hash).
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
1. In User Manager, select the User Groups tab, and then click Add User Group.
2. In Add User Group - User Group Name, enter a group name, and then click Next.
3. In Add User Group - Users, select the users you want to be in the new group form the list of
available users, and then click Next.
NOTE: Supervisor-level users are not included in the available users list. A supervisor-level
user can only be a member of the Global group, not a custom group.
4. In Add User Group - Sources, in the Available Sources tree, select the sources you want the
users in this group to be able to access, and then click Next.
5. In Add User Group - Applications, select the applications you want the users in this group to
be able to access.
6. Click Finish.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group to which you want to add users, and
then click Edit in this row.
3. In Edit User Group, select the Users tab, and then, in the user table, select the user you want
to add.
NOTE: Supervisor-level users are not included in the available users list. A supervisor-level
user can only be a member of the Global group, not a custom group.
4. Click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group to which you want to add sources,
and then click Edit in this row.
3. In Edit User Group, select the Sources tab, and then, in the Available Sources tree, select
the sources you want to add.
4. Click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group for which you want to change the
name, and then click Edit in this row.
3. In Edit User Group, select the User Group Name tab, and then change the name under
Name to the new group name.
4. Click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group from which you want to remove a
user, and then click Edit in this row.
3. In Edit User Group, select the Users tab, and then, in the user table, clear the check box for
the user you want to remove.
4. Click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group from which you want to remove
sources, and then click Edit in this row.
4. In the Selected Sources list, select the source you want to remove, and then click Remove
5. Repeat step 4 for all the sources you want to remove from the user group.
(Optional) Click Remove All to remove all sources from the group.
6. Click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group for which you want to change
application access, and then click Edit in this row.
3. In Edit User Group, select the Applications tab, and then select the check boxes for the
applications you want to add, or clear the check boxes for the applications you want to
remove.
4. Click Save.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
To move a user between two user groups, remove the user from the one group and add it to the other
group. The order in which these two tasks are performed is not important.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
2. In the user groups table, select the row of the user group you want to delete, and then click
Delete in this row.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
NOTE: The license information shown in the User Manager is read-only. Use the License
Configuration Tool to make changes to the Web Application user licenses in the system.
2. View license summary information in the top left area of the page. View detailed license
information in the user license table of the page.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
NOTE: When access level privileges are changed for a logged in user, the user must log out and
then log in again for the changes to take effect. If the logged in user's privileges are reduced, some
functionality might no longer be available to them even before they log out and back in.
2. Find the privileges and access levels you want to customize and set the desired options.
TIP: Use Search to find the privilege you are looking for based on key words.
NOTE: Only correctly licensed features and functions are displayed in the Privileges tab.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
• User Manager
User Groups UI
Licenses UI
Privileges UI
NOTE: Access to the web applications is controlled through user group settings. If a user group
does not have access to a web application, then the group members cannot access this
application regardless of their user access permissions.
The following table shows the system default privileges assigned to the different access levels:
Yes Dashboards Access the application Yes Yes Yes Yes Yes
Yes Dashboards View slideshow list Yes Yes Yes Yes Yes
Yes Diagrams Access the application Yes Yes Yes Yes Yes
Yes Diagrams (Standalone) Access the application Yes Yes Yes Yes Yes
Generator Performance
Yes Access the tool No No No Yes Yes
Configuration Tool
Insulation Monitoring
Yes Access the tool No No No Yes Yes
Configuration Tool
Yes Logical Device Type Editor Access the tool No No No Yes Yes
Yes Management Console Access the application No Yes Yes Yes Yes
Connect/disconnect sites
Yes Management Console No No Yes Yes Yes
and devices
Yes Personal Preferences Access the settings No Yes Yes Yes Yes
Yes Reports Access the application Yes Yes Yes Yes Yes
Manage report
Yes Reports No Yes Yes Yes Yes
subscriptions
Yes Time of Use Editor Access the tool No No Yes Yes Yes
Yes Trends Access the application Yes Yes Yes Yes Yes
By default, the localization settings in Personal Preferences are the same as the ones in System
Language. Changes to the settings in System Language are automatically copied to the Personal
Preferences settings as long as the Personal Preferences settings have never been customized.
After you customized the Personal Preferences localization settings once, they will no longer
change when the System Language settings are changed.
NOTE: Your personal localization settings overrule the system localization settings for your user
account.
Example 1: Language settings in Personal Preferences follow System Language if they have never
been customized.
Example 2: Personal Preferences remain at customized setting after having been customized at
some point.
Default links:
NOTICE
INOPERABLE DATABASE
Back up the database before executing SQL scripts.
Failure to follow these instructions can result in an inoperable database and loss of data.
NOTE: You can also copy and paste the example script below into SSMS.
4. Update the script settings, in the marked areas in the script, to meet your needs.
NOTE: The order value determines the order in which the links are arranged in the web page
banner. The order numbers increase from left to right. The numbers for the default links are:
Dashboards (10), Diagrams (20), Trends (30), Alarms (40), Reports (50). The location of the
SETTINGS link is not controlled by the order value. It is always in the right most position.
TIP: You can execute this query repeatedly to change any of the settings for the custom link.
6. Close SSMS.
Example script to create a MY CUSTOM LINK link between the REPORTS and SETTINGS links in
the Web Applications banner that opens a custom web page:
USE ApplicationModules
DECLARE @id NVARCHAR(255)
DECLARE @name NVARCHAR(255)
DECLARE @displayName NVARCHAR(255)
DECLARE @description NVARCHAR(255)
DECLARE @order NVARCHAR(100)
DECLARE @target NVARCHAR(400)
----------------------------------------------------------------------
-- Edit the following values to define your custom settings
----------------------------------------------------------------------
-- Custom application link (internal) name.
SET @id = 'MyCustomLink'
-- Custom application link description
SET @description = 'My custom link shows my custom content'
-- Display Name
set @displayName = 'My Custom Link'
-- Custom application link order. Less than 10 will bring new link to
-- first left position.
SET @order = 60
-- Target URL can be provided in single quote here,
-- e.g. 'https://www.mypage.com'
-- If on the same machine, should be the relative path.
-- e.g., '/myApp/index.html'
SET @target = 'https://www.mypage.com'
----------------------------------------------------------------------
-- DO NOT MODIFY CONTENT BELOW
----------------------------------------------------------------------
DECLARE @configurationValue NVARCHAR(MAX)
SET @configurationValue =
'<FrameworkApplication id="' + @id + '"'
+ ' displayName="' + @displayName + '"'
+ ' description="' + @description + '"'
+ ' resourceSet="ApplicationFrameworkResources"'
+ ' target="' + @target + '"'
+ ' privilege=""'
+ ' order="' + @order + '"'
+ ' enabled="true"'
+ ' xmlns="uri:application-modules/power/framework/application#" />'
EXECUTE [ApplicationModules].[Configuration].[WriteConfigurationValue]
'ApplicationFramework'
,'Applications'
,@id
,@description
,@configurationValue
,NULL
,0
3. Execute the query on the ApplicationModules database. This returns the settings for the Web
Applications links.
4. Copy the content of the Value column for the link you want to hide or unhide, into a text editing
tool such as Notepad. For example:
<FrameworkApplication id="MyCustomLink" displayName="My Custom
Link" description="My custom link shows my custom content"
resourceSet="ApplicationFrameworkResources"
target="https://www.mypage.com" privilege="" order="60"
enabled="true" xmlns="uri:application-
modules/power/framework/application#" />
5. Change the enabled property value to "false" in the text editor to hide a link, or to "true" if to
unhide a link
To re-order links:
3. Execute the query on the ApplicationModules database. This returns the settings for the Web
Applications links.
4. Copy the content of the Value column for the link you want to reorder, into a text editing tool
such as Notepad. For example:
<FrameworkApplication id="MyCustomLink" displayName="My Custom
Link" description="My custom link shows my custom content"
resourceSet="ApplicationFrameworkResources"
target="https://www.mypage.com" privilege="" order="60"
enabled="true" xmlns="uri:application-
modules/power/framework/application#" />
5. Change the order property value to a new value in the text editor.
NOTE: The order value determines the order in which the links are arranged in the web page
banner. The order numbers increase from left to right. The numbers for the default links are:
Dashboards (10), Diagrams (20), Trends (30), Alarms (40), Reports (50). The location of the
SETTINGS link is not controlled by the order value. It is always in the right most position.
To delete a link:
4. Execute the query on the ApplicationModules database. This deletes the Web Applications
link.
6. Close SSMS.
User authentication
PME Web applications require user authentication to launch. There are multiple methods to access
a PME Web application from inside another EcoStruxure supervisor software:
• Manual PME Authentication: The user must enter PME user credentials into a login window
before a PME Web application can launch. These credentials are then cached for the rest of the
PME session.
• Automatic PME Authentication: (less secure) Specific URL addresses are created for the
target PME web application. When one of these PME URLs is used to launch a PME Web
application from another supervisory software, PME automatically allows access without
prompting the user to enter PME credentials. This method provides a seamless user
experience, but it does not provide the security level of the Manual Authentication method. For
security reasons, supervisor-level user names cannot be used.
• Windows Authentication: (more secure) Logs the user into PME using their current Windows
credentials. This method provides a seamless user experience and is more secure.
NOTE: The Windows Authentication option is more secure but requires that Power Monitoring
Expert has been configured with Windows Active Directory users and user groups.
When testing the generated authentication URL, test the URL in a separate browser session, not
just in a separate tab in the current browser. Otherwise, your current login credentials may be used,
or you may be logged out of this page altogether.
To open a new browser session in Internet Explorer, open the File menu and select New Session. If
you are using Chrome, open a new incognito window.
1. Log on to WorkStation
3. Click Domains
4. Click Add
6. In the Authentication window, type the Active Directory Windows domain name (for example,
Example.org). Click Next.
9. Click Create
To add the Active Directory user groups to the Building Operation Domain:
7. Select the AD user group from the list and click OK.
8. Click Create.
2. Open WorkStation and enter your Windows credentials or select to log on as the currently
signed-in Windows account. Click Log on.
+33 (0) 1 41 29 70 00
www.se.com
7EN02-0464-00 05/2021