PME System Guide 2024
PME System Guide 2024
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™ Power Monitoring Expert 2024 System Guide
Contents
Safety Information 3
Safety Precautions 21
Overview 22
About this document 22
Document updates 22
Document revisions 22
Document organization and content 23
How to use this document 23
What's new in Power Monitoring Expert 2024 24
Highlights of this release 24
Details of this release 24
Resources 28
Cybersecurity 31
Cybersecurity awareness 31
Cybersecurity features 31
Recommended actions 32
Plan 35
Planning checklist 36
System architecture 37
Client types 39
Engineering Client 39
Web Client 39
IT Requirements 41
Computer Hardware 42
Operating Environment 50
Network connectivity 54
Other IT considerations 55
System maintenance 56
Designing for maintenance 56
Database maintenance 57
System health review 67
Disaster recovery strategy 74
Identify disaster recovery objectives 74
IT architecture and resources plan 75
Backup plan 76
Recovery plan 82
Recommended consolidated disaster recovery strategy plan 83
Cybersecurity 84
Obtain security certificates 84
Obtain antivirus and application allowlisting software 84
Plan user access 84
Maintenance 1689
Disturbance Direction Indicators in TGML 1691
Overview 1691
Components 1692
Prerequisites 1692
Limitations 1693
Configuration 1693
Operation 1695
Indicator description 1698
Thermal Monitoring of Low Voltage (LV) Busways 1699
Overview 1699
Components 1700
Prerequisites 1701
Limitations 1701
Design 1701
Configuration 1702
Operation 1706
Maintenance 1708
Thermal Monitoring of Medium Voltage (MV) Substations 1710
Overview 1710
Components 1711
Prerequisites 1712
Limitations 1712
Design 1713
Configuration 1713
Operation 1717
Maintenance 1720
Reference 1721
Cybersecurity Reference 1722
Data encryption 1722
PME accounts 1722
PME Services 1723
Network shares 1723
Session timeout 1723
System integration security 1724
Verifying file integrity and authenticity 1724
Planning references 1726
Accessing the ION Database with 3rd-party applications 1727
Database growth calculations 1728
Default device type support 1730
IIS Application Pools 1736
Insulation Monitoring Design for ANSI 1737
IP Ports 1744
Licensing resources 1746
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
About this document
This guide is intended for Application Engineers, System Integrators, or other qualified personnel
who are responsible for designing, installing, configuring, maintaining, and using EcoStruxure™
Power Monitoring Expert (PME) software.
This document is not a tutorial, it was written with the assumption that you have been trained in
the deployment and use of PME.
This document does not discuss the planning, design, and operation of the electrical power
system that is being monitored.
Document updates
This document is available online through the Schneider Electric website. We may update the
online version over time to improve clarity and accuracy. If you see differences between your local
copy and the online version, use the online version as your reference. See Resources for contact
information.
Document revisions
Revision Number: Rev 00
MRP#: 7EN02-0500-00
Release Date: Oct 2024
Some tools, tasks, or functions are specific to a particular stage, others are part of different
stages. For example, deciding on which computer hardware to use, is done during the Planning
stage. Licensing, in contrast, has a Planning component, to purchase the correct licenses, and a
Configuring component, to activate the licenses on the system.
Reference is a resource chapter that contains detailed information. Use Reference information to
deepen your understanding of Power Monitoring Expert concepts, and to complete complex
procedures that might require additional information. The Reference section content is organized
to mirror the structure of the functional life-cycle stages.
You can also use the table of contents to navigate through the document, or use Find to search
for specific content.
• Implementation of Secure ION, secure EtherGate, and secure Modbus useful for connecting
to devices that support Secure ION and Modbus encryption communication. By utilizing this
capability, your installations will benefit from encrypted communications by Transport Layer
Security (TLS) implementation in Power Monitoring Expert 2024.
• EWS client 1.2 real time data support to monitor the data from EcoStruxure Building
Operation and smart connector applications.
• Power Monitoring Expert 2024 supports the definition of custom days that can be used to
aggregate data (daily, weekly, monthly and yearly) in reports, and dashboards.
• Three new Power Monitoring Expert Windows Services are included to help improve
performance.
• Strong password policy is implemented for PME standard users and is enforced when
password is created or modified for a PME standard user.
• Waveform analytics provides the information on the cause for voltage disturbance.
• Device replacement manager ensures there is no spike or dip in the dashboards and reports
when the device is replaced or the parameter overflow happens upon reaching the threshold
value.
• New Reports: Device Replacement report and IEC61000-2-4 report.
• Neutral Protection settings values added to the Circuit breaker setting report.
Web Applications
Item Details
You can now define a custom start of the day; based on
requirements or shifts. You can then use custom day in
Custom day update
dashboards and reports to aggregate data on a daily, weekly,
monthly and yearly basis.
Item Details
To help improve performance, three new services are included:
• ION Application Modules Core Service Host (x64 bit)
PME Windows Services
• ION Application Modules Data Service Host (x64 bit)
Graphic Editor Graphic Editor is integrated with EWS sources, Ethernet Devices,
VIP, logical devices, and so on. To bind TGML component,
double-click the respective device or source, and then double-click
Managers > Modules >Output Registers/Measurement
Names.
You can now view the TGML document in Diagrams > Graphic
TGML Viewer
Diagrams.
You can now set new passwords and edit existing passwords
using the strong password criteria.
• lowercase letters
• numbers
• special characters.
Item Details
Device Replacement Report
New reports
IEC61000-2-4 Report
IEEE 519-2022 Report
Bar Chart
Consumption Ranking
Energy Equivalency
Improved reports
Period over Period
Pie Chart
Table
Operating Environment
Item Details
PME supports SQL Server 2022 Standard/Enterprise/Business
New SQL Server version Intelligence.
support
SQL Server 2022 Express is included with PME 2024
For the complete list of supported operating systems and SQL Server versions, see the IT
Requirements chapter in this guide.
Devices
Item Details
The following device types are now supported in PME 2024:
• EVlink Pro AC (DL-E License)
• Galaxy V Series
• HDPM6000 Series
Updated device type
• Galaxy / Samsung Lithium-ion Battery Cabinet
support
• AccuSine PCS+/PFV+/PCSn/EVC+
• Bender Series
• Easergy P3
Performance
Item Details
Quality improvements PME 2024 includes a wide range of quality improvements.
Resources
The Resources page is a central reference for any resources that are referred to in this guide but
that are not included in the guide.
Download Center
NOTE: The EcoStruxure™ Power Monitoring Expert System Guide includes the content of the
following guides: What's New Guide, IT Guide, Web Applications Guide, and the Insulation
Monitoring User Guide.
The following EcoStruxure™ Power Monitoring Expert 2024 documents are available on the
Schneider Electric Download Center:
• System Guide (English) – Document number 7EN02-0485
NOTE: On the Exchange you can find discussion forums, key content, service providers, and
knowledge base articles. You can also sign-up to become a service provider. To gain access to
the Exchange and its content, register at https://exchange.se.com/.
EWS Specification
Application Notes
Drivers
Help Files
Upgrade Map
PME Scripts
EcoStruxure Power Digital Applications for Large Buildings & Critical Facilities - Design
Guide for North America
How Do I Extend the DDD Indicators Application to Support More Than 30 Devices
• Device Drivers
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)
Other
• Schneider Electric Cybersecurity Support Portal
Technical Support
• Schneider Electric Support (Support)
• mySchneider app
24/7 support. Mobile catalog. Access to expert help.
• Offline Licensing Support
Offline license activation, return, and refresh
External Resources
The following are resources that are referenced in different sections of this guide; they provide
additional information and downloadable components.
• How to determine which versions and service pack levels of the Microsoft .NET Framework
are installed
Cybersecurity
This section includes information on how to help secure your system.
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.
Cybersecurity awareness
Knowledge is first step to prevent cyber intrusions. Review the following resources to increase
your cybersecurity awareness:
• Securing Power Monitoring and Control Systems (Schneider Electric White Paper on se.com)
To find out about the latest cybersecurity news, sign up for security notifications, or to report a
vulnerability, visit the Schneider Electric Cybersecurity Support Portal.
Cybersecurity features
PME includes features that help to secure your system, including:
• Data encryption using SHA-512 and AES-256 cryptography (At Rest) and TLS 1.2 / HTTPS
(In Transit)
• Compatibility with antivirus and allowlisting software
For more information on these and other features, see Recommended actions.
NOTE: PME 2024 complies with the requirements of the security relevant standards for Security
Level 1 (SL 1) according to IEC 62443-4-1 and IEC 62443-4-2.
Recommended actions
PME is designed for a defense in depth security strategy, in compliance with IEC 62443, the
global standard for industrial automation control system security. A defense in depth strategy is a
multi-layered approach to cybersecurity with intentional redundancies to increase the security of a
system as a whole.
The different defense in depth layers can be described as:
• Data Layer (includes access control and encryption of data)
• Policies
To help secure your system, you must take specific actions for the different layers and at every
stage of the project life-cycle. The following shows the actions we recommend to help secure your
system, organized by life-cycle stage:
NOTE: The list of recommended actions below is not a complete list of possible cybersecurity
measures. It is meant to be a starting point to improve the security of your system. Consult with
cybersecurity experts to plan, install, configure, administer, and decommission your system
based on your needs.
Plan
Use the information provided in this chapter to prepare for an installation or upgrade of a Power
Monitoring Expert (PME) system.
Use the links in the following table to find the content you are looking for:
Topic Content
This is a planning tool to remind you of the different decisions that
Planning checklist have be made and actions that have to be taken during the
planning process.
Discusses where the system software and the database server
System architecture
can be installed.
Client types Introduces the different PME software client types.
Provides information on information technology components, such
IT Requirements
as computer hardware, operating environment, and networking.
Provides information on database maintenance and
System maintenance
recommended actions.
Provides information on disaster recovery and recommended
Disaster recovery strategy
strategy.
Cybersecurity Provides recommended actions to help secure your system.
Licensing Provides information on software licensing for PME systems.
System installation and Lists considerations related to new system installs and system
upgrades upgrades.
Provides an overview of the features and modules available in the
Feature selection and
software. It introduces the different functions, applications and
design
modules and discusses dependencies and design considerations.
Provides information on the communication links between the
Device Networks
software and the monitoring devices.
Provides information on the different approaches and
System Integration
technologies for integrating PME with other systems.
Provides information on the time, effort, and expertise that is
Deployment considerations
required to deploy a PME system.
Links to reference information related to the content of the
Planning references
Planning chapter.
Planning checklist
The following checklist has an entry for each of the sections in the planning chapter of this guide.
Use the list as a planning tool to remind you of the different decisions that have be made and
actions that have to be taken during the planning process.
System architecture
PME is a client-server, on-premise software application that collects power monitoring data
through a network of connected devices. The power monitoring data is processed and stored
using Microsoft SQL Server and can be accessed by users in a variety of formats through different
user interfaces.
Standalone architecture
In a Standalone architecture, all PME system files, the SQL Server database, and any other tools
or utilities are installed on the same computer. You access the power monitoring data through
clients.
The following example diagram shows both architectures in the context of the overall system,
including the monitoring devices:
However, in some cases it might be necessary to use the Distributed Database architecture, such
as:
• Your customer wants to use an existing SQL server.
• Your customer IT requirements do not allow a Microsoft SQL Server to be installed with
another application on the same server.
• The application requires Microsoft SQL Server redundancy with SQL Clustering or other third-
party tools.
• The application requires specific rules for database management, for example SQL jobs,
back-ups, data security, and so on.
Client types
In PME you use clients to access the configuration tools and the applications for viewing data.
There are two different types of clients:
• Engineering Clients configure and administer the system.
Engineering Client
An Engineering Client is an administrative interface in PME that is used to configure and
administer the system. Engineering Clients include tools such as the Management Console,
Vista, and Designer.
One Engineering Client is installed, by default, on the PME server. Additional Engineering Clients
can be installed on other computers, for example on a portable notebook computer, that are more
accessible than the server. Engineering Clients require a Base Access license.
Web Client
A Web Client is used to view power monitoring information such as real-time data, historical
information, and alarms which are used in day-to-day power management tasks.
Web Clients access the data on the server through a Web browser. No installation is required.
Web Clients can run on any computer on the network. Web Clients require a Client Access
license.
Web Clients can access the Web Applications (Dashboards, Diagrams, Trends, Alarms, and
Reports) in PME.
To set up a Web Client, enter the fully qualified domain name of the PME server or its IP address,
followed by /Web into your browser.
Examples:
• http://10.160.42.1/Web
• http://PMEServer.MyCompany.com/Web
NOTE: Web is the default root directory. The root directory is configurable and can be changed
during installation.
By default, the first application on the navigation bar in Web Applications opens in the browser. To
specify which application should open first, add one of the following application parameters to the
Web address: (Note that the parameters are case-sensitive.)
NOTE: For cybersecurity and performance reasons, we recommend that you do not use a Web
Client on the PME server computer.
IT Requirements
This section provides information on specifications and requirements related to information
technology (IT) components, such as computer hardware, operating environment, and
networking.
Use the links in the following table to find the content you are looking for:
Topic Content
Computer Hardware Computer types, CPU, RAM, and HDDs.
Operating Environment OS, DB server, Web browser, and other compatible software.
Required network shares, Windows domain compatibility, IPv6
Network connectivity
compatibility, and IP port requirements.
Other IT considerations Computer name limitations, display resolution.
Computer Hardware
The performance of a computer is determined by the following factors:
• Computer type (desktop, workstation, or server)
When choosing the computer hardware for your PME system, you need to consider the following:
• Number of devices in the system
NOTE: Undersized computer hardware is a common source of performance issues with PME
systems.
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:
• Factory default measurement logging (logging frequency ≥ 15 minutes)
• 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)
RECOMMENDATION: If you use Microsoft SQL 2022, then the minimum RAM requirement is
16 GB.
Advanced Systems
An advanced system is defined by any of the following characteristics:
• Custom measurement logging with <15-minute intervals
• Large scale data exchange with third party systems (for example through OPC, ETL, or
EWS)
• Other resource intensive software systems installed on the same computer
RAM
Distributed
Distributed
OPC Database
System Computer Database
Devices Users DA Standalone architecture
Size Hardware architecture
Tags architecture -
- Database
Application
Server
Server
Workstation
Intel Xeon W-
Small ≤ 100 ≤ 15 5000 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)*
RAM
Distributed Distributed
System Response OPC UA Computer Database Database
Users Standalone
Size Time Server Hardware architecture architecture
architecture
- Application - Database
Server Server
Server
Intel
~5
50000 Xeon 64 GB 32 GB 64 GB
Seconds
Silver (12
core)*
Large ≤ 50
Server
Intel
1 Minutes 100000 Xeon 64 GB 32 GB 64 GB
Silver (12
core)*
RAM
Distributed Distributed
System Response OPC UA Computer Database Database
Users Standalone
Size Time Client Hardware architecture architecture
architecture
- Application - Database
Server Server
Server
Intel
~2 Minutes 20000 Xeon 64 GB 32 GB 64 GB
Silver (12
core)*
Large ≤ 50
Server
Intel
<10
100000 Xeon 64 GB 32 GB 64 GB
Seconds
Silver (12
core)*
Client Computers
Since all the data processing is done on the server, the client computer hardware
recommendations are the same for Basic Systems and Advanced Systems.
4 GB of RAM
• Web Client
2 GHz, Dual Core processor
4 GB of RAM
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.
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:
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.
• 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:
• Factory default measurement logging
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.
Operating Environment
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.
NOTE: Apply the latest updates to the operating system and database system before installing
or upgrading PME.
** 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. For
information on the limitations when using SQL Server Express, see SQL Server considerations.
*** 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.
Windows Updates
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Apply the latest updates and hotfixes to your Operating System and software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Critical and routine Windows Updates can be applied to the operating systems hosting the PME
server and clients without prior approval by Schneider Electric.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the update, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the update.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the update, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the update.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Localization
PME supports the following languages:
English, Chinese (Traditional and Simplified), Czech, French, German, Italian, Japanese, Korean,
Norwegian (Bokmål), Polish, Portuguese, Russian, Spanish, Swedish, and Turkish.
A non-English version of PME only supports an operating system and SQL Server of the same
locale. For example, a Spanish version of the product must be used with a Spanish version of
SQL Server and an operating system with a regional setting of Spanish.
The English version of PME can be used with a supported language, non-English operating
system and SQL Server as long as both have the same locale. For example, an English version of
the product can be used with a German version of SQL Server and an operating system with a
regional setting of German.
In addition, PME has the following limitations when used with SQL Server Express:
• Only supported for Standalone systems, not for Distributed Database systems.
NOTE: 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 do not want to use a different SQL Server.
Type Description
PME requires a certain configuration of the SQL Server. Find the
New SQL Server Standard installation instructions for SQL Server in the Install and Upgrade
chapter of this guide.
PME includes a free version of SQL Server Express. You have the
New SQL Server Express
option to install this Express version during the installation of PME.
To use an existing instance of SQL Server Standard , the SQL
Existing SQL Server Server setup wizard must be rerun to configure the software
Standard correctly for use with PME. Find the configuration instructions for
SQL Server in the Install and Upgrade chapter of this guide.
Existing SQL Server The PME installer can add a new instance to an existing SQL
Express Server Express for use with PME.
NOTE: The operating system and SQL Server combination you choose must be supported by
Microsoft. This applies to edition, version, and 32-/64-bit.
NOTE: SQL Server clustering is only supported for Distributed Database systems, not for
Standalone systems.
Network connectivity
Network communication
The PME server, database server, and clients must be able to communicate with each other over
the network using TCP/IP protocol. The licensing component of PME requires that PME clients
and server can resolve each other’s address by name (not just fully qualified domain name or IP
address). If a proxy server is used on the network, then a local address bypass must be
configured on the PME server.
Network shares
Engineering Clients require that the Power Monitoring Expert folder on the PME server is
shared with full read and write permissions. File and Printer Sharing must be enabled.
Added as a Login in SQL Server with sysadmin role in the database instance.
• PME supports Windows Active Directory services for user account sharing.
IPv6 compatibility
PME supports IPv6 (and IPv4) for communications with metering devices. The software
components of PME require IPv4. That means PME can be used on computers with single stack
IPv4 or dual stack IPv4/IPv6 network adapters.
IP Port Requirements
PME uses certain ports for the communication between its components and the connected
devices. Which ports are required for a specific installation depends on the system configuration
and the monitoring devices used. See IP Ports for a list of relevant ports.
Other IT considerations
Internet Information Services (IIS) .NET Trust Level
The .NET Trust Level for PME web applications and Default Web Site must be set to Full
(internal), in IIS Manager. See IIS Application Pools for a list of PME web (ASP.NET)
applications.
NOTE: The computer name must not be changed after the PME software is installed. If the
computer name is changed after the install, the software ceases to function correctly. If that
occurs, contact Technical Support for assistance.
Display resolution
The minimum display resolution for PME user interfaces is 1280 x 960 pixels.
System maintenance
Once a PME system is installed and commissioned, it must be maintained on a regular basis.
Without periodic, proactive system maintenance, system performance degrades over time and
the system operates with poor performance (timeouts and sluggish response) and eventually
becomes unusable.
This section provides guidelines and recommendations for creating a maintenance schedule.
Proper adherence to the maintenance guide ensures a steady-state operation of a PME system.
This section does not detail troubleshooting system issues, but identifies the steps to develop a
maintenance plan that should allow for a commissioned system to continuously run at optimal
performance.
A maintenance plan keeps your PME system healthy. A comprehensive maintenance plan starts
in the system planning stage before commissioning. The plan should include frequent monitoring
and system reviews, and maintenance tasks to ensure the system is operating under healthy
conditions.
The following sections provide recommendations for developing your maintenance plan:
• Designing for maintenance
• Database maintenance
Size a system for the final state (for example: maximum devices, maximum logging
parameters, etc) to ensure that the system runs in a healthy state for a longer time. See IT
Requirements for recommended system sizing.
• Storage space allocation
Make sure there is enough hard drive space to perform database maintenance, archive and
trim operations. See Storage Performance and Availability for recommended hard drive
sizing.
• Disk I/O performance
Disk read/write operations impacts system performance. Plan to have different storage
devices installed for the system files, the database files, and the Microsoft Message Queuing
(MSMQ) files. See Choosing Data Storage for recommended storage information.
• Pre-size databases
By default, ION_Data database is configured with a 10% auto-growth parameter. This growth
operation can lead to a fragmented database and hard drive and can impact database
performance over time. To minimize the use of the auto-growth feature, pre-allocate hard
drive space for the ION_Data database during system commissioning, including systems
running SQL Server Express. See Database growth for recommendation on database
growth.
• Database auto growth
For systems expected to have large ION_Data databases (> 100 GB), change the default
auto-growth setting to a fixed size rather than by percentage (Default is 10%). In this case, the
database auto-grows when the database exceeds the preset container size. This ensures
better control of database growth. Auto-growth events are expensive operations that slow
down the performance of your database. Take the following preventive steps to ensure your
auto-growth is in control:
Minimize future auto-growth events by monitoring the growth of your databases, and re-
establishing auto-growth settings when a database growth profile changes.
Monitor auto-growth events so you can be alerted when your databases grow.
See SQL Server Database Growth and Autogrowth Settings for more information.
Database maintenance
PME uses databases to store information such as system configuration, data logs, and system
event log messages. These databases must be maintained to preserve performance, manage
disk space usage, and guard against data loss in case of database failure. Maintenance is the key
to a healthy system that supports system longevity and future scalability. You must not ignore
maintenance. Non-maintenance may lead to system downtime and you might need to rebuild the
system from scratch.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
Based on the key activities, see Consolidated recommendation for database maintenance.
Performance maintenance
For performance maintenance, enable and schedule the following daily maintenance tasks for all
PME systems of any configuration:
Maintenance Tasks*
Maintenance
Database Type of Data (update statistics Size
Trim**
and index Notification
defragmentation)
Web Applications related
ApplicationModules configuration data and ✓ ✓ –
system event log entries.
✓
NOTE: For
systems with
Historical power system SQL Server
data such as interval data Express,
ION_Data ✓ ✓
logs, waveforms and enable SQL
alarms. Express
Database
Size
Notification.
In Standalone PME systems, the database maintenance tasks are pre-configured and scheduled
to run automatically by default. For Distributed Database PME systems, you need to configure the
tasks and set up the schedules manually.
For more information, see the Database maintenance section in the Configuring chapter of this
guide.
For all systems, it is recommend to update database statistics daily. The following table shows the
default database maintenance task schedules for standalone systems:
In distributed systems, the database maintenance tasks are not pre-configured. You need to set
up these tasks manually.
These scheduled tasks trigger the DatabaseMaintenance.ps1 Windows PowerShell script. This
script executes the local [Maintenance].[UpdateStatisticsAll] stored procedure in each database.
Check the PME system logs and SQL Server logs to confirm that the scheduled tasks are
completed successfully. The log might report errors if an issue arises. As the database grows,
these jobs will take longer time to complete.
See Microsoft’s SQL Server documentation on SQL Server Query Statistics for more information
about query statistics.
For more information, see the Database maintenance section in the Configuring chapter of this
guide.
To minimize index fragmentation, monitor the fragmentation regularly and perform re-indexing.
In distributed systems, the database maintenance tasks are not pre-configured. You need to set
up these tasks manually.
These scheduled tasks trigger the DatabaseMaintenance.ps1 Windows PowerShell script. This
script executes the local [Maintenance].[ DefragIndexAll] stored procedure in each database.
Check the PME system logs and SQL Server logs to confirm that the scheduled tasks are
completed successfully. The log might report errors if an issue arises. As the database grows,
these jobs will take longer to complete.
Index fragmentation in ION_Data is unavoidable for large systems because of the amount of data
written to the system and queried on a regular basis. Index fragmentation is also common when
database reads exceeds database writes, that is, when PME is configured with added
components to move data from PME to another non-PME system.
For large systems, you need to monitor the index fragmentation daily. To monitor, run the
following SQL commands against the database:
• DBCC SHOWCONTIG
• sys.dm_db_index_physical_stats
Both the commands generate a report on index fragmentation. The time it takes to complete these
statements depend on the amount of data in the table and the level of fragmentation. The more
fragmented the index, the longer the query will run. You should expect the query to return results
within 1 to 20 minutes.
DBCC SHOWCONTIG
DBCC SHOWCONTIG displays fragmentation information for the data and indexes for specified
tables.
NOTE: This command applies to SQL Server 2008 to 2019 and is expected to be deprecated in
a future version of SQL Server.
DBCC SHOWCONTIG
USE ION_Data
GO
DBCC SHOWCONTIG WITH TABLERESULTS, ALL_INDEXES
Review the output from DBCC SHOWCONTIG for the following three statistics:
Shows the accurate indication of how full your pages are. A high percentage means the pages are
almost full, and a low percentage indicates much free space. This value should be compared to
the fill factor setting specified when the index was created to decide whether or not the index is
internally fragmented. The fill factor is the percentage of space on each leaf-level page that
should be filled with data, and it is applied only when the index is created, rebuilt or reorganized. If
the Average Page Density and Fill Factor are close in value, then it would suggest that there is
little index fragmentation.
2. Scan Density:
Shows the ratio between the Best Count of extents that should be necessary to read when
scanning all the pages of the index, and the Actual Count of extents that was read. This
percentage should be as close to 100% as possible. Defining an acceptable level is difficult, but
anything under 75% definitely indicates external fragmentation.
Shows the ratio of pages that are out of logical order. The value should be as close to 0% as
possible and anything over 10% indicates external fragmentation.
sys.dm_db_index_physical_stats
sys.dm_db_index_physical_stats also returns size and fragmentation information for the data and
indexes of the specified table or view in SQL Server. This command is available in SQL Server
2005 or later.
For ION_Data, run the following commands to show fragmentation details for tables with more
than 100,000 rows and a fragmentation level of greater than 50%. Comment out the WHERE
clause to show results for all table indices. The output is sorted by fragmentation level from
highest to lowest.
sys.dm_db_index_physical_stats
USE ION_Data
GO
SELECT
DB_NAME(db_id()) AS DatabaseName,
OBJECT_NAME(object_id) AS TableName,
object_id,
index_id,
index_type_desc,
avg_fragmentation_in_percent,
fragment_count,
page_count,
avg_page_space_used_in_percent,
record_count
FROM
sys.dm_db_index_physical_stats(db_id(),DEFAULT, DEFAULT, DEFAULT, 'SAMPLED')
WHERE
(record_count > 100000) AND (avg_fragmentation_in_percent > 50)
ORDER BY
avg_fragmentation_in_percent DESC;
When reviewing the output from sys.dm_db_index_physical_stats, review the values in the avg_
fragmentation_in_percent column. You should defragement the indexes, if the fragementation is
10% and above.
There are different corrective statements depending on the level of fragmentation. For PME,
select the statements as follows:
Fragmentation
Corrective Statement Remarks
Percentage
Reorganizing an index uses minimal
ALTER INDEX system resources and is an online
10 to 30%
REORGANIZE operation, which means PME can remain
online during this operation.
Rebuilding an index drops and re-creates
the index. Depending on the type of index
ALTER INDEX REBUILD and Database Engine version, a rebuild
> 30%
WITH (ONLINE = OFF) operation can be done online or offline.
For large indexes, it is recommended to
perform this operation offline.
See Resolve index fragmentation by reorganizing or rebuilding indexes for more information on
correcting index fragmentation.
Archive and Trim shortens the backup process by keeping only business critical data in the live
database and also reduces the resource demands in the disaster recovery efforts by shrinking the
database to backup and restore.
Archiving is not recommended since it fractures the data into multiple databases. PME is unable
to query multiple databases at the same time to make comparisons in the data. It is possible to run
reports against an archived database, but it can only be done on one database at a time.
However, the ION_Data database may need to be reduced in size for two reasons:
• SQL Server Express is used as the database engine, which has a limit of 10 GB for the .mdf
file.
• SQL Server (Standard or Enterprise edition) is used as the database engine and the ION_
Data database has become so large that query performance (in Vista for example) is not
acceptable to the PME system users. It is also important to ensure that the ION_Data
database is trimmed well within the hard drive size, as it can affect the operation of PME.
For PME systems with considerable database growth (medium to very large systems), it is
important to consider frequent removal of older and lesser used data from ION_Data. PME
includes an ION_Data data archive maintenance task by default. The database archive task is
pre-configured and disabled for standalone systems, while it must be manually added for
distributed systems.
When an ION_Data archive is created, it is attached to the SQL Server database engine so that
its data is still accessible to Vista and Diagrams. However, the data is not available to other
applications in the Web Applications component.
NOTE: Data archival in PME is different from the normal terminology of archiving. PME's archive
task does not remove data from the database, it only copies data to the archive. Once the data is
archived in PME, it cannot be re-imported back.
We recommend to manually trim the database of historical data after each archive task.
• Is it sufficient to review older data trends only through web reports or diagrams?
• What date range of data is needed for historical reporting – start and end dates?
In this example, archive data from start of Q4 Year 1 to end of Q1 Year 3 into the database
called ION_Data Archive Year 1. This results in a new archive database named ION_Data_
Archive_2017 containing data from 01 September 2016 to 01 April 2018.
• Backup the newly created archive database.
• Schedule the archive activity once per year starting at the end of Q1 of the current year.
NOTE: Archive the older year of data with an additional 3 months on each side of the year of
interest.
• After each successful archive, backup the newly created archive database.
• Schedule the trim activity to trim data in the last 3 months of the dataset from the main ION_
Data database.
• Schedule the trim to run every 3 months.
• When an archive database contains data older than 3 years, mark the archive database for
deletion.
• Delete the marked archive database after 12 months of non-use.
The recommended consolidated trim plan of ION_Data database for the different purpose of PME
system are as follows:
Run DBCC CHECKDB in SQL Server Management Studio on all PME related databases once
per month or quarter.
Check for errors reported in the output of DBCC CHECKDB. A database with integrity displays the
following at the end of the output.
CHECKDB found 0 allocation errors and 0 consistency errors in database
'ION_Data'.
• If the number of connected devices have increased over time, review hardware and hard
drive space requirements at least once per year to ensure server specifications meets
growing demand.
• Review the frequency of the ION_Data database maintenance task as the system grows.
Reduce the frequency from daily to weekly to monthly as the database grows and the
maintenance tasks (Update statistics and re-indexing) take longer to complete.
• Never shrink the database container; it causes fragmentation.
• Archive and trim the ION_Data database regularly and in batches, such as 3 to 12 month data
sets. Refer to Historical Data Archive and Trim Strategy for more information.
Large ION_Data databases require additional effort to maintain because all the maintenance task
might not run completely.
• Disable the ION_Data database maintenance task
With large systems, index fragmentation occurs quickly and is unavoidable.
If you plan to rebuild indexes, ensure that you have an equivalent amount of free space
as the database size.
• If ION_Data database increases over 100 GB unexpectedly, it can be due to following
reasons:
Database fragmentation can occur when there are more database read than database
write actions.
Power quality and / or waveform logging is enabled accidentally, then power quality data
increases.
More data points are logged than usual and frequent logging is performed.
• Defragmenting indexes may require a lot of free hard drive space to allow reindexing to
succeed. Review hard drive space requirements.
Frequent review of system health is to ensure optimal system health over the long term. This task
involves identifying and resolving potential issues. It is recommended to perform system health
checks at least once per month or quarter depending on the amount of data flowing into the
system and how often the system is used.
It is recommended to use the following approach to set up regular system health checks:
1. Determine which system health checks are appropriate. The following is a list of system
health checks appropriate for most of the PME system. Customized PME systems might
include additional checks or have some removed, however all system health checks listed
should be considered:
2. Identify and document how the above information can be collected for the system health
review. See Tools for troubleshooting. Note the following tools:
PME Diagnostic Tool - Install and deploy this tool to obtain a snapshot of the current
state of the system. See PME Diagnostics tool for more information.
3. Create a template system health report. This report should contain at least the following
information:
Report date
Contact information
A list of each system health check with the following information for each line item:
Recommended action
4. Determine a storage location for system health reports. Reports should be stored in a
consistent location and they should be accessible by administrators and support users.
6. In the location created in step 4, save the template report and the initial system health report.
The following table provides the information on list of system checks on why the check is required
and what you need to check:
Primary
• PhysicalDisk: Avg. Disk sec/Write
File system space used by 3rd party software. system growth. If found, take
growth preventive action to reduce the
The best preventive measure is to
risk of a full disk, that is, add more
track of the disk space usage and
disk space or adjust system
assess the growth over time. If the
configuration to reduce disk
used space for a disk has
space usage.
consistently increased for several
months and the percent free disk
space is below 30% then action is
required. Investigate the root cause
of the growth, and develop a plan to
either prevent more disk space from
being used or for more disk space to
be added.
• IIS Logs
• System recovery - The minimal state of the system that should be recovered after a disaster
and the acceptable limit of data and time loss.
Disasters can occur at any time and, if unprepared, such events can lead to data loss and service
disruptions. Factors leading to system disasters include:
• Inoperative hardware
• Database corruption, such as a database exceeding the maximum expected size or allowable
hard drive space
• Natural disasters (For example, earthquakes, fire, flood, storms, and so on)
• Backup plan
• Recovery plan
Developing the plan requires collaboration with the IT team, application champions
(administrators, power users) and recovery experts.
NOTE: If you have limited time and resource to define the strategy, you can consider third-party
products and services for assistance.
• What would be the result if an hour’s, day's or month's worth of analysis, reporting, alarming
and data were lost?
• What would be the result of a complete loss of the PME system?
If your system is not critical, you may decide the best strategy is a simple one where a new PME
system is redeployed in the event of a disaster and device data is re-imported and you experience
potentially irrelevant historical data loss. If your system is critical, you may develop a plan for a
quick recovery with minimal data loss.
You must set a written expectation of what constitutes an acceptable loss. Consider the following
questions:
• What is an acceptable level of data loss in your PME systems?
The answer to this question determines the Recovery Point Objective (RPO) objective. It is
the maximum amount of recent data the business can lose when a disaster strikes. It helps to
measure how much time can occur between your last data backup and the disaster without
causing serious damage to your business. RPO is used to determine how often to perform
data backups.
For example, your backup schedule is set to daily at midnight and a disaster occurs at 8 AM.
At the point of the disaster, you would have lost 8 hours’ worth of data. If your RPO is one day
of data then the loss of the last 8 hours of data is not an issue. However, if your RPO is one
hour of data, then you must revise your backup schedule to at least one backup per hour.
• What is an acceptable recovery time?
The answer to this question determines the Recovery Time Objective (RTO) objective. It is
the amount of time the business can survive without the system after a disaster and before
operations are restored to normal. It determines how quickly you need to recover the PME
system after a disaster.
For example, if your RTO is 24 hours, you can wait up to 24 hours before the system must be
available to users. If data and infrastructure are not recovered within 24 hours, the business
might be impacted.
• What level of disaster should we be prepared for?
Identify the possible disasters that could affect your PME system and the level of impact of
each disaster. For example: If your PME system is an on-premise solution, you should
prepare for disasters such as power loss, fire, flood, etc. If your PME system is hosted on off-
site servers in a data center, prepare for natural disasters but with low priority compared to
cybersecurity risks.
Ensure there is enough hard drive space to perform backup operations and take at least two
backup files. The spare hard drives can ensure minimal rebuild time. RAID arrays (commonly
used on all PME systems) can protect against disk damages. See Storage Performance and
Availability for recommended hard drive sizing.
• Backup power
UPS systems and redundant power supplies to servers can prevent server power
interruption.
• Connection redundancy
If available, redundant data links can protect critical data transmission when the
communication cannot be established in the network.
• Standby servers
With supporting infrastructure and cost, standby servers can provide another set of hardware
that can replace the PME system hardware in the event of an inoperative server. This
approach is valuable when PME is a critical system.
Backup plan
Creating backups are a key part of every PME deployment. A backup solution unique to the PME
deployment can be created based on the recovery objectives, the PME system, and available IT
resources. The backup plan should comprise:
• Components backup
• Backup frequency
Once you have a strategy with details, document the details and supporting processes. Whenever
a system or process change occurs, review and update this document. Store the document
outside of the PME server.
Components backup
The following table contains the components of a standard PME system that must be considered
for backup:
All PME databases should be backed up frequently and a full server backup should be taken upon
system configuration changes (for example, Vista diagrams, updating device drivers, registry
settings, VIP framework changes, and so on). Use Configuration Manager for performing the
backup.
Complete database backup is taken and a restore can only be done up to the point when the
backup was taken.
• Full recovery model
Provides backup options such as differential, incremental, and transaction log. The restore
can be done using different options.
All PME databases are configured with the simple recovery model by default. The ION_Data
database recovery model should be updated to reflect your backup plan.
The recovery model is determined by comparing the disaster identification time with the backup
schedule. For example, as per the following diagram:
A system that is configured to have a single backup cannot be recovered. System is not accessed
by users over the weekend, and becomes inoperative such that the automated backup jobs are
still able to run. In this case, the backup would not be valid and there would be loss of the
complete PME system.
You can prevent this situation by setting the ION_Data database recovery model to Full, thus
allowing more refined backup options.
The key benefit of the full recovery model is that it can restore a database exactly to any point in
time since the last full backup was taken, including potentially to the point the disaster occurred,
resulting in no data loss. It should only be used if simple recovery is not sufficient to meet the
recovery needs as it incurs cost of performance and storage space.
Backup frequency
By default, PME is configured to backup the ApplicationModules and ION_Network databases on
a daily basis, while the ION_Data database is backed up once per week. This default
configuration assumes that meters installed throughout the network have onboard memory and
onboard logging enabled with a log of at least 14 days of data. This weekly frequency balances
the need for performance in steady state and disaster recovery preparation. Frequent transaction
log backups can lead to an unnecessarily bloated LDF file, which can cause performance issues.
If your PME system is critical, it is important to ensure you have a frequent backup strategy to
support quick recovery. In this case, the recommended practices are:
• Set the ION_Data database recovery model to Full
• Increase hard drive storage space by the 2 x size of a ION_Data.MDF file for the additional
transaction log backup files
• Keep the last 24 transaction log backup files on the server
The recommended backup configuration and frequency for PME and system database are as
follows:
Recovery Backup
Component Name Description
Model Frequency
PME Database ION_Network All Simple Daily
PME Database Application Module All Simple Daily
For systems with meters
PME Database ION_Data that have at least 14 days Simple Weekly
of onboard logging
For systems without
onboard logging or for
critical systems
Upon
PME Database ION_Data archive All Simple
creation
System Database master All Simple Daily
System Database model All Full As required
System Database msdb All Simple Daily
The recommended backup configuration and frequency for PME and system files are as follows:
• Backup “%PROGRAMFILES%
System Files SQL Server
Microsoft SQL Server” folder upon major system
changes (hotfixes and upgrades)
System Files Windows registry Monthly and after a significant system change
• Annually or upon significant system change
Store backups locally on a RAID protected drive for the shortest amount of recovery time.
Store a copy of backups on a centralized set of disks so you can recover the backups on
another server if the production SQL Server encounters a critical issue.
Store a copy of the backups off-site on external drives or in the cloud in case a site
disaster occurs.
• Set up automated processes to backup and move files to separate locations.
• Maintain a reasonable set of backups off site and outside of the PME servers. We
recommend the following backup retention strategy. Check with your legal team on keeping
certain amount of critical data in the event of a disaster.
10 daily backups
5 weekly backups
6 monthly backups
• Delete the old backup files on a regular basis in order to manage the storage cost.
When practicing the restore procedure, ensure that you restore to a different server and at a
different location.
Recovery plan
Backup files are worthless if they cannot be restored, so you must have a recovery plan with the
goal of getting a recovered PME system functional with minimum downtime and data loss. The
disaster recovery objectives and backup and archive strategies help create a recovery strategy.
The most important point to remember when creating a recovery plan is that it is not valid until it is
actually tested, and your recovery position is good as your last recovery test. Once you have a
recovery plan, allocate some time to test your disaster recovery strategy. Be aware of who is
executing the recovery as well. Do not assume that a specific person is available to restore the
PME system.
2. Identify the necessary hardware, software, backup and archive files and types (full,
differential, and log).
Ensure resources – physical (servers, software, network) and personnel – are allocated and
assigned, so they are readily available if a disaster strikes.
If you have a large recovery time window, such as 1 week, you may have enough time to
contact PME support team to assist in a recovery procedure. If you have a smaller time
window then any PME administrator (factoring in employee turnover) should be capable of
performing a restore, so this procedure should be well documented. At a minimum, all
backup and archive locations should be documented and accessible to any PME
administrator. Store the documentation outside of the PME production servers.
NOTE: Training PME administrators and / or support staff on PME disaster recovery may
be important to ensure you have redundant personnel available.
4. Schedule system downtime and test the restore procedure. This is a necessary step to
ensure the disaster recovery strategy is valid. Track the time the recovery procedure takes
to verify your time expectation for recovery is valid. Take corrective action for any areas
missed in your recovery documentation, backup, or archive strategies.
5. Progressively update recovery documentation after any major system changes are made
that changes the restore procedure.
NOTE: See SQL Server Limitations on Restoring System Databases in cases where a full SQL
server recovery is needed.
Cybersecurity
This section provides information to help you plan your system security.
You also need a certificate for the database server computer to use an encrypted connection
between PME and the SQL database server in a Distributed Database architecture installation.
See Set up encrypted database communication for Distributed Database architectures for more
information on this topic and for links to Microsoft articles with certificate requirements for SQL
server computers.
See Data encryption for information on data encryption, at rest and in transit, in PME.
PME can be used with application allowlisting software products such as McAfee Application
Control software. See Configure application allowlisting software for more information.
NOTE: AV software can have a significant impact on system performance if not set up correctly.
In particular, SQL Server performance can be affected if data and log files are not excluded from
on-access scans. See Configure antivirus software on your SQL Server for more information.
• device security
Determine what level of expertise will be required to deploy and maintain the network
architectures and security measures. Plan to have this expertise available for the system
deployment and maintenance.
Define workarounds and alternatives for cybersecurity-imposed restrictions, for example, for USB
and CD-ROM drive access.
Licensing
This section provides information on software licensing for PME systems.
Use the links in the following tables to find the content you are looking for:
PME Licensing:
Topic Content
Licensing overview The licensing model and the different license types in PME
Licensing process High level flow diagrams showing the licensing process.
Licensing tools Different tools related to licensing.
Important notes on
A list of items for you to consider when planning a PME system.
licensing
Licensing resources Links and contact information for other license related resources.
Topic Content
Operating System licensing Microsoft Windows operating system software licensing.
SQL Server Licensing Microsoft SQL Server software licensing.
Other software licensing Third party software application licensing.
For information on how to configure licensing in PME, see the Licensing configuration section in
the Configuring chapter of this guide.
Licensing overview
PME is a proprietary software that uses licensing to control its use and distribution. The licensing
is enforced through mechanisms that disable certain software functions if no valid license has
been activated.
To use PME, you must purchase software licenses and activate them in the system. The licenses
give you the right to use the software according to the terms and conditions described in the
software End User License Agreement (EULA). The licenses generally do not expire, unless
stated otherwise in the software EULA. PME licenses are per system. If you have multiple
systems, you must purchase separate licenses for each. Multi-system, or enterprise licenses are
not available.
PME uses a modular licensing structure where different licenses enable different functions in the
software. Some of these functions are optional, others are required. The licenses are cumulative,
meaning that you can add additional licenses to a system, to enable additional functionality.
See Resources for information on where to find a copy of the PME EULA.
License activation
Purchased licenses must be activated either through online or offline methods. An Internet
connection for the PME server is required for online activation. Offline activation must be done
from an alternate Internet-connected computer or smart-phone with web access. See Activating a
license for details.
Licenses are tied to the host computer (physical or virtual). If PME needs to be moved to a new
computer, the licenses must first be returned and then reactivated on the new computer.
License types
PME licenses bundle together one or more PME features. For example, a Base license includes
two Client Access license.
The following table shows the different licenses that are available for PME:
Type Description
New system installations include a time limited Trial license.
Type Description
This is a required license. It enables the PME server functions and
the basic system functions. Without the Base license the system is
not functional. The same Base license can be used for Standalone
or Distributed Database systems.
Base license
The Base license also includes two Client Access licenses. With
Base license, engineering client can be accessed.
Type Description
The Express Base license is similar to the Base license but with
reduced functionality. It is intended for small starter or entry-level
systems. The following shows the differences between Base and
Express Base licenses:
Express
Feature Base
Base
Included device
10 None
licenses
PQ Reports No Yes
Device Licenses Max of 10
Yes
(DL) additional
Client Licenses Max of 2
Yes
Expansion (CL) additional
(optional): Unlimited DL No Yes
Unlimited CL No Yes
Data Exchange
No Yes
Express Base license Module
Energy Billing No Yes
Energy Analysis
Yes Yes
Reports
Energy Analysis
Yes Yes
Dashboards
Capacity
SW Modules No Yes
Management
(optional)
Insulation
No Yes
Monitoring
PQ Performance No Yes
Breaker
No Yes
Performance
Backup Power No Yes
To
Edition Upgrade Standard n/a
Edition
Type Description
This is a required license. It enables the use of monitoring devices
in PME.
Depending on the locale, device licenses are sold as:
• Bundles of 5, 25, 50, 100, 200, unlimited - for the US, Canada,
and India.
• Individual licenses, with 3 different license types - for countries
other than the US, Canada, and India:
E for entry-range device types
Device license M for mid-range device types
See the Default device type support list for details on which
device types require which licenses.
Type Description
This is an optional license. It enables the use of a Software
Module. Each Software Module requires its own specific license.
The following Software Modules exist in PME:
• Backup Power Module
• OPC DA Server
Data Exchange Module
license • OPC UA Server
• COMTRADE Import
Developer/Demo license This is a special license. Contact Schneider Electric for details.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
Licensing process
The licensing process is different for new systems, system upgrades, and system migrations. The
following shows the high-level process for each. For further information, see the resources
provided in Licensing resources.
(*) PME systems must be upgraded using a services plan with software assurance.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
Licensing tools
The tools you use during the licensing process are the Sales Portal and the License Configuration
Tool.
Sales Portal
The Sales portal is an online tool. Use it to create the Bill of Materials (BOM) for your license
purchase, to activate or renew a service plan, and to generate licenses. You can also view license
information for an existing system. The sales portal can be accessed through an Internet
connection with a computer or a mobile device.
For information on how to access the sales portal, see Licensing resources.
TIP: You can access the License Configuration Tool in the install location within
....\Schneider Electric\Power Monitoring Expert\License Configuration
Tool.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
A new Trial license is given when you upgrade a PME system from versions earlier than 2021 to
version 2024.
Upgrade licenses
PME systems must be upgraded using a services plan with software assurance. Activating or
renewing a services plan might add extra time to the licensing process.
Starting from PME 2021, License Configuration Tool is used for license configuration. Floating
License Manager and License Manager are not supported for license configuration. These two
applications are unusable after system upgrade.
NOTE: It is recommended to uninstall Floating License Manager and License Manager from
Control Panel after system upgrade. If you have other systems installed on the same server, for
which the licensing is based on Floating License Manager, see Using Floating License Manager
after system upgrade for steps to use Floating License Manager.
For system upgrade, you must return the licenses using Floating License Manager (for PME
versions earlier than 2021) or License Configuration Tool (for PME version later than 2021) and
after upgrade, activate the new license using License Configuration Tool. For new license contact
Sales Portal. See Licensing resources section for Sales Portal contact details.
NOTE: System migration includes the case where you reinstall PME on the same server after
the operating system has been reinstalled.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
The operating system license is not included in the PME license. Schneider Electric does not
resell Microsoft Windows licenses.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
Microsoft SQL Server is available as a free, scaled down Express version, and as a licensed, full
server version. You can use both versions with PME. For information on the limitations when
using SQL Server Express, see SQL Server considerations.
A free version of SQL Server Express is included in the PME installation files and you have the
option to install it during the installation of PME.
You can purchase licenses for a full server version from Microsoft or from Schneider Electric.
Schneider Electric only resells licenses for specific versions and editions of Microsoft SQL Server,
that are compatible with PME. Contact Schneider Electric for details. See Resources for contact
information.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
Third party software licenses for add-on applications are not included in the PME license.
Schneider Electric does not resell third party add-on licenses.
Related topics:
• Licensing overview
• Licensing process
• Licensing tools
• Licensing configuration
• Licensing resources
Use the links in the following table to find the content you are looking for:
Topic Content
Install planning Things to consider when preparing for a new system installation.
Upgrade planning Things to consider when preparing for a system upgrade.
Migration planning Things to consider when preparing for a system migration.
PME Installer Installer overview, operation, and functions.
PME 2024 Install notes Release notes for PME 2024, related to system installation.
PME 2024 Upgrade notes Release notes for PME 2024, related to system upgrade.
Install planning
Prerequisites
To plan for the installation of the software, review all relevant sections in the Plan chapter of this
guide. In particular, review the sections on system architecture, client types, IT requirements,
licensing, cybersecurity, and deployment considerations. Also review the Install and Upgrade
chapter which provides details on the installation work-flow.
Setup types
In alignment with the system architectures, the PME Installer provides the following Setup Type
options:
• Standalone Server
• Application Server
• Secondary Server
• Engineering Client
Standalone Server
This setup type is used for a Standalone architecture. For information on PME system
architectures, see System architecture.
The Standalone Server installation includes all PME server components, an Engineering Client,
and (optionally) a version of SQL Server Express.
Application Server
This setup type is used for a Distributed Database architecture. For information on PME system
architectures, see System architecture.
The Application Server installation includes all PME server components and an Engineering
Client.
NOTE: Before you can install the Application Server, you must have the remote database server
ready with an installed and configured version of SQL Server. Only full versions of SQL Server
are supported in this architecture. SQL Server Express versions are not supported.
Secondary Server
Secondary Server installations are not common and are used only in exceptional circumstances.
Secondary Server installations require advanced network configuration. Contact Technical
Services if you think you need a Secondary Server.
Engineering Client
This setup type is used to install Engineering Clients on client computers for both Standalone and
Distributed Database architectures. For information on PME Client types, see Client types.
The Engineering Client installation includes all Engineering tools and applications.
NOTE: You must install a Standalone Server or an Application Server before installing an
Engineering Client.
NOTE: Web clients do not require any software installation. Using a supported browser, Web
clients access power monitoring data through the web server running on the PME server. For
information on Web Clients, see Client types.
The default configuration of the software only allows HTTPS connections between the PME
application server and the web clients. This requires that a digital certificate issued by a trusted
Certificate Authority is bound to the default website. If no bound certificate is detected during the
installation of the software, a self-signed certificate is installed. The self-signed certificate is
intended as a temporary solution until an authority issued certificate is installed.
NOTE: Plan to have an authority issued security certificate installed before, or shortly after the
installation of PME.
PME also supports a new Transport Layer Security (TLS 1.3) which includes new set of ciphers
and improvement in device handshaking sequence. The new handshake is faster and more
efficient than legacy handshake.
PME uses TLS 1.3 as default encryption for device communication. If TLS 1.3 is not available on
Devices or Windows, PME selects TLS 1.2 encryption.
For information on how to enable HTTP connections for PME, see Enabling HTTP connections for
PME.
RECOMMENDATION: If TLS 1.2 is enabled in the Operating System, to enable TLS 1.3 see
Enabling TLS 1.3 on PME Web Client .
NOTE: Windows Integrated Authentication is not supported for PME systems with Secondary
Servers.
PME can be installed with either SQL Server Authentication or Windows Integrated
Authentication for SQL database server access.
This is the traditional way of installing PME with database access through both Windows accounts
and SQL user accounts. With SQL Server Authentication, the PME installer creates a number of
SQL accounts and a Windows account during the installation of the software. These accounts are
then used during operation to access the databases. See SQL Server accounts for details on
which accounts are created.
With Windows Integrated Authentication PME uses a Windows account, instead of the SQL
accounts, to access the SQL server databases. You must create this Windows account before
installing the software and provide account details during the installation. The Windows account
must have the required access permissions to the SQL Server database. See Windows accounts
for account details. See Before Installing the software and After installing the software for more
information on Windows Integrated Authentication requirements.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
Miscellaneous
Hard disk drive (HDD) allocation
HDD read/write operations have a big impact on system performance. To optimize your system
performance, plan to have separate HDDs installed for the system files, the database files, and
the Microsoft Message Queuing (MSMQ) files.
HDD indicates old mechanical magnetic type hard disk. Using SSD type disk drive is for a better
performance as SSD is significantly faster than HDD.
The software uses MSMQ for writing device data logs to the SQL database. By storing the MSMQ
files on a different HDD from the database files, both can be written to simultaneously, increasing
system performance. For details on optimizing SQL Server performance and changing the MSMQ
storage location, see information from Microsoft and other sources available online.
Database growth
The database occasionally grows by 10% to create room for additional measurements. This
growth operation can occur at any time and can have a significant impact on server and database
operation. Therefore, it is recommended that you pre-allocate the hard drive space for the
database during the initial commissioning phase of the system. For example, if you calculate that
a database will grow to 500 GB over 5 years, it is recommended that you pre-allocate the hard
drive space to avoid the effects of the periodic growth operations.
Other
• Install and configure the Terminal Server component if Terminal Server connection to the
PME Primary Server is required. Refer to the “Terminal Server Licensing Overview” topic in
your Microsoft Windows documentation to learn about Terminal Server Licensing
requirements.
• Configure the Remote Desktop Connection if you require remote connection to a PME
primary server, see support information provided by Microsoft.
• If you plan to use TAPI modem drivers for Windows (WinModems) in your PME system, install
and configure the WinModems. See Adding a modem for more information.
Related topics:
• Install and Upgrade
Upgrade planning
Prerequisites
To plan for the upgrade of the software, review all relevant sections in the Plan chapter of this
guide. In particular, review the sections on system architecture, client types, IT requirements,
licensing, cybersecurity, and deployment considerations. Also review the Install and Upgrade
chapter which provides details on the upgrade work-flow.
From To
PME 2023 PME 2024
PME 2022 PME 2023
PME 2021 PME 2022
PME 2020 PME 2021
PME 9.0 PME 2020
PME 8.2 PME 9.0
PME 8.1, 8.0, and 7.2.2 systems cannot be upgraded using the PME 2024 installer. To upgrade a
PME 8.1, 8.0, and 7.2.2 system, use the Configuration Manager 2024 tool. See Upgrades from
PME 8.1, 8.0, and 7.2.2 for more information.
NOTE: To upgrade PME 7.2.x systems, you must first apply the latest service packs to get the
systems to version PME 7.2.2. See Upgrade tools and resources for information on where to find
the service packs.
Contact technical support if you want to upgrade older versions of the software that are not
supported by the tools.
Upgrade limitations
• Only upgrades within the same architecture are supported (Standalone -> Standalone,
Distributed Database -> Distributed Database).
• Only upgrades within the same language are supported, for example English -> English,
Spanish -> Spanish, ... .
There are many possible upgrade paths, but only some are supported by the In-Place and Side-
by-Side upgrade tools and procedures. Use the Upgrade Map tool to find the supported upgrade
paths and methods for your system. See Upgrade tools and resources for information on where to
get the Upgrade Map tool.
NOTE: Upgrade paths that are not listed by the Upgrade Map are considered custom upgrades.
If you need to perform a custom upgrade, contact technical support for help.
NOTE: Determine your upgrade path before deciding on the upgrade type. Not all upgrade types
are supported for all upgrade paths.
There are two different upgrade types, In-Place Upgrade and Side-by-Side (SBS) Upgrade.
Each type uses different tools and has different prerequisites.
In-place upgrade
Use an In-Place upgrade to upgrade an older version of PME to the latest version on the same
computer. The upgrade replaces the old system files with new files and leaves the old
configuration and data in place. After the upgrade, the new software has the same configuration
and data as the old. The installer of the new PME version performs an In-Place upgrade
automatically if it detects that an old version of the software exists on the computer.
• The same computer is used for the new version of the software as for the old version before.
• All non-PME settings and configurations on the computer stay as they were.
• The computer hardware is the same as before, which means the performance of the new
system on the old computer might not be as expected.
• The OS and DB Server versions are the same as before, which means the performance of the
new system on the old OS and DB Server versions might not be as expected.
• The power monitoring system is unavailable during the upgrade process until the new system
has been put into service.
• The old system is no longer available after the upgrade. A downgrade is not possible.
• Only more recent versions of the software can be upgraded in place. An in-place upgrade for
older versions may not be possible.
Side-by-side upgrade
Use an SBS upgrade to copy the configuration and data of an old PME system to a new system
on a different computer. The new version of PME is installed on a new computer. The old version
of PME stays installed on the old computer. After the SBS upgrade, the new software has the
same configuration and data as the old one but exists on a different computer. SBS upgrades are
performed manually with the Configuration Manager tool. See Upgrade tools and resources for
information on where to get the Configuration Manager tool.
• The new PME system is installed on a new computer that can be sized to meet your
performance expectations.
• The new PME system is installed on a new OS and DB server version.
• The old PME system stays in service until the new system is ready to be put into service.
• A parallel operation of the old and new systems for a certain amount of time might be
possible.
• The old system stays available after the upgrade.
• The upgrade process is more complex than an in-place upgrade and takes more time.
• A new computer is used for the new version of the software, which means that any non-PME
settings and configurations must be recreated on the new computer.
NOTE: Windows Integrated Authentication is not supported for PME systems with Secondary
Servers.
PME can be installed with either SQL Server Authentication or Windows Integrated
Authentication for SQL database server access.
This is the traditional way of installing PME with database access through both Windows accounts
and SQL user accounts. With SQL Server Authentication, the PME installer creates a number of
SQL accounts and a Windows account during the installation of the software. These accounts are
then used during operation to access the databases. See SQL Server accounts for details on
which accounts are created.
With Windows Integrated Authentication PME uses a Windows account, instead of the SQL
accounts, to access the SQL server databases. You must create this Windows account before
installing the software and provide account details during the installation. The Windows account
must have the required access permissions to the SQL Server database. See Windows accounts
for account details. See Before upgrading the software and After upgrading the software for more
information on Windows Integrated Authentication requirements.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
Miscellaneous
Hard disk drive (HDD) allocation
HDD read/write operations have a big impact on system performance. To optimize your system
performance, plan to have different HDDs installed for the system files, the database files, and the
Microsoft Message Queuing (MSMQ) files.
The software uses MSMQ for writing device data logs to the SQL database. By storing the MSMQ
files on a different HDD from the database files, both can be written to simultaneously, increasing
system performance. For details on optimizing SQL Server performance and changing the MSMQ
storage location, see information from Microsoft and other sources available online.
Migration planning
System migration
During a system migration, you are copying the configuration of one PME system to another PME
system on a different computer. Both PME systems are the same version. Before you can migrate
an existing system, you must first install the new version of PME on the new computer, following
the new system install procedures. The Configuration Manager tool that is used to help with the
migration only supports the migration of the PME version it was built for. For example
Configuration Manager 2024 can only be used to migrate PME 2024 systems. Example
applications for system migrations include off-site configuration, and computer hardware
upgrades.
TIP: You can use the system migration workflow to rename your PME server computer. To do
this, save the configuration with Configuration Manager, uninstall PME, rename the server, re-
install PME, write the configuration with Configuration Manager.
Prerequisites
To plan for the migration of the software, review all relevant sections in the Plan chapter of this
guide. In particular, review the sections on system architecture, client types, IT requirements,
licensing, cybersecurity, and deployment considerations. Also review the Install and Upgrade
chapter which provides details on the migration work-flow.
NOTE: Windows Integrated Authentication is not supported for PME systems with Secondary
Servers.
PME can be installed with either SQL Server Authentication or Windows Integrated
Authentication for SQL database server access.
This is the traditional way of installing PME with database access through both Windows accounts
and SQL user accounts. With SQL Server Authentication, the PME installer creates a number of
SQL accounts and a Windows account during the installation of the software. These accounts are
then used during operation to access the databases. See SQL Server accounts for details on
which accounts are created.
With Windows Integrated Authentication PME uses a Windows account, instead of the SQL
accounts, to access the SQL server databases. You must create this Windows account before
installing the software and provide account details during the installation. The Windows account
must have the required access permissions to the SQL Server database. See Windows accounts
for account details. See Before migrating the software and After migrating the software for more
information on Windows Integrated Authentication requirements.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
Related topics:
• Install and Upgrade
Use the links in the following tables to find the content you are looking for:
Software features:
Feature Details
This includes the Diagrams, Trends, Dashboards, and Vista
Real-time Monitoring
applications.
This includes the Alarm Viewer, the Alarm Annunciator, and
Alarm Management
Software Alarms.
Analytics and Visualization This includes the Dashboards and Reports applications.
Software modules:
Module Application
Backup Power Module Generator and Uninterruptible Power Supply (UPS) performance
design monitoring and reporting, including battery health.
Breaker Performance
Circuit breaker aging and breaker settings monitoring.
Module Design
Generator and Uninterruptible Power Supply (UPS) capacity
Capacity Management
monitoring and reporting. Includes transformer and UPS loss
Module Design
monitoring.
Energy Analysis Gadgets for identifying consumption patterns and anomalies and
Dashboard Module design for comparing different consumers over time.
Energy Analysis Reports Reports for energy consumption monitoring and modeling,
Module design including energy usage by process area or by product output.
Energy Billing Module Energy-based billing and reporting, including consumption
design monitoring and reporting at the branch circuit level.
Event Notification Module
Notifications of power system events via email, SMS, or SNMP.
Design
Insulation Monitoring Monitoring for isolated power systems, such as the ones found in
Module Design hospital operating rooms.
Power Quality
Analysis of power quality events and disturbances and their
Performance Module
impact on the monitored system.
Design
Real-time Monitoring
Real-time monitoring is the viewing of power monitoring data as it is being measured by the
monitoring devices. The data is transferred from the device through the communication network
to the software, where it is displayed. The software displays the data, either as individual
measurements, or as part of a sequence, such as a trend. The data might be temporarily stored
by the software while it is being displayed, but it is not logged into the database for long-term
storage.
Components
The following applications are used to view real-time data:
• Diagrams
• Trends
• Dashboards
• Vista
For details on how to use these applications see the Operate chapter. For details on how to
configure these applications see the Configure chapter.
Prerequisites
The measurement data you want to display must be available from the devices. That means that
the devices must provide the measurements and the device driver must support the
measurements. The devices must also be online and communicating for the data to be available
in the user interface.
Design Considerations
Consider which of the real-time applications best meet the user needs. The Trends and
Dashboards applications only require a small amount of configuration. The amount of
configuration and custom engineering required to create diagrams for the Vista and Diagrams
application depend on the user needs. Creating nested, graphical diagrams, or facility one-line
diagrams might require a considerable amount of time and effort.
Ensure that the monitoring devices that are used have the capabilities required to provide the
desired real-time data.
The Trends application can take advantage of historical data to show trends that seamlessly
extend from the present into the past. The required measurements must be recorded by the
monitoring devices if you want to use historical data with trends.
Related topics:
Software features
• Real-time monitoring
• Alarm Management
Software Modules
• Backup Power Module design
Alarm Management
Alarm management is the viewing, analyzing, and processing of software generated and device
based Incidents and Alarms. It might also include the configuration of these alarms on the devices
and in the software.
Alarm conditions are monitored by the devices, or by the software. When a condition is met, an
Alarm is logged to the database and displayed in the software. The software processes the Alarm
information to categorize the Alarm and associate it with an Incident. Users can acknowledge
Alarms.
Components
The following applications are used for Alarm management:
• Alarms (Viewer)
• Alarm Annunciator
• Software Alarms
For details on how to use these applications see the Operate chapter. For details on how to
configure these applications see the Configure chapter.
Prerequisites
The alarm conditions must be defined and actively monitored on the devices or in the software.
That means that the devices or the software must indicate the active or inactive alarm states and
must log the alarm details into the database. Software alarms require real-time communications
with the devices that are monitoring the measurements that are being alarmed on.
Design Considerations
Carefully choose the alarm conditions on the devices and in the software. Alarming on too many,
too few, or incorrect alarm conditions leads to poor system performance for alarm management.
• Alarms are logged with the date and time of the software server, not the monitoring device.
Consider setting up logging of alarm related information, such as waveform captures or system
states. This additional information might be valuable when analyzing Incidents. When creating
Alarm Views, consider the needs of the users and their applications.
Related topics:
Software features
• Real-time Monitoring
• Alarm management
Software Modules
• Backup Power Module design
Components
The following applications are used for analytics and visualization:
• Dashboards
• Reports
For details on how to use these applications see the Operate chapter. For details on how to
configure these applications see the Configure chapter.
Prerequisites
The measurement data you want to analyze or visualize must be available in the database as
historical data logs. This includes data recorded by the monitoring devices and any third-party
data, such as weather measurements, or process measurements, that might be required.
Individual reports or dashboard gadgets might have specific requirements that must be met.
The use of some of the reports and gadgets is not included in the BASE license for the system,
and requires additional licensing.
Design Considerations
The features related to these applications vary greatly in complexity and input requirements. It is
important that you understand the user needs and that you manage the user expectations. There
might be a need to provide user training to interpret the visualizations and to get the most value
from the results.
Some dashboards and reports require input data from specialized devices, such as high-end
power monitoring devices with advanced power quality monitoring capabilities, or advanced
breaker monitoring. The required data must be available from the devices in the system to provide
the analytics and visualizations.
Some dashboard gadgets and reports require input data that might not be directly monitored and
recorded by the software, for example weather data or process data. This data has to be imported
into the database. Upfront planning and the use of third-party tools might be required to get this
data.
Expect an iterative approach when working with your users to provide the results they are looking
for.
Related topics:
Software features
• Real-time Monitoring
• Alarm Management
Software Modules
• Backup Power Module design
The Generator Test EPSS Report can be configured to conform to the requirements for an
Emergency Power Supply System (EPSS) test, including automatic transfer switches (ATS). For
example, the report shows the transfer time of the lead ATS and indicates whether the transfer
time passes or does not pass the test requirements. See Emergency Power Supply Systems for
more information on EPSS.
Components
The following applications and features are part of this module:
Reports:
• Generator Activity Report
Tools:
• Generator Performance Configuration Tool with EPSS Test Module (includes a generator run
history)
• UPS Configuration Tool
Diagrams:
• EPSS Vista Diagrams
Prerequisites
• The different reports have different input requirements. See Supported measurements and
devices for more information.
• The measurement data for the reports must be available as historical data logs in the
database.
• The generators, UPSs, and other equipment must be configured in the configuration tools
before running the reports.
• This module requires a separate license. See Licensing for more information.
Design Considerations
• This module contains reports for different applications. Only some of these applications might
apply to your system.
• The generator test report is complex. Configuring this report takes time and expertise.
The following table shows the required and optional data, for each ATS and generator:
# of
Data Type Measurements Importance Comments
Channels
This data is
typically available
through digital
output signals
Normal Required from the ATS.
ATS Status Test Required NOTE: All
Digital Input 3-4
Indicators Emergency Required statuses for a
Power Outage Optional(*) specific ATS
must be recorded
by the same
monitoring
device.
This data needs
to be provided by
a power
monitoring device
connected to the
ATS load-side
feeder.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically available
through digital
output signals
Stopped from the
Required
Running generator.
Generator Required
Starting NOTE: All
Status Digital Input 2-4 Optional(*)
Emergency statuses for a
Indicators Optional(*)
Power Source specific
Available (EPA) generator must
be recorded by
the same
monitoring
device.
This data needs
to be provided by
a power
monitoring device
connected to the
generator feeder.
Vln a,b,c,avg; Vll
ab, bc,ca,avg NOTE: Electrical
Generator 3-Phase Power
I a,b,c,avg; kW data must be
Electrical System - Required
tot; kVA tot; PF logged with a 1-
Data Measurements
sign tot; minute logging
Frequency interval. Use the
generator
Running signal to
start the logging
and the Stopped
signal to end the
data logging.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically available
through analog
output signals
Engine from the
Temperature generator.
Required
(**) NOTE: Engine
Generator Exhaust Gas data must be
Required
Engine Analog Input 2 or more Temperature logged with a 1-
(**)
Data (***) minute logging
Optional(*)
interval. Use the
Optional(*)
Battery Voltage generator
Oil Pressure Running signal to
start the logging
and the Stopped
signal to end the
data logging.
(*) This data can be included in the report, but it is not required to configure and run the report.
(**) This data is required depending on the generator evaluation method selected. If Engine
Temperature is selected, the Engine Temperature measurement is required, otherwise, it is
optional. If Exhaust Gas Temperature is selected, the Exhaust Gas Temperature measurement is
required, otherwise, it is optional.
(***) Generators with dual exhaust systems require both Exhaust Gas Temperature Left and
Exhaust Gas Temperature Right measurements.
The digital and analog output data from the ATS and generator can be recorded by the power
monitoring devices used to measure the ATS load data and generator electrical data. See
Supported measurements and devices for monitoring device recommendations.
NOTE: Do not use software logging for the ATS and generator status data. Software logging
introduces unpredictable time delays which result in low timestamp accuracy for the logged
data. Always use device on-board logging for this data.
NOTE: The Generator Test EPSS Report supports Open Transition Transfer (OTT), Closed
Transition Transfer (CTT), and Delayed Transition Transfer (DTT) power transfers. Refer to the
ION device frameworks for EPSS monitoring section to learn more about the ATS monitoring
framework used to support all transition types.
Related topics:
Backup Power topics
• Backup Power Module design
• Alarm Management
Components
The following applications and features are used for this module:
• Breaker Aging Report
• Vista diagrams
• VIP framework
Prerequisites
• This module can only be used with specific device types, see Supported devices for more
information.
• The measurement data for the reports must be available as historical data logs in the
database.
• This module requires a separate license. See Licensing for more information.
Design Considerations
• This module only works with the devices listed above under Prerequisites.
Related topics:
Breaker Performance Module topics
• Breaker Performance Module design
• Alarm Management
Components
The following applications and features are part of this module:
Reports:
• Branch Circuit Power Report
Tools:
• Generator Performance Configuration Tool
Diagrams:
• Equipment Vista Diagrams
Prerequisites
• The measurement data for the reports must be available as historical data logs in the
database before running the report.
• This module requires a separate license. See Licensing for more information.
Report Needs
• A hierarchy must be configured using the data center
hierarchy template.
• Branch circuit level measurements for current and power must
Branch Circuit Power exist.
Report
• A meter on the main incomer is needed for coincident demand
measurements.
Report Needs
• The generators and equipment must be configured in the
Equipment Capacity Generator Performance Configuration Tool before running the
Report reports.
Generator Capacity Report (See Supported Measurements and Devices for more
information.)
• The generators must be configured in the Generator Power
Configuration Utility before running the report.
Generator Power Report
(See Supported Measurements and Devices for more
information.)
• The transformers and UPS must be monitored on both the
primary and secondary side (in and out) for the loss
calculations.
Power Losses Report • The transformers and UPS must be configured in the Power
Losses Configuration Utility before running the report.
Design Considerations
• Some of the reports only work with certain device types.
Related topics:
Capacity Management Module topics
• Capacity Management Module design
• Alarm Management
Components
The following gadgets are part of this module:
• Aggregated Consumption Ranking gadget
• Sankey gadget
Prerequisites
• The gadgets need consumption data, for example electrical consumption (kWh) or WAGES
(water, air, gas, effluent, steam) consumption.
• The consumption measurement data for the gadgets must be available as historical data logs
in the database.
• For the Sankey gadget you need to set up a hierarchy for the input measurements. See
Hierarchy Manager for information on setting up a hierarchy.
Design Considerations
No special design considerations.
Related topics:
Energy Analysis Dashboard Module topics
• Energy Analysis Dashboard Module design
• Alarm Management
Components
The following reports are part of this module:
• Create Model Report
• KPI Gadget
• KPI Report
Prerequisites
• The different reports have different input requirements. See Supported measurements and
devices for more information.
• The measurement data for the reports must be available as historical data logs in the
database.
• Before you can use the energy modeling report you must create a model.
• This module requires a separate license. See Licensing for more information.
Design Considerations
• Consider how to measure and log the different states for the Per State reports.
• You might have to import state measurements into PME (I/O, Modbus, OPC, ETL) if they are
captured in a different system.
• The Energy Regression Analysis Report is a complex report which requires some expertise to
create and to interpret the results correctly.
• The KPI Report requires some upfront planning to define the KPI calculations and ensure that
the required input parameters are available in the system.
• PUE Category 1 and 2 (based on the Uptime Institute recommendations) are supported.
• The energy modeling report is complex. Configuring this report takes time and expertise.
Related topics:
Energy Analysis Reports Module topics
• Energy Analysis Reports Module design
• Alarm Management
Components
The following reports are part of this module:
• Billing Report
Prerequisites
This module requires the following:
• A certain hierarchy configuration and a rate file configuration.
• Energy, or demand, or WAGES type input measurements. Any device type that can provide
these measurement types can be used.
• A Time of Use (TOU) schedule might have to be configured.
• For the Energy by IT Customer Report, branch circuit level measurements are required, see
Supported measurements and devices for more information.
• The measurement data for the reports must be available as historical data logs in the
database.
• This module requires a separate license. See Licensing for more information.
Basic Energy and Demand measurements have been pre-mapped for this module, but might
have to be adjusted or added to in the rate file. See Supported measurements and devices for
more information.
Design Considerations
• Setting up the hierarchy and the rate file requires manual xml file editing.
• The monitoring devices providing the billing data should have revenue metering accuracy.
• The monitoring devices might require analog or digital inputs for WAGES monitoring.
Related topics:
Energy Billing Module topics
• Energy Billing Module design
• Alarm Management
Components
The following application is used for this module:
• Notifications
Prerequisites
To configure a notification rule, you need:
• One or more alarm views to use to trigger the notification. This can be default system views or
custom views.
• Recipient information such as an email address, phone number (for SMS notification), or
SNMP server name.
• SMTP server information if you want to use email notifications.
• SMS account information from Twilio if you want to use SMS notifications.
NOTE: The SMS capabilities of the Event Notification Module are built on technology from
Twilio, a third-party vendor. To use SMS with notifications, you need to open an account with
Twilio and sign up for SMS service. See the Twilio web site for more information.
NOTE: The SNMP client, called Agent sends the notification. PME acts as SNMP Agent.
You need to install the SNMP server, called Manager to receive the notification. Install
SNMP Manager in the same network of SNMP Agent for active SNMP communication. To
receive the notification on SNMP Manager, run the Windows Services "SNMP Trap" and
"SNMP Service" on SNMP Manager. If these services are disabled, SNMP notification fails
to deliver to SNMP Manager.
• This module requires a separate license. See Licensing for more information.
Design Considerations
Consider the following when setting up notifications:
• Configure the alarm views so that they only display the alarms you want to be notified on.
• Decide if you want to be notified on all activity in the alarm view or only when an alarm goes
active or when a new incident occurs.
• Decide if you want the notification to be sent immediately when the activity is detected, or
after a short delay to wait for additional activity (reduces the number of notifications sent
during an incident).
• Use maintenance mode to temporarily disable all notifications before a planned power system
event, for example a planned shutdown.
• Test the notification delivery. Check your spam filter inbox and settings if you do not receive
the test email.
Related topics:
Event Notification Module topics
• Event Notification Module design
• Alarm Management
Components
The following components are part of this module:
• Insulation Monitoring Report
• Vista diagrams
• VIP framework
Prerequisites
• This module can only be used with specific device types, see Supported measurements and
devices for more information.
• The measurement data for the report must be available as historical data logs in the
database.
Design Considerations
• In IEC configuration, the module monitors insulation resistance.
• This module requires the configuration of VIP frameworks and Vista diagrams.
• This module is used for very specific applications. It needs certain types of devices and
equipment.
See Insulation Monitoring Design for ANSI for more information on this application in the ANSI
market.
Related topics:
Insulation Monitoring Module topics
• Insulation Monitoring Module design
• Alarm Management
The following diagram shows the different elements that are part of this module:
For definitions and classifications of power quality phenomena, see power quality events and
disturbances.
Components
The following applications and features are used for this module:
• Diagrams
PQ Indicator diagrams
• Dashboards
Power Quality Rating gadget
Prerequisites
This module has very specific requirements regarding system configuration and available
measurements:
• Most of the gadgets and reports require advanced power quality measurements taken by the
monitoring devices. The power quality data is aggregated across multiple devices and
depends on data from the right device types in the right monitoring locations, see Device
Selection for Power Quality Performance monitoring for more information.
• The Standardized Equipment diagrams are designed for very specific equipment types. See
the Standardized Equipment Diagrams device list for details on compatible device types.
• For the Impact gadgets and report, process impact alarms are required. These alarms might
require measurements from third party equipment, which might have to be brought into the
system.
• For the Impact gadgets and report, billing rates must be defined to convert the measured
values into cost data.
The following diagrams show the power quality inputs that are required for the different diagrams,
gadgets, and reports:
Indicator diagrams
Rating gadgets
Incident gadgets
PF Impact gadgets
PQ Analysis report
See Required measurements for Power Quality Performance monitoring for more information.
Design Considerations
The power quality information provided by this module is only as good as the data monitored by
the devices. To get the full value, use the device types recommended for the different monitoring
locations.
Use the Advanced Systems hardware and SQL Server database servers (not Express) for
systems with the PQ Performance Module.
Time synchronization of the devices and the software is very important for this module. The
standard time synchronization methods for devices in the software are sufficient. High accuracy
time synchronization, such as IRIG-B, can be used, but is not required.
Review the configuration steps for this module to identify any unexpected requirements or
dependencies.
If the devices that are used for power quality performance monitoring do not support all the
required power quality measurements, then the information that is based on these measurements
is not displayed in the gadgets, diagrams, and reports. However, other power quality information,
that is based on available measurements might still be displayed. In this case, analyze which
module outputs are affected and manage the user expectations accordingly.
Related topics:
• Alarm Management
Device Networks
This section provides information on the communication links between the software and the
monitoring devices.
Use the links in the following table to find the content you are looking for:
Topic Content
Device network basics and the supported protocols and device
Device networks overview
types.
Network types Ethernet and serial communication networks.
Network performance Ways to improve the device communication performance.
Time synchronization Time synchronization on the monitoring device network.
Tools The Daisy Chain Calculator tool.
• Smart panels
• Modbus™ RTU
• ION™
• OPC DA
For a device to be compatible with PME, it must support one of these communication protocols.
Related topics:
• Device networks overview
• Network types
• Network performance
• Time synchronization
• Tools
Network types
The two basic types of communication networks for PME are Ethernet and serial.
Devices are configured in PME by providing fixed IP addresses (IPv4 or IPv6) and ports, or based
on host names. Host names must be used for devices with dynamic address assignment, for
example using the DHCP protocol. When host names are used in PME, then a host name
resolution mechanism is required by the external IT network.
Device communications are based on encapsulated Modbus or ION protocol and are not
encrypted. Bandwidth requirements per device are typically low, but depend heavily on the
amount and type of data requested from the device by PME.
Ethernet (TCP) networks are in many ways superior to serial networks and we recommend that
you use Ethernet (TCP) networks whenever possible.
NOTE: If you use an ION meter as a gateway, with Ethergate protocol, you lose the ability to
multi-master the serial devices.
Serial device communications are based on Modbus RTU or ION protocol and are not encrypted.
See Tools for information on how to design a serial network.
• The existing Ethernet (TCP) networks do not allow the connection of monitoring devices.
Ethernet (TCP) networks are in many ways superior to serial networks and we recommend that
you use Ethernet (TCP) networks whenever possible.
Related topics:
• Device networks overview
• Network types
• Network performance
• Time synchronization
• Tools
Network performance
Communications between the software and the devices consist of:
• On demand, real-time data requests, for example for Diagrams or Dashboards displays.
• Periodic polling and uploading of data logs, events, and waveform records.
To optimize the on demand and background polling performance, consider the following when
designing the system and the communication network:
• Real-time data polling periods should be set to meet the user needs. Do not poll with high
speed when it is not needed. Real-time data clients include Vista, Diagrams, OPC, VIP,
Trends, and EWS.
• Disable devices that are not presently commissioned or functional. This includes devices that
are inoperable, or that have a communication error rate >5%.
• Connect high-end devices with power quality monitoring features, such as the ION9000,
directly through Ethernet, not serial. These devices can generate large amounts of logged
data, such as power quality data, which requires a high bandwidth connection to the
monitoring software. If a direct Ethernet connection is not possible, then connect the devices
through small serial loops, with one or two devices per loop.
NOTE: Test the data upload performance when using high-end devices on serial networks.
Depending on configuration and operating conditions, it is possible for devices to have a
higher data generation rate than can be uploaded over a serial network.
NOTE: The ION9000T, a high-end power monitoring device with high speed transient
capture, will not upload high speed transient waveform data to the software if it is connected
through a serial connection.
• Setup the devices to only log those measurements that are needed to meet the user needs.
• Schedule the log uploads to occur at times when the system usage is low, for example during
night time or off hours.
• Use the Daisy Chain Calculator tool to determine the maximum number of devices in a serial
loop for your system. See Tools for more information.
• In most applications, Ethernet networks will provide a better performance than serial
networks.
Related topics:
• Device networks overview
• Network types
• Network performance
• Time synchronization
• Tools
Time synchronization
To maintain accurate time in the monitoring system, the devices must be time synchronized.
Depending on the synchronization mechanism, different levels of time accuracy can be achieved.
PME has the ability to synchronize devices to the PME server computer clock. This can be done
over serial networks and Ethernet networks. See Time synchronization for ION meters and Time
synchronization blackout for more details.
The time synchronization to the computer clock using the regular communications protocols can
maintain a system time accuracy in the range of seconds. This is accurate enough for many
applications. However, for applications such as power event analysis or protection coordination
studies, that require high absolute and relative time accuracy, you need to use other time
synchronization methods for the devices, such as PTP or GPS time synchronization.
Related topics:
• Device networks overview
• Network types
• Network performance
• Time synchronization
• Tools
Tools
Use the Daisy Chain Calculator tool to design your serial communication networks. This tool helps
you estimate the communication utilization for serial daisy chains. You can use it for new system
design and for optimizing existing systems.
NOTE: The Daisy Chain Calculator is available through the Exchange Community. See
Resources for link information.
Related topics:
• Device networks overview
• Network types
• Network performance
• Time synchronization
• Tools
System Integration
This section provides information on the different approaches and technologies for integrating
PME with other systems.
Use the links in the following table to find the content you are looking for:
Topic Content
Overview Integration basics and the supported technologies.
Integration technologies OPC, EWS, ETL, ODBC, PQDIF, VIP
Integration with PO References to PO documentation.
Detailed planning information on the integration of PME with
Integration with EBO
EcoStruxure Building Operation.
Integration with
References to SmartConnector documentation.
SmartConnector
Overview
In addition to data collection from monitoring devices, PME can also connect to and share data
with other systems or software. Using PME in such a connected way is called system integration.
In an integrated system, PME either acts as a server, providing data to other systems, or as a
client, receiving data from other systems, or both at the same time. Real-time data and historical
data can be exchanged between the systems.
The reason for integrating systems is to leverage the strengths and capabilities of each system in
order to provide value that could not be achieved with any of the systems alone.
• EWS server for exporting real-time data, historical data, and alarm data.
Each of these technologies has its strengths and weaknesses. Which technologies to use
depends on the system capabilities, the application needs, and the performance expectations.
See Integration technologies for more details.
Integration technologies
The following sections discuss the integration technologies available in PME.
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.
PME includes an OPC server and an OPC client, which means it can export and import real-time
data to or from another system.
The following shows an example where the OPC server capabilities in PME are used to share
device real-time data with another application:
The following shows an example where the OPC client capabilities in PME are used to bring
device real-time data into PME from another application:
See OPC Unified Architecture (UA) Client Support and"OPC Unified Architecture (UA) Server
Support" on page 1037
RECOMMENDATION: Use an OPC tunneling application for OPC DA data exchange over a
network
PME includes an EWS server, which means that EWS can be used to export real-time data,
historical data, and alarms from PME to another system.
PME includes an EWS client, which means that EWS can be used to import historical data and
alarms data into PME from another system.
Visit the Exchange Community Web site for more information on EWS. See Resources for contact
information.
The following graphic shows the data source and target stores and formats that are supported by
the ETL:
Visit the Exchange Community Web site for more information on ETL. See Resources for contact
information.
• Modbus
• SQL databases
Data Export
• ION
• SQL Databases
• SMTP email
• SMS text
• .exe program
For planning and configuration information on this integration see the Power Operation 2022
System Guide.
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.
• Solution Limitations
• Software compatibility
• Computer hardware
• Solution architectures
NOTE: The deployment of the PME/EBO Integration solution requires application engineering
expertise in installing and configuring EBO 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 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 System architecture for more information on PME installation architectures.
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.
SBO SBO SBO SBO EBO EBO EBO EBO EBO EBO
PME Version
1.6 1.7 1.8 1.9 2.0 3.0.1 3.2.3 4.0.2 5.0 6.0.3
8.0 ■ ■ ■ - - - - - - -
8.1 ■ ■ ■ - - - - - - -
8.2 - - ■ ■ ■ - - - - -
9.0 - - - ■ ■ - - - - -
2020 - - - - - ■ - - - -
2021 - - - - - - ■ - - -
2022 - - - - - - - ■ - -
2023 - - - - - - - - ■ -
SBO SBO SBO SBO EBO EBO EBO EBO EBO EBO
PME Version
1.6 1.7 1.8 1.9 2.0 3.0.1 3.2.3 4.0.2 5.0 6.0.3
2024 - - - - - - - - - ■
NOTE: Perform a refresh for the service to start pulling the real-time data in EBO, when a new
device in added in PME via EWS (EcoStruxture WebService) to display the data correctly.
Operating Environment
PME
See Operating Environment for supported operating systems and SQL Server versions.
Building Operation
See IT System Planning Guide - EcoStruxure Building Management 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
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.
Building Operation and PME both use the same HTTP (80) and HTTPS (443) ports by default. If
you install Enterprise Server and PME on the same computer, you must change these ports for
Building Operation to avoid a port conflict.
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.
Computer hardware
PME
Building Operation
For information on Building Operation hardware specifications, see the IT System Planning Guide
- EcoStruxure Building Management.
As a general guideline, we recommend that you use the PME Advanced Systems hardware
specifications for systems based on Architecture 2 where the PME and Building Operation
software is installed on the same server.
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.
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.
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, and
Alarms) 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. Also Building Operation collects the alarm data and copies it to PME, using the
PME EWS client.
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.
You can use the Building Operation Trend objects for displaying simple trend data. In this case,
any historical data collected in PME, that is to be displayed in Building Operation, needs to be
copied to Building Operation.
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.
For complex historical data and larger data sets, use the PME Dashboards and Reports
applications for displaying the data. In this case, any historical data in Building Operation that is to
be displayed in a dashboard or report needs to be copied to PME, using the PME EWS client or
ETL tool.
Architecture 1
Building Operation collects the historical data and copies it to PME, using the PME EWS client or
ETL tool.
Architecture 2
• 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.
If only kWh and a few power measurements are needed from a device, then either Architecture 2
or Architecture 1 can be used, as long as the existing Automation Server can handle the Modbus
serial loop communication of the power devices.
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:
• The types of graphics available to display real-time power device data
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.
The number of communication layers the real-time values have to go through, in each polling
cycle, differs between the two architectures. This can affect the real-time data update rate in the
user interface.
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:
• Serial communication speed
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:
• Update rate for EWS communication
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 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
PME/EBO Integration section for details.
IT Considerations
The server recommendations are different for Architecture 1 and Architecture 2. See Computer
hardware for more information.
Architecture 1
Device Communications
Refer to the Architectural Guidelines - EcoStruxure Building Management document and relevant
device documentation for more communication design information.
In Architecture 1, historical data is collected in TrendLogs. TrendLogs can be fed by any Building
Operation variables, including BACnet, LON, XML, or Modbus Point.
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 PME EWS client or 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 PME EWS Client or 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: 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 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:
• High priority alarm: 193 - 255
• 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.
Architecture 1: SmartConnector (EWS server) exports the historical and alarm data to PME
system (EWS client).
Architecture 2: SmartConnector (EWS client) imports the historical and alarm data from PME
system (EWS server).
This integration planning section includes the following topics:
• Integration Components
• Integration Limitations
• Software compatibility
• Computer hardware
• Integration architectures
NOTE: The deployment of this integration requires application engineering expertise in installing
and configuring SmartConnector and PME.
Integration Components
The integration includes the following components:
SmartConnector
SmartConnector is an extensible and configurable application framework. At its simplest,
SmartConnector is a multi-threaded Windows service. Threads are configured to execute custom
code written by solution providers and integrators. SmartConnector also provides the
infrastructure to provision HTTP endpoints. These endpoints can either serve data to Schneider
Electric systems and third-party clients via Schneider Electric’s EcoStruxure™ Web Services
(EWS) SOAP protocol or generic RESTful services.
Integration Limitations
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 this integration. The
PME Distributed Database architecture installation type is not supported. See System
architecture for more information on PME installation architectures.
Software compatibility
This section describes the integration 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.
Operating Environment
PME
See Operating Environment for supported operating systems and SQL Server versions.
SmartConnector
See SmartConnector Installation and Configuration Guide for supported operating systems and
SQL Server versions.
Integration requirements
• For deployments where SmartConnector and PME are installed on the same server, the
operating environment must be supported by both systems.
• The following browsers are supported when SmartConnector and PME are installed on the
same server:
Microsoft Edge
Google Chrome
Mozilla Firefox
Port Settings
PME
SmartConnector
See SmartConnector Installation and Configuration Guide for information on the port.
Computer hardware
PME
SmartConnector
Integration 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.
The integration of PME with SmartConnector supports the following integration architectures:
• Architecture 1 - SmartConnector (EWS server) exports the historical and alarm data to PME
system (EWS client)
• Architecture 2 - SmartConnector (EWS client) imports the historical and alarm data from PME
Deployment considerations
This section provides information on the time, effort, and expertise that is required to deploy PME
systems and its components.
Use the links in the following table below to find the content you are looking for:
Topic Content
Power Quality (PQ)
Prerequisites and configuration time estimates.
Performance Module
Commissioning time estimates for the integration of PME and
PME/EBO Integration
EcoStruxure Building Operation (EBO).
Prerequisites
Competency
Application Engineers who are responsible for deploying the PQ Performance module must have
a basic knowledge of power quality and also be familiar with the following:
• Power Monitoring Expert software systems.
We strongly recommend that you take the PME PQ Performance technical training from your local
or regional training center.
Time Estimates
The following time estimates are based on the configuration steps documented for the PQ
Performance module. The assumption is that all the prerequisites are met. For details on how to
configure this module, see the Configure chapter.
* This is site-specific, and highly dependent on the customer requirements. It might require a deep
understanding of the local power quality standards and particular customer needs.
PME/EBO Integration
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.
NOTE: Use PME EWS client instead of ETL to reduce the time taken to deploy Architecture 1 by
24.4 minutes in average.
Architecture 1
Below are commissioning time estimates for PME/EBO Integration solutions for Architecture 1:
Average Standard
Architecture 1 Configuration Workflow Time Deviation
(min) (min)
Installing and licensing Building Operation *
1.1 Installing and licensing License Server
1.2 Installing Enterprise Server
1.3 Installing Workstation
1 Installing Building Operation 16.7 1.5
1.4 Connector components, snippets, and
binding template
Single-server install only: Changing
1.5
Building Operation ports
Installing and licensing PME *
2.1 Installing PME
2 2.2 Activating PME licenses 54.7 18.4
Single-server install only: Changing
2.3
PME ports
Configure the devices in Building Operation with
SmartWidgets
3.1 Configuring Modbus Master Interface
3.2 Importing SmartWidgets
3 81.7 36.6
3.3 Modifying SmartWidgets graphic
3.4 Creating trend logs for SmartWidgets
Copy, paste and edit to have the full
3.5
system
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)
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 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.
• System update
• System upgrade
• System migration
• Cybersecurity
• Tools
• References
Topic Content
Before Installing the Provides information and reminders for you to consider before
software starting the installation.
Provides detailed information on installing the SQL Server and the
Installation process
PME software.
After installing the software Provides procedures for you to complete after the installation.
PME 2024 Install notes Provides release notes related to the installation of PME 2024.
Installing the PME/EBO Provides information on installing the PME/EBO Integration
Integration solution solution.
Installing the Provides the documentation reference on installing the
SmartConnector SmartConnector.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
NOTE: Permissions for the Administrators group can be restricted by system policies which
might affect the PME installation. Work with your network administrator to resolve any
permissions issues.
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.
NOTE: Vista and Designer, on Engineering clients and Secondary servers, use this file share to
access diagram files on the application server.
3. Right-click the product folder and select Properties, this opens the Properties window.
Permissions:
Groups or user names: Select the user that will be installing the Engineering client
or Secondary server, and the users that will be accessing them. Alternatively, select
the Everyone group.
NOTE: Windows Integrated Authentication is not supported for PME systems with Secondary
Servers.
Standalone architecture
NOTE: You can remove this account from the SQL database logins after PME is installed.
• Add the Windows account that is used by PME to access the databases to the local
Administrator group.
• Set the 'Logon As A Service' privilege for the database access account.
• Add the database access account for PME to the local Administrator group.
• Set the 'Logon As A Service' privileges for the database access account.
• Add the account for the install user to the SQL database logins with a sysadmin Server Role.
NOTE: You can remove this account from the SQL database logins after PME is installed.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Install troubleshooting
Unsuccessful installation due to invalid account passwords
Problem:
The installation of PME was not successful, after changing the Windows accounts or database
accounts passwords to passwords that do not meet the password policies.
Background:
PME uses Windows accounts and database accounts to run its services and access the
databases. These accounts are created during the installation of the software. The installer
generates default passwords for these accounts. The default passwords are long and complex
and most likely comply with your Windows and SQL Server password policies.
The installer also gives you the option to change these default passwords. If you decide to change
the passwords, the passwords you are providing must comply with your Windows and SQL
Server password policies. The software installer cannot validate the passwords at the time you
enter them. If the passwords are not valid, the installation will not be successful.
Solution:
If the installation does not succeed because the passwords do not meet the policies, do the
following:
NOTE: The installer will detect that the software has been installed on this computer, and
open in maintenance mode.
4. Follow the wizard and change the passwords for the Windows and database accounts to
passwords that meet the password policies. Allow the installer to complete the account
reset.
Installation process
The installation is a two-step process that must be performed in the following order:
NOTE: The same PME installer is used to install a Standalone Server, Application Server, or
Engineering Client. Which component is installed is determined by the Setup Type, which you
select during the installation. Based on this Setup Type, the installer displays the appropriate
setup pages. See Setup Types and applicable Installer pages for more information.
For information on the different Setup Types, see Standalone Server, Application Server,
Engineering Client.
Web Clients do not need to be installed. For information on Web Clients, see Client types.
For information on choosing a supported SQL Server version, see Operating Environment, SQL
Server considerations, and SQL Server Licensing.
The installation steps are generally the same for all supported SQL Servers. For illustration
purposes, the images in the following steps are from the SQL Server 2014 Standard edition
installation unless indicated otherwise.
1. Insert the SQL Server Installation DVD in your DVD drive or access the installation media on
your system, then navigate to the root directory on the DVD and double-click setup.exe to
open the SQL Server Installation Center.
2. Select Installation in the left pane and New SQL Server stand-alone installation or add
features to an existing installation on the right.
3. Follow the steps provided by the installation wizard until you reach the Setup Role page, for
SQL Server 2012 and 2014, or the Feature Selection page, for SQL Server 2016, 2017,
and 2019.
(For SQL Server 2012 and 2014) Under Shared Features, select Management Tools -
Basic and Management Tools - Complete.
(For SQL Server 2016, 2017, and 2019) The Management Tools are installed in a separate
Web-based process after completing the installation of SQL Server.
Click Next.
This page identifies any errors related to the feature selection validation. If successful, the
next page opens. If not successful, follow the instructions on the page and click Re-run.
Click Next when the process completes successfully.
Select Named instance and enter a name in the Instance Name field, for example ION.
(Do not use an underscore character ( _ ) within the instance name.) Click in the Instance ID
field to automatically add your Instance name entry. Click Next.
Change the Account Name for SQL Server Agent and SQL Server Database Engine to NT
AUTHORITY\SYSTEM (your local system account). To do this, highlight the existing entries
in the Account Name column and enter NT AUTHORITY\SYSTEM for the two services. (For
SQL Server 2017 and 2019) Select Grant Perform Volume Maintenance Task privileges
to SQL Server Database Engine Service. Click Next.
NOTE:
If you specify a Windows account other than the local system account, when you begin
installing PME, the Check System page in the Installer indicates that the service account
under which the SQL Server currently runs does not have the required system
permissions. To resolve this situation, you need to do one of the following:
Temporarily change the SQL Server service to run under an account that has Write
permissions to (1) the folder created for the product's databases (the default is the
install location for ...\Power Monitoring Expert\), and (2), for the current
logged-in user's Temp folder. (To find the full path to the Temp folder, click Start >
Run, enter %Temp% and click OK.) The default local system account is an example of
an account with these privileges.
Temporarily grant Write permission for the two folders mentioned above to the
Windows account that the SQL Server service runs under. Use the Windows Services
control panel to identify this account. (Click Start > Administrative Tools > Services,
right-click SQL Server, click the Log On tab in the SQL Server Properties dialog.)
NOTE: If you are planning to install PME with Windows Integrated Authentication, then
you can choose to configure the database engine either with Windows Authentication
Mode or Mixed Mode. Mixed Mode authentication is also referred to as SQL Server
authentication in this document.
b. (For Mixed Mode) Type a password for the SQL Server system administrator (sa)
account in the Enter password and Confirm password fields. (Keep a record of the
password for future use.)
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices for password creation and management.
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.
c. Click Add Current User to add the SQL Server Administrator if it is not specified by
default.
d. (For SQL Server 2012 and 2014) Click the Data Directories tab. (For SQL Server 2016,
2017, and 2019) Click the TempDB tab.
e. Specify a drive for the TempDB directories (Data and Log). If possible, locate these files
on different drives than the database directories to improve performance. Click Next.
NOTE: The specification of different drives is for performance reasons. If all of the files
are located on the same drive, data that is being inserted, updated, or deleted can
potentially result in slower write operations than if the Temp DB directories are located
on a separate drive. The specification of different drives is dependent on your
hardware configuration and may not be possible in all cases.
The rules are run automatically to validate that the installation can proceed. If validation is
successful, the next page opens. This can be very quick and it might seem that the install
wizard jumps directly to the next page. If validation is not successful, follow the instructions
on the page and click Re-run. Click Next when the validation is successful.
The page shows the SQL Server features that are about to be installed. Click Install.
The Installation Progress page provides a visual indication of the progress of the
installation. When the installation finishes, the Complete page opens.
Contains information about the Setup operations or possible next steps, as well as
supplemental information related to your installation. Click Close to close the setup dialog.
13. (For SQL Server 2016, 2017 and 2019) In SQL Server Installation Center, click Install SQL
Server Management Tools to launch the download page for the installation of SQL Server
Management Studio. Follow the instructions to install SQL Server Management Studio. A
system reboot is required after installing SQL Server Management Studio.
NOTE: Internet access is required. If Internet access is not possible from this server,
download the SQL Server Management Studio setup file on a different computer and copy
it to the SQL Server computer for installation.
14. Go to the Maintenance page in the SQL Server Installation Center and click Launch
Windows Update to search for product updates that you can install.
16. (Recommended) Set the SQL Server memory options. See Setting SQL Server memory
options for more information.
If you have an existing installation of SQL Server Standard Edition, then rerun the SQL Server
Setup wizard and follow the steps described in Installing a new SQL Server.
In most cases, fewer steps are required. The Instance Configuration page is slightly different,
as noted below.
The Instance Configuration page:
1. Enter a name in the Instance Name field, for example ION. (Do not use an underscore
character ( _ ) within the instance name.)
2. Click in the Instance ID field to automatically add your Instance name entry.
3. Click Next.
Any existing instance names appear in the Installed Instances area on the page. If
Management Studio Tools have previously been installed, they are identified as the shared
components SSMS, and Adv_SSMS.
Complete the remaining steps in the instance addition process and close the SQL Server
Installation Center.
(Recommended) Set the SQL Server memory options. See Setting SQL Server memory options
for more information.
For SQL Server 2016, 2017, and 2019, if SQL Server Management Tools need to be installed,
click Install SQL Server Management Tools in the SQL Server Installation Center to launch the
download page for their installation. Internet access is required.
NOTE: As part of the software installation you need to provide SQL Server credentials with
sysadmin privileges on the database server. For Distributed Database architectures, if you are
not able to provide these kinds of credentials, see Installing PME with manual installation of the
databases for an alternate installation method.
Start the installation process by inserting the PME DVD into the DVD drive. If the installation does
not start automatically, use Windows Explorer to navigate to the DVD drive and double-click
MainSetup.exe.
After installing the .NET Framework, you are prompted to restart your system. After the
restart, double-click MainSetup.exe to continue the PME installation.
The Application Language setting determines the language that is displayed in the
following installer pages and the language of the PME system that is installed.
3. Welcome page:
Review the reminders for tasks to complete before continuing with the installation, and click
Next.
Read the End User License Agreement (EULA) on the License Agreement page. If you
accept the terms of the license agreement, click I Agree to proceed.
Select the Setup Type you want to install and click Next.
Standalone Server:
Application Server:
Secondary Server
NOTE: Secondary Server installations are not common and are used only in exceptional
circumstances. They require advanced network configuration. Contact Technical Services
if you think you need a Secondary Server.
NOTE: Secondary servers must be able to access files on the primary application server.
This is done through a file share on the primary server. You must set up this file share
before continuing with the Secondary server install. The install will not be successful if the
file share cannot be found. For details on how to set up the file share, see Create a file
share for Engineering clients and Secondary servers.
Engineering Client:
NOTE: Engineering clients must be able to access files on the application server. This is
done through a file share on the server. You must set up this file share before continuing
with the Engineering client install. The install will not be successful if the file share cannot
be found. For details on how to set up the file share, see Create a file share for Engineering
clients and Secondary servers.
NOTE: Not all of the following installer pages are shown for all Setup Types. See Setup
Types and applicable Installer pages for more information.
Select Generate a system key or Import a system key and click Next.
Generate a system key for the initial installation of a Standalone Server or Application
Server setup type, or when you are re-installing one of those setup types and a system key
is not available.
Import a system key when you are re-installing a Standalone Server, or an Application
Server setup type and you have the system key that you previously exported.
It is mandatory that you export the system key. Next is enabled after you complete the
export.
a. Click Export System Key to open the file explorer.
b. Navigate to the location where you want to store the system key.
c. Type a file name for the system key and click Save.
d. Click Next.
The system key is required if you install an Engineering Client, or if you need to uninstall and
then reinstall Power Monitoring Expert.
NOTE: You can export the system key at any time after the installation. See PME Installer
for details.
The Engineering Client installation needs to use the system key that you exported when you
installed a Standalone Server or an Application Server.
a. Ensure that the system key is available.
d. Click Open to add the system key location to the Import System Key page.
e. Click Next.
Change the default URL path for the Web Applications component of the product, or use the
default values, and click Next.
NOTE: The first time you are installing an Engineering Client for a system, the selection
box on this page is empty. Manually enter the name of the Application Server or
Standalone Server. For repeated client installs, you can select the server name from the
box.
11. (Standalone Server and Application Server) Diagnostics and Usage page:
Diagnostics and Usage, when enabled, collects and sends system data to Schneider
Electric. We use this data to help improve our software by understanding how you use it.
See Diagnostics and Usage for details.
This page shows the default installation location for the product folders and files. Use the
browse button to select a different location if desired. Click Next. Click Yes if you are
prompted to create the folder.
Enter and confirm a password for the supervisor account for the software.
The supervisor account has the highest level of access to the system. Use this account to
configure the system. The entered password must meet the length and complexity
requirements, which is displayed on the page. Next is enabled after the password meets the
requirements.
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.
NOTE: If you continue to the next pages in the Installer and then return to this page by
clicking Back, the page contains a Change Password button. If you want to change the
password that you initially entered, click Change Password, type the new password in the
fields, and click Next to proceed.
Use the default password for the Windows accounts or change the password and click Next.
NOTE: If you change the password, the password you are providing must comply with the
password policies of the Windows server and the SQL server.
The software installer cannot validate the password at the time you enter it.
If the password is not valid, the installation will not be successful. In that case, complete the
installation, skipping any unsuccessful steps. See Unsuccessful installation due to invalid
account passwords for information on how to repair the unsuccessful install.
PME uses two Windows accounts for its operation, IONMaintenance and IONUser. By
default, the password for these accounts is generated automatically by the installer. The
same password is used for both accounts.
The IONMaintenance account is used to run PME database jobs in Windows Task
Scheduler. The IONUser account is used for subscriptions created in the Reports
application when the generated report is created using the fileshare option.
NOTE: If you want to later change the settings for the database jobs in Windows Task
Scheduler, you need the password for the IONMaintenance account. In this case you
must choose your own password for the Windows Accounts on this page since the default
password cannot be retrieved.
NOTE: You can change the Windows Accounts password at any time after the installation.
See PME Installer for details.
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.
Select Use SQL Server Authentication or Use Windows Integrated Authentication for
the PME database accounts. For SQL Server Authentication, use the default password for
the database accounts, or change the password. For Windows Integrated Authentication,
specify an existing Windows account. Click Next.
NOTE: Windows Integrated Authentication is not supported for PME systems with
Secondary Servers.
NOTE: If you change the password, the password you are providing must comply with the
password policies of the Windows server and the SQL server.
The software installer cannot validate the password at the time you enter it.
If the password is not valid, the installation will not be successful. In that case, complete the
installation, skipping any unsuccessful steps. See Unsuccessful installation due to invalid
account passwords for information on how to repair the unsuccessful install.
With SQL Server Authentication, PME uses three SQL accounts for its database access,
ION, ionedsd and AMUser. These accounts are created by the installer. By default, the
password for these accounts is generated automatically by the installer. The same
password is used for all three accounts.
With Windows Integrated Authentication, PME uses one Windows account for its database
access. You must choose an existing account or create a new one with the correct access
permissions. We recommend you create a new, dedicated Windows account for this.
NOTE: The Windows account for Windows Integrated Authentication must be created
outside of the PME installer. You cannot create this account through the installer.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows
account that is used to access the database is also used to run the PME services and the
IIS Application Pools.
NOTE: You can change the password for the SQL accounts and update the password for
the Integrated Authentication Windows account at any time after the installation. See PME
Installer for details.
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.
NOTE: For Windows Integrated Authentication, enter the Windows account User Name as
DOMAIN\UserName or COMPUTERNAME\UserName.
The page indicates that SQL Server Express will be installed. Click Next.
For a Standalone Server setup type when the detected SQL Server instances
include one with the name ION
Select the database server instance, provide the necessary authentication values, and
click Next.
NOTE: The user account, Windows or SQL, that is specified in this step, is used for the
installation of PME and for future password changes. This is different from the
database accounts that are used during the operation of the software. These accounts
were defined in the previous step.
NOTE: For the Windows Authentication option, the current Windows user needs to be
a member of the sysadmin SQL Server role. For the specified SQL Server
authentication option, the SQL Server user needs to be a member of the sysadmin
SQL Server role.
Select the SQL Server instance that you were planning to use with PME when you
installed or reconfigured the SQL Server.
For a Standalone Server setup type when the detected SQL Server instances do not
include one with the name ION
Select either the Install SQL Server Express on this computer option to install an
instance specifically for use with PME or select one of the detected database instances
you want to use with PME. Click Next.
NOTE: The user account, Windows or SQL, that is specified in this step, is used for
PME installation. This is different from the database accounts that are used during the
operation of the software. These accounts were defined in the previous step.
After the completion of the SQL Server Express installation, a system check is
performed to verify that the mandatory prerequisites have been met. The results of the
verification are shown on the Check System page.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices for password creation and management.
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.
NOTE: We recommend that you change the SQL Server Express sa account
password after installing PME.
If this is the first time that you are installing an application server, the dropdown field for
the remote database server is empty. Ensure that your database server is defined in
your system network and type its name and the SQL Server instance in the Database
Server field, where the format is server_name\instance_name.
Click Next.
NOTE: The user account, Windows or SQL, that is specified in this step, is used for
PME installation. This is different from the database accounts that are used during the
operation of the software. These accounts were defined in the previous step.
NOTE: For the Windows Authentication option, the current Windows user needs to be
a member of the sysadmin SQL Server role. For the specified SQL Server
authentication option, the SQL Server user needs to be a member of the sysadmin
SQL Server role.
17. (Standalone Server and Application Server) Database Files Destination page:
This page shows the installation location for the PME databases. Click Next. Click Yes if you
are prompted to create the folder.
This page shows the database file location on the database server that you selected on the
Database Software page.
NOTE: Enter the path to the folder on the database server where you want to install the
database files (MDF and LDF files). The installer will create this folder if it does not exist.
The Check System page verifies that the mandatory prerequisites have been met before
proceeding. If there is a problem, the item is identified and clicking on it displays additional
information about the situation. Click Next.
Note that if you specified a Windows account other than the local system account when you
installed SQL Server, the Check System page will show that the service account under
which the SQL Server currently runs does not have the required system permissions. In that
case do one of the following:
Temporarily change the SQL Server service to run under an account that has Write
permissions to (1) the folder created for the product's databases (the default is the install
location for ...\Power Monitoring Expert\), and (2) the current logged-in user's
Temp folder. (To find the full path to the Temp folder, click Start > Run, enter %Temp%
and click OK.) The default local system account is an example of an account with these
privileges.
Temporarily grant Write permission for the two folders mentioned above to the Windows
account that the SQL Server service runs under. Use the Windows Services control
panel to identify this account. (Click Start > Administrative Tools > Services, right-
click SQL Server, click the Log On tab in the SQL Server Properties dialog.)
The Ready to Configure page summarizes your configuration for the installation of the
software. Click Install to begin the installation.
The Copy Files page indicates the progress as files are copied to the server as part of the
installation.
When the copy operation is complete, the system configuration process begins and is
shown on the Configure System page. Click Next when the configuration process ends.
The Configure System page shows each of the configuration steps. If a configuration step
is not successful, an X appears in a column to the left of the item. Click the link on the
message text on the right of the item to display instructions for resolving the error. If you
correct the problem, click Try Again to continue with the installation. Otherwise, cancel the
install process until you can resolve the problem.
The Complete page contains links that open the Installation Log and start the Web
Applications component, respectively.
The Installation Log summarizes the processing that took place during the installation
process. (You can access the installation log at a later time in the install location within
...\Power Monitoring Expert\SetupLogs).
Click the Web Application link to verify that Web Applications component launches
successfully in a browser.
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.
For information on how to activate licenses, see Licensing configuration. For general information
on licensing, see Licensing.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
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.
For information on how to install and bind a certificate, see Installing and binding a Server
Certificate.
For information on how to configure PME after installing and binding a certificate, see Configure
PME for server certificates.
For information on how to enable HTTP connections for PME, see Enabling HTTP connections for
PME.
• Add the Windows group to PME as a User. See Adding a Windows group for details.
• Add the Windows group to the SQL database server with db_owner role for the PME
databases. (See work flow steps below)
• Add all users who need to access to Engineering client applications to the Windows group. All
members of this Windows group now have the required permissions to access PME and the
database through the Engineering Client applications.
• Remove the Windows account for the install user from the SQL database logins. See Before
Installing the software for more information on this account.
3. Navigate to Security > Logins, right-click Logins, and select New Login from the context
menu. This opens the Login - New window.
4. In Login - New, select Windows authentication, click Search, and locate the Windows
group you want to add.
7. Click OK.
3. Navigate to Security > Logins, right-click Logins, and select New Login from the context
menu. This opens the Login - New window.
4. In Login - New, select Windows authentication, click Search, and locate the Windows
user you want to add.
7. Click OK.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Check services
Open the Windows Services dialog and ensure that all of the necessary ION services are started.
The services run under the Local System or the NT AUTHORITY\System account, by default. You
can change the Log On As attribute of a service by specifying the account and password. Use
the Log On tab on the service properties dialog to do this. The Log On As account must have
read/write permissions on the product's installation directory, which by default is ...\Power
Monitoring Expert\.
For more information the ION Windows Services, see PME Windows services.
user group:
Access to Access to
Group Name ...\Power Monitoring ...\Power Monitoring
Expert\system Expert\config
Administrator_Group_Name,
which is the name you create Full Control Full Control
for your administrator group.
User_Group_Name, which is
the name you create for your Read Change
user group.
For more information on Database Manager and Windows Task Scheduler, see Database
Manager.
Check IIS
Ensure that Internet Information Services (IIS) is working by typing the URL
http://localhost/ in the address field of your browser to display an IIS image. In some
cases, security restrictions may block access to this web page.
4. Installing PME
5. Using PME EWS Client or Installing ETL (only for Architecture 1 solutions)
NOTE: From PME 2022, EWS client is supported. Use PME EWS client for importing
historical data from Building Operation to PME.
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.
Changing Building Operation port settings (for single server installation only)
If Building Operation and PME are installed on the same server, you must change the ports used
by Building Operation through the Software Administrator in order to avoid conflicts between
Building Operation and PME. The default ports of 80 and 443 are reserved for PME.
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
See New system install for details on how to install and license PME.
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.
Installing PME: See New system install for details on how to install and license PME.
Installing SmartConnector: See SmartConnector Installation and Configuration Guide for details
on how to install and license SmartConnector.
System update
Use the links in the following table to find the content you are looking for.
Topic Content
Provides information on the different types of updates, such as
Types of updates
cumulative update, hotfix, and so on.
Before updating the Provides information and reminders for you to consider before
software starting the update.
Provides detailed information on the installation of the different
Updating the software
types of updates.
After updating the software Provides procedures for you to complete after the update.
Types of updates
Cumulative Update (CU)
A CU is a PME software update that provides general product improvements. There can be more
than one CU release for a particular software version. The latest CU for a software version
includes the improvements of any previous CUs. You only need to install the latest CU; it is not
necessary to install older CUs or install them in the order in which they were released.
The following is true for a CU:
• It is a general update that is released to all PME users.
• It does not change the existing trial license status on the system.
• It contains the improvements of the previous CUs for this version of the software.
NOTE: We recommend that you install available CUs for your version of the software. Check the
Exchange Community for information on available updates. See Resources for a link to the
Exchange Community.
NOTE: To find out which CU version is installed on your system, check Help > About in any of
the Engineering applications, or check the Windows registry at HKEY_LOCAL_
MACHINE\SOFTWARE\Wow6432Node\Schneider Electric\Power Monitoring
Expert\2024\CumulativeUpdate.
Hotfix
A hotfix is a PME software update that provides specific product improvements for certain
installations or applications. A hotfix is not a general product update.
• It does not change the existing trial license status on the system.
NOTE: Technical Support will help determine if a hotfix is needed for a system.
• It does not change the existing trial license status on the system.
• The file includes the device driver and related resources, such as diagrams, measurement
mapping information, and release notes.
• It includes an installer.
NOTE: Only users with a need for the specific device type support should install an add-on
device driver on their system.
NOTE: Do not use an update file for which the integrity cannot be confirmed. In that case,
download the update again and check its integrity. Repeat this process until you have a correctly
downloaded update file with confirmed integrity.
For details on how to verify the update file integrity, see Verifying file integrity and authenticity.
NOTE: You cannot uninstall a Cumulative Update after it has been installed.
NOTE: Check the digital signature on the CU install file and confirm that it is OK and shows
Schneider Electric as the signer. Do not install the CU if the signer name is different, for
example Unknown. See Verify the update file integrity and authenticity for more information.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Apply the latest updates and hotfixes to your Operating System and software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Before installing PME2024 CU, install the Windows Update available up to the release date of the
cumulative update on the PME Application Server.
NOTE: PME services are stopped during the installation of a CU. This can affect
communications and data processing.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the update, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the update.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the update, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the update.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
To install a CU:
1. On the PME application server computer, log in with the local Administrator Windows user
account or with an account that is a member of the Administrators group.
2. Take PME out of service by informing system users of the outage and disabling any
automated system control or third-party interactions.
3. Close all Engineering Client applications (Management Console, Vista, Designer, any
Management Console tools).
NOTE: Web client applications can remain open but might experience a service
interruption during the update.
6. If your system includes secondary PME application servers or Engineering Clients, then you
need to install the CU on each of these servers and clients.
To install the CU on secondary servers and Engineering Clients:
a. Log into each server or client with the local Administrator Windows user account or with
an account that is a member of the Administrators group.
7. After the installation of the CU, verify the correct operation of the PME system and put the
system back into service.
NOTE: To resolve issues that might occur after CU installation, contact Technical Support.
8. Restart any Web client applications that experienced a service interruption during the
update.
Installing a Hotfix
A hotfix provides specific product improvements for certain installations or applications. See
Hotfix for more information.
NOTE: PME communications and data processing might be affected during the installation of a
hotfix. Review the information provided with the hotfix for more information.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the update, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the update.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the update, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the update.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
To install a hotfix, follow the instructions provided with the hotfix. A hotfix includes updates for
individual files that need to be manually installed on the system.
NOTE: Take the PME system out of service, if the hotfix instructions indicate that the system
availability is impacted during the installation. To take the system out of service, inform system
users of the outage and disable any automated system control or third party interactions.
NOTE: PME services are stopped during the installation of a CU. This can affect
communications and data processing.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the update, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the update.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the update, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the update.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
1. On the PME application server computer, log in with the local Administrator Windows user
account or with an account that is a member of the Administrators group.
2. Take PME out of service by informing system users of the outage and disabling any
automated system control or third party interactions.
3. On the PME application server, extract the downloaded add-on device driver archive file to a
location of your choice, for example a temporary folder.
4. Open the folder with the extracted files and double-click the .udf file. This will start the
driver installer.
NOTE: Review the release notes that are included with the driver files for any additional
information and install instructions.
7. Done.
After you have installed a CU, do not simply use the Reconfigure function of the original installer
of your PME software anymore.
To reconfigure the software, after installing CUs, you must run the Reconfigure function of the
original installer first, and then run the Reconfigure function of each CU installer in sequential
order. For example, if you have installed CU1 and CU2 on your system, you must run Reconfigure
on the original PME installer, then Reconfigure on the CU1 installer, and then Reconfigure on the
CU2 installer. See Reconfigure for information on this function.
System upgrade
Use the links in the following table to find the content you are looking for.
Topic Content
Before upgrading the Provides information and reminders for you to consider before
software starting the upgrade.
Provides detailed information on the In-Place upgrade of the PME
In-Place upgrade
software.
Provides detailed information on the Side-by-Side upgrade of the
Side-by-Side upgrade
PME software.
After upgrading the
Provides procedures for you to complete after the upgrade.
software
PME 2024 Upgrade notes Provides release notes related to the upgrade of PME 2024.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
Upgrade Path
An upgrade path describes from which older system to which newer system PME is upgraded.
There are many possible upgrade paths, but only some are supported by the In-Place and Side-
by-Side upgrade tools and procedures. See Determine your upgrade path for information on how
to determine your upgrade path.
Upgrade Type
There are two different upgrade types, In-Place Upgrade and Side-by-Side (SBS) Upgrade.
Each type uses different tools and has different prerequisites. See Determine the upgrade type for
information on upgrade types.
Service Packs
The In-Place and SBS upgrade tools require the latest service pack versions of the older PME
systems to be installed before the upgrade. For example, PME 2024 can upgrade a PME 7.2.2
system, but it cannot upgrade a PME 7.2.0 system. If you have PME 7.2.0, you must apply the
service pack first to get the system to PME 7.2.2 before you can do an upgrade.
Your upgrade path determines if your old system requires a service pack installation before the
upgrade. See Determine your upgrade path for more information. See Upgrade tools and
resources for information on where to get the latest service packs for older versions of PME.
Operating Environment
A requirement for in-place upgrades is that the Operating System and Database Server versions
are supported by the new PME system. The Upgrade Map tool, in Determine your upgrade path,
identifies any Operating Environment perquisites for your upgrade path.
Licensing
Product licensing might have changed between the old version of PME and the new version.
Review Licensing and in particular Important notes on licensing for more information, and make
sure you have the correct licenses for the new system before starting the upgrade.
NOTE: Windows Integrated Authentication is not supported for PME systems with Secondary
Servers.
Standalone architecture
NOTE: You can remove this account from the SQL database logins after PME is upgraded.
• Add the Windows account that is used by PME to access the databases to the local
Administrator group.
• Set the 'Logon As A Service' privilege for the database access account.
• Add the database access account for PME to the local Administrator group.
• Set the 'Logon As A Service' privileges for the database access account.
• Add the account for the upgrade user to the SQL database logins with a sysadmin Server
Role.
NOTE: You can remove this account from the SQL database logins after PME is upgraded.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Upgrade troubleshooting
Rolling back an unsuccessful PME in-place upgrade
Under certain circumstances the database upgrades, which are part of the system upgrade, might
not be successful. Use the following steps to rollback an upgrade where the database upgrades
were not successful. After completing these steps, your system should be back in the state it was
in before the upgrade.
To rollback an in-place upgrade with unsuccessful database upgrades:
2. Restore the PME databases from backup, using Microsoft SQL Server Management Studio.
NOTE: Backing up the databases was an optional, recommended step in the in-place
upgrade workflow of the software installer.
3. Open the Windows Service panel and start all ION services. Also, re-enable and start the
Application Modules services as follows:
NOTE: The installer stopped the ION services and disabled the Application Module
services during the upgrade.
4. Open Internet Information Services Manager (IIS Manager) and start the PME application
pools:
Application Modules AppPool
ION AppPool
WebReporterAppPool
In-Place upgrade
Use an In-Place upgrade to upgrade an older version of PME to the latest version on the same
computer. An In-Place upgrade is done with the PME installer. The installer automatically detects
an existing, older PME installation and performs an In-Place upgrade instead of a new install.
The installer completes the following steps during an in-place upgrade:
NOTE: The same PME installer is used to upgrade a Standalone Server, Application Server, or
Engineering Client. The installer automatically detects which older components are installed and
runs the upgrade accordingly.
Upgrade instructions
NOTE: The PME system will be unavailable, after you start the upgrade, until the upgrade is
complete and the new system has been put into service.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the upgrade, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the upgrade.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the upgrade, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the upgrade.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
1. On the PME application server computer, log in with the local Administrator Windows user
account or with an account that is a member of the Administrators group.
2. Take PME out of service by informing system users of the outage and disabling any
automated system control or third party interactions.
3. Close all PME Engineering Client applications (Management Console, Vista, Designer, any
Management Console tools).
NOTE: Web client applications can remain open but will experience a service interruption.
You need to restart web clients after the upgrade.
4. Follow the steps for Installing the PME software. Some of the installer pages differ slightly
for system upgrades and new installs. Some pages are not applicable to upgrades and will
not be shown. Simply follow the instructions on the installer pages
5. After the upgrade, verify the correct operation of the PME system and put the system back
into service.
6. Restart any web client applications that experienced a service interruption during the
upgrade.
Side-by-Side upgrade
Use a Side-by-side (SBS) upgrade to copy the configuration of an old PME system to a new
system on a different computer. SBS upgrades are performed manually with the Configuration
Manager tool.
NOTE: SBS upgrades only apply to Standalone Servers and Application Servers. There is no
SBS upgrade for Engineering Clients.
Upgrading a configuration from an old system to a new system using Configuration Manager is
accomplished in six steps and must be done in the following order:
• Step 1 – Prepare both systems
See Estimated task time for SBS upgrades for information on the expected upgrade time.
NOTE: The old PME system can keep running while the configuration is upgraded. However,
you might experience some performance degradation if two systems are working with the same
monitoring devices.
1. Review the old PME system to see if Devices, Vista Diagrams, Reports, Web
Applications, and any other configurations are working as expected.
2. Check the system log for errors. Correct any items in error or note them down so you can
address them on the new system after the migration.
NOTE: Verify that the database archives you want to include for upgrade are
compatible with the old PME version. Database archives that are not compatible will
not be written to the new system.
4. Check the size of the databases and consider what is needed in the new system.
Upgrading large amounts of historical data can be time consuming. Trim large
databases to avoid long upgrade times.
5. Determine whether the old report packs have been upgraded to work on the new system.
Report packs must be upgraded to be compatible with the new version of PME before
they can be installed on the new system.
The Diagnostics Tool output provides a snapshot of the current state of the system.
Reviewing this helps in identifying current or potential issues. It is advised that you select
all the commands to run to get a full view of this system. Unzip the files (if compressed)
and open the HTML page by clicking on index.html for an overview of the results. Fix
any issues as needed before upgrading.
7. (Only for PME versions 8.2 and newer) Have a copy of the system key for the old
system.
NOTE: The migration of the ION_Data database is often the most time consuming part of the
system migration. You can expect this process to take about 1 hour for each 15 GB in database
size. It is often better to trim the database or archive portions that are no longer needed before
the migration. This is especially important for large database sizes. Plan this part of the
migration carefully.
NOTE: The procedures in this document assume that the new PME system is installed correctly
on the new computer, and that it is in a factory default configured state. Any custom
configuration that exists on the new system will be overwritten by the procedures in this
document. Any custom configuration that exists might cause the migration to fail in unexpected
ways.
Install the new version of PME. See New system install for more information. After the installation
is complete, assess the new system:
1. Check a few of the basic functions such as the system log for errors, and inspect the
System Configuration Report.
2. Open the Web Applications and ensure that there are no Dashboards and that the
default Web Reports are available.
4. Ensure that the remaining trial license period is sufficient for transferring the source
configuration and validating the new system.
NOTE: You should have at least four times the size of the old PME databases in free hard disk
space on the new system to allow for: backups, disk usage during the database upgrade
process, and increase in the database size after the migration. Before writing a saved
configuration to a system, Configuration Manager performs a disk space check to ensure there
is sufficient disk space for the configuration and databases. If there is not enough free disk
space, Configuration Manager will display a warning.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before writing a configuration verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after writing a configuration.
• Verify that you are writing to the correct new, factory installed target system.
• Avoid introducing malicious software into your system.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before writing a configuration verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after writing a configuration.
• Do not introduce malicious software into your system.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
NOTICE
LOSS OF DATA
• Back up the system configuration before writing a new configuration.
• Verify the correctness of a configuration before writing it to the system.
Failure to follow these instructions can result in irreversible database changes.
Distributed systems
For a distributed system, the target system database server and PME server must be in the same
domain.
To run the Configuration Manager on the target PME server, log into Windows with a domain
account that meets the following conditions:
• It is a member of the administrators group on the PME server.
• It has been added as a Login in SQL Server with sysadmin role in the PME database instance
NOTE: The configuration transfer will not succeed if the above conditions are not met.
c. After the operation completes, review the log for errors. Correct errors that could cause
problems on the new system.
d. (Optional) Repeat steps b. and c. until the errors and warnings have been eliminated or
have a known recovery process that will be applied on the destination system.
g. (Only for PME versions 8.2 and newer) Export the PME system key. This can be done
through the PME installer.
NOTE: The system key of the old source system is required to write the configuration
to the new target system. Make sure this key is available when writing the configuration
with the Configuration Manager.
j. Create a backup of any historical database archives that you want to use on the new
system.
k. Copy the database backup files for transfer to the new system.
NOTE: Keep the configuration archive and database backups 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.
2. On the new PME system:
a. Delete the existing ION_Data, ION_Network, and ApplicationModules databases on the
DB server.
c. Log into the new PME application server Windows operating system with a domain
account that meets the conditions described above.
e. Click Load from Archive to load the archived configuration from the old system.
NOTE: During the write to system, the Configuration Manager will prompt for the
system key from the old source system, if that system was PME version 8.2 or newer.
g. Review the log for errors. Correct any errors that will cause problems on the new
system.
NOTE: The new PME system is NOT operational yet. You must manually complete the upgrade.
See the following sections for detailed information on how to complete the upgrade.
Standalone systems
To transfer the configuration:
c. After the operation completes, review the log for errors. Correct errors that could cause
problems on the new system.
d. (Optional) Repeat steps b. and c. until the errors and warnings have been eliminated or
have a known recovery process that will be applied on the destination system.
f. Click Save to Archive. You can optionally save the historical data.
g. (Only for PME versions 8.2 and newer) Export the PME system key. This can be done
through the PME installer.
NOTE: The system key of the old source system is required to write the configuration
to the new target system. Make sure this key is available when writing the configuration
with the Configuration Manager.
b. Click Load from Archive to load the archived configuration from the old system.
NOTE: During the write to system, the Configuration Manager will prompt for the
system key from the old source system, if that system was PME version 8.2 or newer.
d. Review the log for errors. Correct any errors that will cause problems on the new
system.
NOTE: The new PME system is NOT operational yet. You must manually complete the upgrade.
See the following sections for detailed information on how to complete the upgrade.
Carefully review the topics in this section to initialize the new system.
Run the PME installer in Reconfigure mode on the target system after Write to System completes
to ensure that all application settings are configured correctly. See PME Installer for information
on Reconfigure mode.
NOTE: If manual changes to the Web Applications web.config file are required, then make those
edits before reconfiguring the system. See Step 4 - Manually Recreate Customizations and Web
Application web.config for more information.
TIP: Configuration Manager flags missing device drivers as warnings in the Log, and indicates
whether there are newer versions that should be installed. The tool also logs warnings for drivers
that do not match the expected default for the version of PME. These could be drivers that were
installed after the release of PME, or that were modified after the install.
NOTE: Review any device driver warnings in the Configuration Manager Log. Install missing
device drivers and updated drivers to the latest versions if necessary.
For information on where to find the required device drivers, see Resources.
Some LE device drivers (drivers that were downloaded) from the old PME system may have
become Standard Edition (SE) drivers (i.e. default drivers) in the newest version. This results in
two entries in the device type list for the same type.
You can see these device type entries in the Management Console: one is an LE type carried
over from the earlier version; the other is the SE version that was installed during upgrade.
Manually changing the device type can unlink previously logged data. Therefore, an upgrade to
SE should be performed.
The original LE device type might work on the target system but it might not be as fully-featured as
the natively-released version.
NOTE: A possible consequence of upgrading the device type is that any custom diagrams may
no longer work correctly.
A warning message is displayed asking to confirm that it is okay to stop and restart PME
Services.
Clicking OK executes the device upgrade. A message is displayed when the upgrade is
finished.
After you close the Upgrade status window, the device type of the instance will change.
This procedure applies to both CE and LE drivers listed below. The list of drivers that need to be
upgraded include:
UDF Drivers
Custom UDF drivers detected by Configuration Manager on the source system will be saved to
the configuration archive. During the Write to System, the driver packages (UDF files) are copied
to the CM Migration Files folder on the target system. Review the UDF driver packages in the CM
Migration Files folder on the target system after Write to System and determine if any of them
need to be installed on the new system. To install a driver on the new system, double click the
UDF file to start the PME Driver Package installer.
Reports Database
Verify that the correct reporting database is selected.
2. Under Tools > Reports Configuration, click Location of report data in the Reports tab
and confirm that it is set to the database that you want to report on.
2. The target system contains new default values and changes that should not be overwritten.
Configuration Manager copies all customized configuration files that are not automatically
installed in the system to ...\Power Monitoring Expert\CM Migration Files
For example:
Review this folder and decide which customizations you want to recreate on the new system.
The topics that comprise this section consist of all possible configuration customizations.
However, most systems in the field only use a small subset of these.
Alert Monitor
To upgrade the templates to versions that are supported on the new PME system:
Copy compatible templates onto the target system and install them after Configuration Manager
has finished the Write to System.
2. Determine whether the files copied to the CM Migration Files folder were customized.
3. Manually recreate any desired customizations on the target system by customizing the
new version of the driver.
NOTE: Since this process may need to be followed for any future PME upgrades, note the
customizations for future upgrades.
Test each modem or serial port to verify that everything works as expected.
EWS User
If you are upgrading from PME 7.2.2, you must create an EWS user account on the new systems.
NOTE: EWS server must be enabled in PME for the user account configuration UI to be visible in
the Web Applications Settings.
3. Under SETTINGS > Integrations > EWS Server, click Set Credentials.
NOTE: Update all EWS clients with the new account details.
2. Compare the target default file to the source files in the CM Migration Files folder.
3. Manually recreate the settings you want to use on the target system.
2. Compare the target default files to the source files in the CM Migration Files folder.
3. Copy the custom device type definition XML files that you want to include to the new system.
2. Compare the target default files to the source files in the CM Migration Files folder.
3. Recreate the customized default device type definitions you want to use on the target
system.
NOTE: Customization to these files is quite rare. Determine whether PME performance
enhancements require the recreation the LogInserter and Query Server customizations.
2. Compare the target default files to the source files in the CM Migration Files folder.
3. In ION Designer, open LogInserter and edit the Log Acquisition and Query modules to
include the source customizations.
1. Check the CM Migration Files folder to see if there are any custom device type
definitions for OPC.
To recreate customized default device type definitions from the source system:
2. Check the default device type extension XML files from the source in the CM Migration
Files folder.
3. Recreate the customized default device type definitions that you want to include to the new
system.
NOTE: These files are merged in memory into the master DefaultMeasurements.xml
file without needing to modify the master file.
4. Open the file, delete the content of the original device and then replace it with the new
device content.
PQDIF Exporter
Configuration Manager does not automatically install the PQDIF configuration files because the
older files are not compatible with the newer version of PME.
2. Compare the target default files to the source files in the CM Migration Files folder.
3. Recreate the customized PQDIF configuration files that you want to include to the new
system.
2. Recreate any customized registry keys on that you want to use on the target system.
PME Services
Configuration Manager does not transfer customizations in services settings from the source to
the target.
Recreate PME Services settings customizations in service settings using Microsoft Windows
Services.
Additionally, custom VIPs need to be manually started after Configuration Manager completes the
Write to System and the system is ready to be put into service.
Scheduled Jobs
Configuration Manager does not automatically install scheduled jobs from the source system to
the target system.
To recreate scheduled jobs on the new system:
1. In the CM Migration Files folder, check the copied files or review the scheduled jobs on
the source system and then compare it to the target system configuration.
NOTE: Ensure that the user permissions for Windows Task Scheduler are set correctly on the
target system.
1. In the CM Migration Files folder, check the copied web.config file and compare it to
the target system default web.config file in
...\Applications\SystemDataService\.
2. Back up web.config on the target system and then edit the file as needed.
NOTE: You must reconfigure the system after editing the Web Applications web.config file. That
means you have to return to Step 3 - Initialize the Configuration in the workflow.
System reboot
At this point, many configuration changes are complete and it is recommended that you reboot the
system.
PME Hotfixes
If the target system had any hotfixes applied to it before you ran the Reconfigure step, they need
to be reinstalled after you reboot the system.
This will clear any old configurations or cached pages that might have been on the
system before the transfer. If you are unsure about how to do this, an Internet search can
help you find out how to delete the cache on every supported browser.
This ensures that the reports can be read correctly on the new system.
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.
Perform all required manual tasks, especially installing missing device drivers, and then enable
the server, sites, and devices through the Management Console.
Test that each device can display the default diagram. If communication problems exist, address
them before proceeding.
For example:
• Are all devices configured and communicating?
NOTE: You might have to configure some of the new features, that did not exist in the old
version of PME, before they can be used.
Checklist
NOTE: The following list is intended to be a starting point for your system check. Each system
configuration is different. Your system might require additional checks to verify the correct
configuration. Test your system carefully to ensure it is functioning as expected.
3. Check the availability of the archived databases for reporting in Reports Configuration in
the Management Console.
4. Log into Vista, verify the network diagram, real time data, and data logs.
9. In Web Reporter, run saved/custom reports and verify the report subscription.
11. Review the user accounts and passwords to ensure they meet your cybersecurity
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.
For upgrades from versions earlier than 2021 to version 2024: The newly installed software
includes a 90-day trial license for all features of the product. You must activate valid purchased
software licenses within 90 days, otherwise some software functionality is disabled.
For upgrades from version 2021 to version 2022 or version 2022 to version 2024: You
must activate valid purchased software licenses, otherwise some software functionality is
disabled.
NOTE: License Configuration Tool displays trial license is activated. But, PME features are not
enabled. You must activate valid purchased software licenses.
For upgrades from versions earlier than 2021 to version 2024: The newly installed software
includes a 90-day trial license for all features of the product. After you are satisfied with the new
system, you must return your old licenses and then activate valid purchased software licenses
within 90 days, otherwise some software functionality is disabled.
For upgrades from version 2021 to version 2022 or version 2022 to version 2024: Return
your old licenses and then activate valid purchased software licenses, otherwise some software
functionality is disabled.
NOTE: After you return the licenses, the old system is no longer functional.
For information on how to activate licenses, see Licensing configuration. For general information
on licensing, see Licensing.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
• Add the Windows group to PME as a User. See Adding a Windows group for details.
• Add the Windows group to the SQL database server with db_owner role for the PME
databases. (See work flow steps below)
• Add all users who need to access to Engineering client applications to the Windows group. All
members of this Windows group now have the required permissions to access PME and the
database through the Engineering Client applications.
• Remove the Windows account for the upgrade user from the SQL database logins. See
Before upgrading the software for more information on this account.
3. Navigate to Security > Logins, right-click Logins, and select New Login from the context
menu. This opens the Login - New window.
4. In Login - New, select Windows authentication, click Search, and locate the Windows
group you want to add.
7. Click OK.
3. Navigate to Security > Logins, right-click Logins, and select New Login from the context
menu. This opens the Login - New window.
4. In Login - New, select Windows authentication, click Search, and locate the Windows
user you want to add.
7. Click OK.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Check services
Open the Windows Services dialog and ensure that all of the necessary ION services are started.
The services run under the Local System account, by default. You can change the Log On As
attribute of a service by specifying the account and password. Use the Log On tab on the service
properties dialog to do this. The Log On As account must have read/write permissions on the
product's installation directory, which by default is ...\Schneider Electric\Power
Monitoring Expert.
For more information on the ION Windows Services, see PME Windows services.
For more information on Database Manager and Windows Task Scheduler, see Database
Manager.
Check IIS
Confirm that Internet Information Services (IIS) is working by typing the URL
http://localhost/ in the address field of your browser to display an IIS image. In some
cases, security restrictions may block access to this web page.
System migration
Use the links in the following table to find the content you are looking for.
Topic Content
Before migrating the Provides information and reminders for you to consider before
software starting the migration.
Provides detailed information on the migration of the PME
System migration
software.
After migrating the software Provides procedures for you to complete after the migration.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
NOTE: Windows Integrated Authentication is not supported for PME systems with Secondary
Servers.
System migration
Use a system migration to copy the configuration of one PME system to another PME system on a
different computer. System migrations are performed manually with the Configuration Manager
tool.
NOTE: System migration only applies to Standalone Serves and Application Servers. There is
no migration for Engineering Clients.
Migrating a configuration from an old system to a new system using Configuration Manager is
accomplished in six steps and must be done in the following order:
• Step 1 – Prepare both systems
See Estimated task time for SBS upgrades for information on the expected upgrade time.
NOTE: The old PME system can keep running while the configuration is migrated. However, you
might experience some performance degradation if two systems are working with the devices.
1. Review the old PME system to see if Devices, Vista Diagrams, Reports, and any other
configurations are working as expected.
2. Check the system log for errors. Correct any items in error or note them down so you can
address them on the new system after the migration.
3. Check the size of the historical data database (ION_Data) and look for database
archives that need to be migrated.
4. Check the size of the databases and consider what is needed in the new system.
Transferring large amounts of historical data can be time consuming. Trim large
databases to avoid long transfer times.
The Diagnostics Tool output provides a snapshot of the current state of the system.
Reviewing this helps in identifying current or potential issues. It is advised that you select
all the commands to run to get a full view of this system. Unzip the files (if compressed)
and open the HTML page by clicking on index.html for an overview of the results. Fix
any issues as needed before upgrading.
NOTE: The migration of the ION_Data database is often the most time consuming part of the
system migration. You can expect this process to take about 1 hour for each 15 GB in database
size. It is often better to trim the database or archive portions that are no longer needed before
the migration. This is especially important for large database sizes. Plan this part of the
migration carefully.
NOTE: The procedures in this document assume that the new PME system is installed correctly
on the new computer, and that it is in a factory default configured state. Any custom
configuration that exists on the new system will be overwritten by the procedures in this
document. Any custom configuration that exists might cause the migration to fail in unexpected
ways.
Install the new version of PME. See New system install for more information. After the installation
is complete, assess the new system:
1. Check a few of the basic functions such as the system log for errors, and inspect the
System Configuration Report.
2. Open the Web Applications and ensure that there are no Dashboards and that the
default Web Reports are available.
4. Ensure that the remaining trial license period is sufficient for transferring the source
configuration and validating the new system.
NOTE: You should have at least four times the size of the old PME databases in free hard disk
space on the new system to allow for: backups, disk usage during the database upgrade
process, and increase in the database size after the migration. Before writing a saved
configuration to a system, Configuration Manager performs a disk space check to ensure there
is sufficient disk space for the configuration and databases. If there is not enough free disk
space, Configuration Manager will display a warning.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before writing a configuration verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after writing a configuration.
• Verify that you are writing to the correct new, factory installed target system.
• Avoid introducing malicious software into your system.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before writing a configuration verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after writing a configuration.
• Do not introduce malicious software into your system.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
NOTICE
LOSS OF DATA
• Back up the system configuration before writing a new configuration.
• Verify the correctness of a configuration before writing it to the system.
Failure to follow these instructions can result in irreversible database changes.
Distributed systems
For a distributed system, the target system database server and PME server must be in the same
domain.
To run the Configuration Manager on the target PME server, log into Windows with a domain
account that meets the following conditions:
• It has been added as a Login in SQL Server with sysadmin role in the PME database instance
NOTE: The configuration transfer will not succeed if the above conditions are not met.
c. After the operation completes, review the log for errors. Correct errors that could cause
problems on the new system.
d. (Optional) Repeat steps b. and c. until the errors and warnings have been eliminated or
have a known recovery process that will be applied on the destination system.
g. Export the PME system key. This can be done through the PME installer.
NOTE: The system key of the old source system is required to write the configuration
to the new target system. Make sure this key is available when writing the configuration
with the Configuration Manager.
j. Create a backup of any historical database archives that you want to use on the new
system.
k. Copy the database backup files for transfer to the new system.
NOTE: Keep the configuration archive and database backups 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.
c. Log into the new PME server Windows operating system with a domain account that
meets the conditions described above.
e. Click Load from Archive to load the archived configuration from the old system.
NOTE: During the write to system, the Configuration Manager will prompt for the
system key from the old source system.
g. Review the log for errors. Correct any errors that will cause problems on the new
system.
Standalone systems
To transfer the configuration:
c. After the operation completes, review the log for errors. Correct errors that could cause
problems on the new system.
d. (Optional) Repeat steps b. and c. until the errors and warnings have been eliminated or
have a known recovery process that will be applied on the destination system.
f. Click Save to Archive. You can optionally save the historical data.
g. Export the PME system key. This can be done through the PME installer.
NOTE: The system key of the old source system is required to write the configuration
to the new target system. Make sure this key is available when writing the configuration
with the Configuration Manager.
b. Click Load from Archive to load the archived configuration from the old system.
NOTE: During the write to system, the Configuration Manager will prompt for the
system key from the old source system.
d. Review the log for errors. Correct any errors that will cause problems on the new
system.
NOTE: The new PME system is NOT operational yet. You must manually complete the
migration. See the following sections for detailed information on how to complete the migration.
Carefully review the topics in this section to initialize the new system.
Run the PME installer in Reconfigure mode on the target system after Write to System completes
to ensure that all application settings are configured correctly. See PME Installer for information
on Reconfigure mode.
TIP: Configuration Manager flags missing device drivers as warnings in the Log, and indicates
whether there are newer versions that should be installed. The tool also logs warnings for drivers
that do not match the expected default for the version of PME. These could be drivers that were
installed after the release of PME, or that were modified after the install.
NOTE: Review any device driver warnings in the Configuration Manager Log. Install missing
device drivers and updated drivers to the latest versions if necessary.
For information on where to find the required device drivers, see Resources.
Reports Database
Verify that the correct reporting database is selected.
2. Under Tools > Reports Configuration, click Location of report data in the Reports tab
and confirm that it is set to the database that you want to report on.
2. The target system contains new default values and changes that should not be overwritten.
Configuration Manager copies all customized configuration files that are not automatically
installed in the system to ...\Power Monitoring Expert\CM Migration Files
For example:
Review this folder and decide which customizations you want to recreate on the new system.
The topics that comprise this section consist of all possible configuration customizations.
However, most systems in the field only use a small subset of these.
Alert Monitor
Test each modem or serial port to verify that everything works as expected.
NOTE: Customization to these files is quite rare. Determine whether PME performance
enhancements require the recreation the LogInserter and Query Server customizations.
2. Compare the target default files to the source files in the CM Migration Files folder.
3. In ION Designer, open LogInserter and edit the Log Acquisition and Query modules to
include the source customizations.
2. Recreate any customized registry keys on that you want to use on the target system.
PME Services
Configuration Manager does not transfer customizations in services settings from the source to
the target.
Recreate PME Services settings customizations in service settings using Microsoft Windows
Services.
Additionally, custom VIPs need to be manually started after Configuration Manager completes the
Write to System and the system is ready to be put into service.
Scheduled Jobs
Configuration Manager does not automatically install scheduled jobs from the source system to
the target system.
To recreate scheduled jobs on the new system:
1. In the CM Migration Files folder, check the copied files or review the scheduled jobs on
the source system and then compare it to the target system configuration.
NOTE: Ensure that the user permissions for Windows Task Scheduler are set correctly on the
target system.
System reboot
At this point, many configuration changes are complete and it is recommended that you reboot the
system.
PME Hotfixes
If the target system had any hotfixes applied to it before you ran the Reconfigure step, they need
to be reinstalled after you reboot the system.
This will clear any old configurations or cached pages that might have been on the
system before the transfer. If you are unsure about how to do this, an Internet search can
help you find out how to delete the cache on every supported browser.
This ensures that the reports can be read correctly on the new system.
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.
Perform all required manual tasks, especially installing missing device drivers, and then enable
the server, sites, and devices through the Management Console.
Test that each device can display the default diagram. If communication problems exist, address
them before proceeding.
For example:
• Are all devices configured and communicating?
Checklist
NOTE: The following list is intended to be a starting point for your system check. Each system
configuration is different. Your system might require additional checks to verify the correct
configuration. Test your system carefully to ensure it is functioning as expected.
3. Check the availability of the archived databases for reporting in Reports Configuration in
the Management Console.
4. Log into Vista, verify the network diagram, real time data, and data logs.
9. In Web Reporter, run saved/custom reports and verify the report subscription.
11. Review the user accounts and passwords to ensure they meet your cybersecurity
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.
After you are satisfied with the new system, return your old licenses and then activate the licenses
on the new PME system.
NOTE: After you return the licenses, the old system is no longer functional.
For information on how to activate licenses, see Licensing configuration. For general information
on licensing, see Licensing.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
Cybersecurity
Review the cybersecurity information. See Cybersecurity for details.
Check services
Open the Windows Services dialog and ensure that all of the necessary ION services are started.
The services run under the Local System account, by default. You can change the Log On As
attribute of a service by specifying the account and password. Use the Log On tab on the service
properties dialog to do this. The Log On As account must have read/write permissions on the
product's installation directory, which by default is ...\Schneider Electric\Power
Monitoring Expert.
For more information the ION Windows Services, see PME Windows services.
For more information on Database Manager and Windows Task Scheduler, see Database
Manager.
Check IIS
Ensure that Internet Information Services (IIS) is working by typing the URL
http://localhost/ in the address field of your browser to display an IIS image. In some
cases, security restrictions may block access to this web page.
Cybersecurity
This section provides information on how to help secure your system during the Installing and
Upgrading phase.
NOTE: Application allowlisting software can prevent a legitimate application from executing, if
not configured correctly. See Configure application allowlisting software for more information.
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.
Verify the file integrity and authenticity for software updates and other components before
installing them in the system. Do not install files for which the integrity and authenticity cannot be
confirmed.
For details on how to verify file integrity and authenticity, see Verifying file integrity and
authenticity.
As long as the PME server has the original key stored in the registry, it is possible to use the
installer to export a copy at any time. However, if the original key is deleted from the server, it
cannot be recreated or exported. In that case, you can use the exported copy to restore the
system key in the registry. Without the system key, PME user accounts can no longer be
accessed.
NOTE: Protect the exported system key in a location accessible only to authorized users. An
unauthorized user might be able to use the system key to gain access to your power monitoring
software and devices.
For example,
• Scan the system with up-to-date antivirus/antimalware tool
Tools
This section contains information on tools that are used for installing and upgrading PME.
Use the links in the following table to find the content you are looking for.
Topic Content
Provides information on the PME installer and the following
PME Installer installer tasks: Reconfigure, Reset Accounts, Export System Key,
Import System Key, Uninstall.
Provides information on the Configuration Manager tool that is
Configuration Manager
used for Side-by-Side upgrades and system migrations.
PME Installer
Overview
Use the PME installer to:
• Install PME on a new system. See New system install for more information.
• Upgrade PME on an existing system. See System upgrade for more information.
• Perform system maintenance and repair tasks. See below for more information.
Installer Operation
The installer:
• Runs pre-installation checks
• Allows users to set the PME, Windows, and SQL Server account passwords.
The installer produces a detailed installation log file which is saved inside the PME folder structure
on the PME server.
• Reset Accounts
• Uninstall
3. Click Change in the header area of the list of programs. This opens the installer in
maintenance mode.
Reconfigure
Reconfigure lets you rerun the configuration part of the PME install process. Reconfigure
reverts many of the system settings and components to the install defaults.
Typically, you would use Reconfigure to repair or troubleshoot a damaged system. Consult with
Technical Support before running a reconfigure if you are not familiar with the details of this
operation.
NOTE: If your system is installed with Windows Integrated Authentication, you can use
Reconfigure to change which account is used. To only update the password for the account,
run Reset Accounts.
Reset Accounts
As part of the initial installation of PME, you were given the option to set or change the default
passwords for the supervisor account, the Windows accounts, and the database accounts. Reset
Accounts lets you change those passwords.
The dialog sequence is as follows: (1) Supervisor Account page, (2) Windows Accounts page, (3)
Database Accounts page, (4) Database Software page, (5) Reset Accounts progress dialog.
NOTE: If your system is installed with Windows Integrated Authentication, you can use Reset
Accounts to update the password for the Integrated Authentication Windows account. To
change which account is used, run Reconfigure.
You can rerun Reset Accounts as often as required, and you can use it to change none, some,
or all of the passwords.
The system key is required for the installation of an Engineering Client, or if you need to uninstall
and then reinstall PME.
Typically, you would import a system key during a side-by-side upgrade or migration of the PME
server.
Prerequisites
You must list the Server Roles and Description in Service Manager.
1. Go to Service Manager > Server Roles > Next > Web Server.
3. Click Next.
5. Click Next.
6. Click Install.
RECOMMENDATION: Make sure all the required roles and features are enabled /
installed for running PME.
Configuring FQDN:
3. Click Change in the header area of the list of programs. This opens the installer in
maintenance mode.
5. Verify the list of Internet Information Services (IIS) Server Roles and Features enabled
for PME.
6. Click Next.
7. Enter the details for Configure FQDN. This enables the configuration of PME with HTTP
and HTTPS.
For HTTPS:
For HTTP:
HTTP supports only localhost. For HTTPS, we require SSL certificate to bind to the
specified port number in the IIS. During binding the following validations are also
performed:
8. Click Next.
9. Select Set the accounts to Application Pools of IIS to change the login settings for
Application Pools.
10. Select Set the log-on accounts for Windows Services to change the login settings for
Windows Services.
NOTE: After PME reconfiguration, run Configure FQDN again, if you need to set FQDN /
Account Settings.
Uninstall
Uninstall removes system files and components and prepares the computer for a re-installation of
PME. Uninstall does not remove all files from the system. It also does not remove the databases.
To remove all files and components you must decommission the system. You risk disclosing your
power system data, system configuration, user information, and passwords if you do not
decommission the system at the end of its life. See Decommission for more details.
NOTICE
UNAUTHORIZED OR UNINTENDED ACCESS TO CONFIDENTIAL DATA
• Decommission the system at the end of its life by following the instructions provided with the
software.
Failure to follow these instructions can result in unauthorized or unintended access to
sensitive or secure data.
NOTE: As part of the uninstall workflow, you have the option to leave the databases attached to
the database server, making it easier to re-install the software.
Consult with Technical Support before performing an uninstall if you are not familiar with the
details of this operation.
Configuration Manager
EcoStruxure™ Power Monitoring Expert (PME) configuration can be modified or added to during
the commissioning phase and throughout the lifetime of the software.
Because configuration information is stored in the software in various places such as the
database, the Windows Registry, the file system, and configuration files, managing a PME
configuration is a complex, time consuming operation.
Configuration Manager reduces the time it takes to work with PME configurations by reading and
displaying a system's configuration information. Once read, you can inspect and save the
configuration information to an archive file. You can then transfer the archived configuration
information to other systems.
NOTE: Configuration Manager is an add-on tool for PME. It is not included in the software install.
See Resources for Configuration Manager download information.
See Configuration Manager for more information on the Configuration Manager Configuration
Manager user interface.
Requirements
To use the Configuration Manager, your Windows user account must have administrative rights
on Windows and must exist as a Login in SQL Server with sysadmin role in the database
instance.
Supported configurations
Configuration Manager 2024 supports configurations for systems with Standalone and Distributed
Database architecture. It supports all language versions of PME. The following upgrade and
migration paths are supported:
• Archived configurations saved with an earlier version of Configuration Manager are not
compatible with this release of the tool.
NOTE: You cannot restore data or configuration from a newer version of SQL to an older
version. For example, if the source system uses SQL Server 2016, you cannot restore the
configuration to a target system using SQL Server 2012.
Localization
The Configuration Manager is available in English only; it cannot be localized into other
languages.
Version History
The following shows the tool release history:
Getting Started
See the following to get started quickly:
• Review the Tool Design section to get a good idea of how the Configuration Manager is
designed as well as its capabilities before you use it.
• Review the Using the Tool section to understand how to perform the most common tasks
using Configuration Manager.
Basic Steps
Here are the basic steps for using the Configuration Manager:
3. (Optional) Add descriptive notes or attach resource files that you want to save with the
configuration.
Tool Design
The Configuration Manager reads and displays a PME system's configuration information.
Configuration Manager can be used to save and then write a saved configuration and optional
historical data to a PME system.
Before using the Configuration Manager, carefully review the topics in this section.
Configuration Manager also scans the system for compatible historical database archives. You
can choose to include these to be saved to archive with the configuration.
NOTE: Configuration Manager does not display source historical database archives that were
saved using an unsupported power monitoring system version. These historical database
archives cannot be saved with the configuration. To include unsupported historical database
archives with the configuration, upgrade them to a supported version before using Configuration
Manager.
Save to Archive
When Configuration Manager saves a configuration to archive, it copies the customized values,
files, and configuration databases into a single archive folder in a user selected location. The
historical database and historical database archives can optionally be included in the archive. Any
notes or attachments created in the Configuration Manager are also included in the archive folder.
Write to System
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before writing a configuration verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after writing a configuration.
• Verify that you are writing to the correct new, factory installed target system.
• Avoid introducing malicious software into your system.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before writing a configuration verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after writing a configuration.
• Do not introduce malicious software into your system.
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.
NOTICE
LOSS OF DATA
• Back up the system configuration before writing a new configuration.
• Verify the correctness of a configuration before writing it to the system.
Failure to follow these instructions can result in irreversible database changes.
When Configuration Manager writes a saved archive to a target system, it scans the target
version to verify that it is the supported version of PME. It then copies all customized configuration
values to the target. If replacing the default values is compatible with the target system,
Configuration Manager copies the customized files directly to the PME system. Configuration
components that cannot be automatically updated due to overwriting issues are copied to the
following folder: ...\Power Monitoring Expert\CM Migration Files. You must add
these components manually. See Side-by-Side upgrade or System migration for detailed
information on how to perform a system upgrade or migration with the Configuration Manager.
NOTE: To use the Configuration Manager to upgrade or migrate an existing power monitoring
system, you must install it on both the source and target power monitoring systems that you
want to work with.
NOTE: Configuration Manager does not read, save, or write all component customizations. See
Side-by-Side upgrade or System migration for detailed information on how to perform a system
upgrade or migration with the Configuration Manager.
NOTE: Configuration Manager does not transfer PME licenses, nor does it provide warnings
about licensing issues.
Off-site configuration
Perform the off-site configuration of a PME system, and then transfer the configuration
information into a new, non-configured PME system.
Version Upgrade
You can use the Configuration Manager to transfer the configuration of an older PME system into
a newly installed PME system. See Requirements for supported upgrade paths.
NOTE: Configuration Manager does not read, save, or write all component customizations. See
Side-by-Side upgrade or System migration for detailed information on how to perform a system
upgrade or migration with the Configuration Manager.
Server Migration
You can use Configuration Manager to move a PME configuration from a system on one
computer to a system on a different computer. For example, to upgrade to a newer, more powerful
server computer or a newer operating system.
Configuration Library
You can use the Configuration Manager to create a set of system configurations that can be used
as templates for PME deployments. Doing so simplifies and speeds up the deployment by
providing a base configuration that can then be customized and built upon.
Security
Transferring sensitive PME configuration information between systems and IT networks
introduces security risks.
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.
Carefully review the following information to understand the potential security risks that are
introduced when you use the Configuration Manager, and how to minimize these risks.
NOTE: The information contained in this topic is not exhaustive; if you are uncertain about
security protocols, consult your IT department.
In order to write a source system archive to a PME target system, a copy of the source system key
is required. During the write to system work flow, you are prompted to enter the source system
key:
The source system key can be exported from the source system using the PME installer.
NOTE: Keep the system key in a secure location, protected from unauthorized access.
The Configuration Manager displays a reminder for the need to export the key at the end of a save
to archive for a PME configuration:
NOTE: The Configuration Manager cannot determine if the provided key is correct for the source
system configuration. If an incorrect key is provided, the write to system will continue without
warnings. However, the following Reconfigure step in the migration process will fail and the
target system will not be functional. To correct the situation see Reconfigure fails after Write to
System.
The following table lists the potential security risks that could arise when you attach files to an
archive:
To minimize the risk of someone using the Configuration Manager to introduce malicious software
or viruses into a PME system or an IT network:
• Virus scan all files before attaching them to a configuration.
• Be certain that you know where an archived configuration comes from before you write it to a
system.
• Virus scan all attached files that are written to the target machine.
An archive contains detailed and sensitive information about a PME system. Unauthorized
individuals might gain access to this information.
Given this security risk, consider using the following safety precautions when working with the
Configuration Manager:
• Add a password when you save a configuration to an archive
When you save a configuration to an archive, you are prompted to enter a password:
A password-protected archive cannot be loaded into Configuration Manager without providing the
correct password. Additionally, files in a password-protected archive cannot be opened or copied
without providing the password:
The tool also checks whether the configuration is being written to a local disk, a network drive, or a
removable disk. If it is a local disk, the tool uses a minimum threshold to determine whether or not
to display a disk space warning. The default warning threshold value is 10 GB. If the expected
remaining free disk space is less than this threshold, you are warned that there may not be
sufficient free space left after the configuration is written.
NOTE: The Configuration Manager does not perform threshold checks on network drives or
removable disks.
The Configuration Manager uses the following logic to estimate the required disk space:
NOTE: The Configuration Manager looks at both the .mdf and .ldf file sizes and adds them up for
the estimation.
Save to Archive
2x historical data (ION_Data + ION_Data archives) + 2x (unzipped archive + attachments)
Write to System
Upgrades:
Migrations:
You can change the default threshold value by editing the Configuration Manager's configuration
file.
NOTE: Lowering the threshold value can render the disk space warning feature ineffective in
preventing the system from running out of disk space.
Before using the Configuration Manager, review the requirements to make sure that your PME
system meets the minimum requirements. Also review Tool Design to understand the
Configuration Manager capabilities and limitations.
See Side-by-Side upgrade or System migration for detailed information on how to perform a
system upgrade or migration with the Configuration Manager.
If your system does not meet the Configuration Manager Requirements, functionality will be
limited. For example, if you run Configuration Manager on a machine that does not host a power
monitoring system, the following message appears:
Next steps:
• Reading a System
See "Configuration Manager user interface" on page 1801 for a description of the controls and
options available in the tool.
Reading a System
Reading a system provides you with configuration information about the power monitoring system
that is installed and configured on your system. Once the Configuration Manager reads a
configuration, you can inspect the configuration to see its component information and resolve any
problems that are written to the log. You can also copy the configuration by saving it as an archive
file.
To read a system:
NOTE: If there is no system on the machine from which you open the Configuration
Manager, or your system is not supported by the tool, you will not be able to read a system.
NOTE: Read from system will continue even if errors occur. Review the log after reading
from system for possible warnings or errors.
5. Scroll through the components to see the number of instances of each system component.
TIP: Click a column header to sort components alphabetically. Right-click and click Clear
Sort to display the default sort.
You can add attachments to a configuration to provide supporting resources to the configuration.
Attachments can be: restore and validate procedures, checklists, knowledge base articles,
deployment documents, customer order forms, graphics, and so on.
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.
NOTE: Adding attachments can introduce malicious software or viruses to the configuration.
See Configuration Manager security for details on how to minimize potential security risks.
1. Read a system.
3. Click Add.
4. Navigate to and select the files that you want to attach and then click Open.
The file is attached to the configuration. The file name, type, size, date added to the
configuration, and date modified are displayed.
NOTE: Attachments that you add to a configuration are lost if you do not save the
configuration to an archive.
TIP: If you want to reread from a system, you do not need to re-add attachments. Attachments
that you add prior to rereading a system are retained in memory and will be loaded again.
You can add notes to a configuration to provide additional information about the configuration.
Examples of notes are: hand-off instructions, tips, reminders, and known issues.
TIP: You can prevent others from seeing sensitive notes by adding a password to the archive
when you save it.
1. Read a system.
3. Click Add.
NOTE: Notes that you add to a configuration are lost if you do not save the configuration to
an archive.
TIP: If you want to reread from a system, you do not need to re-add notes. Notes that you add
prior to rereading a system are retained in memory and will be loaded again.
To delete a note, highlight the note that you want to delete and then click Delete.
TIP: To delete multiple notes press either Shift or Ctrl, click the notes that you want to delete to
highlight them, and then click Delete.
Saving to Archive
Saving a configuration to an archive file lets you copy the system that is loaded in the
Configuration Manager and save it as a ZIP file. You can then use the Configuration Manager to
load and write the archived configuration and historical data to the new system.
The Save As dialog opens with the file name format: Configuration-<SOURCE_SERVER_
NAME-SourceVersion_yyyy-mm-dd_hh-mm-ss>.zip.
4. Navigate to the location where you want to save the archive file and click Save.
NOTE: You cannot save an archive to a network drive. To save an archive to a network
location save it to a local drive and then copy it to the network location.
5. (Optional) Exclude the historical database and historical database archives from the archive
by de-selecting them.
TIP: Exclude the historical database or historical database archives if disk space is a
concern or if you do not want to overwrite the historical data on the target system.
7. Click Save.
The Configuration Manager copies the system and saves it to an archive file.
NOTE: Save to archive will continue even if errors occur. Review the log to determine
whether you need to correct them and then save to archive again.
For PME version 8.2 and newer configurations, Configuration Manager displays a reminder
for the need to export the system key (see Security for more details):
The saved archive configuration information appears beside the source system:
Copy the saved archive file to another file location on a local or mapped network drive, an external
drive, or the target system.
4. (Optional) If the archive is password-protected, enter the password and then click OK.
You can inspect the configuration, add notes and attachments (which will be automatically
saved), or write it to the target system.
NOTE: Configuration Manager saves new notes and attachments into the loaded archive
automatically when they are added. No additional user action is required.
Writing a configuration to a target system overwrites the existing target configuration; once
started, the operation cannot be canceled or rolled back.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before writing a configuration verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after writing a configuration.
• Verify that you are writing to the correct new, factory installed target system.
• Avoid introducing malicious software into your system.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before writing a configuration verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after writing a configuration.
• Do not introduce malicious software into your system.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
2. Read the target system first to verify that you are writing to the correct system.
TIP: Prior to writing an archive to a target system, backup the target configuration by
saving it to an archive.
NOTICE
LOSS OF DATA
• Back up the system configuration before writing a new configuration.
• Verify the correctness of a configuration before writing it to the system.
Failure to follow these instructions can result in irreversible database changes.
5. (Optional) Include the historical database and historical database archives then click Next.
For PME version 8.2 and newer configurations, Configuration Manager prompts to enter the
source system key (see Security for more details):
NOTE: The Configuration Manager cannot determine if the provided key is correct for the
source system configuration. If an incorrect key is provided, the write to system will
continue without warnings. However, the following Reconfigure step in the migration
process will fail and the target system will not be functional. To correct the situation see
Reconfigure fails after Write to System.
6. Review how the Write to System operation will impact the target system and then click
Write.
NOTE: Write to system will continue even if errors occur. Review the log to determine
whether you need to correct errors in the target system.
7. Complete the manual configuration tasks. See Side-by-Side upgrade or System migration
for detailed information on how to perform a system upgrade or migration with the
Configuration Manager.
Review the log and resolve any problems in the configuration prior to saving a system to an
archive or writing it to another system.
NOTE: The log is not saved with the archive; it is retained while the tool is running only.
Restarting the tool erases the log.
For each Configuration Manager session, Configuration Manager saves a copy of the log in
...\<Configuration Manager extraction location>\Configuration
Manager\Logs\. There will be a new file for each CM tool session.
TIP: If you are saving a configuration to archive, attach the latest log file to the configuration and
then save it.
If you encounter problems with the configuration and you want to resolve them before you save or
write the configuration:
3. Read the configuration again to verify that the problems were resolved.
Manual Tasks
Configuration components that cannot be automatically updated due to overwriting issues are
copied to the following folder on the target system: ...\Power Monitoring Expert\CM
Migration Files. You must add these components manually. See Side-by-Side upgrade or
System migration for detailed information on how to perform a system upgrade or migration with
the Configuration Manager.
Configure
This chapter describes the different tools and tasks for configuring Power Monitoring Expert
(PME).
Use the information in the following tables to find the content you are looking for:
Main functions:
Function Task
Alarms configuration Configure alarm and incident views in Web Applications.
Cybersecurity Provides recommended actions to help secure your system.
Dashboards configuration Configure Dashboards and Slideshows in Web Applications.
Database maintenance Configure and schedule tasks such as backup, archive, and trim.
Diagrams and graphics
Configure Diagrams in Web Applications.
configuration
Duplicate Data logging Enable the logging of duplicate historical data records.
Licensing configuration Configure the software and device licenses.
Reports configuration Configure Reports in Web Applications.
Software Alarms Configure Software Alarms.
System integration Integrate PME with other EcoStruxure™ systems.
System performance Customize system parameters to optimize performance.
Time synchronization Configuring time synchronization for monitoring devices.
Trends configuration Configure Trends in Web Applications.
Software modules:
Module Application
Backup Power Module Generator and Uninterruptible Power Supply (UPS) performance
configuration monitoring and reporting, including battery health.
Breaker Performance
Circuit breaker aging and breaker settings monitoring.
Module configuration
Generator and Uninterruptible Power Supply (UPS) capacity
Capacity Management
monitoring and reporting. Includes transformer and UPS loss
Module configuration
monitoring.
Energy Analysis
Gadgets for identifying consumption patterns and anomalies and
Dashboard Module
for comparing different consumers over time.
configuration
Energy Analysis Reports Reports for energy consumption monitoring and modeling,
Module configuration including energy usage by process area or by product output.
Module Application
Energy Billing Module Energy-based billing and reporting, including consumption
configuration monitoring and reporting at the branch circuit level.
Event Notification Module
Notifications of power system events via email, SMS, or SNMP.
configuration
Insulation Monitoring Monitoring for isolated power systems, such as the ones found in
Module configuration hospital operating rooms.
Power Quality
Analysis of power quality events and disturbances and their
Performance Module
impact on the monitored system.
configuration
Tool Task
Configure the Breaker Aging Module and the Breaker Settings
Breaker Configuration Tool
report.
Designer Configure ION devices and the VIP.
Device Manager Add and manage devices and sites.
Device Replacement Configure processed measurement and device replacement.
Device Type Editor Create device drivers for Modbus and OPC devices.
Downstream Device
Manage downstream devices.
Assistant
Event Watcher Manager Define events to trigger report subscriptions.
EWS Client Configure the EWS client to import EWS server data.
Generator Performance
Configuration Tool with Configure the Multi-Source Management Module.
EPSS Test Module
Generator Power
Configure the Multi-Source Management Module.
Configuration Utility
Hierarchy Configuration
Bulk configure Hierarchies.
Utility
Configure and maintain Hierarchies, Apportioned Meters, Virtual
Hierarchy Manager
Meters.
Perform the following tasks: Reconfigure, Reset Accounts, Export
Installer
System Key, Import System Key, Uninstall
Insulation Monitoring
Configure the Insulation Monitoring Module for ANSI applications.
Configuration Tool for ANSI
Insulation Monitoring
Configure the Insulation Monitoring Module for IEC applications.
Configuration Tool for IEC
Log Viewer View system events for troubleshooting and auditing.
Tool Task
Logical Device editors Create logical device types and logical devices.
Setup the device network, create Managed Circuits, configure
Management Console
Connection Schedules.
Manually edit logged measurement data to correct incorrect data
Manual Data Editor
or add new data.
OPC DA measurement
Define which measurements to expose to the OPC DA server.
support
OPC UA measurement
Define which measurements to expose to the OPC UA server.
support
Power Losses
Configure the Power Efficiency Module.
Configuration Utility
PQDIF Exporter Export Power Quality data to PQDIF format.
Rate Editor Configure rates for billing reports.
Configure dialup modems that will be connected to meters at
Remote Modem Setup
remote locations.
Software Logging Add or edit software based data logging for Modbus device types.
Set up a system use notification to be displayed before users can
System use notification
log into the system.
Time of Use Editor Define Time of Use schedules for reports.
Update EWS Server Update EWS measurement mappings.
Update OPC Server Update OPC measurement mappings.
Upload Report Template Upload report template
UPS Configuration Tool Configure the Multi-Source Management Module.
UPS Power Configuration
Configure the Multi-Source Management Module.
Utility
User Manager Configure Users and User Groups.
Virtual Processor service Configure the VIP to perform data processing and control
(VIP) functions.
Virtual Processor setup Configure the VIP service.
Configure Web apps localization, EcoStruxure Web Services
Web Applications settings Login, Diagnostics and Usage, Report Themes, Alarm Viewer,
Annunciator and more.
ASCO Automatic Transfer Configure the communication details for devices within ASCO
Switch Configuration Tool Automatic Transfer Switches.
References:
Topic Content
Links to reference information related to the content of the
Configuration References
Configuring chapter.
Alarms configuration
TIP: You can open the alarm viewer from the ALARMS link in the Web Applications banner.
Use the Alarms application to view incidents, alarms and events. You access the information in
the Alarms application through views which are saved in the view library. PME comes with several
pre-configured system views. These system views cannot be deleted or modified, but you can
create additional views and customize them to meet your needs.
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.
• Deactivating alarms
1. In the alarm viewer, open the view library and navigate to the folder where you want to
create the view.
(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.
NOTE: The System Views folder is read-only. You cannot add folders or alarm views to the
System Views folder.
2. In the view library, at the bottom of the panel, click Add View , or click Add View in the
Options menu at the top of the library. This creates a new view and opens the view
settings.
3. In View Settings, enter a view name, select a location where to save the view in the library,
set access permissions, and select the view type.
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 for details.
4. Adjust the filter settings for Priority, State, Sources, and Categories to customize the view if
necessary.
NOTE: Not all of these filters are available for all view types.
1. In the alarm viewer, open the view library and navigate to the view you want to copy.
2. Right-click the view name or click Options for this view 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 view library, select the new view, right-click the view name or click Options
for this view, and select Edit to open View Settings. You can also open View Settings by
double-clicking the view name. Change the view name, location, access permissions and
view type, and adjust the filter settings for Priority, State, Sources, and Categories to
customize the view if necessary.
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 for details.
NOTE: Not all of these filters are available for all view types.
NOTE: To add a copy of a system view, use Copy To to create a copy in a different location. You
can also open the System View for Edit and then click Save as New in the view settings to
create a copy in View Library > Home. You cannot use Duplicate because the System Views
folder is read-only.
Related topics:
• Adding a new Alarms view
• Deactivating alarms
1. In the alarm viewer, open the view library and navigate to the view you want to copy.
2. Right-click the view name or click Options for this view 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 view library, select the new view, right-click the view name or click Options
for this view, and select Edit to open View Settings. You can also open View Settings by
double-clicking the view name. Change the view name, and adjust the filter settings for
Priority, State, Sources, and Categories to customize the view if necessary.
NOTE: Not all of these filters are available for all view types.
NOTE: You cannot Duplicate a system view because the System Views folder is read-only. Use
Copy To instead to create a copy in a different location.
Related topics:
• Adding a new Alarms view
• Deactivating alarms
NOTE: You cannot overwrite system views. If you edit the settings of a system view and click
Save as New, a copy of the view is created in View Library > Home.
1. In the alarm viewer, open the view library and navigate to the view you want to edit.
2. Right-click the view name or click Options for this view and select Edit to open View
Settings. You can also open View Settings by double-clicking the view name. Change the
view name, location, access permissions and view type, and adjust the filter settings for
Priority, State, Sources, and Categories to customize the view as necessary.
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 for details.
NOTE: Not all of these filters are available for all view types.
Related topics:
• Adding a new Alarms view
• Deactivating alarms
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.
1. In the alarm viewer, open the view library and navigate to the view you want to share.
2. Right-click the view name or click Options for this view and select Share. This opens the
Share View window.
3. In Share View, select the user groups you want to share this view with.
(Optional) Specify a name for the shared view. The groups you are sharing this view with will
see this name. The name of the original view 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:
• Adding a new Alarms view
• Deactivating alarms
1. In the alarm viewer, open the view library and navigate to the view you want to move.
2. Right-click the view name or click Options for this view and select Move To. This opens
the Select Location window.
3. In Select Location, select the location you want to move this view to.
NOTE: You cannot move system views or the System Views folder.
Related topics:
• Adding a new Alarms view
• Deactivating alarms
1. In the alarm viewer, open the view library and navigate to the view you want to delete.
2. Right-click the view name or click Options for this view, and select Delete
3. In Delete Content, click Yes, to delete the view from the view library.
NOTE: You cannot delete system views or the System Views folder.
Related topics:
• Adding a new Alarms view
• Deactivating alarms
NOTE: Access to this application or function is controlled by user privileges. See Default User
Access Level Privileges and Customizing Access Level Privileges for details.
1. In the alarm viewer, open the view library and navigate to the view you want to set as default.
2. Right-click the view name or click Options for this view and select Set as default. This
opens the Configure Default Item dialog.
Related topics:
• Adding a new Alarms view
• Deactivating alarms
Deactivating alarms
Active alarms can continue to appear in the Alarms viewer if, for example, an alarm dropout has
not been configured, or a device has been removed from the network after an alarm was issued.
In such cases you can use the Deactivate Alarms utility to remove these permanently active
alarms from the Alarms viewer.
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: There can be a time delay between submitting a deactivation request with this utility and
when the alarm is deactivated in the system.
1. Open Management Console and select Tools > Deactivate Alarms to open the dialog.
2. Select a date for the Show Active Alarms older than field if you want to change the default
date.
3. Click Load Active Alarms to display a list of the active alarms that are older than the date
specified.
4. Use the Select column to select the alarms that you want to set to an inactive state. You can
also click Select All to select all the alarms displayed in the grid. Use Select None to clear
the selection of any alarms listed.
NOTE: The Active column displays N for all alarms set to the inactive state.
NOTE: Allow a few minutes of time for the alarm to be deactivated in the system. There can
be a time delay between submitting a deactivation request with this utility and when the
alarm is deactivated in the system.
6. Click Done to close the Deactivate Alarms dialog and then close Management Console.
When you log in to Management Console again and open the Deactivate Alarms dialog,
the number of alarms shown in the Alarms Displayed field matches the number in the
Alarms Displayed field in the All Active Alarms view in the Alarms application. (The
Alarms application is available in the Web Applications component.)
Related topics:
• Adding a new Alarms view
• Deactivate alarms
Cybersecurity
This section provides information on how to help secure your system during the Configuring
phase.
See Data encryption for information on data encryption, at rest and in transit, in PME.
NOTE: Only the communication between the PME application server and the database server
will be encrypted, not the data in the database.
NOTE: The use of self-signed certificates is supported but we recommend that you use a
certificate from a certification authority.
1. Install a Server Authentication certificate from a public certification authority on the SQL
Server computer.
2. Take PME out of service by informing system users of the outage and disabling any
automated system control or third-party interactions.
6. Confirm that the PME application server computer can verify the ownership of the certificate
used by the SQL Server computer.
7. Restart PME, verify the correct operation of the system, and put the system back into
service.
• See TLS 1.2 support for Microsoft SQL Server, a Microsoft document, for information on TLS
1.2 support in different versions of SQL Server.
When you deploy allowlisting software to help protect a system, it scans the system and creates a
allowlist of all executable binaries and scripts present on the system. The allowlist also includes
hidden files and folders.
The allowlist includes all authorized files and determines trusted or known files. In Enabled mode,
only files that are present in the allowlist can execute. All files in the allowlist are protected and
cannot be changed or deleted. An executable binary or script that is not in the allowlist is said to
be unauthorized and is prevented from running.
Consider the following when using allowlisting software with PME:
• Complete the system configuration before setting up and enabling the allowlisting software.
• Any program or script that should be able to update the system will need to be configured as
an updater.
• After solidification, no updates or extensions, such as add-on device drivers, may be installed.
• Disable the allowlisting software when making changes to the PME system. Enable it again
after the change.
• Follow the instructions of the software vendor for installing, configuring, and operating the
allowlisting software.
NOTE: Verify the correct operation of your PME system after you enable the allowlisting
software.
NOTE: Antivirus software can have a significant impact on system performance if it is not set up
correctly. Consider the following:
• SQL Server performance can be affected if data and log files are not excluded from on-
access scans.
• Special configuration of the antivirus software might be required.
• Follow the instructions of the software vendor for installing, configuring, and operating the
antivirus and allowlisting software.
users and groups for integration with Windows and Active Directory.
RECOMMENDATION: Use Windows users instead of standard users in your PME system to
improve cybersecurity. Windows offers the advanced user management function of limiting the
number of invalid login attempts. This function is required for IEC 62443 compliance, the global
standard for industrial automation control system security.
For information on creating users and user groups, and on setting user access levels, see User
Manager.
RECOMMENDATION: Remove the PME Web Applications shortcuts from the server.
Dashboards configuration
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.
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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• Editing a gadget
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 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. See Styling a dashboard for more details.
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 for details.
Related topics:
Dashboards:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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. For dashboard styling, see Styling a dashboard for more details.
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 for details.
Related topics:
Dashboards:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• 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:
• Adding a new dashboard
• Editing a dashboard
• Sharing a dashboard
• Moving a dashboard
• Deleting a dashboard
• Configuring a slideshow
Gadgets:
• Adding a gadget to a dashboard
• Editing a gadget
Database maintenance
PME uses databases to store information such as system configuration, data logs, and system
event log messages. These databases must be maintained to preserve performance, manage
disk space use, and guard against data loss in case of database failure.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
The following table shows the PME databases and the recommended database maintenance
tasks for each:
In Standalone PME systems, the database maintenance tasks are pre-configured and scheduled
to run automatically by default. For Distributed Database PME systems, you need to configure the
tasks and set up the schedules manually.
NOTE: It is best to automate the maintenance tasks, but you can run them manually on demand
using Database Manager and Microsoft SQL Server Management Studio.
The following table shows the default database maintenance task schedules for Standalone PME
systems:
* The PME archive task does not trim the database, it only copies data to the archive.
** You need to edit the Windows user account settings before enabling the archive task. See the
Note on the ION_Data archive task for more details.
*** Size Notification is only used for systems with SQL Server Express, which has a maximum
database size limit of 10 GB.
For more information on the default task settings see Default maintenance task settings.
NOTE: The archive task for the ION_Data database is disabled by default. The Windows user
account that is used to run this task must have a sysadmin server role in the SQL Server
database server. The Windows user account that is used by default, IONMaintenance, does not
have a sysadmin server role. To enable and run the scheduled archive task successfully, you
need to add the sysadmin role to IONMaintenance, or change the user account that is used to
run this task to an account with sysadmin role. See Database maintenance account
requirements for more information on account requirements.
To edit the task schedule settings (enable or disable tasks, set trigger times):
NOTE: The database maintenance tasks in Task Scheduler are configured to run using the
IONMaintenance Windows user account. To save any changes to the task settings in Task
Scheduler, you need to enter the password for the IONMaintenance account. See Using
IONMaintenance for database maintenance tasks for information on where to find the password.
2. In the Task Scheduler Library, open the Schneider Electric > Power Monitoring Expert
folder to see the configured database maintenance tasks.
b. To edit task settings, double-click a task and make the desired changes in the Job
Properties dialog box.
4. (Optional) Select Enable All Tasks History in the Actions pane in Task Scheduler. This
turns on event recording for the scheduled tasks, which is useful for auditing and
troubleshooting.
To edit the task script settings (change backup and archive location, set the data to keep on trim,
size notification threshold):
2. Change the values of the variables in the script file for the settings you want to change. The
following settings can be customized:
NOTE: Follow the instructions in the script file on formatting and syntax.
3. Save the script file changes and close the text editor.
NOTE: The following sections describe how to set up the different database maintenance tasks,
except for the archive task for ION_Data. See Setting up the ION_Data archive task for
Distributed PME systems for instructions on how to set up this task.
Step 1: Creating a Windows user account to run the maintenance tasks. See Database
maintenance account requirements for more information on the account requirements.
NOTE: This requires downloading the framework installer from Microsoft or copying it from the
PME installation DVD/ISO.
NOTE: This requires copying files from the PME application server to the database server.
1. On the database server, create a new Windows user as a member of the Users group, for
example PMEMaintenance.
NOTE: You will need the password for this account during the initial task setup, and later if
you want to edit the tasks in Task Manager in the future.
3. In the Local Security Policy tool, open the policy settings list in Security Settings > Local
Policies > User Rights Assignment.
4. Add the new Windows user to the following policies: Deny log on locally and Log on as a
batch job.
7. Add the new Windows user as a database Login with the following roles and mappings:
Database Role
ApplicationModules db_backupoperator; db_ddladmin; Maintenance; public
ION_Data db_backupoperator; db_ddladmin; Maintenance; public
ION_Network db_backupoperator; db_ddladmin; Maintenance; public
ION_SystemLog db_backupoperator; db_ddladmin; Maintenance; public
NOTE: You will need the password for this account if you want to edit the tasks in Task Manager
in the future, after the initial setup.
1. Check if the framework is already installed on the database server. To do this, find the
following registry key: HKEY_LOCAL_
MACHINE\SOFTWARE\WOW6432Node\Microsoft\Microsoft SQL Server\.
If this key includes a Data-Tier Application Framework key, then the framework is
installed. Continue with Step 3 - Installing and configuring the Windows PowerShell script
files
If this key does not include a Data-Tier Application Framework key, then the framework is
not installed. Continue with the installation of the framework.
NOTE: You can also find the framework installer (DacFramework.msi) on the PME
DVD/ISO under Setup\SetupSupport\database.
1. On the database server, create a new folder. You can choose the location and folder name,
for example C:\PME_Database_Maintenance.
4. Change the values of the folder path variables in the script file to the new folder path as
follows:
a. Change the value of $customUserDirectory (line 28 in the script) to <New Folder
Path>\dbScheduledTasks\Support, for example C:\PME_Database_
Maintenance\dbScheduledTasks\Support. The default value is
C:\PMEDBs\dbScheduledTasks\Support.
c. (Only if you are using Windows Integrated Authentication) Change the value of
$pmeUsingIntegratedAuth (line 32 in the script) to 1. The default value is 0.
7. Change the value of the backup and archive folder path variables in the script file to the new
folder path as follows:
a. Change the value of $locationForBackupFiles (line 46 in the script) to <New Folder
Path>\Backups\, for example C:\PME_Database_Maintenance\Backups\. The
default value is ..\Database\Backup\.
8. Save the script file changes and close the text editor.
2. (Optional) In the Task Scheduler Library, create a new folder for the PME database
maintenance tasks, for example Task Scheduler Library > Power Monitoring Expert.
NOTE: For setting up the archive task for ION_Data, see Setting up the ION_Data archive
task for Distributed PME systems
Use the following information to create the tasks. Replace the variables with the specific
settings shown in the task settings table below.
Name: <task_name>
Security options: Set the Windows user account created in Step 1 to run the task.
Security options: Select Run whether user is logged on or not.
Trigger: <trigger_time>
Action: Select Start a program.
Action: Program/script:
C:\Windows\syswow64\WindowsPowerShell\v1.0\powershell.exe
Action: Arguments: -noninteractive -nologo -file "<New Folder
Path>\DbScheduledTasks\<script_name>" -DatabaseIdentifier <DB ID>
NOTE: Valid settings for the <task_name>, <trigger_time>, <script_name>, and <DB ID>
variables are given in the Task Settings table below.
NOTE: The task names and trigger times shown in the table are recommendations. You
can choose different names or triggers if necessary.
Task Settings
Task Name: [ApplicationModules] - Backup - Job
ApplicationModules
Trigger Time: Daily at 01:30 (1:30 AM)
backup
Action: Arguments: Script Name: Backup.ps1, DB ID: APPS
Task Name: [ApplicationModules] - MAINTENANCE - Job
ApplicationModules
Trigger Time: Daily at 03:30 (3:30 AM)
maintenance
Action: Arguments: Script Name: DatabaseMaintenance.ps1, DB ID: APPS
Task Name: [ApplicationModules] - TRIM - Job
ApplicationModules
Trigger Time: Daily at 02:30 (2:30 AM)
trim
Action: Arguments: Script Name: TrimDiagnostics.ps1, DB ID: APPS
Task Name: [ION_Data] - BACKUP - Job
ION_Data backup Trigger Time: Weekly at 00:00 (12:00 AM) on Fridays
Action: Arguments: Script Name: Backup.ps1, DB ID: ION
Task Name: [ION_Data] - MAINTENANCE - Job
ION_Data
Trigger Time: Daily at 02:00 (2:00 AM)
maintenance
Action: Arguments: Script Name: DatabaseMaintenance.ps1, DB ID: ION
Task Name: [ION_Network] - BACKUP - Job
ION_Network backup Trigger Time: Daily at 01:00 (1:00 AM)
Action: Arguments: Script Name: Backup.ps1, DB ID: NOM
Task Name: [ION_Network] - MAINTENANCE - Job
ION_Network
Trigger Time: Daily at 07:30 (7:30 AM)
maintenance
Action: Arguments: Script Name: DatabaseMaintenance.ps1, DB ID: NOM
Task Name: [ION_SytemLog] - MAINTENANCE - Job
ION_SystemLog
Trigger Time: Daily at 07:05 (7:05 AM)
maintenance
Action: Arguments: Script Name: DatabaseMaintenance.ps1, DB ID: SYSLOG
Task Name: [ION_SytemLog] - TRIM - Job
ION_SystemLog trim Trigger Time: Daily at 04:00 (4:00 AM)
Action: Arguments: Script Name: TrimDiagnostics.ps1, DB ID: SYSLOG
To edit the task script settings (for example to change the backup and archive location or to set
the amount of data to keep in the database on trim), open the Configuration.ps1 script file, as
described in Step 3 and change the values of the variables.
Configurable variables in Configuration.ps1:
Open the Diagrams application from the Diagrams link in the Web Applications banner.
NOTE: To display the correct local time for monitoring device data in the Diagrams application,
you must configure the TZ Offset, DST Start, DST End, and DST Offset settings on the device.
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.
• Diagram Library
Graphics Editor
Use the Graphics Editor to create graphics pages for viewing in Diagrams.
For information on how to configure graphics pages, see the following topics:
• "Adding graphics pages" on page 372
The Graphic Editor loads and displays all the connected devices in the Binding pane.
NOTE: If any devices are added or deleted or renamed in Management Console or Device
Manager, select Refresh Devices to view the latest device list.
2. Double-click on each node to load the Managers, Modules, and Registers supported by
each device type.
3. From the left pane, drag and drop components to create the graphics page.
4. To animate a component in the Graphics Viewer, in the Properties pane set up the
component-specific Custom properties.
5. To edit the Graphics Viewer menus, see the Defining the Graphics Viewer menu structure.
6. Select Save.
NOTE: You can only open or save a file in the following path: ..\Program Files
(x86)\Schneider Electric\Power Monitoring
Expert\config\diagrams\tgml
If a binding property is incorrectly configured on any graphics page, a message appears and
the Validate TGML Document window displays.
8. In the Validate TGML Document window, view any binding issue details by component
Type or Binding Notes. If there are error messages, correct the binding issues in the
Graphics Editor workspace.
9. To validate the TGML document, select Validate TGML Document in the toolbar.
2. On the Graphics Editor screen, in the Components pane, find a standard component that is
the same type as the custom component you want to create:
ATS
Breaker
Meter
Motor
Source
Switch
Transformer
3. Right-click the component, select Duplicate, and then enter a unique name for the new
custom component.
4. Open the My Components category, right-select on the new custom component, and then
select Edit.
A new instance of the Graphics Editor opens with the new custom component selected.
5. Add a Snippet Tooltip if one is not already added to component:
a. Go to Snippets > Basic Functions.
b. Drag the Tooltip snippet onto the custom component in the center pane.
6. In the Objects pane: Open the Group element, and then delete any figures (Line, Ellipse,
etc.) that you do not want in the custom component. To maintain the animations, keep the
Script and all Binds.
NOTE: You must keep the following: Rectangle Background, Conditions, and all existing
custom properties.
1. Right-select the component that you want to edit, and then select Edit.
NOTE: You cannot edit standard components; however, you can edit a standard
component which has been duplicated. For more details, see Adding custom components.
2. Create a background rectangle that is the same size as the component, and then right-click
and select Arrange > Send to Back so it is one of the first objects in the Objects pane.
3. In the Properties pane (under Appearance): Edit the Fill property. You can select None to
make the background transparent or set a Custom Color.
3. In the Properties pane (under Appearance): Edit the Fill property. You can select None to
make the background transparent or set a Custom Color.
NOTE: By default, new TGML files are saved in the TGML folder.
2. Create folders and sub-folders with your desired menu item names and structure, and then
put the TGML files in the respective folders.
The TGML folder and sub-folder names will become menu items appearing in alphabetical
order. The TGML files in each folder will also be listed alphabetically as menu items within
the parent menu item (folder).
NOTE: Any TGML files in a folder will appear first before any sub-folder menu items.
Configuring breakers
To configure a breaker:
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
3. In the Components tab, select Select All, and then select Close.
4. Select a component, and then drag and drop the component to workspace area.
7. Select Apply.
Breaker animations
Previewing breaker graphics
The Graphics Editor includes a preview function you can use to preview the designed TGML.
Select the Bind, and then enter the appropriate value.
NOTE: You should use Uppercase while providing the input in Preview Mode. Example - TRUE
or FALSE.
Examples:
If Breaker Status is TRUE and Breaker Position is Close:
Exposed Properties
When a user selects a component, the following Exposed Properties are available:
• BreakerColorOnClose: The color of a closed breaker. Default color: red.
You can customize Exposed Properties by selecting a property, and then updating it as required:
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not rely solely on the display of the graphic on the one-line.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Source disconnected: If you disconnect the bound source from Management Console or the
Device Manager, the source display color is yellow, and tooltip displays the following warning
message with a warning symbol:
Source deleted or disabled: If you delete or disable the source from the Management Console
or Device Manager, the source displays as a red X. When you hover over the component a tooltip
displays indicating the source is deleted or disabled:
Timeout: When a source is not responding for a specific time interval, a timeout might occur. If
this happens, the source displays as a red X. When you hover over the component a tooltip
displays indicating the source is disabled:
Tooltips
To enable TGML graphics tooltips:
3. Drag and drop the tooltip snippet onto the graphic objects window to see the tooltip feature.
After you drag and drop the tooltip snippet onto the graphic, the Metadata –
TooltipContainer is added to the object properties:
7. Select Apply.
ii. Unit: To set measurement unit value. This value is appended after bind value in the
textbox.
9. Select Save.
2. Draw a Textbox by selecting from the toolbox (from the top menu) onto the workspace:
5. From the drop down, select the appropriate bind. For example: Energy register.
Custom Textbox
function change(evt) {
var baseColor = evt.getCurrentTarget().getParentNode().getParentNode
().getChildNodes().getChildByName("PMEExposed").getAttribute
("BaseColor");
var disconnectedColor = evt.getCurrentTarget().getParentNode
().getParentNode().getChildNodes().getChildByName
("PMEExposed").getAttribute("Fill");
7. Select OK.
8. In the Objects pane: Select Bind. Go to Properties at the bottom right corner and update
the following properties:
a. Format: Presentation.
b. Attribute: Content.
9. To add tooltip:
a. At the bottom left corner, select Snippets.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
8. Select Apply.
11. (Optional) You can change the default color properties by following the below steps:
a. Select the Numeric component / Use the Numeric component.
c. Unit: To set measurement unit value. This value is appended after bind value in the
Numeric box.
c. Change color for below Exposed Properties from top right corner:
a. ColorOnEmergencyCond.
b. ColorOnNormalCond.
NOTE: When PME upgrades from 2023 to 2024, animated and non animated both components
is available in EV component category in Graphic Editor. Use only the animated (EV)
components as PME ends the support for non animated components from next version.
NOTE: The Set Zone Reduction EV component can write values to EVCE over SmartConnector
only. This component doesn’t support write operation to Modbus/ION devices.
2. Expand EV Components.
3. Drag and drop the Set EV Zone Reduction component to the workspace.
6. Select Apply.
7. Select Save and name the file. For example: Set Zone Reduction.tgml.
9. Select Settings > Security, and then select Diagrams Control Options.
10. In the Diagrams Control Options pane: enable Enable manual controls in Diagrams,
select Dialog Box with Password > select Save.
If Enable manual controls in Diagrams is disabled, then the credentials pop-up will not
appear.
12. Select Set EV Zone Reduction.tgml. When you hover over the component, the following
message appears:
13. In the workspace, select on Set EV Zone Reduction tgml. A login window appears.
14. Enter the Username and Password to log in, and then select Next.
15. After you log in, the EWS Client - Send Message dialog appears.
18. Select Until, and then select the date and time value.
19. Select Duration, and then enter the Days, Hours, and Minutes values.
NOTE: When PME upgrades from 2023 to 2024, animated and non animated both components
is available in EV component category in Graphic Editor. Use only the animated (EV)
components as PME ends the support for non animated components from next version.
NOTE: The Set EV Connector Availability component can write values to EVCE over
SmartConnector only. This component doesn’t support write operation to Modbus/ION devices.
2. Expand EV Components.
3. Drag and drop the Set EV Connector Availability component to the workspace.
6. Select Apply.
7. Select Save and name the file. For example: Set Connector Availability.tgml.
9. Select Settings > Security, and then select Diagrams Control Options.
10. In the Diagrams Control Options pane: enable Enable manual controls in Diagrams,
select Dialog Box with Password > select Save.
11. If Enable manual controls in Diagrams is disabled, then the credentials pop-up will not
appear.
When you hover over the component, the following message appears:
14. In the workspace, select Set EV Connector Availability.tgml. A login window appears.
15. Enter the Username and Password to log in, and then select Next.
16. After you log in, the EWS Client - Send Message dialog appears.
A lot of the functionality for opening other items is predefined in TGML snippets. For examples on
how to use the snippets to create linked TGML graphics, see TGML snippet examples.
1. Open the Graphics Editor: Go to Start > Power Monitoring Expert > Graphics Editor.
NOTE: Newly created TGML graphic pop-ups can be used for all the devices. When the
user selects on a breaker in the PME Web Applications, the pop-up displays the same for
all the components, but the values will be different based on the breaker.
Example
The following steps demonstrate how to create a rectangle box and bind it:
1. From the top menu bar select Rectangle, draw on the workspace, and then select the
Objects tab.
2. Go to the TGML, right-click on Rectangle, select New, and then select Bind.
3. Select Bind > press F2 or go to the Properties pane, and then set the value of Format to
Presentation and Attribute to Stroke.
5. Select ConvertText > press F2 or go to the Properties pane, select the appropriate stroke
color, and then set SignalEqualTo to FALSE.
NOTE: To configure other signal values, repeat step 5. For example: TRUE or
DISCONNECTED.
NOTE: If the bind name is used without component, rename the bind to: Device
Name$$Measurement Name$$Handle Number. For a EWS source, rename the bind to:
Device Name$$Measurement Name.
11. Select on the created TGML file in the Diagram Library menu.
The following table explains the error rendering with the respective place holder that appears in
the output Pop-Up as shown in the previous image:
Comm Loss
NA Value -INF
Quality is good Show Value returned by API
PME not running Default Comm Loss
Unknown
For example, when PME is shut down, the default comm loss is shown below:
1. Open the Graphics Editor: Go to Start > Power Monitoring Expert > Graphics Editor.
3. Expand the Basic Controls tab, and then drag and drop the button components to the
workspace.
NOTE:
Button TGML components have a built-in snippet script for opening either in the same tab
or in a new window. You don't need to add additional snippets over the button TGML
components. Instead, select any button component and under the Link Name property, if
the button definition is Open New Window, enter the URL of file you want to open. And, for
all other button components, either give the TGML file name that you want to open on the
select event of that button. For example: tgml\Test1 or the URL of the file.
4. At the bottom left, select Snippets, and then drag and drop Pop-Up onto the Button
component in the workspace.
c. For example, in Diagram Library select on the three dots of any vista diagrams, Open in
New Window, and then copy the highlighted new window URL.
d. Go back to Graphics Editor TGML page, double-select on Link > Object, and then
paste the copied URL.
1. Go back to PME Web Applications page that was already open, and then refresh the page.
URL saved graphic file name is displayed in the Diagram Library menu.
3. Select Button.
1. Open the Graphics Editor: Go to Start > Power Monitoring Expert > Graphics Editor.
3. Expand the Basic Controls tab, and then drag and drop the Button component to the
workspace.
NOTE:
Button TGML components have a built-in snippet script for opening either in the same tab
or in a new window. You don't need to add additional snippets over the button TGML
components. Instead, select any button component and under the Link Name property, if
the button definition is Open New Window, enter the URL of file you want to open. And, for
all other button components, either give the TGML file name that you want to open on the
select event of that button. For example: tgml\Test1 or the URL of the file.
4. At the bottom left, select Snippets, and then drag and drop Pop-Up onto the Button
component in the workspace.
a. Expand the Definitions > Component node to find the Link attribute within the button.
b. Double-click on Link > Object, and then enter the TGML file name without the
extension. Fr example: tgml\Test 1.
NOTE: If the TGML file is placed in another folder inside the tgml folder, then you need
mention all the folder names before the file name using the following format:
...tgml\<sub-folder name>\TGML file name. For example: ...tgml\My
TGML\Test1. Refer to the following image:
1. Go back to PME Web Applications page that was already open, and then refresh the page.
URL saved graphic file name is displayed in the Diagram Library menu.
3. Select Button.
NOTE: TGML Write operation supports on Modbus devices and ION meters with Standard
Security. ION Meters with Advanced Security is not supported in Write Operations via PME Web
Diagrams application.
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 remote equipment without proper access control and
status feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
This section includes examples that configure the following TGML graphic components to perform
write operation.
Prerequisites
Configuring Diagrams Control Options
To configure the Diagrams Control Options in PME:
3. In the Diagrams Control Options pane: select Enable Manual controls in Diagrams.
4. Select the Confirmation Method for control action requests. You can either choose to
select Dialog Box with Password or Dialog Box without Password.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
If you select Operator, Supervisor can access the privileges, but Controller cannot
access the privileges.
If you select Controller, both Operator and Supervisor will be able to access the
privileges.
If you select Supervisor, both Operator and Supervisor can access the privileges, but
Controller will not be able to use the privileges.
8. Select Apply.
13. (Optional) You can change the default color properties by following the below steps:
a. Select the Numeric Control component / Use the Numeric Control component.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
If you select Operator, Supervisor can access the privileges, but Controller cannot
access the privileges.
If you select Controller, both Operator and Supervisor will be able to access the
privileges.
If you select Supervisor, both Operator and Supervisor can access the privileges, but
Controller will not be able to use the privileges.
8. Select Apply.
13. (Optional) You can change the default color properties by following the below steps:
a. Select a new String Control component / use the same String Control component.
g. DisconnectedBorderColor: To set the border color of the String box when source
is disconnected.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
If you select Operator, Supervisor can access the privileges, but Controller cannot
access the privileges.
If you select Controller, both Operator and Supervisor will be able to access the
privileges.
If you select Supervisor, both Operator and Supervisor can access the privileges, but
Controller will not be able to use the privileges.
8. Select Apply.
13. (Optional) You can change the default color properties by following the below steps:
a. Select the Select Control component / use the Select Control component.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
If you select Operator, Supervisor can access the privileges, but Controller cannot
access the privileges.
If you select Controller, both Operator and Supervisor will be able to access the
privileges.
If you select Supervisor, both Operator and Supervisor can access the privileges, but
Controller will not be able to use the privileges.
8. Select Apply.
13. (Optional) You can change the default color properties by following the below steps:
a. Select the Status Control component / Use the Status Control component.
f. DisconnectedColor: To set the color of the Select Control box when source is
disconnected.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
If you select Operator, Supervisor can access the privileges, but Controller cannot
access the privileges.
If you select Controller, both Operator and Supervisor will be able to access the
privileges.
If you select Supervisor, both Operator and Supervisor can access the privileges, but
Controller will not be able to use the privileges.
8. Select Apply.
13. (Optional) You can change the default color properties by following the below steps:
a. Select the Pulse Control component / Use the Pulse Control component.
b. DisconnectedColor: To set the color of the Pulse Control box when source is
disconnected.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
2. Select Preview.
You can preview the real-time control actions in the Preview Mode.
3. Select the saved TGML file in the Diagram Library menu for the Numeric Control write
component.
5. Enter the new value for Source Manager (EL1 Cutoff) and then enter your Login
Credentials.
6. Select OK.
NOTE: You will get a confirmation message that The value was written to the device. This
message is automatically closed within few seconds.
TGML snippets
A snippet is TGML code that stores a behavior for reuse. Several common behaviors are stored in
the Snippets pane.
A snippet can be dragged and dropped onto an object in the Graphics Editor workspace. Objects
can be copied, modified, created and then saved as new snippets in the library.
If you want to add a snippet in Graphics Editor, in Windows Explorer navigate to ...\Program
Files (x86)\Schneider Electric\Power Monitoring
Expert\config\diagrams\tgmlcomponents\SnippetLibraries\Snippets.
This section includes TGML Snippet Examples that demonstrate how to use the snippet types.
Prerequisites
To follow the TGML snippet examples, you need to have a graphic file with a binded component in
the workspace.
b. Select any component and then drag and drop it onto the workspace.
NOTE: If you dragged a Component onto the workspace, the below steps are required.
5. Click Save.
This example uses a graphic file that already has a binded component in the workspace. For more
information on how to prepare the TGML graphic snippet examples, see TGML snippet examples
prerequisites.
To create a Link snippet:
1. In the left bottom corner select Snippet, and then select Link.
2. Drag and drop the Link snippet over the selected component in the workspace.
For example:
3. In the bottom right corner select Objects, and then expand the TGML node.
NOTE: You can also open web diagrams from Link snippet. To open the web diagrams,
copy the URL of web diagram from PME Web Applications, and paste it in the Link section
of graphic editor tool, instead of file name.
NOTE:
If the TGML file is placed in another folder inside the tgml folder, then you need mention all
the folder names before the file name using the following format: ...tgml\<sub-folder
name>\TGML file name. For example: ...tgml\My TGML\Test1. Refer to the
following image:
2. Navigate to Diagrams > Graphic Diagrams, and then select on TGML file.
(https://localhost/Web or https://ipaddress/web).
3. Select the new TGML file from the left panel Diagram Library as shown in the following
image:
This example uses a graphic file that already has a binded component in the workspace. For more
information on how to prepare the TGML graphic snippet examples, see TGML snippet examples
prerequisites.
To create a NewTab snippet:
1. Select Snippets pane in the bottom left corner, and then from the list of snippets select
NewTab.
2. Drag and drop the NewTab snippet over the selected component in the workspace and save
it.
3. In the bottom right corner select Objects, and then expand the TGML node.
2. Select the new TGML file from the left panel Diagram Library as shown in the following
image:
This example uses a graphic file that already has a binded component in the workspace. For more
information on how to prepare the TGML graphic snippet examples, see TGML snippet examples
prerequisites.
To create a NewWindow snippet:
1. Select Snippets pane in the bottom left corner, and then from the list of snippets select
NewWindow.
2. Drag and drop the NewWindow snippet over the selected component in the workspace and
save it.
3. In the bottom right corner select Objects, and then expand the TGML node.
OR
2. Select the new TGML file from the left panel Diagram Library as shown in the following
image:
This example uses a graphic file that already has a binded component in the workspace. For more
information on how to prepare the TGML graphic snippet examples, see TGML snippet examples
prerequisites.
1. Select Snippets pane in the bottom left corner, and then select PopUp.
2. Drag and drop the PopUp snippet over the selected component in the workspace and save
it.
3. In the bottom right corner select Objects, and then expand the TGML node.
NOTE: You can configure only the Vista diagram and other TGML files in the Pop-up
snippet.
NOTE: To open the TGML file, enter the folder name and file name in the Link section,
instead of the URL. For example: tgml\Test 1.
NOTE: If the tgml file is located in another folder inside the tgml folder you need
mention all the folder names before the file name in the following format: tgml\<sub-
folder name>\<file name>. For example: tgml\My TGML\Test1.
2. Select the new TGML file from the Diagram Library from the left hand panel as shown in the
following image:
NOTE:
For Text or Textbox control, you can edit the status text to be displayed.
• ON Text: Active
1. In the workspace draw a textbox or rectangle, select Snippet, and then select Status(Fill).
2. Drag and drop the Status(Fill) snippet over the selected object in the workspace. For
example:
5. Select Apply.
1. In a web browser, log in to PME Web Applications, and then navigate to Diagrams >
Graphic Diagrams.
2. Select the new TGML file from the left panel Diagram Library. The following windows appear
for each device status:
OFF
ON
Disconnected
NOTE:
For Text or Textbox control, you can edit the status text to be displayed.
• ON Text: Active
1. In the workspace draw a textbox or rectangle, select Snippet, and then select Status
(Stroke).
NOTE: The Status(Stroke) snippet can used for other components as well.
2. Drag and drop the Status(Stroke) snippet over the selected object in the workspace. For
example:
5. Select Apply.
1. In a web browser, log in to PME Web Applications, and then navigate to Diagrams >
Graphic Diagrams.
2. Select the new TGML file from the left panel Diagram Library. The following windows appear
for each device status:
OFF
ON
Disconnected
2. From the left pane, drag and drop a component in the Design workspace.
3. Set the various properties to animate the one-line diagram. These properties include such
information as BaseColor and StrokeWidth.
a. All components must have a background rectangle with an opacity of .01
Before you can view your one-line, you must edit the menu structure, which controls the
appearance of the graphics page. For more information, see Defining the Diagrams menu
structure.
For information on how to configure graphics on a one-line, see the following topics:
• "Configuring a transformer" on page 469
Configuring a transformer
To configure a transformer that you added to a one-line in the Graphics Editor:
StrokeWidth: Set the stroke width for the entire component that is selected.
NOTE: The device type specific diagrams are the same as the ones used in the default Vista
network diagram.
NOTE: It takes time for the system to generate the diagrams when you add a new device.
Restart Diagrams after adding a new device to see the new device diagrams.
Related topics:
• Configuring Devices diagrams
• Diagram Library
Note that the Vista component is installed with Power Monitoring Expert on a primary server or
Engineering Client.
To generate a default network diagram in Vista:
1. Start Vista.
Related topics:
• Configuring Devices diagrams
• Diagram Library
1. Open Vista and create a new diagram. Use the Vista tools to create display objects and
embedded graphics as applicable.
Related topics:
• Configuring Devices diagrams
• Diagram Library
NOTE: For each user, Set as my default supersedes Set as system default. For example, if a
user with supervisor-level access sets a diagram as the system default diagram, and another
user sets a different diagram as their default diagram, that user's default diagram takes priority
over the system default diagram, but only for them.
1. In Diagrams, open the Diagram Library and navigate to the diagram you want to set as
default.
2. Right-click the diagram name or click Options for this diagram and select Set as default
to open the Configure Default Item dialog.
Related topics:
• Configuring Devices diagrams
• Diagram Library
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 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 for information on control object
configuration.
4. Click Save.
Related topics:
• Configuring Devices diagrams
• Diagram Library
Diagram Library
Use the Diagram Library to access all the diagrams that you can view in the Diagrams application.
You can add diagrams to the library, edit them, share them, or delete them.
NOTE: You cannot add, edit, share, or delete Devices diagrams. See Configuring Devices
diagrams for details.
NOTE: A network diagram is automatically added to the library when it is generated in Vista. See
Configuring a network diagram for details.
1. In Diagrams, open the Diagram Library and navigate to the folder where you want to create
the diagram.
(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. In the Diagram Library, at the bottom of the panel, click the Add Diagram icon . This
opens the Diagram Settings.
3. In Diagram Settings, enter a diagram name, select a location, and select the diagram you
want to add.
1. In Diagrams, open the Diagram Library and navigate to the diagram you want to copy.
2. Right-click the diagram name or click the Options icon for this diagram and select
Duplicate to create a copy in the same folder. Select Copy To... to create a copy in a
different folder.
(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. (Optional) In the Diagram Library, select the new diagram, right-click the diagram name or
click the Options icon for this diagram and select Edit to open the Diagram Settings.
Change the diagram name.
1. In Diagrams, open the Diagram Library and navigate to the diagram you want to edit.
2. Right-click the diagram name or click the Options icon for this diagram and select Edit to
open the Diagram Settings. Change the diagram name or location.
1. In Diagrams, open the Diagram Library and navigate to the diagram you want to share.
2. Right-click the diagram name or click the Options icon for this diagram and select
Share.... This opens the Share Diagram window.
3. In Share Diagram, select the user groups you want to share this diagram with.
(Optional) Specify a name for the shared diagram. The groups you are sharing this diagram
with will see this name. The name of the original diagram remains unchanged.
NOTE: When you share a diagram with another user group, it appears in the Shared folder of
this group. You cannot share a shared diagram.
1. In Diagrams, open the Diagram Library and navigate to the diagram 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 diagram name or click the Options icon for this diagram and select Move
To.... This opens the Select Location window.
3. In Select Location, select the location you want to move this diagram to.
1. In Diagrams, open the Diagram Library and navigate to the diagram you want to delete.
2. Right-click the diagram name or click the Options icon for this diagram and select Delete
3. In Delete Content, click Yes, to delete the diagram from the Diagram Library.
Related topics:
• Configuring Devices diagrams
• Diagram Library
NOTICE
IRREVERSIBLE OPERATING SYSTEM DAMAGE OR DATA CORRUPTION
Before making any changes, back up your Windows Registry in a network folder or other
remote location.
Failure to follow these instructions can result in irreparable damage to the operating
system of the computer and all existing data.
NOTE: Registry edits must be performed only by qualified and experienced personnel.
The following table lists the optional registry entries you can set for custom functionality.
Modifying system registry keys without the required knowledge or experience in these procedures
can damage the computer's operating system and all existing data.
Related topics:
• Configuring Devices diagrams
• Diagram Library
NOTE: If you access Diagrams from outside the Web Applications framework, through a
browser using the URL https://server_name/ion (where server_name is the fully-
qualified name of the server or its IP address), you are prompted to log in using your Power
Monitoring Expert credentials.
If you have a custom network diagram on the primary server that you want to use instead of the
automatically generated network diagram, you need to modify the registry settings of the
computer where you run the Diagrams application to specify the location of the custom network
diagram.
Modifying system registry keys without the required knowledge or experience in these procedures
can damage the computer's operating system and all existing data.
NOTICE
IRREVERSIBLE OPERATING SYSTEM DAMAGE OR DATA CORRUPTION
Before making any changes, back up your Windows Registry in a network folder or other
remote location.
Failure to follow these instructions can result in irreparable damage to the operating
system of the computer and all existing data.
NOTE: Registry edits must be performed only by qualified and experienced personnel.
3. Right-click NetworkDiagram, select Modify, then type the path and name of your custom
network diagram in the Value data field.
4. Click OK.
For more information, refer to the NetworkDiagram item in the table under Diagrams registry
settings. If there is no NetworkDiagram entry in the registry, then the default value “x-
pml:/diagrams/ud/network.dgm” is used.
The Network Diagram navigation button located on the date range page and the results page is
automatically updated to link to the custom network diagram you specified. However, the Network
Diagram button that exists in each meter user diagram uses a hard-coded link to “x-
pml:/diagrams/ud/network.dgm”. Use Vista to manually update the Network Diagram link in the
meter user diagrams. If you do not have access to Vista, contact your system administrator to
change the link for the grouping object in the network diagram as described below.
Changing the link for the grouping object in the network diagram
1. Start Vista and select Options > Show Toolbox to switch to Edit mode.
2. Right-click the grouping object in the network diagram to open the Grouping Object
Configuration dialog.
4. Click Browse to locate your custom network diagram. Select the diagram filename, then
click Open.
Related topics:
• Configuring Devices diagrams
• Diagram Library
Before you can use these diagrams, you must first configure the Power Quality Performance
module. You must complete the following tasks, as part of the Power Quality Performance module
configuration:
• Deploy the VIP framework for Power Quality Performance using Designer.
• Deploy and configure the Power Quality Performance Indicator and Equipment Vista
diagrams.
• Configure which devices to include and exclude for each type of power quality event and
disturbance.
Related topics:
• Configuring Devices diagrams
• Diagram Library
Before you can use these diagrams, you must first configure the Power Quality Performance
module. You must complete the following tasks, as part of the Power Quality Performance module
configuration for multiple sites:
• Deploy the VIP framework for Power Quality Performance for the sites using Designer.
• Deploy and configure the Power Quality Performance Indicator and Equipment Vista
diagrams for the sites.
Related topics:
• Configuring Devices diagrams
• Diagram Library
TGML performance
PME Web
Total number of Graphics Application
Number of Graphics Editor
Editor TGML Category Average
devices TGML Category type
Type (Components) Response Time
(seconds)
Components (Component
5 50 <1
library)
Components (Component
10 100 <2
library)
Components (Component
50 200 <3
library)
Graphics Editor TGML: 5 tabs currently open on single client (Each tab bind with 500
measurements)
PME Web
Total number of Graphics Application
Number of Graphics Editor
Editor TGML Category Average
devices TGML Category type
Type (Tabs Snippet) Response Time
(seconds)
5 Tabs (Web Applications) 1 <5
10 Tabs (Web Applications) 5 <10
• For Meters with Firmware V4.5 and has Advanced Security and Legacy security support
enabled, the Meter Password should be set as Non-Zero. Also, the Username is not
editable, it is Default always.
NOTE: Before proceeding, ensure there is an appropriate real-time source in PME that will
provide the total energy for each zone. This requires aggregating multiple sources using an
Arithmetic Module in a VIP.
3. Select an image of the facility’s floor plan to a new TGML diagram workspace.
1. Select the Polyline tool and the Stroke color to Dark Green.
NOTE: Make sure to enclose the area by completing the Polyline from where it began.
3. Click Properties.
c. Opacity - 0.4
5. Check and confirm that the zone on the floor plan is overlaid in Green.
6. Repeat the steps 1-4 for each EUI Zone on the floor plan.
1. Go to Objects.
2. Select the Polyline Objects > right-click > New > Bind.
3. Go to Properties.
a. Id: Choose the same term used to identify the parent polyline.
b. Name: Set an appropriate real-time source that provides the total energy for the zone.
c. Attribute: Fill
5. Repeat the steps 1-4 to add binding for each remaining EUI Zone.
1. Go to Objects.
3. Go to Properties.
b. AttributeMinValue: #FFFF00
c. AttributeMaxValue: #FF0000
5. Go to Objects.
7. Go to Properties.
b. AttributeMinValue: #FFFF00
c. AttributeMaxValue: #FF0000
9. For each remaining EUI Zone binding, add the same two ConvertRanges by:
b. Go to Objects and then copy the two ConvertRanges from the first EUI Zone binging
and paste into the other EUI Zone bindings.
10. Go to Objects, confirm that each polyline zone has a binding Objects, and that every
binding Objects has two ConvertRange Objects.
Overview
Each EUI Zone requires two setpoints to be configured within each Yellow to Red ConvertRange
Objects, which determines when the zone’s color changes.
• SignalMinValue: It is the average value for the EUI Zone and when the color changes from
green to yellow.
• SignalMaxValue: It is the expected maximum value for the EUI Zone and when’s the color
reaches red.
Color Changing Setpoints for each EUI Zone can be based on custom reduction goals or
historical data and can be determined by generating Power Monitoring Expert reports, such as the
Load Profile report, or creating a trend.
Create a Trend
2. Go to Trends.
3. Open the Trend Library and navigate to the folder where you want to create the trend.
(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.
a. Select a Source and Measurement that equates to those used for the zone on the EUI
Map.
5. Click OK.
The new created Trend with Mean and Max value appears.
7. Go to Objects.
9. Set the following Properties for the selected Yellow to Red ConvertRange:
11. Set the following Properties for the selected Max Red ConvertRange to ensure that the EUI
Zone remains red even if it exceeds the maximum value:
b. SignalMaxValue: Max value multiplied by 100 from the Trend (or equally large value
that will never be actually reached).
12. For each remaining EUI Zone, configure color changing setpoints repeat the step 1-11.
By default, PME does not log duplicate data records in the historical database. It logs one of the
duplicate records in the database, and removes the other records.
Under certain circumstances, for example for audit reasons, or billing applications, it might be
desirable to log all duplicate records. For these applications, PME provides the option to enable
duplicate data logging.
NOTICE
LOSS OF DATA
Back up the database before making manual database edits.
To enable duplicate data collection, set the SaveDuplicates parameter, in the dbo.Registry
table in the ION_Data database, to 1.
NOTE: The duplicate entries are stored in the DataLog2Duplicate table in the ION_Data
database. You can access this data through the following reports, or through direct database
access: Trend Report, Tabular Report, Data Export - Standard, and Data Export - Extended.
EWS Client
TIP: You can open EWS Client from SETTINGS > Security > Integrations > EWS Client 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.
Use EWS Client to configure EWS Client and map device, measurement, monitor the real time
data, and / or alarm data of EWS sever with PME.
Once the mapping is complete, you can use the EWS device, measurement, and / or alarm data
to view alarms, historical trends, key performance indicators, gadgets, reports, real time data, and
other information from the EWS server you are monitoring using PME web applications.
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 EWS Client, click Configure EWS Client. This opens the Configure EWS Client dialog.
2. In Configure EWS client, under EWS Client Details, enter the required information such as
client name.
3. (Optional) In Configure EWS client, under EWS Client Details, enter Description
information.
4. In Configure EWS client, under EWS Server Authentication, enter the required information
such as server URL, server user name, and server password.
5. (Optional) In Configure EWS client, under EWS Server Authentication, click Test
Authentication to test the connection with the server.
6. In Configure EWS client, under EWS Server Polling, enable or disable historical data polling
and / or alarm data polling. If enabled, select the polling interval in seconds.
If alarm polling is enabled, perform the alarm priority mapping of the EWS server with PME.
Set the Start value of Low and Medium of EWS server to map with the Low and Medium
value of PME alarm. The End value of Low and Medium are adjusted automatically. Set the
End value of EWS server to map with the End value of PME alarm.
7. Click Next. This opens the Device and Measurement Mapping dialog.
NOTE: EWS server devices are not automatically mapped to PME devices. Some of the
EWS server measurements are mapped to PME measurements. See Automated
measurement mapping of EWS Client for more details on automated measurement
mapping. See Customize measurement mapping of EWS Client for more details on
customizing measurement mapping. By default, all the device, measurement, and alarm
mapping are disabled.
To map to new device, enter the required information such as group name. Select
the time zone from the drop down list.
NOTE: The new group 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
devices.
c. Click OK.
NOTE: All the similar measurements are mapped during mapping of the individual
measurement. For example, if "Voltage" is associated with "Device1" and "Device2".
When mapping is performed for "Voltage" associated with "Device1", the same
mapping applies to "Voltage" associated with "Device2".
To create and map to new measurement, under New Measurement, enter the name
of the measurement. Click Create. Optionally, update if the measurement is
cumulative, edit unit, and time rollup options.
c. Under Associated Devices, enter the measurement scale for the listed associated
devices.
d. Click OK.
NOTE: You can use alarm mapping if you want a different alarm name for PME other than
the alarm name from EWS sever.
a. In the mapping table, select the row of an alarm for which you want to map, and then
click Map in this row. This opens the Map Measurement dialog.
b. In Map Measurement, under Existing Measurements, select Alarms to see the list of
PME alarm names.
d. Click OK.
Related topics:
• Configuring EWS Client
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 EWS Client table, select the row of the EWS client for which you want to edit, and then
click Edit in this row. This opens the Re-configure EWS Client dialog.
4. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
6. Click OK.
Related topics:
• Configuring EWS Client
NOTE: When an EWS client is deleted, the configuration and mapping is also deleted.
1. In EWS Client table, select the row of the EWS client for which you want to delete, and then
click Delete in this row.
Related topics:
• Configuring EWS Client
1. In EWS Client table, select the row of the EWS client for which you want to disable, and then
click Edit in this row. This opens the Re-configure EWS Client dialog.
4. Click OK.
1. In EWS Client table, select the row of the EWS client for which you want to enable, and then
click Edit in this row. This opens the Re-configure EWS Client dialog.
4. Click OK.
Related topics:
• Configuring EWS Client
1. In EWS Client table, select the row of the EWS client for which you want to remap, and then
click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
To remap to new device, enter the required information such as group name. Select
the time zone from the drop down list.
NOTE: The new group 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
devices.
NOTE: The time zone changes of the device does not reflect automatically in
Management Console or Device Manager. You need to manually update the
device time zone in Management Console or Device Manager.
c. Click OK.
4. Click OK.
1. In EWS Client table, select the row of the EWS client for which you want to remap, and then
click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
NOTE: All the similar measurements are mapped during remapping of the individual
measurement. For example, if "Voltage" is associated with "Device1" and "Device2".
When remapping is performed for "Voltage" associated with "Device1", the same
remapping applies to "Voltage" associated with "Device2".
To create and map to new measurement, under New Measurement, enter the name
of the measurement. Click Create. Optionally, update if the measurement is
cumulative, edit unit, and time rollup options.
c. Under Associated Devices, enter the measurement scale for the listed associated
devices.
d. Click OK.
4. Click OK.
NOTE: You can use alarm mapping if you want a different alarm name for PME other than the
alarm name from EWS sever.
1. In EWS Client table, select the row of the EWS client for which you want to remap, and then
click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
b. In Map Measurement, under Existing Measurements, select Alarms to see the list of
PME alarm names.
d. Click OK.
4. Click OK.
Related topics:
• Configuring EWS Client
TIP: Select Delete All Mapping to delete all the device, measurement, and alarm mapping.
1. In EWS Client table, select the row of the EWS client for which you want to delete device
mapping, and then click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of the device mapping for which you
want to delete, and then click Delete in this row.
1. In EWS Client table, select the row of the EWS client for which you want to delete
measurement mapping, and then click Edit in this row. This opens the Re-configure EWS
Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of the measurement mapping for
which you want to delete, and then click Delete in this row.
1. In EWS Client table, select the row of the EWS client for which you want to delete alarm
mapping, and then click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of an alarm mapping for which you
want to delete, and then click Delete in this row.
Related topics:
• Configuring EWS Client
NOTE: By default, all the device, measurement, and alarm mapping are disabled.
TIP: Select Enable All Mapping to enable all the device, measurement, and alarm mapping.
1. In EWS Client table, select the row of the EWS client for which you want to enable device
mapping, and then click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of the device mapping for which you
want to enable, and then turn on the enabled option.
4. Click OK.
NOTE: On device enabled, the associated measurement(s) and alarm(s) are enabled.
1. In EWS Client table, select the row of the EWS client for which you want to enable
measurement mapping, and then click Edit in this row. This opens the Re-configure EWS
Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of the measurement mapping for
which you want to enable, and then turn on the enabled option.
4. Click OK.
1. In EWS Client table, select the row of the EWS client for which you want to enable alarm
mapping, and then click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of an alarm mapping for which you
want to enable, and then turn on the enabled option.
4. Click OK.
TIP: Select Disable All Mapping to disable all the device, measurement, and alarm mapping.
1. In EWS Client table, select the row of the EWS client for which you want to disable device
mapping, and then click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of the device mapping for which you
want to disable, and then turn off the enabled option.
4. Click OK.
NOTE: On device disabled, the associated measurement(s) and alarm(s) are disabled.
1. In EWS Client table, select the row of the EWS client for which you want to disable
measurement mapping, and then click Edit in this row. This opens the Re-configure EWS
Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of the measurement mapping for
which you want to disable, and then turn off the enabled option..
4. Click OK.
1. In EWS Client table, select the row of the EWS client for which you want to disable alarm
mapping, and then click Edit in this row. This opens the Re-configure EWS Client dialog.
2. In Re-configure EWS Client, select the Device and Measurement Mapping tab.
3. In Device and Measurement Mapping, select the row of an alarm mapping for which you
want to disable, and then turn off the enabled option..
4. Click OK.
Related topics:
• Configuring EWS Client
Licensing configuration
Power Monitoring Expert (PME) is a proprietary software that uses licensing to control its use and
distribution. To use PME, you must purchase software licenses and activate them in the system.
PME uses a modular licensing structure where different licenses enable different functions in the
software. Some of these functions are optional, others are required. The licenses are cumulative,
meaning that you can add additional licenses to a system, to enable additional functionality.
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.
• Returning a license
• Refreshing a license
For information related to license planning, see the Licensing section in the Planning chapter of
this guide.
For reference information see:
• License Configuration Tool user interface
Activating a license
Activate a license to enable the use of the system after a new install, an upgrade, or a migration.
Activate licenses to enable features, such as software modules, or additional monitoring devices.
You can activate licenses online, directly from the PME server if it has an Internet connection. You
can also activate licenses offline, from an alternate internet connected computer or smartphone.
In both cases you use License Configuration Tool to activate licenses.
NOTE: You must have a valid Activation ID to activate a license. See Licensing process for more
information.
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.
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.
NOTE: The instructions shown on the activation method page are the same as the
instructions provided here, in this document.
4. On Initiate section, enter the Activation ID and select the location to save the activation
request file. Click Download.
NOTE: Contact Technical Support for help regarding the login. See Licensing resources
for contact information.
10. In Offline Device Management page, click Choose File, and then select the
capabilityrequest.bin file, and click Upload.
11. In Download my License Response File window, click Download to save the
capabilityresponse.bin file.
TIP: If you are using a smartphone, try using a USB cable to copy the file.
13. 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.
16. On Complete section, select the location of the capabilityresponse.bin file, and click
Activate.
• Activating a license
• Returning a license
• Refreshing a license
Returning a license
Return a license before migrating a system. When you migrate a system, you must first return the
license on the old system before you can activate it again on the new system. This includes the
case where you re-install Power Monitoring Expert (PME) on the same server after the operating
system has been reinstalled.
You can return licenses online, directly from the PME server if it has an Internet connection. You
can also return licenses offline, from an alternate internet connected computer or smartphone. In
both cases you use License Configuration Tool to return licenses.
NOTE: Write down the Activation ID of the licenses before you return them. You need the ID to
activate the licenses again on the new system. See System migration and license returns for
more details.
NOTE: If you have activated license using online method, you can return the license using online
method only. You cannot use offline method.
1. On the PME server, open the License Configuration Tool, and click Return License.
NOTE: You can access the License Configuration in the install location within
....\Schneider Electric\Power Monitoring Expert\License
Configuration Tool.
The licenses are returned and disappear from the License Configuration Tool.
NOTE: If you have activated license using offline method, you can return the license using offline
method only. You cannot use online method.
1. On the PME server, open the License Configuration Tool, and click Return License.
NOTE: You can access the License Configuration in the install location within
....\Schneider Electric\Power Monitoring Expert\License
Configuration Tool.
NOTE: The instructions shown on the Return Method page are the same as the
instructions provided here, in this document.
4. On Initiate section, select the location to save the return request file. Click Download.
NOTE: Contact Technical Support for help regarding the login. See Licensing resources
for contact information.
10. In Offline Device Management page, click Choose File, and then select the
capabilityrequest.bin file, and click Upload.
11. In Download my License Response File window, click Download to save the
capabilityresponse.bin file.
TIP: If you are using a smartphone, try using a USB cable to copy the file.
13. On the PME server, open the License Configuration Tool, and click Return License.
TIP: You can access the License Configuration in the install location within
....\Schneider Electric\Power Monitoring Expert\License
Configuration Tool.
16. On Complete section, select the location of the capabilityresponse.bin file, and click
Return.
The licenses are returned and disappear from the License Configuration Tool.
• Returning a license
• Refreshing a license
Refreshing a license
Refresh licenses to enable additional features, such as software modules, or additional
monitoring devices.
You can refresh licenses online only, directly from the PME server if it has an Internet connection.
You use License Configuration Tool to refresh licenses. Offline refresh method is not available.
To refresh a license online:
NOTE: If you have activated license using online method, you can refresh the license using
online method only.
1. On the PME server, open the License Configuration Tool, and click Refresh License.
NOTE: You can access the License Configuration in the install location within
....\Schneider Electric\Power Monitoring Expert\License
Configuration Tool.
• Returning a license
• Refreshing a license
NOTICE
LOSS OF COMMUNICATION
• Activate product and component licenses after deletion 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. In the trial license table, right-click the trial license, and select Delete from the context menu.
3. Click Confirm.
NOTE: After trial license deletion, PME is unusable. You must purchase license and activate for
continuous usage of PME.
• Returning a license
• Refreshing a license
2. In Management Console, click Help > About. This opens the About Application window.
NOTE: You can access the License Configuration in the install location within
....\Schneider Electric\Power Monitoring Expert\License
Configuration Tool.
2. In License Configuration Tool, click License Information. This opens the License
Information window.
3. In License Information, view the feature list, device license usage, and client access license
usage.
You can also see Client Access license information in the User Manager. See Viewing Web
Applications user license information for more details.
• Returning a license
• Refreshing a license
Reports configuration
TIP: You can open Reports from the REPORTS link in the Web Applications banner.
Use the Reports application to generate historical data reports. The reports are saved in the
Report Library. PME comes with many default report templates. Use these default templates to
create new reports or upload your own custom templates. Set up subscriptions to automatically
generate and distribute reports based on a schedule or an event.
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.
For information on how to configure the Reports application, refer to the following topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
1. Open Management Console and select Tools > Reports Configuration to open the dialog.
(Optional) Use the slider in the Report Timeout section to set the time (in seconds)
after which Reports stops trying to complete a report generation task.
3. Click the Subscriptions tab to configure the settings for report subscriptions:
SMTP Server: Enter the IP address of your SMTP server, or the fully-qualified network
server name from which the report subscriptions are emailed.
Username: If required by your SMTP server, enter the Windows user name used to
configure the SMTP server settings.
Password: If required by your SMTP server, enter the password associated with the
Windows user name.
“From” Display Name: (Optional) Type the name that you want to appear in the “From”
field of an emailed report.
“From” Email Address: Type the email address that you want to appear in the “From”
field of the emailed report.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
1. In Reports, open the Report Library and navigate to the folder where you want to add the
report.
(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. In the Report Library, click Add Report at the bottom of the panel, or click Add Report
in the Options menu at the top of the Library. This opens Add Report - Report Template
Selection.
3. In Add Report - Report Template Selection, find and select the report template you want to
use for the new report, and click OK. This opens the report template and the Report Settings
for the new report.
4. In the report template, enter and select the input parameters that you want to use for the new
report.
NOTE: The number and type of input parameters are report template specific.
5. (Optional) Click Generate Report to test the report output and adjust the input parameters if
necessary.
6. In Report Settings, enter a report Name, select a Location and access permissions, and
select which report inputs you want to save with the report.
NOTE: Saved inputs are stored with the report and reused every time the report is
generated. To change saved input values for an existing report, see Editing a report. Inputs
that are not saved must be entered every time the report is generated.
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 for details.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
Copying a report
Copy reports to quickly create new reports that are the same as, or similar to existing reports. For
example, create a copy of a report to experiment with the input parameters without affecting the
original report. You can also use a copy of a report as a starting point for a new report that shares
many of the input settings of the original report.
To copy a report:
1. In Reports, open the Report Library and navigate to the report you want to copy.
2. Right-click the report name or click Options for this report 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 Report Library, select the new report, right-click the report name or click
Options for this report and select Edit to open Report Settings. You can also open Report
Settings by double-clicking the report name. Change the report Name, Location and access
permissions, and the saved Report Inputs to customize the report if necessary.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
Editing a report
Edit reports to update the report name, Location and access permissions, and the saved report
Inputs.
To edit a report:
1. In Reports, open the Report Library and navigate to the report you want to edit.
2. Right-click the report name or click Options for this report and select Edit to open Report
Settings. You can also open Report Settings by double-clicking the report name.
3. Change the report Name, Location and access permissions, and the saved Report Inputs to
customize the report as necessary.
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 for details.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
Moving a report
Move reports to a different location in the Report Library to make them easier to find or easier to
manage.
To move a report:
1. In Reports, open the Report Library and navigate to the report you want to move.
2. Right-click the report name or click Options for this report and select Move To. This
opens the Select Location window.
3. In Select Location, select the location you want to move this report to.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
Deleting a report
Delete reports that are no longer needed.
To delete a report:
1. In Reports, open the Report Library and navigate to the report you want to delete.
2. Right-click the report name or click Options for this report, and select Delete
3. In Delete Content, click Yes, to delete the report from the Report Library.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
Sharing a report
Share saved reports 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.
1. In Reports, open the Report Library and navigate to the report you want to share.
2. Right-click the report name or click Options for this report and select Share. This opens
the Share Report window.
3. In Share Report, select the User Groups you want to share this report with.
(Optional) Specify a name for the shared report. The groups you are sharing this report with
will see this name. The name of the original report 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:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
Subscribing to a report
Subscribe to reports to receive scheduled report outputs or automatically generate reports based
on system events. For example, you can configure a subscription so that a report is generated
monthly and sent via email to a group of people.
NOTE: You can only create a subscription for a report that has all its inputs saved.
1. In Reports, open the Report Library and navigate to the report you want to subscribe to.
2. Right-click the report name or click Options for this report and select Subscribe to open
Add New Subscription.
1. In Reports, open the Report Library and select Manage Subscriptions from the Options
menu at the top of the Library. This opens Manage Subscriptions.
2. In Manage Subscriptions, click Add Subscriptions. This opens the reports list in Add New
Subscription.
3. From the reports list In Add New Subscription, select the reports you want to subscribe to.
Click Next.
4. In Add New Subscription, enter a name for the subscription in the Subscription Name field.
NOTE: This is the name that is displayed in the list when you open Manage
Subscriptions from the Options menu at the top of the Library.
5. Under Output Format, select one of the formats for the report that will be generated.
RECOMMENDATION:
Install 64-bit version of Microsoft Access Database Engine 2016 Redistributable in silent
mode if you want the output in XML format.
Users/Groups tab
The names listed on this tab are the users and groups that have been created in User
Manager. They are listed in alphabetical order. Select Order by Type to order the list
NOTE: The limit for the number of email recipients in a subscription is 100.
File share: Type the location of the computer and folder where you want the report to be
saved. You must type the absolute pathname to the folder (including the drive letter).
The Windows user account “IONUser” must be configured with valid credentials to read
and write to that fileshare. See your system administrator for assistance. To overwrite
an existing report (if one exists in the folder), select Overwrite existing file. To leave an
existing file in the folder and save the report with a new name, clear Overwrite existing
file.
Printer: From the dropdown list, select the printer to which you want to send the report.
NOTE: For printed subscriptions, the printer must be a local printer on the Primary
Server. For information on setting a network printer as a local printer, consult your
server's documentation.
7. In the Subscription Schedule section, select when you want the report to be generated
and delivered. (You can type the date and time in the respective fields without using the
calendar or dropdown lists). The following items include descriptions for using the calendar
and dropdown lists.
On Trigger: Select this option to configure the subscription to run when an event
occurs. Select the event from the Deliver report on trigger list that you want to use to
trigger the subscription. To use this option, you must first configure an Event Watcher.
See the Event Watcher topic in the online help for Management Console Tools for
information on creating an Event Watcher.
Once: Select this option to run the report once at the specified date and time. Click the
Date field or calendar icon to open a calendar and select the date. You can specify the
hours and minutes by typing over the entries or using the dropdown lists. You can also
click Now to set the date and time to the current server time.
Hourly: Select this option to run the report every hour. Select the time from the Deliver
Report dropdown list (for example, on the hour, 15 minutes after the hour, and so on).
Daily: Select this option to run the report once per day at the specified time. Click the
Time of Day field to open the Choose Time dialog, and either type the hours and
minutes in the respective fields or use the dropdown lists to select the hours and
minutes. You can also click Now to set the time to the current server time.
Weekly: Select this option to run the report once per week, on the day of the week and
at the time that you specify. Select the day from the dropdown list for On. Click the Time
of Day field to open the Choose Time dialog, and either type the hours and minutes in
the respective fields or use the dropdown lists to select the hours and minutes. You can
also click Now to set the time to the current server time.
Monthly — Absolute Monthly: Select Monthly then select Absolute Monthly to run
the report on selected days in the calendar month at a specified time. Type the days in
the On calendar day(s) field. Separate multiple dates with a comma. To select a range
of contiguous days, separate the first and last day in the range with a hyphen. For
example, to schedule the report to run on the 1st, 10th to 15th, and 20th days of the
month, type 1, 10-15, 20. After you have entered the days, click the Time of Day field to
open the Choose Time dialog, and either type the hours and minutes in the respective
fields or use the dropdown lists to select the hours and minutes. You can also click Now
to set the time to the current server time.
Monthly — Relative Monthly: Select Monthly then select Relative Monthly to run the
report on a specific day of the week in a selected week of the month at a specified time.
For example, to set the subscription to run on the Monday of the last week of the month,
select Last and Monday from the dropdown lists. Click the Time of Day field to open
the Choose Time dialog, and either type the hours and minutes in the respective fields
or use the dropdown lists to select the hours and minutes. You can also click Now to set
the time to the current server time.
8. (Optional) Click Test Now to test that the report subscription is functioning.
Note that the button is disabled for the Email or Printer delivery options if configuration
errors are detected.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
1. In Reports, open the Report Library and select Manage Subscriptions from the Options
menu at the top of the Library. This opens Manage Subscriptions.
2. In Manage Subscriptions, find the subscription you want to change. All existing
subscriptions are displayed in the subscriptions table.
3. To view the options for the subscription, click Edit Subscription to open the Modify
Subscription dialog.
4. In Modify Subscription, change the options in the dialog and click Save to update the
subscription.
5. Click Close.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
1. In Reports, open the Report Library and select Manage Subscriptions from the Options
menu at the top of the Library. This opens Manage Subscriptions.
2. In Manage Subscriptions, find the subscription you want to delete. All existing subscriptions
are displayed in the subscriptions table.
4. Click Close.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
The tool to upload custom report templates is in Management Console. See the Upload Report
Template topic for information on uploading the custom report template.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
TIP: You can open Software Alarms from the SETTINGS > Alarms > Software Alarms page in
Web Applications or from Management Console > Tools > Web Tools > Alarm
Configuration.
Use Software Alarms to set up software-based alarms in PME. For software-based alarms, the
alarm conditions are defined and monitored in the software instead of on the device. PME
provides Alarm Templates to simplify the configuration of software-based alarms. Software based
alarms can be defined for real-time data or for logged data.
Real-time Alarms
These Alarms are based on real-time data coming from monitoring devices. Reliable
communication links to the devices are required for these Alarms to function correctly. Use real-
time Alarms for alarming on power system operational parameters such as currents and voltages.
Template Notes
Use this alarm to monitor the breaker trip status. Alarms generated
Breaker Status
by this template are categorized as Protection alarms.
Use this alarm to monitor communications between the software
Communication Status and devices. Alarms generated by this template are categorized
as Communication Status alarms.
Use this alarm to monitor phase currents. Alarms generated by
Over Current
this template are categorized as Over Current alarms.
Use this alarm to monitor line to line phase voltages. Alarms
Over Voltage (Line to Line) generated by this template are categorized as Over Voltage
alarms.
Use this alarm to monitor line to neutral phase voltages. Alarms
Over Voltage (Line to
generated by this template are categorized as Over Voltage
Neutral)
alarms.
Use this alarm to monitor Boolean (True/False) values. Alarms
Realtime Digital Setpoint generated by this template are categorized as General Setpoint
alarms.
Use this alarm to monitor analog values. Alarms generated by this
Realtime Setpoint
template are categorized as General Setpoint alarms.
Use this alarm to monitor line to line phase voltages. Alarms
Under Voltage (Line to
generated by this template are categorized as Under Voltage
Line)
alarms.
Use this alarm to monitor line to neutral phase voltages. Alarms
Under Voltage (Line to
generated by this template are categorized as Under Voltage
Neutral)
alarms.
PME provides two types of logged data Alarms: Fixed Setpoint Alarms and Smart Setpoint
Alarms.
Template Notes
Set up Alarms for over or under demand. Demand data logs are
Demand required for this Alarm. Alarms generated by this template are
categorized as Demand alarms.
Set up Alarms for water consumption. Water volume data logs are
Water Consumption required for this Alarm. Alarms generated by this template are
categorized as Water alarms.
Set up Alarms for compressed air monitoring. Air volume data logs
Air Consumption are required for this Alarm. Alarms generated by this template are
categorized as Air alarms.
Set up Alarms for fuel gas monitoring. Gas volume data logs are
Gas Consumption required for this Alarm. Alarms generated by this template are
categorized as Gas alarms.
Set up Alarms for electric consumption. Electric energy data logs
Electricity Consumption are required for this Alarm. Alarms generated by this template are
categorized as Electricity alarms.
Set up Alarms for steam monitoring. Steam volume data logs are
Steam Consumption required for this Alarm. Alarms generated by this template are
categorized as Steam alarms.
Set up Alarms for any logged digital measurement in your system.
Datalog Digital Setpoint
Data logs for the measurement are required for this Alarm.
Set up Alarms for any logged analog measurement in your
Datalog Setpoint system. Data logs for the measurement are required for this
Alarm.
Template Notes
Set up Alarms to monitor the retrieval of data for devices
connected via gateway and also for devices, which is not
Data Log Status
connected to the software all the time. Alarms generated by this
template are categorized as Data Log Status alarms.
See Logged Data Alarms UI (Fixed Setpoint) for information on fixed setpoint logged data Alarm
configuration.
Template Notes
Set up Alarms for over or under demand. Demand data logs are
Demand
required for this Alarm. Alarms generated by this template are
(Smart Setpoint)
categorized as Demand alarms.
Set up Alarms for water consumption. Water volume data logs are
Water Consumption
required for this Alarm. Alarms generated by this template are
(Smart Setpoint)
categorized as Water alarms.
Set up Alarms for compressed air monitoring. Air volume data logs
Air Consumption
are required for this Alarm. Alarms generated by this template are
(Smart Setpoint)
categorized as Air alarms.
Set up Alarms for fuel gas monitoring. Gas volume data logs are
Gas Consumption
required for this Alarm. Alarms generated by this template are
(Smart Setpoint)
categorized as Gas alarms.
Set up Alarms for electric consumption. Electric energy
Electricity Consumption
measurement data logs are required for this Alarm. Alarms
(Smart Setpoint)
generated by this template are categorized as Electricity alarms.
Set up Alarms for steam monitoring. Steam volume data logs are
Steam Consumption
required for this Alarm. Alarms generated by this template are
(Smart Setpoint)
categorized as Steam alarms.
Set up Alarms for any logged analog measurement in your
Datalog Setpoint
system. Data logs for the measurement are required for this
(Smart Setpoint)
Alarm.
See Logged Data Alarms UI (Smart Setpoint) for information on fixed setpoint logged data Alarm
configuration.
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
1. In Software Alarms, select the Alarm Rules tab, and then click Add Alarm Rule to open the
Add Alarm Rule window.
2. In Add Alarm Rule, select the Alarm Template that best matches the Alarm you want to
create. Click Next.
NOTE: Some Alarm Templates have preselected, recommended measurements. You can
accept these recommended measurements, or select your own.
4. Specify an Alarm Name, the Input Evaluation, Active Condition, Inactive Condition, and
Advanced settings. Click Next.
NOTE: For Smart Alarms, specify the Smart Setpoint conditions instead of the Input
Evaluation.
5. Select the sources to which you want to apply this Alarm Rule. Click Next.
NOTE: Source selection is optional for adding a new alarm rule. However, the alarm rule
cannot be enabled until the sources are selected.
6. (Optional) Select an Alarm Schedule that you want to use for this Alarm Rule. Click Next.
You can Add a new Schedule by clicking Add Schedule. See Adding a Schedule for more
information
7. Specify an Alarm Rule name, enable or disable the Rule, and enable or disable real-time
Alarm Status measurements.
NOTE: By default, real-time Alarm Status measurements are disabled, which means that
information about the state of the Alarm is only available through the Alarms application.
Enable real-time Alarm Status measurements if you want to access Alarm state
information in Diagrams, Trends, or other real-time applications in PME. These status
measurements are not currently available in the VIP/Designer.
8. Click Finish.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
2. In the Alarm Rules table, find the row of the Rule which you want to enable or disable , and
then turn Enabled on or off in this row.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
2. In the Alarm Rules table, find the row of the Rule which you want to edit, and then click Edit
in this row to open the Edit Alarm Rule window.
TIP: You can also open the Edit Alarm Rule window by double-clicking the Alarm Rule in
the table or through the Edit command in the right-click context menu.
3. In Edit Alarm Rule, select the tab that contains the settings you want to change.
5. Click Save.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
2. In the Alarm Rules table, find the row of the Rule which you want to duplicate, and then click
TIP: You can also duplicate an Alarm Rule through the Duplicate command in the right-
click context menu.
3. In Edit Alarm Rule, review the Rule settings in the different tabs and update the settings for
the duplicated Rule as needed.
4. Click Save.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
2. In the Alarm Rules table, find the row of the Rule which you want to delete, and then click
Delete in this row. This opens the Delete Alarm Rule confirmation box.
TIP: You can also delete an Alarm Rule through the Delete command in the right-click
context menu.
3. Click Delete.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
1. Click Calculate Values in the Add Alarm Rule - Details window for a new Alarm Rule, or
the Details tab in the Edit Alarm Rule window for an existing Alarm Rule. This opens
Setpoint Calculator.
2. In Setpoint Calculator, enter a baseline value for the measurement you want to monitor in
the Baseline entry field.
For example, for an Over Voltage alarm, assume you enter a baseline value of 480.
3. Enter a percentage value in the On Setpoint entry field to calculate when the alarm is set
ON.
Using the voltage baseline of 480, if you enter a 105 as the percentage value for On
Setpoint, the calculated value is 504, which displays below the entry field.
Initially, the On Setpoint and Off Setpoint entry fields are linked. That is, the value you
enter in On Setpoint is automatically duplicated in the Off Setpoint entry field.
4. To set a different value for Off Setpoint , click the link button to disable the linking of the
entry fields, and then enter a percentage value in the Off Setpoint entry field.
The off setpoint value is calculated and displays below the entry field. For example, using
the voltage baseline of 480, if you enter 95 as the percentage value for Off Setpoint, the
calculated value is 456, which displays below the entry field.
5. Click Apply to add your setpoint values to the respective Active Condition and Inactive
Condition fields, or click Cancel to discard your entries and to close the Setpoint
Calculator.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
Adding a Schedule
Add a Schedule to be used for controlling when Alarm Rules are active and inactive. The new
Schedule will be available in the Select Alarm Schedule selection box in the Add Alarm Rule -
Schedule window for a new Alarm Rule, or the Schedule tab in the Edit Alarm Rule window for an
existing Alarm Rule.
To add a Schedule:
Add Alarm Rule - Schedule window (when adding a new Alarm Rule)
Edit Alarm Rule > Schedule tab (when editing an existing Alarm Rule)
3. Define the active and inactive days and times of the Schedule.
4. Click Save.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
Schedules
Use Schedules to control when an alarm rule is applied or not. Schedules are based on the time of
day and the day of the week. For example, you can set up an Over Demand Alarm with certain
threshold conditions for weekdays, and another Over Demand Alarm with different threshold
conditions for weekends.
The following rules apply to schedules:
• Schedules are applied in the timezone of each source. If an alarm rule has sources from
different timezones, then it is possible for a schedule to be active for some sources, and
inactive for other sources at the same time.
• If an alarm is in the active state when a schedule transitions to inactive, then the alarm is
deactivated.
• Real-time measurement alarms and communication status alarms are only evaluated when
the schedule is active.
• Historical measurement alarms are only evaluated against data that was logged when the
schedule was active.
NOTE: A historical data log timestamp marks the end of the logging interval. For example, a
data log with a 15 minute logging interval and timestamp of 17:00 represents data for the
time interval of 16:45 - 17:00.
Related topics:
• Adding a new Alarm Rule
• Adding a Schedule
• Software Alarms UI
• Schedules Configuration UI
System integration
This section provides information on how to integrate Power Monitoring Expert with other
EcoStruxure™ systems.
Use the links in the following table to find the content you are looking for:
Topic Content
References to Power Operation documentation with integration
Integration with PO
configuration information.
Detailed configuration information on the integration of PME with
Integration with EBO
EcoStruxure Building Operation.
Integration with References to SmartConnector documentation with configuration
SmartConnector information.
For configuration information on this integration see the Power Operation System Guide.
2. Configuring communications
NOTE: These steps are required for both solution architectures, unless specifically called out in
the workflow steps.
PME uses Transport Layer Security (TLS) 1.2 for an encrypted, authenticated connection using
HTTPS between the server and the Web clients.
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 After installing the software for additional recommended post-installation configuration steps.
Building Operation and PME can be installed on the same server (operating system) or on two
separate servers.
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:
Add the power devices to Building Operation. For information on how to add devices to Building
Operation, see the EcoStruxure Building Operation Technical Reference Guide.
Confirm that:
• Enable EWS Server is set to "True"
We recommended you setup a dedicated ETLUser account for EWS in Building Operation.
To create an account:
The PME EWS client connects to the Building Operation EWS server, reads out the required
historical data (Trend logs), and inserts that data into the PME database.
Prerequisites
Before configuring the PME EWS client, confirm that:
• Building Operation is installed and configured.
• 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
• PME is installed and configured
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.
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. In EWS Client, click Configure EWS Client. This opens the Configure EWS Client dialog.
5. In Configure EWS client, under EWS Client Details, enter the required information such as
client name.
6. (Optional) In Configure EWS client, under EWS Client Details, enter Description
information.
7. In Configure EWS client, under EWS Server Authentication, enter the required information
such as server URL, server user name, and server password as follows:
Server URL – Replace localhost:8080 with your <server name>:<https port number>
Server User Name – The Building Operation EWS user name (for example: admin)
8. (Optional) In Configure EWS client, under EWS Server Authentication, click Test
Authentication to test the connection with the server.
9. In Configure EWS client, under EWS Server Polling, enable or disable historical data polling
and / or alarm data polling. If enabled, select the polling interval in seconds.
If alarm polling is enabled, perform the alarm priority mapping of theBuilding Operation with
PME. Set the Start value of Low and Medium of Building Operation to map with the Low and
Medium value of PME alarm. The End value of Low and Medium are adjusted automatically.
Set the End value of Building Operation to map with the End value of PME alarm.
10. Click Next. This opens the Device and Measurement Mapping dialog.
NOTE: Building Operation devices are not automatically mapped to PME devices. Some of
the Building Operation measurements are mapped to PME measurements. See
Automated measurement mapping of EWS Client for more details on automated
measurement mapping. See Customize measurement mapping of EWS Client for more
details on customizing measurement mapping. By default, all the device, measurement,
and alarm mapping are disabled.
To map to new device, enter the required information such as group name. Select
the time zone from the drop down list.
NOTE: The new group 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
devices.
c. Click OK.
NOTE: All the similar measurements are mapped during mapping of the individual
measurement. For example, if "Voltage" is associated with "Device1" and "Device2".
When mapping is performed for "Voltage" associated with "Device1", the same
mapping applies to "Voltage" associated with "Device2".
To create and map to new measurement, under New Measurement, enter the name
of the measurement. Click Create. Optionally, update if the measurement is
cumulative, edit unit, and time rollup options.
c. Under Associated Devices, enter the measurement scale for the listed associated
devices.
d. Click OK.
NOTE: You can use alarm mapping if you want a different alarm name for PME other than
the alarm name from EWS sever.
a. In the mapping table, select the row of an alarm for which you want to map, and then
click Map in this row. This opens the Map Measurement dialog.
b. In Map Measurement, under Existing Measurements, select Alarms to see the list of
PME alarm names.
d. Click OK.
The ETL tool connects to the Building Operation EWS server, reads out the required historical
data (Trend logs), and inserts that data into the PME database. Within the ETL, the task
descriptions required to complete the data copy process are organized into Jobs.
• 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:
• Building Operation is installed and configured.
• 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
• PME is installed and configured
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.
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.
• 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 and Customizing Access Level Privileges for details.
NOTICE
NETWORK INOPERABILITY
Do not make unauthorized changes in the network configuration.
See Setting up your network in Management Console or Device Manager for details on how to
add devices.
After adding the devices or making any changes to the device configuration in the PME, you must
update the EWS server through the Update EWS Server tool in the Management Console.
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 the EWS server configuration was successful.
• Report Theme
• System Language
• System Theme
• Registration
• Login Options
• Session Timeout
• Authorized Hosts
• Billing Rates
• Device Manager
• Device Replacement
• Hierarchies
• Modeling
• System Log
• User Manager
Prerequisites
Before using the PME/EBO Integration Utility, complete the following tasks:
• Install and configure PME.
• (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
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 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
• 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.
NOTE: The PME/EBO Integration is also known as Power Manager. These names refer to the
same solution.
Architecture 1:
Architecture 2:
Prerequisites
Before configuring the EWS server in SmartConnector, confirm that SmartConnector is installed
and configured.
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.
2. Navigate to http://localhost:8082.
5. Click Add New. Pick an assembly page displays. SmartConnector automatically analyzes
the SmartConnector install directory and displays all possible assemblies.
7. Click Next. Choose a class page displays. SmartConnector automatically analyzes the
selected SmartConnector Extension assembly and list all possible classes.
10. In Name EWS server, enter the required information such as Name, Address, User Name,
Password, and Confirm Password as follows:
Name – EWS Server names must be unique within SmartConnector.
Address – Complete URL for the SmartConnector EWS server. For example:
http://localhost:57630/DataExchange.
User Name – Enter the user name for the SmartConnector EWS server.
Confirm Password – Enter the password again to confirm for the SmartConnector
EWS server.
PME uses Transport Layer Security (TLS) 1.2 for an encrypted, authenticated connection using
HTTPS between the server and the Web clients.
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 After installing the software for additional recommended post-installation configuration steps.
NOTE: Device licenses are required for all devices connected to PME. The PME trial license
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 or Device Manager 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 and Customizing Access Level Privileges for details.
NOTICE
NETWORK INOPERABILITY
Do not make unauthorized changes in the network configuration.
See Setting up your network in Management Console or Device Manager for details on how to
add devices.
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 the EWS server configuration was successful.
Prerequisites
Before configuring the EWS client in SmartConnector, confirm that SmartConnector is installed
and configured.
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.
2. Navigate to http://localhost:8082.
4. Click Configurations in the navigation bar and select Endpoint Configurations from the
drop down list.
5. Click Add New. Pick an assembly page displays. SmartConnector automatically analyzes
the SmartConnector install directory and displays all possible assemblies.
7. Click Next. Choose a class page displays. SmartConnector automatically analyzes the
selected SmartConnector Extension assembly and list all possible classes.
14. In Server Address, enter the complete URL of the PME EWS server.
System performance
PME is installed with a number of factory default settings that should be acceptable for most
installations. However, the needs of individual systems can be different from one another and
there are several parameters that can be used to fine-tune PME.
Device communications
See Network performance for information on how to optimize device communications.
Operating conditions
There are two operating conditions that PME experiences when communicating with devices in
the network:
• System start-up (when first connecting to devices).
System Start-up
During system start-up it is normal for the software to perform slowly as it communicates to
devices in the network and downloads the available historic logs. Depending on how long the
devices have been in service there could be over a month of historic logs, PQ events, and
waveforms to download. This behavior is particularly noticeable on long daisy chains that include
meters with a high quantity of on-board logged data.
After the system has downloaded the available logs from devices, the performance of PME can
be measured and, if necessary, appropriate action can be taken to improve it. The Diagnostics
Viewer in Management Console should be used to determine when the historic logs have been
downloaded from devices.
LOGINSERTER.<server_name>.
3. Select the Log Performance tab to display the status of the historic logs in the devices.
During system start-up the CaughtUp column displays No, indicating that there are historic logs
on the devices that have not yet been downloaded to the database. As the logs are downloaded
the individual rows change to Yes. Continue to monitor this column for several minutes to verify
that the logs have been completely downloaded. At this point the software is in steady-state
operation.
Steady State
After the system has completely started up, you can use the Diagnostics Viewer to diagnose and
tune the field-level communication.
1. Ensure that all of the devices on the daisy chain to be tested are enabled.
2. Apply the desired test load to the devices on the daisy chain (for example VIP, Vista, OPC,
Diagrams, or Log Inserter).
3. In the Diagnostics Viewer, expand Communications Diagnostics and select the site of the
associated daisy chain.
6. Let the system gather metrics. For real-time data loads, a few minutes is usually enough.
For logging, it is better to leave it for an hour or more, depending on logging intervals.
For each site (either a daisy chain with a gateway or an Ethernet device), the Time Util (%) column
indicates how utilized the communication channel is:
A value at 100% indicates that the daisy chain is saturated and may not be providing responses
as quickly as all requesting clients are configured to meet. For example, this could mean that
instead of 5 second updates in Vista, you may see it as 6 or more seconds depending on how
saturated the site is.
Conversely, a low percentage indicates room for more data requests. The user can set the
software components (Real-time clients, LogInserter) to poll more quickly to achieve better user
experience, or put more devices on the same daisy chain.
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.
Registry Settings
The registry keys below can be used to adjust PME performance. These keys are located under
HKEY_LOCAL_ MACHINE\SOFTWARE\Schneider Electric\Power Monitoring Expert in the
registry. If the impact of the change is not well understood, then consider an alternate fix or
consult Technical Support for guidance.
ConnectedThreadPoolSize (DWORD; default 200): The number of sites ION SiteServer service
sends requests to simultaneously. Ideally, this value is equal to or greater than the number of
sites in the system (that is, serial sites, Ethernet gateway sites, and Ethernet devices) up to a
maximum of 400.
LI_PollingPeriod_s (DWORD; default 30): The minimum time (in seconds) between polls for a
historic log position of a given log. This is a global setting used to adjust the amount of Log
Inserter driven communication traffic for the entire system.
LI_MaxPollingPeriod_s (DWORD; default 60): This is the maximum value that LI_
PollingPeriod_s can be set to. If you increase LI_PollingPeriod_s beyond 60, you also need to
increase this setting.
NOTE: Other performance tuning settings may be available. Contact a Technical Support
representative to look at your specific needs.
This control is achieved by editing the LogAcquisitionControl.xml file. The file includes
examples of required syntax and possible configurations. Note that this feature is for advanced
users only.
• Polling intervals can be set for any device type or device instance. They can also be set to
change based on a schedule. The schedules used by this feature are defined using the TOU
Editor tool that is available from the Tools menu in Management Console.
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.
Power Monitoring Expert has time synchronization blackouts enabled automatically even though
time syncing is disabled by default in Power Monitoring Expert. The blackout intervals are every
five minutes as follows: 0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55. Each blackout is 2 minutes and
30 seconds in duration. This duration is distributed evenly before and after the interval. The
diagram below illustrates the time synchronization blackout feature in Power Monitoring Expert.
If a regularly scheduled time sync is not sent because of a blackout interval, the software
continues trying to send the time synchronization signal every 15 seconds until the blackout
period expires and the time sync is sent.
NOTICE
IRREVERSIBLE OPERATING SYSTEM DAMAGE OR DATA CORRUPTION
Before making any changes, back up your Windows Registry in a network folder or other
remote location.
Failure to follow these instructions can result in irreparable damage to the operating
system of the computer and all existing data.
NOTE: Registry edits must be performed only by qualified and experienced personnel.
There are two registry entries that control the time-synchronization blackout behavior.
TimesyncBlackoutInterval_mins
Default value: 5
This entry is specified in minutes. It must have a value greater than 1 in order for
time-synchronization blackouts to occur. A value of 60 or greater configures
blackouts to occur once an hour.
TimesyncBlackoutDuration_secs
This entry is specified in seconds. A value of 0 (zero) disables the blackout feature.
This entry cannot have a value greater than or equal to 3600 (one hour).
NOTE: If you want to disable the blackout feature but keep time synchronization enabled, set the
TimesyncBlackoutDuration_secs register to 0.
Do not use the following settings. They disable both the blackout feature as well as time
synchronization in general.
• TimesyncBlackoutInterval_mins < 1
To disable time synchronization for a particular device, use Management Console. Refer to
Enabling and configuring time synchronization.
Trends configuration
Use the Trends application to view trends for real-time and historical data. The information in the
Trends application is accessed through trend graphs that are saved in the library. Power
Monitoring Expert (PME) does not provide any pre-configured trends. Configure your own trends
to meet your needs.
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.
Open the Trends application from the TRENDS link in the Web Applications banner.
For information on how to configure the Trends application, see:
• Adding a new trend
• Editing a trend
• Sharing a trend
• Moving a trend
• Deleting a trend
1. In Trends, open the Trend Library and navigate to the folder where you want to create the
trend.
(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. In the Trend Library, at the bottom of the panel, click Add Trend . This creates a new
trend and opens the Add Trend dialog.
3. In Add Trend, enter the configuration information on the General, Axes, Chart, and Data
tabs. See Configuring a trend for details on the configuration options.
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 for details.
1. In Trends, open the Trend Library and navigate to the trend 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 trend name or click Options for this trend 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 Trend Library, select the new trend, right-click the trend name or click
Options for this trend, and select Edit to open the trend settings. Change the trend name
and other relevant settings.
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 for details.
Related topics:
• Adding a new trend
• Editing a trend
• Sharing a trend
• Moving a trend
• Deleting a trend
Editing a trend
Edit a trend to change the trend name, add a data series, remove a data series or change the
trend settings.
To edit a trend:
Clicking Edit on the top right of the trend in the trend display pane.
Right-clicking a trend name in the Trend Library and selecting the Edit menu item.
Clicking Options for this trend in the Trend Library and selecting the Edit menu item.
2. Change the General, Axes, Chart, and Data settings for the trend in the Trend Setup
dialog. See Configuring a trend for details on the configuration options.
Related topics:
• Adding a new trend
• Editing a trend
• Sharing a trend
• Moving a trend
• Deleting a trend
Sharing a trend
Share trends 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 trend:
1. In Trends, open the Trend Library and navigate to the trend you want to share.
2. Right-click the trend name or click Options for this trend and select Share. This opens the
Share Trend window.
3. In Share Trend, select the user groups you want to share this trend with.
(Optional) Specify a name for the shared trend. The groups you are sharing this trend with
will see this name. The name of the original trend 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:
• Adding a new trend
• Editing a trend
• Sharing a trend
• Moving a trend
• Deleting a trend
Moving a trend
Move trends to a different location in the Library to make them easier to find or easier to manage.
To move a trend:
1. In Trends, open the Trend Library and navigate to the trend 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 trend name or click Options for this trend and select Move To. This opens
the Select Location window.
3. In Select Location, select the location you want to move this trend to.
Related topics:
• Adding a new trend
• Editing a trend
• Sharing a trend
• Moving a trend
• Deleting a trend
Deleting a trend
Delete trends that are no longer needed.
To delete a trend:
1. In Trends, open the Trend Library and navigate to the trend you want to delete.
2. Right-click the trend name or click Options for this trend, and select Delete
3. In Delete Content, click Yes, to delete the trend from the Trend Library.
NOTE: Access to this application or function is controlled by user privileges. See Default User
Access Level Privileges and Customizing Access Level Privileges for details.
Related topics:
• Adding a new trend
• Editing a trend
• Sharing a trend
• Moving a trend
• Deleting a trend
Software Modules
Software modules combine different software features and capabilities to create a specific set of
deliverables. Software modules are designed around a particular application. Examples of
software modules include the Power Quality Performance Module, the Energy Analysis Reports
Module, and the Breaker Performance Module.
This section provides configuration information for the software modules in PME.
Use the links in the following table to find the module you are looking for:
Module Application
Backup Power Module Generator and Uninterruptible Power Supply (UPS) performance
configuration monitoring and reporting, including battery health.
Breaker Performance
Circuit breaker aging and breaker settings monitoring.
Module configuration
Generator and Uninterruptible Power Supply (UPS) capacity
Capacity Management
monitoring and reporting. Includes transformer and UPS loss
Module configuration
monitoring.
Energy Analysis
Gadgets for identifying consumption patterns and anomalies and
Dashboard Module
for comparing different consumers over time.
configuration
Energy Analysis Reports Reports for energy consumption monitoring and modeling,
Module configuration including energy usage by process area or by product output.
Energy Billing Module Energy-based billing and reporting, including consumption
configuration monitoring and reporting at the branch circuit level.
Event Notification Module
Notifications of power system events via email, SMS, or SNMP.
configuration
Insulation Monitoring Monitoring for isolated power systems, such as the ones found in
Module configuration hospital operating rooms.
Power Quality
Analysis of power quality events and disturbances and their
Performance Module
impact on the monitored system.
configuration
The Backup Power Module provides generator and Uninterruptible Power Supply (UPS)
monitoring and reporting. It reports on generator and UPS performance and battery health.
The Generator Test EPSS Report can be configured to conform to the requirements for an
Emergency Power Supply System (EPSS) test, including automatic transfer switches (ATS). For
example, the report shows the transfer time of the lead ATS and indicates whether the transfer
time passes or does not pass the test requirements. See Emergency Power Supply Systems for
more information on EPSS.
The following reports, diagrams, and tools are part of this module:
(*) The Generator Performance Configuration tool includes the Run History, which is a record of
the generator run activities.
To use the reports and diagrams in this module, the module must be configured, and the
measurement data must be available as historical data logs in the database.
Related topics:
Backup Power Module topics
• Backup Power Module design
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. Set up the monitoring device that records the generator electrical data in PME. See
Supported measurements and devices for details on which measurements are required.
2. Create a Generator in the Generator Performance Configuration Tool with EPSS Test
Module, and define, at a minimum, the following fields for this Generator:
Electrical Data - Select the Source of the electrical measurement data for the
generator. Enter the generator Nameplate Rating and select the Unit.
Status Measurements - Select the Source of the generator Status Measurements, and
the measurements used to indicate the Running and Stopped states.
3. Create a Transfer Switch in the Generator Performance Configuration Tool with EPSS Test
Module, and define, at a minimum, the following fields for this transfer switch:
Status Measurements - Select the Source of the transfer switch Status Measurements,
and the measurements used to indicate the Normal, Test, and Emergency states.
NOTE: The transfer switch states are required for the Run Reason information in the
report.
4. (Optional) Repeat steps 2 and 3 to add additional generators and transfer switches.
5. Create a Group in the Generator Performance Configuration Tool with EPSS Test Module,
and define, at a minimum, the following fields for this Group:
6. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
NOTE: The groups you create with the Generator Performance Configuration Tool are available
for selection as inputs to the Generator Activity Report. All Generators that are defined in a
group are included in the report when that group is selected. You have the option to exclude
generators in a group from a report by selecting this option in the report inputs section.
For information on how to use the report, see Generator Activity Report.
NOTE: Generator Battery Health Export is based on the same data as the Generator Battery
Health Report. The export version provides the raw data in CSV file format. The export file can
be imported by other systems, such as Energy Operation.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
1. Set up the monitoring device that records the generator battery voltage in PME. See Set up
the Generator Battery Health monitoring device for details.
2. Create a Generator in the Generator Performance Configuration Tool with EPSS Test
Module, and define, at a minimum, the following fields for this Generator:
Electrical Data - Select the Source of the electrical measurement data for the
generator. Enter the generator Nameplate Rating and select the Unit.
Status Measurements - Select the Source of the generator Status Measurements, and
the measurements used to indicate the Running and Stopped states.
Battery Waveforms - Select the Battery Waveforms check box. Select the source
that is capturing the waveform. Select the measurement recording the waveform, for
example V4 Waveform.
4. Create a Group in the Generator Performance Configuration Tool with EPSS Test Module,
and define, at a minimum, the following fields for this Group:
5. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
NOTE: The groups you create with the Generator Performance Configuration Tool are available
for selection as inputs to the Generator Battery Health Report. All Generators that are defined in
a group are included in the report when that group is selected. You have the option to exclude
generators in a group from a report by selecting this option in the report inputs section.
For information on how to use the report, see Generator Battery Health Report, and Generator
Battery Health Export Report.
NOTE: The devices used for monitoring the generator electrical data for the Generator Battery
Health Report must be able to run an ION framework and must have a V4 input for capturing the
battery voltage waveform. Only the following devices meet those requirements:
- ION9000
- ION7650
- ION7550
Other devices cannot be used for this application.
Basic setup
Install and configure the monitoring device. Refer to the device Installation Guide for more
information. Obtain the latest version of these documents from Schneider Electric Download
Center.
• Perform a visual inspection of the connections to ensure there is physical separation between
the system connected to V1, V2 and V3, and the battery connected to V4.
• For other wiring options with PTs, see the monitoring device Installation Guide.
DANGER
ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
Treat the battery circuit as energized to the category of the installation.
The Battery Health Framework is designed to capture and record a generator’s battery voltage
signature at start up. This voltage signature provides some indication of the health of the
generator’s battery bank. A typical waveform capture of the voltage drop when starting is shown
next:
• There is about 0.5 seconds of data before the voltage drops to approximately 20 V.
Two options in the framework are possible to capture the waveform, based on how the crank relay
signal is triggered - pulse or KYZ.
Example Framework
The following figure shows the typical modules for the framework.
• Digital Input
• Convert
• OneShot Timer
• Waveform Recorder
See the following descriptions for the way each module works in this framework.
Refer to ION Reference for details on how each module operates and for setting module
parameters.
The V4 signal from the meter goes to the Data Acquisition module.
This module accepts the Cranking Relay signal from the field. When the signal goes high, the
logic to record the battery voltage triggers.
When the Crank Relay signal goes high, a pulse is generated on the Trigger output register,
labeled "G1 Crank Relay." The setup registers for the Digital Input module are shown next.
Note that the Input Mode value is Pulse. The Trigger output can now be fed into the first
Waveform Recorder along with V4 from the Data Acquisition module.
If you are using the same Digital Input to handle the Generator Start signal (EPSS_Start) it is
probably set to KYZ mode.
Input Mode KYZ means that a pulse is generated on the Trigger output register when the Crank
Relay signal goes high AND when it goes low. The Convert module and One Shot Timer module
(explained later) prevent triggering the downstream logic twice.
Convert
The signal from the Digital Input module cannot be fed directly into the One Shot Timer. The
Convert module converts the digital signal to analog for the One Shot Timer.
One-Shot Timer
To prevent triggering the downstream logic twice, send the state (EPSS_Start) from the Convert
module into the One Shot Timer:
Send the output register into the first Waveform Recorder G1 Battery 1.
The Data Acquisition module and G2 Crank Relay module are the inputs to the first Waveform
Recorder, labeled “G1 Battery 1.”
• Format should 16x96. This means 16 samples per cycle and 96 cycles, so at 60 Hz this
results in approximately 1.6 seconds' worth of data.
• Record Delay Cycles is set to 95 to allow the “window of observation” to move so that only
post-event data is captured. Refer to ION Reference for more details.
The second Waveform Recorder - G1 Battery 2 - is cascaded with the first to capture another 1.6
seconds of the battery voltage signature. Do this by using the Record Complete output register on
G1 Battery 1 as a flag to trigger G1 Battery 2 to start recording.
The third Waveform Recorder - G1 Battery 3 - is cascaded with the second recorder to capture the
final 1.6 seconds of the battery voltage signature. As above, use the Record Complete output
register on G1 Battery 2 as a flag to trigger G1 Battery 3 to start recording.
The Setup Registers should be the same as first waveform recorder with different labels.
After the framework is complete, in Vista you should see the voltage signature that looks like the
following example image:
After you obtain this type of result, you can configure the generator in the Generator Performance
Configuration Tool and define the Battery Health Report.
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: Before starting the configuration, the monitoring devices must be installed,
communicating and connected to the relevant electric circuits. The generator and automatic
transfer switch (ATS) digital and analog outputs must be connected to the equivalent inputs on
the monitoring devices.
NOTE: All statuses for a specific ATS must be recorded by the same monitoring device. All
statuses for a specific generator must be recorded by the same monitoring device.
You need to configure the system before you can use any of the EPSS features. The
configuration includes these high-level steps:
Step 1: Setting up the monitoring devices in the PME software.
Step 2: Defining generators, ATSs, and groups in the Generator Performance Configuration
tool.
1. Add the devices that are monitoring the generators, ATS, and load to PME, using
Management Console or Device Manager. If ASCO ATS are part of the installation, use the
ASCO Automatic Transfer Switch Configuration Tool.
2. Configure the digital inputs on the devices for the generator and ATS status measurements,
for each generator and ATS, with the following settings and labels:
NOTE: PME includes ION framework templates for the generator and ATS input
measurements. These templates provide a starting point for configuring ION devices to
monitor generator and ATS status data. If you use ION devices to monitor these inputs,
see ION device frameworks for EPSS monitoring for more information.
(*)These signals are not required for the EPSS Test module. They can optionally be
included in the EPSS report.
(**) The labels shown in the table are recommended labels; they are recognized by PME
Alarms and categorized as Asset Monitoring alarms. PME creates measurement definitions
based on the digital input labels. You can use different labels if necessary.
3. Configure the analog inputs on the devices for the generator engine measurements, for
each generator, with the following labels:
NOTE: PME includes an ION framework template for the generator analog input
measurements. This template provides a starting point for configuring ION devices to
monitor generator engine data. If you use ION devices to monitor these inputs, see ION
device frameworks for EPSS monitoring for more information.
Signal Label(**)
Engine Temperature (or Coolant Temperature) Engine Temp
Exhaust Gas Temperature (if single exhaust) Ex Gas Temp
Exhaust Gas Temperature Left (if dual exhaust) Ex Gas L Temp
Exhaust Gas Temperature Right (if dual exhaust) Ex Gas R Temp
Engine Oil Pressure(*) Engine Oil Prssr
Other Engine related measurements, for example
<your custom label>
battery voltage(*)
(*)These signals are not required for the Generator EPSS Test module. They can optionally
be included in the EPSS report.
(**) The labels shown in the table are recommended labels. PME creates measurement
definitions based on the analog input labels. You can use different labels if necessary.
NOTE: Do not use software logging for the ATS and generator status data. Software
logging introduces unpredictable time delays which result in low timestamp accuracy for
the logged data. Always use device on-board logging for this data.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically
available
through
digital output
signals from
Normal Required
the ATS.
ATS Status Test Required
Digital Input 3-4 NOTE: All
Indicators Emergency Required
statuses for
Power Outage Optional(*)
a specific
ATS must be
recorded by
the same
monitoring
device.
This data
needs to be
provided by
a power
monitoring
device
connected to
the ATS
load-side
feeder.
NOTE: Load
3-Phase Power data must be
ATS Load logged with
System - kW tot or kVA tot Optional(*)
Data a 1-minute
Measurements
logging
interval. Use
the ATS
Test and
Emergency
signals to
start the
logging and
the Normal
signal to end
the data
logging.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically
available
through
digital output
Stopped signals from
Running Required the
Generator Starting Required generator.
Status Digital Input 2-4 Emergency Optional(*) NOTE: All
Indicators Power Source Optional(*) statuses for
Available a specific
(EPA) generator
must be
recorded by
the same
monitoring
device.
# of
Data Type Measurements Importance Comments
Channels
This data
needs to be
provided by
a power
monitoring
device
connected to
the
generator
feeder.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically
available
through
analog
output
signals from
the
generator.
Engine
Temperature NOTE:
Required Engine data
Exhaust Gas
(**) must be
Generator Temperature
Required logged with
Engine Analog Input 2 or more (***)
(**) a 1-minute
Data
Optional(*) logging
Battery Voltage
Optional(*) interval. Use
the
Oil Pressure
generator
Running
signal to
start the
logging and
the Stopped
signal to end
the data
logging.
(*) This data can be included in the report, but it is not required to configure and run the
report.
(**) This data is required depending on the generator evaluation method selected. If Engine
Temperature is selected, the Engine Temperature measurement is required, otherwise, it is
optional. If Exhaust Gas Temperature is selected, the Exhaust Gas Temperature
measurement is required, otherwise, it is optional.
(***) Generators with dual exhaust systems require both Exhaust Gas Temperature Left and
Exhaust Gas Temperature Right measurements.
5. (Optional) Configure the device to generate a Transfer Time alarm in PME for an EPSS run.
See EPSS Transfer Time alarm for details.
6. (Optional) Configure the device for remotely switching the ATS into Test mode. See Remote
control of ATS Test mode for details.
Next, define the generators, ATSs, and groups in the Generator Performance Configuration tool.
Step 2: Defining generators, ATSs, and groups in the Generator Performance Configuration tool:
2. On the Generators tab, add a generator, set its nameplate rating, and map the sources and
measurements for the electrical, engine, and status measurements.
3. Repeat step 2 for all the generators that are part of your emergency power supply systems.
4. On the Transfer Switches tab, add an ATS, set its priority level, and map the sources and
measurements for the load and status measurements.
5. Repeat step 4 for all the ATSs that are part of your emergency power supply systems.
6. (Optional) On the Equipment tab, add any additional equipment for which you want to
include data in the EPSS report. Map the source and measurement for this equipment.
7. On the Groups tab, add a group representing an EPSS, and assign the generators, ATSs,
and equipment that are part of the EPSS to this group.
NOTE: The groups you create with the Generator Performance Configuration Tool are available
for selection as inputs to the Generator Test EPSS Report. All generators and transfer switches
that are defined in a group are included in the report when that group is selected. You have the
option to exclude generators and transfer switches in a group from a report by selecting this
option in the report inputs section.
See Generator Performance Configuration Tool with EPSS Test Module for information on how to
use the tool.
See Generator Performance Configuration Tool with EPSS Test Module for information on how to
use the tool.
See Generator Test EPSS Report for information on report input parameters.
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. Set up the monitoring device that records the generator electrical data in PME. See
Supported measurements and devices for details on which measurements are required.
2. Create a Generator in the Generator Performance Configuration Tool with EPSS Test
Module, and define, at a minimum, the following fields for this Generator:
Electrical Data - Select the Source of the electrical measurement data for the
generator. Enter the generator Nameplate Rating and select the Unit.
Status Measurements - Select the Source of the generator Status Measurements, and
the measurements used to indicate the Running and Stopped states.
4. Create a Group in the Generator Performance Configuration Tool with EPSS Test Module,
and define, at a minimum, the following fields for this Group:
5. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
NOTE: The groups you create with the Generator Performance Configuration Tool are available
for selection as inputs to the Generator Load Summary Report. All Generators that are defined
in a group are included in the report when that group is selected. You have the option to exclude
generators in a group from a report by selecting this option in the report inputs section.
For information on how to use the report, see Generator Load Summary Report.
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: See Supported measurements and devices for information on supported UPS
devices for this report.
2. Set up the UPS ION framework in the VIP. See Setting up the UPS Auto Test ION
framework in the VIP for details.
4. Define a Group in the UPS Configuration Tool and add the UPS devices to the group.
5. Generate the Vista diagrams with the UPS Configuration Tool and configure the diagrams.
See Setting up the Vista Diagram for UPS Auto Test for details.
6. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
For information on how to use the report, see UPS Auto Test Report.
1. Set up the monitoring device that records the battery voltage. See Set up the UPS Battery
Health monitoring device for information on how to configure the device. See Supported
measurements and devices for details on which measurements are required
2. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
For information on how to use the report, see UPS Battery Health Report.
2. Drag a Grouping Object and open it. Make sure that the toolbox is available (Options >
Show toolbox).
3. Select Edit > Paste from framework, find UPS Alarming Status.fwn under
...\config\fmwk\EPSS\, and free paste the framework into the Grouping object.
4. Set up the framework and customize it to match your system configuration. The default
template assumes that you have two groups with five UPSs in each group.
The following example shows an instance where the user has three groups with a different
UPS in each group:
5. Connect the inputs of each AND/OR module (UPS) to the critical operation and battery
usage status from the UPS devices.
6. Repeat this step for each UPS in the group and for all UPSs in the other groups.
2. Link the status object from the framework that you pasted in VIP in the previous steps.
3. Repeat step 2 for all other groups. Your UPS Monitoring system is now setup.
NOTE: Any UPS in the groups that require attention show a red indicator.
NOTE: The devices used for monitoring the UPS electrical data for the UPS Battery Health
Report must be able to run an ION framework and must have a V4 input for capturing the battery
voltage waveform. Only the following devices meet those requirements:
- ION9000
- ION7650
- ION7550
Other devices cannot be used for this application.
Basic setup
Install and configure the monitoring device. Refer to the device Installation Guide for more
information. Obtain the latest version of these documents from Schneider Electric Download
Center.
• Perform a visual inspection of the connections to ensure there is physical separation between
the system connected to V1, V2 and V3, and the battery connected to V4.
• For other wiring options with PTs, see the monitoring device Installation Guide.
DANGER
ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
Treat the battery circuit as energized to the category of the installation.
The UPS Battery Health framework is designed to capture and record a UPS’s battery voltage
signature at start up. This voltage signature provides some indication of the health of the UPS’s
battery bank. A typical waveform capture of the voltage drop when the UPS comes online is
shown below:
• There is about 0.5 seconds of data before the voltage drop to approximately 20 V.
1. Open Designer and open the device node of the monitoring device.
2. Drag a Grouping Object and open it. Make sure that the toolbox is available (Options >
Show toolbox).
3. Select Edit > Paste from framework, find UPS Battery Health.fwn under
...\config\fmwk\EPSS\, and free paste the framework into the Grouping object.
4. Link the Setpoint module Source input to the high speed Vln a input of the Power Meter
module of the monitoring device. This input triggers the waveform capture during the UPS
test when the UPS output turns on.
5. Check that the waveform recorder input is linked to the V4 output of the Data Acquisition
module.
The Breaker Performance Module monitors aging and wear of circuit breakers and reports on
breaker protection settings. It provides historical and real-time information for aging and wear
related breaker parameters. You can also set up alarming on these parameters.
To use the reports and diagrams in this module, the module must be configured and the
measurement data must be available as historical data logs in the database.
NOTE: Only certain Low Voltage, Schneider Electric breakers are supported by this module, see
Supported devices for more information.
NOTE: A Compact NSX Trip Unit does not memorize data related to breaker operations
(open, close, trip). It is BSCM, which memorize information like OF/SD counters that is
needed to have the Breaker Aging feature work correctly. Therefore, a BSCM must be
connected to the breaker for Breaker Aging to work.
2. Set up the breaker aging calculations in PME. See Set Up the Breaker Aging Calculations
for details.
3. Configure Breaker Devices, Switchboards, and Groups in the Breaker Configuration Tool.
4. Configure the breaker aging ION framework in the VIP. See Pasting the Circuit Breaker
Framework in VIP for details.
5. (For the report) Open the report template in the Reports Web Application, set the report
input parameters, and generate the report.
6. (For the Vista diagrams) Use the Generate Vista Diagrams function in the Breaker
Configuration Tool to create the diagrams. Configure the diagrams after they have been
generated. See Configuring Breaker Aging Vista diagrams for details. View the diagrams in
Vista or in Web Applications Diagrams.
NOTE: Step 2 in the workflow description below is optional. You can run the Breaker Settings
Report without configuring the breakers in the Breaker Configuration Tool. The benefit of
configuring breakers in the tool is that the breakers can be grouped and associated with
switchboards for reporting. Also, if you want to run the Breaker Aging Report on the same
breakers, you must configure them in the tool.
NOTE: Clear the Enable Breaker Aging check box, in the Breaker Devices tab of the
configuration tool, for breakers that are only used for the Breaker Settings Report. In that
case only the Name and Source fields are required. To configure a breaker that is used for
the Settings report and the Aging report, check the Enable Breaker Aging box and define
all the required fields.
3. To run the report, open the report template in the Reports Web Application, set the report
input parameters, and generate the report.
NOTE: PME checks the settings of a new breaker device as soon as the device has been
added to the system. However, there can be a time delay until the settings data is available
in the database for reporting. After the initial check, PME checks the breaker settings for
updates every 24 hours.
NOTE: The groups you create with the Breaker Configuration Tool are available for selection as
inputs to the Breaker Performance reports. All breakers that are defined in a group are included
in the report when that group is selected.
For information on how to use the reports, see Circuit Breaker Aging Report and Circuit Breaker
Settings Report.
Related topics:
See the descriptions below for details on how to complete these tasks.
To start the ION Software Modbus Gateway Service,
1. Open the Windows Services panel, for example through Administrative Tools > Services.
2. Find and start the ION Software Modbus Gateway Service and set the Startup type to
Automatic.
3. From Available Services select Breaker Aging and Wear Calculation Service.
4. In Unit ID enter a value of 1 if this is the first service provider you are adding. Otherwise,
enter the next incremental value for Unit ID.
5. Click Configure.
6. In Breaker Aging Service Configuration, review the settings and leave the values at their
defaults. The defaults are a Real Time Request Polling Interval of 5 seconds and a Real
NOTE: These settings control the real-time data requests for breaker aging and wear
calculations. These settings do not affect other real-time data requests in the system, such
as for Vista, Diagrams, or Gadgets. Only modify these settings if certain load conditions in
the system require a change in the polling priority and frequency of meter real-time data.
8. In Modbus Service Configuration Tool, click OK. A dialog appears informing you about the
configuration change and the need to restart the ION Modbus Software Gateway Service.
9. In Configuration Changed, click Yes to continue and to restart the ION Modbus Software
Gateway Service.
NOTE: You only need one site for the ION Modbus Software Gateway Service in your system.
Skip these steps if you have already set up a site for other applications of the Modbus Software
Gateway Service.
4. Click OK.
3. Add a new Serial Device on Ethernet Gateway Site. Enter the following information:
Group: Enter Breakers.
Unit ID: Enter the same Unit ID you configured in the Modbus Service configuration tool.
4. Click OK.
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 an ION meter's digital output for any safety critical application.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
NOTE: ION modules and registers must only be configured by personnel with a thorough
understanding of ION architecture and the system in which the meters and software are
installed.
The VIP framework aggregates the overall aging and wear status of each breaker in a group to
assess the group status. It also aggregates the status of each group in the system to assess the
overall status for all breakers.
This framework is a template based on a breaker configuration with 2 groups and 5 breakers
per group. Customize this template by adding modules for additional breakers or groups, or
by removing not needed modules.
4. Connect the input of an AND/OR module labeled Device_<xx> to the Breaker Aging and
Wear Provider overall status for the respective breaker device. Match the breaker/group
pairing that you configured with the Breaker Configuration tool.
5. Repeat this step for each Circuit Breaker in each group as required.
6. Delete the Devices_<xx> and Groups_<xx> that do not exist, or add additional ones.
There are three different types of diagrams: Group summary diagram, group details diagram, and
switchboard details diagram. Most of the measurements in these diagrams are automatically
linked to the correct breaker information when the diagrams are created by the Breaker
Configuration tool. You only need to manually link the group status indicators in the group
summary diagram.
NOTE: If you saved the diagrams in a location other than the default, then browse to that
location to open the diagram.
The group summary diagram shows the group summary status and the number of breakers
in the group for each of the groups setup with the Breaker Configuration tool.
Example:
3. Manually link the group status object for each group to the output of the And/OR Module for
the group in the Circuit Breaker Aging Status framework in the VIP.
Example:
The Capacity Management Module provides generator, Uninterruptible Power Supply (UPS), and
general equipment monitoring and reporting. It also includes transformer and UPS loss
monitoring and reporting. The losses are reported in terms of energy and cost.
The following reports, diagrams, and tools are part of this module:
To use the reports and diagrams in this module, the module must be configured and the
measurement data must be available as historical data logs in the database.
For configuration information on the different reports, see:
• Configure the Branch Circuit Power Report
Related topics:
Capacity Management Module topics
• Capacity Management Module Design
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
1. Set up the monitoring device that records the branch circuit data. See Supported
measurements and devices for details on which measurements are required.
TIP: See Hierarchy Configuration Utility and Hierarchy Manager for information on how to
install and maintain a hierarchy.
3. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
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: Before starting the configuration, the monitoring devices must be installed,
communicating and connected to the relevant electric circuits. Relevant generator digital outputs
must be connected to the equivalent inputs on the monitoring devices.
1. Add the devices that are monitoring the generators and loads to PME, using Management
Console or Device Manager.
See Supported Measurements and Devices for information on supported device types.
2. Configure the digital inputs on the devices for the generator status measurements, for each
generator, with the following settings and labels:
(*) The labels shown in the table are recommended labels. PME creates measurement
definitions based on the digital input labels. You can use different labels if necessary.
4. Create a Generator in the Generator Performance Configuration Tool with EPSS Test
Module, and define, at a minimum, the following fields for this Generator:
Electrical Data - Select the Source of the electrical measurement data for the
generator. Enter the generator Nameplate Rating and select the Unit.
Status Measurements - Select the Source of the generator Status Measurements, and
the measurements used to indicate the Running and Stopped states.
Evaluation Method - Select the Evaluation Method that is used for the generator test
and the pass/fail criteria for the selected method.
6. Create a Group in the Generator Performance Configuration Tool with EPSS Test Module,
and define, at a minimum, the following fields for this Group:
Load Sources - Add the loads that are supplied by the generator.
7. To run the report, open the report template in the Reports Web Application, set the report
input parameters, and generate the report.
For information on how to use the report, see Generator Capacity Report.
1. Add the device that is monitoring the equipment load to PME, using Management Console
or Device Manager.
See Supported Measurements and Devices for information on supported device types.
3. Create an Equipment item in the Generator Performance Configuration Tool with EPSS Test
Module, and define, at a minimum, the following fields for this Equipment:
Load Data - Select the Source and Measurement for the load data. Enter the equipment
Rating and select the Unit.
4. (Optional) Repeat steps 1 and 2 to add additional generators and transfer switches.
5. Create a Group in the Generator Performance Configuration Tool with EPSS Test Module,
and define, at a minimum, the following fields for this Group:
Load Sources - Add the loads that are connected to the equipment.
6. To run the report, open the report template in the Reports Web Application, set the report
input parameters, and generate the report.
For information on how to use the report, see Equipment Capacity Report.
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. Set up the monitoring devices that record the load data. See Supported Measurements and
Devices for details on which measurements are required.
2. Define the generator power system using the Generator Power Configuration Utility.
3. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
For information on how to use the report, see Generator Power Report.
1. Set up the monitoring devices that record the UPS output data. See Supported
Measurements and Devices for details on which measurements are required.
2. Define the UPS power system using the UPS Power Configuration Utility.
3. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
For information on how to use the report, see UPS Power Report.
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. Set up the monitoring devices that record the input and output data for the transformers and
UPS. See Supported Measurements and Devices for details on which measurements are
required.
2. Define the power losses system using the Power Losses Configuration Utility.
3. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
For information on how to use the report, see Power Losses Report.
The Energy Analysis Dashboard Module includes dashboard gadgets that help you break down
consumption by load type, visualize consumption cost, and do an 80/20 analysis to identify the
largest consumers. You can identify consumption patterns and anomalies and compare different
consumers over time.
The following gadgets are part of this module:
• Aggregated Consumption Ranking gadget
• Sankey gadget
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.
No special configuration is required for this module. See Dashboards configuration for information
on how to create a dashboard with gadgets.
Related topics:
Energy Analysis Dashboard Module topics
• Energy Analysis Dashboard Module design
The Energy Analysis Reports Module includes reports that help you understand energy usage
patterns to find energy waste, analyze transformer and circuit capacity and assess energy usage
by process area or by product output. Use the energy modeling capabilities in this module, to
forecast consumption, identify unexpected changes in your consumption, or identify actual
savings as a result of energy management measures.
The following reports are part of this module:
• Create Model Report
• KPI Gadget
• KPI Report
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.
To configure the Energy Modeling report, see Configuring the Energy Modeling report for special
configuration information on this report.
1. Set up the monitoring devices that record the report data. See Supported measurements
and devices for details on which measurements are required.
NOTE: To use the reports in this module, the measurement data must be available as
historical data logs in the database.
2. Install the PUE VIP framework. See Loading the PUE framework into VIP.
5. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
TIP: For more information on the PUE Summary Report, see Terms and Definitions and PUE
Summary Report Calculations.
To configure the Energy Analysis Reports Module (except the Energy Modeling report and the
PUE report):
1. Set up the monitoring devices that record the report data. See Supported measurements
and devices for details on which measurements are required.
NOTE: To use the reports in this module, the measurement data must be available as
historical data logs in the database.
2. Open the report template in the Reports Web Application, set the report input parameters,
and generate the report.
For information on how to use the reports in this Module, see Energy Analysis Reports
Related topics:
Energy Analysis Reports Module topics
• Energy Analysis Reports Module design
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 .
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.
NOTE: ION modules and registers must only be configured by personnel with a thorough
understanding of ION architecture and the system in which the meters and software are
installed.
We recommend that you create a new VIP, VIP.Data_Center, to run the PUE framework. If your
PME system already has a VIP.Data_Center, or if you want to use a different preexisting VIP,
then you must be careful not to accidentally overwrite existing VIP modules when pasting the new
framework.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before pasting an ION framework verify that the system is not performing critical control
actions that may affect human or equipment safety.
• Do not overwrite an existing ION framework in the VIP using lock paste.
• Verify correct system operation after pasting an ION framework.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
NOTE: If you choose to create a custom VIP, you need to update the PUE scripts, that create the
logical devices, with the custom VIP name. See Creating Logical Devices for details on where to
find the scripts.
1. Open Designer, and select File > Open. Select the VIP.Data_Center from the Select Node
box. Click OK.
2. (Optional) Create a grouping object in the VIP for the PUE framework. Open the grouping
object to paste the framework into it.
3. Select Edit > Paste from framework. The Paste from Framework screen appears.
5. In the Paste Summary, select the framework modules for lock paste, then click OK.
NOTE: See Using the Paste Summary dialog for information on lock paste.
• IT Load
• HVAC loads
• Generators
• PDUs
Link the data sources to the appropriate Arithmetic Module that aggregates (sums) the data. Be
sure that all unused inputs are linked to the “zero” value, as unlinked inputs will cause a “N/A”
output.
NOTE: To implement real-time energy costs or emissions factor, you can develop a script using
a Visual Basic script or other technique that writes to the XML file in the specified format.
1. Open Designer and click File > Open, then select the VIP that contains the PUE
frameworks.
2. In the Navigation box on the left side of the framework, double-click the KPIs grouping folder
to open the KPI sub-framework.
3. In the KPI sub-framework, right-click the PS4DC_Config_import module to open the ION
Module Setup dialog.
4. In ION Module Setup, select XIM9 URL from the Setup Register list and click Modify….
5. In the Modify String Register dialog, enter the path information to the PS4DC_Config.xml
file.
NOTE: Logical devices are not included as devices in the device licensing count.
1_Create_Custom_Measurements.sql
2_Create_Logical_Device_Types.sql
3_MakeElectricalLogicalDevices.sql
4_MakeGHGLogicalDevices.sql
5_MakeCapacityLogicalDevices.sql
6_MakeCostLogicalDevices.sql
These scripts will create a number of logical devices related to data center applications. Not
all of these devices are needed for PUE.
NOTE: The scripts are designed for a system with VIP.Data_Center. If you use a custom
VIP (not VIP.Data_Center) for the PUE framework, then you need to update these scripts.
You need to change all VIP.Data_Center references in the scripts to the name of your
custom VIP. The following scripts need to be updated: 3_
MakeElectricalLogicalDevices.sql, 4_MakeGHGLogicalDevices.sql, 5_
MakeCapacityLogicalDevices.sql, 6_MakeCostLogicalDevices.sql
2. In numeric sequence, for each script right-click the script and select Open with > SSMS -
SQL Server Management Studio from the drop down list. Run the script.
NOTE: These scripts must be run in the order indicated by their file name.
The scripts create five logical device types and the appropriate custom measurements. The
device types are:
• DC_Elec
• DC_GHG
• DC_PUE
• DC_Capacity
• DC_Costs
The included Vista Data Center KPI files are linked to these devices. If it is necessary to change
the device names, the Vista diagrams must be edited as well.
The Energy Billing Module is a fully functional energy-based billing reporting system. It also
provides load and consumption monitoring and reporting at the branch circuit level, which is
typically used in data center applications.
To use the reports in this module, the module must be configured and the measurement data
must be available as historical data logs in the database.
For information on how to configure this module, download the Billing Module Toolkit from the
Exchange Community. See Resources for link information. The Billing Module Toolkit is a
collection of tutorials and examples that show you how to configure and use this module.
To use this report, the measurement data must be available as historical data logs in the
database, and a hierarchy must be configured using the
CustomerRackCircuitTemplate.xml template.
NOTE: Remember to update the Managed Circuits in the Management Console after each
device configuration change.
Hierarchy template
You can find the CustomerCircuitTemplate.xml hierarchy template at:
...\Power Monitoring
Expert\applications\HierarchyManager\SampleTemplates\DataCenter\.
For information on how to install a hierarchy template and make bulk configuration changes, see Hierarchy
Configuration Utility.
For information on how to maintain a hierarchy configuration and make individual configuration changes, see
Hierarchy Manager.
Related topics:
Use the Event Notification Module (ENM) to notify recipients about critical power system events.
ENM can send notifications of power system events through email, SMS or SNMP. ENM uses the
Alarms application to detect system events. You can set up notifications for activity in any of the
event, alarm, or incident views. The notification details are defined in a notification rule. A
notification rule can be enabled or disabled, and you can use a schedule to determine when the
rule is applied. You can define more than one notification rule.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not rely solely on Event Notification Module use for alarm notification where human or
equipment safety relies on the operation of the control action.
• Do not use Event Notification Module to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and
status feedback.
• Consider the implications of unanticipated transmission delays or failures of
communications links.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
NOTE: Other parts of the overall communication system, such as email servers, cellular phone
systems and SNMP servers, could fail and result in notifications not being delivered. If
notifications are not delivered to recipients, conditions that cause alarming may persist and
result in safety critical issues.
ENM is a built-in feature of PME. It is available for configuration as soon as the Event Notification
Module license has been activated. Before configuring notifications, review the prerequisites and
considerations in Event Notification Module Design.
TIP: You can open Notifications from SETTINGS > Alarms > Notifications in web applications.
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Related topics:
Event Notification Module topics
• Event Notification Module Design
2. In the Settings tab, configure the following options and click Save for each:
a. General Settings:
Remote Access Host: (Optional) The URL or IP address for the PME server. This
URL is used to provide a hyperlink in the notification messages that links back to the
alarm view details in the Alarms web application.
Example:
Maintenance Mode: Maintenance mode disables all notification rules. Use this to
temporarily disable notifications and avoid unwanted messages during a planned
power system event, for example a planned shutdown.
b. Email Settings:
i. Email Settings
From Address: The recipients of email notifications will see the messages
being sent from this address. It must be formatted as an email address, but it
does not have to be from a valid, existing email account.
From Display Name: The recipients of email notifications will see the
messages coming from this sender.
Include Email Header: Set to use a header in the notification email or not.
SMTP Server Uses SSL: Check this box if you want to use an SSL connection
to the SMTP server.
SMTP Server Credentials: Set the username and password if you use an SSL
connection to the SMTP server.
TIP: Test the email server setup by sending a test message to a valid email address in
the Test Email Recipient Address box.
c. SMS Settings
NOTE: The SMS capabilities of the Event Notification Module are built on technology
from Twilio, a third-party vendor. To use SMS with notifications, you need to open an
account with Twilio and sign up for SMS service. See the Twilio web site for more
information.
Set the Twilio SMS Account SID, Authentication Token, and Outbound Phone Number.
This information is provided by Twilio when you open an account and sign up for SMS
service.
TIP: Test the SMS setup by sending a test message to a valid phone number in the
Test SMS Recipient Address box.
d. SNMP Settings
NOTE: The SNMP client, called Agent sends the notification. PME acts as
SNMP Agent. You need to install the SNMP server, called Manager to receive the
notification. Install SNMP Manager in the same network of SNMP Agent for active
SNMP communication. To receive the notification on SNMP Manager, run the
Windows Services "SNMP Trap" and "SNMP Service" on SNMP Manager. If these
services are disabled, SNMP notification fails to deliver to SNMP Manager.
Port: Set the SNMP server port. The default value is 162.
TIP: Test the SNMP setup by sending a test message to a valid server name in the
Test SNMP Recipient Address box.
e. Alarms Settings
Use the Alarms settings to control how soon a notification is sent out after alarm activity
is detected. A shorter delay provides more immediate notification but can result in more
messages being sent. A longer delay can help aggregate additional activity into a single
message, reducing the number of notifications sent during an incident. See Notification
delay example for more details.
Choose between two pre-configured setting options and a custom option. The following
settings can be customized:
Initial Delay (seconds): The time the system waits, after an alarm activity is
detected, before sending a message.
Incremental Delay (seconds): The time the system waits if a new alarm activity is
detected during a delay period, before sending a message.
Maximum Delay (seconds): The time after which the system sends a notification
regardless of any incremental delays.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
1. In Notification Manager, select the Rules tab, and then click Add Notification Rule to open
the Add Notification Rule window.
TIP: Click Duplicate or use the Duplicate command, in the right-click context menu, to
duplicate an existing notification rule.
2. In Add Notification Rule, select the alarm view for which you want to monitor the activity and
receive notifications. Click Next.
TIP: You can add a new recipient to the system by clicking Add Recipient. See Adding a
recipient for more information.
4. (Optional) Select a notification schedule and the schedule timezone for this notification rule.
Click Next.
TIP: You can add a new schedule to the system by clicking Add Schedule. See Adding a
Schedule for more information.
NOTE: You can choose to only receive notifications when an alarm goes active or a
new incident happens.
Or you can choose to receive notifications on all activity.
9. Click Finish.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
2. In the notification rules table, find the row of the rule which you want to enable or disable,
and then turn Enabled on or off in this row.
3. Right-click the row and select Edit Rule to open Edit Notification Rule. You can also open
Edit Notification Rule by double-clicking the row.
4. In Edit Notification Rule, select the Settings tab and then turn Rule Enabled on or off.
5. Click Save.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
2. In the notification rules table, find the row of the rule which you want to edit, and then click
Edit in this row to open the Edit Notification Rule window
TIP: You can also open Edit Notification Rule through the Edit Rule command in the right-
click context menu or by double-clicking the row.
3. In Edit Notification Rule, select the tab that contains the settings you want to change.
5. Click Save.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
2. In the notification rules table, find the row of the rule which you want to delete, and then click
Delete in this row. This opens the Delete Notification Rule confirmation box.
TIP: You can also delete a notification rule through the Delete Rule command in the right-
click context menu.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Adding a recipient
Add a recipient to define the contact information for sending alarm notification messages. The
new recipient will be available in the notification rule wizard when adding or editing a rule.
To add a recipient:
1. In Notification Manager, select the Recipients tab, and then click Add Recipient to open
the Add Recipient window.
TIP: Click Duplicate or use the Duplicate Recipient command, in the right-click
context menu, to duplicate an existing recipient.
Email Address: The email address used to send email notifications to this recipient.
SMS Phone Number: The phone number used to send text notifications to this
recipient.
SNMP Server Name: The server name used to send SNMP message notifications to
this recipient.
TIP: Click Test to send a test email, test SMS message, or test SNMP message to confirm
that your entries are correct and valid.
NOTE: The notification settings for email, SMS, and SNMP must be configured correctly
before you can send test messages. See Editing notification settings for details.
3. Click OK.
NOTE: You can also add recipients though the notification rule wizard when adding or editing a
rule. Use the same process as described in steps 2-3 above.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Editing a recipient
Edit an existing recipient to update the recipient information such as name, email, or phone
number.
To edit a recipient:
2. In the recipients table, find the row of the recipient which you want to edit, and then click Edit
in this row to open the Edit Recipients window
TIP: You can also open Edit Recipients through the Edit Recipient command in the right-
click context menu or by double-clicking the row.
4. Click OK.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Deleting a recipient
Delete a recipient that is no longer needed.
NOTE: If you delete a recipient that is used in a notification rule, then this recipient is
automatically removed from the rule.
To delete a recipient:
2. In the recipients table, find the row of the recipient which you want to delete, and then click
Delete in this row. This opens the Delete Recipient confirmation box.
TIP: You can also delete a recipient through the Delete Recipient command in the right-
click context menu.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Adding a template
Add a template to customize the information that is included in the alarm notification messages.
The new template will be available in the notification rule wizard when adding or editing a rule.
NOTE: You can customize the notes text and hyperlink text that is included in a message. You
cannot customize the alarm details information in the message.
To add a template:
1. In Notification Manager, select the Templates tab, and then click Add Template to open the
Add Template window.
TIP: Click Duplicate or use the Duplicate Template command, in the right-click
context menu, to duplicate an existing template.
Note: The text that is included in the email, SMS, or SNMP message, after the alarm
details information.
Link: (Optional) A hyperlink that is included in the email, SMS, or SNMP message, after
the alarm details information and after the Note text.
3. Click OK.
NOTE: You can also add templates though the notification rule wizard when adding or editing a
rule. Use the same process as described in steps 2-3 above.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Editing a template
Edit an existing template to update the information that is included in the alarm notification
messages.
To edit a template:
2. In the templates table, find the row of the template which you want to edit, and then click Edit
in this row to open the Edit Template window
TIP: You can also open Edit Template through the Edit Template command in the right-
click context menu or by double-clicking the row.
4. Click OK.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Deleting a template
Delete a template that is no longer needed.
NOTE: If you delete a template that is used in a notification rule, the rule changes automatically
to using the default template.
To delete a template:
2. In the templates table, find the row of the template which you want to delete, and then click
Delete in this row. This opens the Delete Template confirmation box.
TIP: You can also delete a template through the Delete Template command in the right-
click context menu.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Adding a Schedule
Add a schedule to define the days and times when a notification rule is applied. The new schedule
will be available in the notification rule wizard when adding or editing a rule.
NOTE: A schedule only has an effect if the associated notification rule is enabled. If the rule is
disabled, the schedule is ignored.
NOTE: Schedules are shared across applications. For example, the same schedule can be used
for an alarm rule and a notification rule.
To add a schedule:
1. In Notification Manager, select the Schedules tab, and then click Add Schedule to open
the Add Schedule window.
TIP: Click Duplicate or use the Duplicate Schedule command, in the right-click
context menu, to duplicate an existing schedule.
3. Define the active and inactive days and times of the schedule.
4. Click Save.
NOTE: You can also add schedules though the notification rule wizard when adding or editing a
rule. Use the same process as described in steps 2-4 above.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Editing a schedule
Edit an existing schedule to change the days and times when a notification rule is applied.
NOTE: Schedules are shared across applications. For example, the same schedule can be used
for an alarm rule and a notification rule.
To edit a schedule:
2. In the schedules table, find the row of the schedule which you want to edit, and then click
Edit in this row to open the Edit Schedule window
TIP: You can also open Edit Schedule through the Edit Schedule command in the right-
click context menu or by double-clicking the row.
4. Click OK.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
Deleting a schedule
Delete a schedule that is no longer needed.
NOTE: Schedules are shared across applications. Confirm that a schedule is not in use before
deleting it.
NOTE: If you delete a schedule that is used in a notification rule, then this schedule is
automatically removed from the rule.
To delete a schedule:
2. In the schedules table, find the row of the schedule which you want to delete, and then click
Delete in this row. This opens the Delete Schedule confirmation box.
TIP: You can also delete a schedule through the Delete Schedule command in the right-
click context menu.
Related Topics:
Rules
• Adding a notification rule
Recipients
• Adding a recipient
• Editing a recipient
• Deleting a recipient
Templates
• Adding a template
• Editing a template
• Deleting a template
Schedules
• Adding a Schedule
• Editing a schedule
• Deleting a schedule
• Add Rule UI
• Add Recipient UI
• Add Template UI
• Schedules Configuration UI
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: This module requires a separate license. See Licensing for more information.
The Insulation Monitoring Module provides monitoring for isolated (IT) power systems, such as
the ones found in hospital operating rooms. It also helps in locating isolation faults. The module
can be configured for applications based on the IEC standard, and for applications based on the
ANSI standard.
To use the report and diagrams in this module, the module must be configured, and the
measurement data must be available as historical data logs in the database.
For information on how to configure this module for the ANSI and IEC markets, see:
• ANSI: Insulation Monitoring configuration (ANSI)
Related topics:
Insulation Monitoring Module topics
• Insulation Monitoring Module Design
1. Install and configure the devices and hardware components. See Insulation Monitoring
Hardware Configuration for ANSI for details.
3. Set up the VIP framework and configure the Vista diagrams. See Configuring the VIP
Framework and Vista Diagrams for ANSI for details.
4. Open the Insulation Monitoring report template in the Reports Web Application, set the
report input parameters, and generate the report.
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.
The Insulation Monitoring application includes several hardware components. Some of these
components communicate on an internal bus and must be configured with unique IP addresses
and unit IDs.
Set up the parameters for the installed hardware as described in this section.
The isolated power panel includes the circuit monitoring devices such as the IG6.
See the Bender Resources Web site for circuit monitoring device installation instructions.
NOTE: Make sure the clocks on all devices are correctly configured during commissioning so
that the reports you run show the correct timestamp.
NOTE: Make sure to always set the unit ID to 1. Doing this sets the gateway to Master mode
on the Bender bus.
See the Bender Resources Web site for instructions on how to configure the gateway.
The Iso-Gard™ IG6 line isolation monitor (LIM-IG6) is installed in the isolated power panel. This
device continuously calculates the total hazard current (THC) by measuring the leakage
impedance between isolated line and ground. Up to two LIM-IG6 monitors can be installed in one
panel.
NOTE: Set the Unit ID of the LIM IG6 to immediately succeed the Unit ID of the COM460.
For example, if you have a branch of COM460s with the devices connected to it, such as three
IG6s, two EDS 461s, and one CMS 460, then set the Unit IDs as follows:
• Set the Unit ID of the Serial devices that are connected to the IGC COM46x gateway.
• Set the total hazard current level to the appropriate value for your location.
NOTE: Make sure the clocks on all devices are correctly configured during commissioning so
that the reports you run show the correct timestamp.
See the LIM-IG6 documentation for instructions on how to install and operate the device.
The EDS 151 and EDS 461 circuit fault locator identifies the specific circuits where insulation
faults could result in current leakage that exceeds the defined total hazard current level. For this
solution, note the following:
NOTE: Make sure the clocks on all devices are correctly configured during commissioning so
that the reports you run show the correct timestamp.
• Set up the unit ID on the device. This ID must be unique from the unit ID and serial ID of other
devices.
See the EDS 151 and EDS 461 documentation for instructions on how to configure the device.
The solution can include an optional SWT3 or SWT4 circuit transformer for load monitoring.
See the LIM-IG6 documentation for instructions to connect wiring to the circuit transformer and
configure the device.
The temperature sensor monitors the temperature of the isolation transformer, if installed.
Temperature data appears in the Vista diagrams if the device is installed and set up in the
configuration tool.
See the LIM-IG6 documentation for instructions to connect wiring to the temperature sensor and
configure the device.
The CMS460 Load Current Evaluator is used to detect, monitor and evaluate loads and
installation for load currents in power supplies.
NOTE: Make sure the clocks on all devices are correctly configured during commissioning so
that the reports you run show the correct timestamp.
• Set up the unit ID on the device. This ID must be unique from the unit ID and serial ID of other
devices.
See the CMS460 Load Current Evaluator documentation for instructions on how to configure the
device.
After the parameters for the hardware components are configured, set up the communications for
the devices as described next.
• LIM-IG6 devices
• CMS460, if installed.
To configure devices:
3. Click Sites.
4. In the sites area, right-click and select New > Add Ethernet Gateway Site. The Ethernet
Gateway Site Configuration screen appears.
TCP/IP Address - This address must be unique from all other gateways and devices in
the system.
Example:
6. Click OK.
7. Click Devices to add the LIM-IG6 and EDS 151 / EDS 461 circuit fault locators that are
connected to the gateway.
8. In the devices area, right-click and select New > Serial Device on Ethernet Gateway Site.
The Serial Device Configuration screen appears.
9. Enter details for the LIM-IG6 or EDS 151 / EDS 461 device.
Name - Enter a name that will be recognizable in the Insulation Monitoring Configuration
Tool.
Unit ID - This value must be unique from all other devices in the system.
11. Repeat steps 8 - 10 for all other devices connected to the gateway.
After all devices associated with the gateway are added, repeat the above steps for other
gateways and their devices in the system.
After all hardware is configured, configure the areas and devices in the Insulation Monitoring
Configuration Tool.
NOTE: Configure the gateway and all devices connected to the gateway as a group. Then set up
another gateway and its associated devices.
NOTE: If there is only one LIM-IG6 in your system, you do not need to create a VIP and
configure the VIP framework. Instead, link the Vista status objects directly to the LIM-IG6. See
Finalizing the Vista Diagrams.
You need to create a new VIP to set up the insulation monitoring VIP framework.
To create a new VIP:
The VIP framework aggregates the alarm status for the different areas and group levels. The
framework logic combines the different statuses using an OR condition, which means the
summary status shows an alarm if one or more of the inputs are in an alarm state. The alarm
summaries are then displayed in the Vista diagrams
To configure the VIP framework:
1. Open Designer.
The framework contains two groups with four areas each. This is meant to be a starting
point. Add or remove areas, or entire groups to meet your needs. Here is an example of the
default framework:
4. Link the Common Registers > Common Alarm register from the LIM-IG6 isolation
monitors to the Area AND/OR modules. Each LIM-IG6 in an area must be linked to the
AND/OR module for this area. For example, if area 1 has three LIM-IG6, then all three must
be linked to the Area 01 AND/OR module.
After the VIP framework is configured, open the diagrams in Vista and link the alarm status
objects to the correct modules in the VIP framework, as shown below. The colors shown on the
status objects are:
• Green - Normal. The Total Hazard Current (THC) measurement is below the limit.
• Red - Alarm. The THC measurement exceeds the limit or the LIM-IG6 is in test mode.
• Gray - Unlinked. The object has not been connected to an alarm status register.
In the top-level Facility Summary diagram, link the alarm status object to the AND/OR module
output for the Group Level Status in the VIP framework.
NOTE: If there is only one LIM-IG6 in your system, link the Vista status object directly to the
Common Registers > Common Alarm register on the LIM-IG6.
In the example above, you would link the status object to the output of the Group 1 AND/OR
module in the VIP.
Area Diagrams
Link the area status objects in the diagram to the corresponding Area AND/OR module outputs in
the VIP framework.
NOTE: If there is only one LIM-IG6 in your system, link the Vista status object directly to the
Common Registers > Common Alarm register on the LIM-IG6.
Link the area details status objects in the diagram to the corresponding Common Registers >
Common Alarm register on the LIM-IG6.
1. Install and configure the devices and hardware components. See Insulation Monitoring
Hardware Configuration for IEC for details
3. Set up the VIP framework and configure the Vista diagrams. See Configuring the VIP
Framework and Vista Diagrams for IEC for details.
4. Open the Insulation Monitoring report template in the Reports Web Application, set the
report input parameters, and generate the report.
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:
• Isolated power panels, optional monitoring devices, and communications for hardware must
be installed in the designated areas.
• The insulation monitoring device must be configured correctly, and time synced to the EGX
gateway.
To configure devices:
3. Click Sites.
4. In the sites area, right-click and select New > Add Ethernet Gateway Site. The Ethernet
Gateway Site Configuration screen appears.
TCP/IP Address - This address must be unique from all other gateways and devices in
the system.
6. Click OK.
7. Click Devices to add the IM and IFL devices that are connected to the gateway.
8. In the devices area, right-click and select New > Serial Device on Ethernet Gateway Site.
The Serial Device Configuration screen appears.
Name - Enter a name that will be recognizable in the Insulation Monitoring Configuration
Tool.
Unit ID - This value must be unique from all other devices in the system.
11. Repeat steps 8 - 10 for all other devices connected to the gateway.
After all devices associated with the gateway are added, repeat the above steps for other
gateways and their devices in the system.
After all hardware is configured, configure the areas and devices in the Insulation Monitoring
Configuration Tool.
NOTE: Configure the gateway and all devices connected to the gateway as a group. Then set up
another gateway and its associated devices.
You need to create a new VIP to set up the insulation monitoring VIP framework.
To create a new VIP:
The VIP framework aggregates the alarm status for the different areas and group levels. The
framework logic combines the different statuses using an OR condition, which means the
summary status shows an alarm if one or more of the inputs are in an alarm state. The alarm
summaries are then displayed in the Vista diagrams
1. Open Designer.
The framework contains two groups with four areas each. This is meant to be a starting
point. Add or remove areas, or entire groups to meet your needs. Here is an example of the
default framework:
4. Link the Alarm Status > Insulation Status Alarm, Electrical Status Alarm, and Wiring
Connection Lost registers from the IMs to the Area AND/OR modules.
After the VIP framework is configured, open the diagrams in Vista and link the alarm status
objects to the correct modules in the VIP framework, as shown below. The colors shown on the
status objects are:
• Green - Normal. The Impedance measurement is below the limit.
• Gray - Unlinked. The object has not been connected to an alarm status register.
In the top-level Facility Summary diagram, link the alarm status object to the AND/OR module
output for the Group level Status in the VIP framework.
In the example above, you would link the status object to the output of the Group 1 AND/OR
module in the VIP.
Area Diagrams
Link the area status objects in the diagram to the corresponding Area AND/OR module outputs in
the VIP framework.
Link the area details status objects in the diagram to the corresponding Area AND/OR module
outputs in the VIP framework.
The Power Quality (PQ) Performance Module analyzes power quality event and disturbance data
as well as power factor measurements. It determines the potential impacts of power quality on the
monitored power system and displays the results in graphical formats, with color coding to
highlight problem areas. The module combines standard software features with specialized
components to produce its outputs. The module can also analyzes power quality event and
disturbance data as well as power factor measurements based on the hierarchy sites, which are
assigned to a user group.
The following reports, diagrams, and Dashboard Gadgets are part of this module:
• Power Quality Impact report
To use the reports, diagrams, and Dashboard Gadgets in this module, the module must be
configured. The measurement data must be available as historical data logs in the database.
For information on how to configure this module, see Configure Power Quality Performance.
For information on how to configure this module for multiple sites, see Configure Power Quality
Performance for multiple sites.
Related topics:
Power Quality Performance Module topics
• Power Quality Performance Module Design
NOTE:
No configuration is required for the following Gadgets:
Type Gadgets
Power Quality Rating Gadget
Power Quality Rating Gadgets
Power Quality Rating Trend Gadget
Power Quality Events Breakdown Gadget
Power Quality Events Detail Gadgets Power Quality Events Impact Gadget
Power Quality Events Location Gadget
The Power Quality Performance module relies on power quality measurements taken by the
monitoring devices in a system. It processes these measurements using back-end analytics
functions and VIP framework logic, and produces outputs that are displayed in Gadgets,
diagrams, and reports.
The module depends exclusively on historical data in the database. It does not use real-time data
from the devices directly. The back-end analytics does not modify the historical source data in the
database. The data is read from the database, processed, and then displayed.
The Power Quality Performance can do its analysis only if the monitoring devices (power meters,
circuit breakers) have been properly configured to capture power quality events and disturbances.
This section describes the following:
• Enable power quality event detection.
See Supported Devices for Power Quality Performance monitoring for supported devices.
Enabling power quality event detection on the supported meters involves:
• Enabling Sag/Swell detection
NOTE: DDD, available on select meters, is used to determine if the events are undetermined,
internal, or external to the system. Without DDD, all events will show as undetermined in the
Power Quality Performance features.
You can do this by using meter configuration tools (such as ION Setup), or by configuring the
meter directly. Refer to the meter documentation for more information.
In addition, you can configure ION meters (such as, ION9000, ION7650, PM8000, etc.), in PME
Vista.
After the power quality events are detected by the meter, they are classified by Power Monitoring
Expert Power Quality Event Classification method and stored in Power Monitoring Expert
database as:
• Interruptions
• Voltage Sag
• Voltage Swell
• Transient Voltage
• Over voltage
• Under voltage
See Power Quality Performance events and disturbances for information on PME Power Quality
Event Classification.
• Current Unbalance
• Voltage Harmonics
• Current Harmonics
• Frequency Variation
• Flicker
The supported meters are listed in Supported Devices for Power Quality Performance monitoring.
They are categorized as:
• Logged by Default – The supported measurements are logged by the default. For these
meters, no additional configuration is required. However, for brownfield installations, care
For example, for Voltage Unbalance, you may find both of the supported registers Voltage
Unbalance L-L Worst and Voltage Unbalance L-N Worst available in a non-ION device. Choose
the one which is required by your local standards.
Or, for Voltage Harmonics, you may find all the 8 supported registers available in a non-ION
device. If per-phase analysis is important to the customer on this device, choose the 3 per-phase
measurements based on your system and standards. If per-phase analysis is not important
(because of the load, design, or other reasons), choose only one measurement; either THD
Voltage L-L or THD Voltage L-N, which are the averages of the per-phase values.
NOTE: For each disturbance category, choose only the needed measurements from the
supported list to log. Do NOT log all of them; doing so can cause unwanted database growth and
performance issues.
NOTE: For non-ION devices, PQ Performance only supports the logged instantaneous values.
Do NOT log the calculated values (Mean, High, or Low). For Harmonics and Unbalance
measurements, the recommended logging Interval is 3600 seconds.
• For the non-ION meters, especially PM800 (except PM810 without PME810LOG), CM3000,
and CM4000, configure the on-board logging using meter configuration tools.
NOTE: The PM800 Series devices are supported, except the PM810 without PM810LOG.
Flicker
Flicker is only available when the supported meter has a PQ framework with EN50160 evaluation
enabled. Refer to the meter documentation for more information.
Once enabled, the flicker measurements are logged in 10-minute intervals by default. There is no
need to change the logging interval.
• Correctly associating the process impact alarms with power quality events.
The standard synchronization between the Power Monitoring Expert server and devices is
adequate for enabling Power Quality Performance features.
• For Modbus devices, time synchronization through Modbus is activated by default.
• For all ION protocol devices (e.g. ION7650, PM8000, etc.), the application engineer needs to
enable this feature.
NOTE: High accuracy of time synchronization (such as IRIG-B, etc.), can be used to address
user requirements, but it is not required for Power Quality Performance.
1. Connect to the device using ION Setup. On the Timezone tab for Clock, change entry for
the CL1 Time Sync Source to ETHERNET - ION. You can also do this on the meter front
panel.
2. In Management Console:
a. For an Ethernet device, set the Time Synch Ethernet Enabled to Yes in the Ethernet
Device Configuration.
b. For a serial device, set the Time Synch ION Enabled to Yes in the Ethernet Gateway
Site Configuration.
1. In SQL Server Management Studio, locate the dbo.vCFG_ConfigItems view in the ION_
Network database, and right-click to select "Edit Top 200 Rows".
The Power Quality (PQ) Indicator Diagrams introduce simple green-yellow-red indicators for the
most common power quality problems.
The PQ Indicator Diagrams are pre-configured with default settings. Complete the following steps
to enable the functionality:
• Paste the Power Quality Performance Framework
NOTE:
• The VIP.PQADVISOR ION Service must be running to proceed with the steps below. (The
service is configured to start automatically.)
• Installing the Power Quality Performance framework onto an ION VIP Service other than
VIP.PQADVISOR is not recommended.
• Installing the Power Quality Performance framework onto an ION VIP Service that has
existing modules that have been put in by a user is not recommended.
NOTE: Use the most current version of the fwn file available.
b. In the Source column, select the first list entry with a green check mark, press and hold
the Shift key, and then click the green check mark icon in the check box on the final
entry. This action applies the lock paste selection to all entries.
NOTICE
UNINTENDED DEVICE OPERATION
Do not use the lock paste option to overwrite existing destination modules.
Only use the lock paste option if you are an advanced user familiar with ION
architecture.
The diagrams start to function once the framework is pasted in the Power Quality Performance
VIP. You can link them to the existing Vista diagrams or use them separately.
NOTE: When a Power Quality Indicator has no supported device to feed it the required data, it
should be disabled by following the procedures in the section Disable unused Power Quality
Indicators.
Alternative symbols can be used to provide a colorblind friendly view. They are located in the
folder:
{root install
folder}\config\diagrams\images\PQPerformance\Indicators\Alternate\
• LandingPage_7d.dgm
• LandingPage_30d.dgm
• LandingPage_12m.dgm
The following sections describe how to set up and configure the Standardized Equipment Pages.
Skip this section if corrective equipment does not exist in the system.
• Configure the Framework for the Equipment Diagrams
Unlike the Power Quality Performance Indicator diagrams, the Equipment diagrams are not auto-
functional pages, but rather templates that you use during commissioning to provide the user with
equipment status displays with the same user experience and focus on simplification as the
Power Quality Performance Indicator pages.
The equipment diagram elements are:
• Equipment Diagram Landing Pages
The Corrective Equipment Status portion of the Power Quality Performance page is a landing
page.
When you select an element of the Equipment landing page (e.g. Capacitor Banks), the grouping
page opens. A summary entry for each device (e.g. Capacitor Bank) in the system could be
configured here.
When you select an element on the Equipment Grouping Page, the equipment diagram detail
page for that device opens.
Configuration Workflow
The order of commissioning is the opposite of user workflow. Set up the Detail Pages first, and
then create the buttons for each Detail Page on the Group Pages. The Landing Pages (both
Equipment and PQ Performance Indicator), require no commissioning other than optional
customization if required.
NOTE: The VIP.PQADVISOR service must be set up and running with the Power Quality
Performance Framework configured to commission the Equipment Diagrams.
The Power Quality Performance framework contains some template OR Logic modules and
simple instructions on configuring the VIP to work with the Equipment Pages:
Summary Section:
2. Double-click any of the ‘Formula’ Setup Registers to modify their value. The value entered
represents the number of devices of corresponding type listed directly to the right in the
Output Registers list.
3. Repeat Step 2 until there is a device count number for each of the listed devices.
b. Enter the name of the capacitor bank device in the Custom Label field.
3. Link the input of the new module to a device alarm status output by performing the following
steps:
a. Click the ION button on the toolbar to open the Create Link dialog.
b. Click the desired device, Alarms under Managers, Low Current Alarm under
Modules, and Low Current Alarm under Output Registers.
c. Click OK.
d. The cursor appears with a circle; click the input of the module and select NEW Source.
4. Repeat Step 3 until each of the capacitor bank’s desired alarm status is connected to the
module.
By doing this, the output of the module outputs a ‘1’ (High) state if any of the connected
alarm states are activated.
5. Link the output of the new module to the input of the module labeled Cap Bank Landing
Page.
7. Remove the link between the output of the template module and the input of the Landing
Page module:
a. Right-click the input of the Landing Page module.
c. Click Unlink.
8. Repeat Steps 1-7 for the Active Harmonic Filter and UPS device frameworks until each
desired corrective equipment device in the system is connected.
NOTE: The outputs of the modules configured for the individual devices drive the Equipment
Group Page indicators, and the outputs of the Landing Page modules drive the Landing Page
Indicators on both the Equipment Pages and Power Quality Performance Indicator pages.
To set up any of the detail pages using the provided template diagrams:
2. Highlight the template that will be used and copy it by pressing Ctrl+C and paste it using
Ctrl+V.
3. When the file is pasted, it is enabled for editing. Choose a new name for the diagram file;
preferably one that is easily associated with the device of interest.
NOTE: Take care not to overwrite the original template file by ensuring that the new file has
a new and distinct file name.
4. Open the PME Vista application and ensure that the toolbox is enabled.
5. Open the new file that was created in step 3 by selecting File > Open and navigating to the
containing folder in the dialog.
6. When the diagram opens, right-click anywhere on the background, and select Properties
on the menu.
8. On the Node tab, select Custom and then click Select to open the Select Node dialog.
9. Select the node name of the equipment for which the diagram was created, and click OK.
Provided the correct device was selected as the parent node of the page (that is, that the
device mapping is correct), all the fields and indicators on the page should populate and be
ready for use.
Verify that the device selected is the correct type for the template being used, and that the
device is configured correctly.
Once the page has been linked to the node, there are a few manual steps that should be
completed to customize the page:
b. Change the picture of the device from the sample image to a custom image, such as a
standard image or an actual picture of the device.
12. As a final step, click the folder icon in the Overview section to view the default diagram of the
device. Verify that the correct default diagram appears, and that the values and status
shown match what appears on the detail page.
This is made possible by creating and customizing "Buttons" that consist of grouping, numeric,
text, and status objects arranged to represent a clickable overview of a single device.
If there are less than eight devices of the Group Page type, then proceed to the Group Page
Buttons set up and Detail Page association. If there are more than eight, create more Group Page
diagrams. These new pages will be linked as tabs from the main device type Group Page.
Device scaling
The first step is to determine how many diagrams will be required by counting the number of
devices of the type in question. A single Group Page diagram has eight Button positions, so there
will need to be a Group Page diagram for each eight devices and portion thereof. For example, if
the system contains ten capacitor banks (each with its own Detail Page diagram), then there will
need to be two Group Page diagrams; one page with eight buttons, one page with two.
Alternately, a different organizational scheme can be incorporated by creating a Group Page for
each logical grouping of devices. For example, a separate Group Page can be created for each
production line in a facility, thus allowing the user to conveniently check the active harmonic filters
that are present for a production line that is experiencing problems.
Another option is to create Group Pages for different buildings or areas within a facility.
Ultimately, it is up to the deploying Application Engineer to determine the solution which makes
the most sense for the user's application.
Group scaling
Each Group Page has space for six tabs, therefore, if there are more than six Group Pages
required for a single device type, they need to be arranged into sub-types on the Landing page
level. For example, if there were twelve Group Pages for active harmonic filters, they need to be
split into two logical categories and treated separately on the Landing Page level.
For this set up guide, assume that there are only six or less Group Pages required in the steps
outlined below.
2. Highlight the template that will be used. Copy it by pressing Ctrl+C and paste it using
Ctrl+V.
3. When the file is pasted, the file name opens for editing.
Choose a new name for the diagram file; preferably one that reflects how the Group Pages
will be organized.
Note that the original file (the one that contains the word "All" or "Pg1" in the filename) will be
the main Group Page that is linked to/from the Equipment landing page. For example, if one
were creating an active harmonic filter Group Page for each floor of a facility the filenames
would be as follows:
a. Equipment_GroupPage__AHFAll.dgm (default filename for the first floor)
b. Equipment_GroupPage_ AHF_Floor2.dgm
c. Equipment_GroupPage__AHF_Floor3.dgm
And so on.
NOTE: Use the most current version of the dgm file available.
2. Open the first logical Group Page file that is to be set up by selecting File > Open from the
menu bar and navigating to the containing folder in the dialog.
3. Select the tab text (the green text Default Group in new installations) and press Ctrl+C to
copy it.
4. Press Ctrl+V to paste up to six text boxes - one for each Group Page.
5. Arrange the text boxes evenly along the tab line in up to five additional "tab" positions.
6. Change the text color for each of the pasted text boxes (but not the original) to black:
a. Right-click the text box to open the Text Box Configuration dialog.
c. Select Custom and click the Font button to open the Font dialog.
d. Select Black from the Color drop down menu and click OK.
7. Place a new Grouping Object over top of each new text box.
8. Change the shape of each new grouping object by left-clicking the object and dragging the
black tabs that appear.
The objects will be what the user will click to navigate to other tabs; they should therefore
cover the text underneath, and should not overlap.
9. Make each new grouping object link to the Group Page diagram referenced by the text
underneath it.
a. Right-click the grouping to open the Grouping Object Configuration dialog.
c. Select Open User Diagram and click the Browse button to open the Choose sub-
diagram dialog.
10. Make each new grouping object appear transparent to show the text underneath it.
a. Right-click the grouping to open the configuration dialog.
c. Select None.
11. Hold down the left mouse button and draw a marquee around the entire tab (text box and
grouping) objects.
2. Delete any existing text box objects in the tab area by selecting them and pressing Delete.
3. Press Ctrl+V to paste the tab objects from the previous Group Page diagram.
4. Change the color of the text in the text box that represents the first Group Page to black (see
"Setting up Tabs in the First Group Page', Step 6).
5. Add a new grouping object over top of the text that represents the first Group Page, modify it
to be transparent, and link it to the first Group Page diagram file (see "Setting up Tabs in the
First Group Page', steps 8-10).
6. Delete the grouping object in the tab area that links to the current Group Page by selecting it
and pressing Delete.
7. Change the color of the text in the text box that represents the current Group Page to green.
8. Change the background image of the diagram to one that has highlighting on the correct
portion of the tab area:
a. Right-click any unpopulated space on the diagram area and select Properties on the
menu.
Each Equipment diagram background image included in this installation is the same,
except for the position of a green highlight in the tab area. The filename of the
background image indicates where the green highlight is located. For example,
"PQEquip_Lvl1BG_Pos2.bmp" has a highlight in the second position from the left,
indicated by the "Pos2" text in the filename. Double-click the file to complete the
selection.
NOTE: Use the most current version of the bmp file available.
9. Repeat steps 1-8 until all Group Pages have the required tabs.
2. Open the Group Page file that is to be set up by selecting File > Open from the menu bar
and navigating to the containing folder in the dialog.
3. Hold down the left mouse button and draw a marquee around the template button in the top
left position of the page space, selecting all objects contained within.
5. Press Ctrl+V to paste up to seven additional buttons (for a total of eight on the page); one for
each device with a Detail Page.
6. Link an indicator (status) object to its corresponding ION module in the Power Quality
Performance Equipment VIP Framework:
a. Right-click the indicator (status) object.
b. Navigate to the correct module output by selecting the following in the Create Link
dialog:
a. Node: VIP.PQADVISOR.
c. Modules: the AND/OR module that was set up for the corresponding device in the
Equipment Status Indicator Framework step.
8. Link the numeric objects within the button to the corresponding outputs on the device.
a. Right-click the numeric object.
b. Navigate to the correct module output by selecting the following in the 'Create Link'
dialog; start by selecting the device in the 'Node' section and navigating to the desired
numeric output.
11. Repeat step 10 for each button (Grouping Object) on the page.
12. Repeat this process for each (corrective) device type in the system.
13. Repeat this process for any other Group Page diagrams in the system.
See the section called “How to Modify Indicators” in the Appendix called “How to Modify Power
Quality Performance Vista Diagrams” for instructions on how to link to ION Handles.
VarPlus Logic Capacitor Bank Button Measurement Display
Measurement Label in
Button Label ION Handle
Device
Power Factor - Target Target Cos Phi 01 0x8502E01
Power Factor - Measured Power Factor Total 0x8803701
Measurement Label in
Button Label ION Handle
Device
Total Load Current - A Load Current A Total 0x8100001
Total Load Current - B Load Current B Total 0x8100002
Total Load Current - C Load Current C Total 0x8100003
Measurement Label in
Button Label ION Handle
Device
Load Harmonic - A Load Harmonics Current A 0x810001B
Load Harmonic - B Load Harmonics Current B 0x810001C
Load Harmonic - C Load Harmonics Current C 0x810001D
The indicators (Status Objects) on the Landing Pages are linked to the output of the respective
Equipment Landing Page ION Module in the Power Quality Performance Framework of the
VIP.PQADVISOR service.
The Equipment Counts (Numeric Objects) are linked to the 'DEVICE COUNTS' ION Arithmetic
Module in the Equipment Status Indicator Framework. The number of devices of each category
within the system needs to be entered into the Setup Registers of the module.
1. Right-click the button (grouping object) area anywhere that there is no other object (such as
numeric or indicator).
• The customer's application demands multiple Landing Pages with custom groups of device
types. An example of this is pre-configured on default Landing Page; there is a tab for all
devices and a tab for corrective devices only.
When customization is required, follow the steps in this section for adding additional pages/tabs
and additional buttons. Note that the background images used for the Group Pages are the same
as those used in the Landing Pages.
An optional step is to create a link in Web Applications to view the Power Quality Performance
Vista diagrams:
See Customizing the Web Applications links for details on how to create this link. See Adding idle
detection to custom Web Application links for information on how to add idle detection to prevent
session timeouts.
OPC tags from the process. Power Monitoring Expert (working as OPC client) acquires
the process impact signals from process SCADA system (working as OPC server) via
OPC.
NOTE: If signals from multiple processes are connected to a single device (for example, process
A and process B signals on a PLC, power meter or OPC connection), then logical devices must
be defined to represent each process to be used in the power quality group definition.
To acquire the process impact signals (if Power Monitoring Expert is not detecting the process
impact independently), the following tasks may be required to accomplish the work:
• Using meter I/Os
After the process impact signals are connected into the Power Monitoring Expert system, or
Power Monitoring Expert is set up to detect the process impact independently, process impact
alarms need to be set up.
To set up process impact alarms:
1. Launch Software Alarms from Management Console > Tools > Web Tools, or from Web
Apps Settings > Alarms.
3. Select the Realtime Setpoint template if the alarm is based on an analog value. Select
Realtime Digital Setpoint template if the alarm is based on a digital value.
4. Select the Measurement that will be used to determine a process impact event (e.g.
Current Avg if using the current drops to signify the process impact, or Equipment State if
the process impact signal is mapped to this measurement for the Logical Device created for
the process)
NOTE: The string “Process Impact Alarm” is the only flag that the Power Quality Impact
report and gadgets looks for.
The alarm will go ON if the threshold has been exceeded for longer, in seconds, than the
“Pickup Delay” value.
The alarm will go OFF if the value is below the threshold for longer, in seconds, than the
“Dropout Delay” value.
8. Configure the Priority. Use a number less than 64 to prevent the alarm from appearing in
the PME Alarm Viewer.
10. Select the Source for the alarm rule. If a Logical Device is created to represent a process,
select the logical device.
11. (Optional) Define and select a schedule if you want to control when the Alarm is enabled or
disabled.
For more details on how to setup software based alarming see Software Alarms configuration.
The Power Quality Groups are defined per process (for example, a production line), so that only
the power quality events captured by the meter which relate to the particular process are
considered in the impact analysis.
Power Quality Groups must be defined or the Power Quality Impact gadgets and Report will not
function.
The incomer meters defined in the Power Quality Groups are also used for the Power Factor
section of the Power Quality Analysis Report.
a logical device if the Process Impact Alarm is defined on a logical device. See Set up process
impact alarms for more information. The load meter typically doesn’t have PQ event detection
capability.
• Rate – The flat hourly rate for the cost impact calculation
NOTE:
• The file structure only allows one incomer meter, one feeder meter, and one load meter per
row. If, for a category, more than one meter needs to be included, define them in multiple
lines with the same group name.
• The file structure allows one rate per group; define it only in the first row of the group.
• The PQ events captured by the meters in a Power Quality Group will be clustered before
associating with the Process Impact Alarms, so that the same event seen by different
meters are counted only once.
• Only the PQ events captured by the incomer meter and feeder meter are considered in the
analysis. If the load meter supports PQ event detection, and you want to include the events it
detects into the analysis, you need to define it as a feeder meter as well. See the examples
in next section.
• The incomer meters defined are also used by the Power Factor section of the Power Quality
Analysis Report to determine the incomer meters in the system. See the examples in next
section.
Edit PowerQualityGroup.csv
NOTE: Before editing the PowerQualityGroups.csv file, make sure you understand the
relationship between the power metering system and the process of the customer’s facility.
1. Identify the system name of a device, go to Device Manager, select Unique System ID in
the Column Selector to add the system name to the display:
2. Edit the file in Excel, Notepad or other text editor. For each Power Quality Group:
a. In column B, list all related incomer meters that can detect PQ events for the group. Use
multiple rows if there is more than one incomer meter.
b. In column C, list all related feeder meters that can detect PQ events for the group. Use
multiple rows if there is more than one feeder meter.
c. In column D, list all related load meters on which the Process Impact Alarms are
configured for the group. Use multiple rows if there is more than one load meter.
e. Specify the rate in column E for only the first row for the group.
NOTE:
• The list separators for the .csv are “,” for most regions, and “;” for several European
countries. The list separators will be detected from the culture settings and used by the
import/export exe.
• The rate under culture settings, other than English (en-XX), needs to be enclosed in double
quotes. For example, for Spain (es-ES), if the rate 123.456.789,0 is represented, it is input
as "123.456.789,0".
Example 1:
Take the metering layout in the following image as an example, the definition contains the
following:
Example 2:
Example 3:
As explained in the previous section, in addition to Example 2, if the feeder meters do not have
PQ event detection capability, there is no need to define them. (There is no effect if they are
defined.)
Example 4:
As explained in the previous section, in addition to Example 3, if the Process Impact Alarm for the
“Process A” is defined only under “Load.meter2”, then “Load.meter2” is the only meter that needs
to be defined for the “Process A”. (There is no effect if other load meters are included.)
Example 5:
As explained in the previous section, in addition to Example 4, if the “Load.meter3” can detect
sag/swell, and you want the event it captures to be included in the analysis, you need to duplicate
it as a feeder meter:
Example 6:
The incomer meters defined in the Power Quality Groups are also used for the Power Factor
section of the Power Quality Analysis Report.
If the customer does not require the Power Quality Impact feature, and only wants to enable the
Power Factor section of the Power Quality Analysis Report, the file can be created as:
If you are using the default file name and path, copy the following command line:
PQGroupConfig.exe import "C:\Program Files (x86)\Schneider
Electric\Power Monitoring
Expert\Applications\PowerQuality\PowerQualityGroups.csv"
If you are using the default file name and path, copy the following command line:
PQGroupConfig.exe export "C:\Program Files (x86)\Schneider
Electric\Power Monitoring
Expert\Applications\PowerQuality\PowerQualityGroups.csv"
NOTE:
• The Power Factor Impact Gadgets only work for billing periods that start on the first day of
the month. Billing periods that do not start on the 1st (for example, the 20th) are not
supported.
• The Viewing Period for the Power Factor Impact Gadget should be set to This Month or
Last Month. The gadget does not show meaningful information if you set the Viewing
Period to another value.
• The Aggregation Period for the Power Factor Impact Trend Gadget should be set to By
Month. The gadget does not show meaningful information if you set the Aggregation Period
to another value.
The calculated surcharge is based on the rate file defined for the PME Rate Engine. Creating or
modifying the rate files requires knowledge of the PME Rate Engine. To learn about the PME
Rate Engine, refer to PME Billing Module Toolkit.
The following sections describe the Power Factor Impact Gadgets configuration steps:
• Set up the Power Factor Impact rate file
The rate file Power Factor Impact Rate.xml is active by default. It includes the same
calculation as the first sample file. See Power Factor Rate File Calculation for the calculations of
the sample rate files.
To set up the Power Factor Impact rate file:
1. Consult with the customer to see how the power factor penalties are calculated by the utility
provider, including the power factor target under which penalty will be charged.
2. Choose the sample file in which the power factor penalty calculation is the closest to
customer’s utility contract.
3. Copy the selected rate file to the file name "Power Factor Impact Rate.xml"
4. Modify the file to have the same power factor penalty calculation with customer’s utility
contract. To learn how to modify the rate files, please refer to the PME Billing Module Toolkit
as mentioned above.
The PME Rate Engine only works with a hierarchy node. Therefore, you need to add the meters
which are subjected to the penalty to a hierarchy. You can do this with the default hierarchy, a
custom hierarchy, or virtual meters.
The gadgets only work on a single node. If more than one physical meter needs to be defined
(e.g. dual incomer from same utility), add the meters to a single node in the hierarchy, or add
meters to a single virtual meter.
For example, to add the dual incomer meters as a virtual meter:
4. Click Add and select a meter to add to the Virtual Meter. Repeat until you have added all the
meters that incur PF penalties.
After the hierarchy node is defined, it can be selected in the Power Factor Impact Gadgets.
The Power Factor section reports the power factor information for the incomer meters in the
system. The report retrieves the incomer meter definition from the Power Quality Group definition.
See for more information on how to define the incomer meters.
Alternatively, the Power Factor section can be toggled off when generating the report.
Power Quality Performance gadgets are grouped into two groups in Power Monitoring Expert
Dashboards:
• Power Quality Overview
Power Quality Impact
the corresponding trending gadget should be set to a time range of Last 12 Months, and an
aggregation of By Month.
NOTE: When you generate the Power Quality Performance reports, a reporting period longer
than 12 months is not supported. Use multiple yearly reports instead.
You can include or exclude certain meters for power quality assessment by Power Quality
Performance. For example, this capability is useful when you want to include only meters which
are critical, or to exclude spare meters, etc. Also, for performance reasons, it is important to
exclude unnecessary meters.
You can include or exclude the following Power Quality Event types:
• Interruptions
• Voltage Sags
• Voltage Swells
• Transient Voltage
• Over Voltage
• Under Voltage
And you include or exclude the following Power Quality Disturbance types:
• Voltage Unbalance
• Current Unbalance
• Voltage Harmonics
• Current Harmonics
• Frequency Variation
• Flicker
Each PQ event or disturbance has an inclusion list and an exclusion list, and the following logic
applies to both lists:
b. If the inclusion list is not empty, use only sources that exist in the inclusion list. If a
source in the inclusion list does not exist in the sources table, do not add it to the list.
The following features in the Power Quality Performance module which are affected by the
inclusion and exclusion lists:
• PQ Indicator Diagrams
• PQ Rating Gadget
• Power Quality Analysis Report – for all sections except the Power Factor section
• Devices considered for the Power Factor section of the Power Quality Analysis Report.
1. Identify the system name of the target device. Go to Device Manager, show Unique System
ID column using the Column Selector:
2. Go to SQL Server Management Studio, locate the dbo.vCFG_ConfigItems view in the ION_
Network database, and right-click and select "Edit Top 200 Rows".
3. In the Value fields, enter the comma delimited list of the devices, for example:
PQ.B1,PQ.B2,Main.BackupGenerator
4. To apply the changes immediately in the PQ Indicator Diagrams, go to the Power Quality
Performance Setup page in Vista:
5. To apply the changes immediately in the Power Quality Rating Gadgets, force the gadgets
to clear their cache by “editing” the gadget, and clicking Save (no changes are required).
To exclude all sources for a given category, put a string in the inclusion and exclusion list. For
example: “disabled”.
The Power Quality Indicator threshold for each indicator is displayed on the information page.
(Click the “i” icon.)
The thresholds are used to determine the Power Quality Rating by using a color (green, orange,
red) for each Power Quality indicator. Also, only the samples which exceed the threshold are
shown in the Detail Report of the PQ Indicator diagrams.
The count thresholds specified here are used to determine the colors for a year. They get divided
by 365 for Last 24 Hours, by 52 for Last 7 Days, and so on. The calculation is as follows:
For example, for 30 days, where the yearly limit for orange is 5 and the yearly limit for red is 15:
NOTE: The orange limits are >=, but the red limits are
1. In SQL Server Management Studio, in the ION_Network database locate the dbo.vCFG_
ConfigItems view.
2. Right-click the dbo.vCFG_ConfigItems view and select Edit Top 200 Rows.
The count thresholds specified here are used to determine the colors for a year. They get
divided by 365 for Last 24 Hours, by 52 for Last 7 Days, and so on. The calculation is as
follows:
For example, for 30 days, where the yearly limit for orange is 5 and the yearly limit for red is
15:
NOTE: The orange limits are >=, but the red limits are >.
4. For the PQ Indicator Diagrams to display the updated limit information, go to the Power
Quality Performance Setting page in Vista:
When setting up a baseline for the Power Quality Rating of the system, adjust the Weight Factor
to meet customer requirements, or to reflect the actual condition of the system. For example,
increase the weight for the indicator that is important to the customer, or decrease the weight for
the indicator that is not important.
NOTE: If a certain indicator is not available in the system, for example, no meter in the system
can monitor transient, set its weight to 0.
Where:
• PQ.Indicators.Value is a number indicating each Power Quality Indicator status, Green = 2 ;
Yellow= 1 ; Red = 0
• PQ.Indicators.MaxValue = 2 for each individual indicator.
• Weight Factor is an adjustable value (default=1) for assigning a different weight to each
individual indicator depending on customer requirements.
1. In SQL Server Management Studio, in the ION_Network database locate the dbo.vCFG_
ConfigItems view.
2. Right-click the dbo.vCFG_ConfigItems view and select Edit Top 200 Rows.
4. To apply the changes immediately in the Power Quality Rating Gadgets, force the gadgets
to clear their cache by “editing” the gadget, and then click Save (no changes are required).
When a Power Quality Indicator has no supported device to feed it the required data, disable it by
using the procedures in the following sections. See Supported Devices for Power Quality
Performance monitoring for meter support information.
1. To prevent Power Quality Performance from requesting Flicker values, add a string
“disabled” to the FlickerInclusionList & FlickerExclusionList (no double quotes needed). See
Change device inclusion and exclusion for the analysis for detail steps.
2. To prevent the Power Quality Performance indicator diagrams from displaying status:
a. Edit the VIP.PQADVISOR in Designer.
d. Link the switch output register of the new module to the Enable input register on the 4
XML import modules used for Flicker.
i. Right click on the newly created Ext Bool Module
ii. Change the Module Label and the switch Output Register Label to “Flicker Enable”
iii. Select the outputs for the Flicker Enable module and select “Flicker Enable”
iv. Select the input of the 24hr Flicker Count Import XML module and select “Flicker
Enable”
Since the Ext Boolean has a default value of “false”, the Flicker Count Import modules are
disabled upon saving the VIP.
1. To Power Quality Performance from requesting Transient values, add the string “disabled”
(without the quotes) to the TransientInclusionList and TransientExclusionList. See Change
device inclusion and exclusion for the analysis for detailed steps.
2. To prevent the Power Quality Performance indicator diagrams from displaying Transient
status:
a. Edit the VIP.PQADVISOR in Designer.
d. Double click on Formula 7 and add “S5 + “ to the beginning of the string. This will cause
the output of the equation to be NA because S5 is unassigned and therefore equivalent
to NA. If transients need to be added back to the system (e.g. a new meter which
supports transients is purchased for the site), then it is easy to remove the string “S5 +”
from the setup register string
4. Check the Power Quality Performance Indicator Diagram. The Transient Voltage icon
should be grey.
1. Create multiple sites and assign the devices for the created sites. See Creating a hierarchy
for information on site creation and assigning devices.
2. Add a user group for the created sites and assign devices to user group. See Adding a user
group for information on adding a user group and assigning devices to user group.
3. Perform the configuration of Power Quality Performance. See Configure Power Quality
Performance for configuration steps. Additionally, you need to perform the following specific
configuration:
Configure Power Quality Reports and Gadgets for multiple sites
1. Locate the PowerQualityGroups.csv file which is located under the folder: {root
install folder}\Applications\PowerQuality\.
2. Edit the file in Excel, Notepad or other text editor. If you are using Excel, for each power
quality group, specify the associated user group name in column F. See Edit
PowerQualityGroup.csv to follow the editing steps and example on different power quality
group.
5. Import the power quality group definition file. See Import / Export Power Quality Group
Definition for information regarding importing the definition file.
NOTE: It is recommended that VIPs created for Power Quality Performance analytics must be
used for Power Quality Performance analytics and must not be programmed for other data
processing tasks.
You need to create VIP service for each of the created sites.
This creates a VIP service with the name <custom name>. For example: if the custom
name is Production, then created VIP service name is NVIP.Production.
The default power quality framework is designed to process all devices information in a PME
system. For multiple site, each VIP is for a specific site and the framework must be configured to
include only the sources assigned to the site.
2. Rename the copied folder to identify for which site the folder is created. For example:
Rename to PQPerformance-Production for the Production site.
By default, the framework request analytics for the entire system via URLs similar to
http://localhost/WebServices/PowerQuality/Analytics.svc/2015-
07/Frequency?StartDaysAgo=30. To configure the specific site, the node path query
string parameter must be appended to these URLs.
The node path query contains two segments. The first segment identifies the view of the
hierarchy and the second segment identifies the node that represents the site.
For example, in the following tree view, Physical Layout is the view of the hierarchy and
Production is the node that represents the site. So, the node path is Physical
Layout/Production.
Based on the above example, the updated URL with node path is
http://localhost/WebServices/PowerQuality/Analytics.svc/2015-
07/Frequency?StartDaysAgo=30&nodePaths=Physical%20Layout/Product
ion
4. Find and update all URLs in the PQPerformance.fwn file using the following regular
expression:
NOTE: Use a find and replace tool to perform the update to the XML files rather than
manually performing the changes. The recommended tool is Notepad++ find and replace
utility in regular expression mode.
Find:
(https:\/\/fanyv88.com:443\/http\/localhost\/WebServices\/PowerQuality\/Analytics\.svc\/201
5-07\/.*=\d{1,3})
NOTE: Ensure the special encoding for the ampersand (&) and use %20 for spaces if
they exist in the node path.
5. Lock paste the created framework in Designer. See Paste the Power Quality Performance
Framework for information on pasting the framework.
The default diagram is designed to show all devices information in a PME system. For multiple
sites, each diagram is for a specific site and the diagram must be configured to include only those
sources assigned to the site.
2. Rename the copied folder to identify for which site the folder is created. For example:
Rename to PQPerformance-Production for the Production site.
3. Find and replace all VIP reference in the folder using the following regular expression:
NOTE: Use a find and replace tool to perform the update to the XML files rather than
manually performing the changes. The recommended tool is Notepad++ find and replace
utility in regular expression mode.
Find: VIP.PQADVISOR
4. Find and replace all links between the diagrams in the folder using the following regular
expression:
NOTE: Use a find and replace tool to perform the update to the XML files rather than
manually performing the changes. The recommended tool is Notepad++ find and replace
utility in regular expression mode.
Find: (xlink:href="x-pml:\/diagrams\/ud\/PQPerformance)
5. Open the Power Quality Indicator Diagrams. See Open the Power Quality Indicator
Diagrams for information on opening the diagrams.
The default log viewer query functions are designed to query all devices information in a PME
system. For multiple sites, each log viewer query function is for a specific site and the query must
be configured accordingly.
1. Find and replace all functional calls between the diagrams in the newly created folder for a
site using the following regular expression:
NOTE: Use a find and replace tool to perform the update to the XML files rather than
manually performing the changes. The recommended tool is Notepad++ find and replace
utility in regular expression mode.
NOTE: Use single quotes ' ' for the node path.
Layout/Production'\2.
3. Repeat step 1 - 2 for creating log viewer query functions for other sites.
The default diagram caption is Power Quality Performance. For each site created, this caption
can be changed so it can be uniquely identified.
1. Find and replace all instances of the default diagram caption in the newly created folder for a
site using the following regular expression:
NOTE: Use a find and replace tool to perform the update to the XML files rather than
manually performing the changes. The recommended tool is Notepad++ find and replace
utility in regular expression mode.
Use the Breaker Configuration Tool to configure the Breaker Performance Module. With this tool
you define Breaker Devices, Switchboards, and Groups for the Breaker Aging Report and the
Breaker Settings Report.
The reports have different configuration requirements. Not all of the components and properties
available in the configuration tool have to be configured for both of the report templates. See
Breaker Performance Module configuration for details.
Prerequisites
• The breaker monitoring devices that are recording the breaker data must be configured in the
PME Management Console before you can configure the components and properties in the
configuration tool.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not install incorrect drivers for the circuit breaker devices in the software.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
NOTE: The first time you open the Breaker Configuration Tool, you must set the regional
settings for the breaker aging engine. The Initial Configuration settings dialog is only displayed
the first time open the tool. After the initial selection, the tool remains in the selected setting for
future start ups. To show this dialog again, hold down Ctrl + Shift when opening the tool.
1. In the Breaker Configuration Tool, select the Breaker Device tab, and then click New to add
a new breaker.
You can also clone an existing breaker. To clone a breaker, select it in the list and then click
Clone. In the Select Breakers to Clone dialog box that opens, select the monitoring
devices that you want to configure as breakers and click OK.
NOTE: Cloned breakers have the same configuration settings as the original. After cloning,
you can edit the settings of the new breakers if necessary. You can only create clones for
monitoring devices of the same device type as the original.
Source: Select the monitoring device that is providing the data for this breaker. You can
only associate a monitoring device with one breaker in the tool.
NOTE: Select Enable Breaker Aging if this breaker is used for both the Breaker
Settings and the Breaker Aging features. Clear the check box for Enable Breaker
Aging if this breaker is only used for the Breaker Settings report.
4. (Only for Breaker Aging) Select Is existing breaker device if the breaker device is a pre-
existing breaker in your electrical system. Clear the check box for Is existing breaker
device if this is a new breaker in your electrical system. For pre-existing breakers, complete
the available fields.
NOTE: If you select Is existing breaker device, then you must ensure the breaker is
mapped to a switchboard, on the Switchboards tab, and Apply Historical Data is selected
for this Switchboard. Otherwise, the breaker aging calculations cannot be performed and
the diagrams will not display any values.
5. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Configuring switchboards
To configure switchboards:
1. In the Breaker Configuration Tool, click the Switchboards tab, and then click New to add a
new Switchboard.
Breakers: Select one or more breakers from the list. Each breaker can only be
associated with one switchboard in the system.
Current Environmental Data: Select values for Vibration Level, Humidity, and
Temperature.
4. (Only for Breaker Aging) Select Apply Historical Data if the switchboard is pre-existing in
your electrical system. Clear the check box for Apply Historical Data if this is a new
switchboard in your electrical system. For pre-existing switchboards, select values for
Vibration Level, Temperature, and Humidity.
5. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Configuring groups
To configure groups:
1. In the Breaker Configuration Tool, click the Groups tab, and then click New to add a new
group.
Switchboards Select one or more switchboards from the list. The same switchboard
can be used in multiple groups.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
1. In the Breaker Configuration Tool, click the Groups tab, and then click Generate Vista
Diagrams to open the Vista Diagram Generation dialog.
2. In Vista Diagram Generation, select the output path for the diagram files and select the
groups for which you want to generate diagrams.
3. (Optional) Select Include Custom Logo and then select the logo image file for the
diagrams. By default, a Schneider Electric logo appears.
4. Under Options, drag the indicator to define the width of Vista diagrams you generate.
5. Click Generate Vista Diagrams to generate the diagram files, then click Close.
Designer
Use Designer to configure nodes on your network that are based on ION Architecture. The node
can be a software component or a hardware device.
NOTE: Only nodes based on ION Architecture can be configured using Designer.
Designer’s graphical user interface helps visualize a node's configuration. You can link ION
modules together to customize a node for your particular application. You can also cut, copy and
paste functionality within a single node or between different nodes.
WARNING
UNINTENDED EQUIPMENT OPERATION
Do not use a controlled output for any safety critical application due to possible unexpected
changes of state during power cycles, power outages, configuration changes, or firmware
upgrades.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Only personnel with a thorough understanding of ION architecture and the system in which the
meters and software are installed can configure ION modules and registers.
For more information on ION Architecture, ION modules or ION registers, see the ION Reference.
The functions used in traditional power monitoring are treated as discrete modular objects that
can be interconnected and customized. These objects, known as ION modules, are the basic
building blocks that comprise a node.
Designer is used to make any changes to the operation of an ION-compliant node. ION devices,
the Virtual Processor and Log Inserter are all configured using Designer.
For those already familiar with Designer, see Designer shortcuts for a list of the most commonly
used commands.
For instructions on logging in to or exiting Designer, see Logging into a component and Ending a
session, respectively.
Workspace
with open Core module (indicated by
A Menu bar B Toolbar C D
node double border)
diagram
Grouping
E Toolbox F Status line G H Shortcut icon
object
I Module link J Module icon K Time display L Progress indicator
M Communication status lights
Title bar
The title bar displays the name of the program, the user name, and the name of the active node
diagram.
Menu bar
Below the title bar is the menu bar. Click on a menu name to display a list of available commands.
Toolbar
The Toolbar offers quick access to the commands used most frequently. Each command offered
on the toolbar is also available from the menu bar.
A Open E Cut
B Save F Copy
C Reset G Paste
D Create a link H Help
When you point at a toolbar button, a description of it appears in the status bar at the bottom of the
screen and on a small ToolTip beside the button.
Workspace
The main area in the center of the screen is the workspace, where you view and edit node
diagrams.
Status bar
The status bar displays status information. The components, from left to right, are:
• Status line: Describes any active processes and provides brief descriptions of the currently
selected command or toolbar button. For example, when you move the pointer over a toolbar
button or click on a menu name, a brief description of the item appears in the status line.
• Time display: Displays the current time on the workstation.
In some cases, groups of modules are organized inside grouping windows. When closed, a
grouping window appears as a grouping object (an icon that looks like a folder). Click a group
object to open the grouping window that contains the module icons.
Use Designer to configure hardware nodes (for example, ION meters) or software nodes (for
example, Virtual Processor or Log Inserter).
NOTICE
LOSS OF DATA
Do not leave hardware or software nodes open in Designer, as this stops log downloads from
the device.
When a meter is opened in Designer, the default diagrams for the appropriate meter and default
template are loaded automatically.
When you select a node from the list, Designer communicates with the specified node and
opens the applicable node diagram.
NOTICE
UNINTENDED DEVICE OPERATION
Do not open a node diagram if the node is currently being configured from its front panel.
When Designer loads a node diagram, it compares the diagram with the configuration of the node.
If there are any discrepancies between the diagram and the node, Designer updates the diagram
to match the node:
• If a diagram depicts a module that does not exist on the node, Designer deletes the module
icon from the diagram.
• If a node contains a module that is not depicted in the diagram, Designer adds the module
icon to the diagram.
• If the links between modules differ from node to diagram, Designer adjusts the diagram to
match the node.
A node diagram typically does not differ from the node's true configuration unless the node's
configuration was changed through other means (for example, with a remote display unit.)
• To save all open node diagrams, select File > Send & Save All.
• Select File > Close All to close all open diagrams and windows.
If you attempt to close a diagram without saving your changes, Designer displays a message with
a list of the modules affected.
You can then do one of the following:
• Click OK to return to the diagram and save your work before closing the diagram.
• Click Close Anyway to discard any unsaved changes and close the diagram.
NOTE: If you reopen a diagram containing unsaved changes, Designer may list the unsaved
changes as offline modules.
Display mode allows you to view the node diagram without making changes. To prevent
accidentally moving or deleting modules or links, use Display mode when navigating node
diagrams. In Display mode, single-click grouping objects to open associated grouping windows.
Edit mode allows you to configure the node and the appearance of the node diagram. In Edit
mode, double-click grouping objects to open associated grouping windows. Right-click objects
or icons to view configuration options.
For more information on the Toolbox, see Using the ION modules toolbox.
Designer shortcuts
Designer provides several shortcuts to assist in programming the nodes.
A Input
B Output
The following table lists the different mouse and keyboard combinations you can perform on a
module’s input or output symbols, and their corresponding functions:
Action Result
The list of inputs appears - you can select an input and link it to
Left-click input
another module's output register
The list of inputs appears with the current input values displayed in
SHIFT + left-click input
square brackets
The Delete Links dialog appears - you can break links from this
Right-click input
dialog.
The Delete Links dialog appears, showing inputs and current input
SHIFT + right-click input
values in square brackets
Left-click output The list of output registers appears
The list of output registers appears with the current register value
SHIFT + left-click output
displayed in square brackets
The list of setup registers appears - these setup registers can be
CTRL + left-click output
linked to inputs on other modules
SHIFT + CTRL + left-click The list of setup registers appears with the current register settings
output displayed in square brackets
The list of output register owners appears - you can break links
Right-click output
from this dialog
The list of setup register owners appears - you can break links
CTRL + right-click output
from this dialog
NOTE: To create a shortcut to an ION module, see Creating a shortcut to an ION module.
Designer icons
In each node diagram, Designer uses icons to represent the configuration of the node. There are
two basic types of icons: module icons and grouping icons.
Module icons represent ION modules located on the node. Grouping icons represent a group of
module icons.
Module icons
All module icons share four common elements: a label, a graphic, an input symbol and an output
symbol.
A Label C Graphic
B Input Symbol D Output Symbol
• The graphic shows a picture to distinguish one type of module from another.
• The input and output symbols provide access to the module's input and output registers.
Click the left symbol to display a list of inputs; click the right symbol to display a list of output
registers. See Linking ION modules for more information.
Module icons with a double border represent core modules; module icons with a single border
represent standard modules. For more information on core and standard modules, see Core
modules and standard modules.
A grouping window acts as a folder or sub-window where you can store icons that you want to
keep together. For example, you can use grouping windows to group module icons by
application—a single grouping window may contain all module icons required for demand or
advanced setup routines.
You can use a grouping window much like a standard window. You can create, rename or delete
a grouping window; you can move a grouping window within a diagram, and you can move a
module into or out of a grouping window.
When you finish editing the grouping window, close it to minimize the window to its corresponding
grouping icon in the node diagram.
To move an icon (or group of icons) to or from an open grouping window, select it and drag it to
the new location.
Drag the grouping window by the title bar and position it so that you can see the icon(s) that
you want to move.
2. Select the icon(s) you want to move and drag the selection into the grouping window.
When you move a linked module icon into a grouping window, the module remains linked but any
lines that represent links to modules outside the window disappear.
To create a new grouping window, drag the grouping object from the toolbox onto the node
diagram.
The ION modules toolbox is a collection of ION modules and generic tools that you can add to a
node diagram. If the ION modules toolbox is not displayed, select Options > Show Toolbox. See
Using the ION modules toolbox for more information.
When you point to an object in the toolbox, the name of the object is displayed on a ToolTip. You
can use ToolTips to identify the grouping object in the toolbox.
When you create a new grouping window, the default name is that of the node diagram. To
change the name of a grouping window, rename the grouping icon:
1. Right-click the grouping icon to open the Grouping Object Configuration dialog.
2. Select Use Custom from the Caption section and type the new name into the text box.
3. Click OK.
1. Right-click the grouping icon to open the Grouping Object Configuration dialog.
To use a different font, select Custom, then click Font to open the Font dialog. Select
the font options you want then click OK to continue.
3. Click OK.
1. Right-click the grouping icon to open the Grouping Object Configuration dialog.
2. Select either Top or Bottom in the Position section to specify a caption position above or
below the grouping icon.
3. Click OK.
NOTE: When you delete a grouping window, any modules inside are deleted as well. Designer
displays a message before deleting modules. See Deleting or cutting an ION module for more
information on deleting modules.
2. Press the Delete key. If the grouping window contains modules, Designer displays a list of
modules that will be deleted.
• Default labels: All modules have a default label. The default label identifies the module by
type and, if applicable, by number. It appears in node diagrams, user diagrams and event logs
unless a custom label is available.
• Custom labels: Custom labels are available only if they have been preconfigured by a user.
A custom label usually identifies a module by its function or purpose. Custom labels are useful
for describing modules, setup registers, output registers, and Boolean ON/OFF conditions.
For information on adding custom labels, see Customizing a module label.
Select Options > Show Default Labels to toggle the option on or off.
• When Show Default Labels is selected, default labels are displayed.
• When Show Default Labels is not selected, custom labels are displayed.
NOTE: Moving the icons in a node diagram does not affect the function of the modules or the
node in any way.
Moving icons
When a grouping icon is selected, all icons within its grouping window are automatically
selected as well.
NOTE: When selecting a group of icons, you can only choose icons from within the active
window.
NOTE: Arranging the icons in a node diagram does not affect the function of the modules or the
node in any way.
If an icon appears on top of another icon that you want to bring to the front, select the icon that is
sitting on top, then click CTRL+K (or click Edit > Send to Back).
Aligning icons
The Align tab in the Layout dialog allows you to specify the horizontal and vertical alignment of
selected objects.
To align objects:
3. Select the Align tab and set the horizontal and vertical alignment of the icons.
The options in each area determine the criteria by which you can align icons. For example, if
you select Left sides under Horizontal and Space evenly under Vertical, Designer aligns
all objects in the selection by their left sides (using the leftmost object for reference) and
distributes them evenly along a vertical axis.
4. Click OK.
The Grid tab in the Layout dialog activates and configures an invisible grid. Icons placed onto the
grid snap to the nearest gridline to help align and space them evenly.
To activate or deactivate the grid:
Grid size in pixels activates the grid. Type a number in the Grid size in pixels box to
specify the size of the grid (distance between grid lines).
Designer windows
To create links between several node diagrams or grouping windows, you need to position the
open windows so you can see all the modules involved. Use the Window menu to organize open
windows in the workspace.
1. Right-click the background of the window and select Background Color to open the Color
dialog.
2. Select the color you want or click Define Custom Colors for more options.
3. Click OK.
When choosing a background color, consider how the color affects the visibility of icons and links.
Links, highlights and shadow effects used to depict the various states of an ION module may not
appear against certain background colors. For this reason, you should avoid using certain colors
for your background, particularly white, dark gray and black.
1. Right-click the background of the window and select Default Font to open the Font dialog.
3. Click OK.
Fonts can also be specified individually for grouping windows and text boxes. See Changing the
font of a grouping window and Changing the font of a Text Box for more information.
This section explains how to add and remove ION modules from your node diagram. It describes
the basic types of modules, and explains how you can organize your node diagram by grouping
modules together, arranging them, and labeling them.
For more information on ION modules and architecture, refer to the ION Reference.
A register is a type of memory bank that stores a module's linking and configuration information.
Each module uses two types of registers: output registers and setup registers.
The terms “online” and “offline” describe whether a module is currently active or not. A module is
described as online when it is functioning normally (monitoring its input and updating its output
registers). An offline module is inactive.
Anytime you send and save changes to a node, Designer temporarily takes the affected modules
offline and programs them with your changes. After they have been programmed, the modules
are then placed back online.
Normally, this is a routine procedure. However, certain circumstances may cause a module to
remain offline. For example, if the node lacks sufficient processing power to operate the module,
the module remains offline.
You can easily identify any offline modules: all offline modules are highlighted with a red outline.
In addition, whenever you open a node diagram, Designer displays a list of all offline modules in
the node.
NOTE: If you have offline modules in your node, you may be able to put them back online by
selecting File > Send & Save.
The terms “programmed” (left) and “pending” (right) refer to whether or not a module's
representation in the node diagram matches the node itself.
Programmed: A programmed module is one that is the same both in the node diagram and in the
node. The links, labels and setup register values in the node diagram exactly match those on the
node. When you first open a node diagram, all the modules appear programmed since they are
read directly from the node itself and then displayed in the node diagram.
Pending: A pending module is one where changes have been made to the module in the node
diagram and not yet sent to the node, so the node diagram does not match the node. The borders
of pending module icons appear as a dashed line.
If you change a module in the node diagram (for example, re-link it or edit its setup registers), it
does not match the node until you select File > Send & Save. Until it is saved, the edited module
is depicted as pending to indicate that it does not match the configuration on the node. When you
send and save your changes to the node, the module becomes programmed.
There are two basic types of ION modules: core (left) and standard (right).
Core modules are required ION modules that are fundamental to the operation of the node. You
cannot add or delete core modules and, in some cases, you cannot configure them. Core module
icons are identified by a double border around the edge. The Power Meter module is an example
of a core module.
Standard modules are reusable ION modules. Generally, most modules in a node are standard
modules. You can add or delete standard modules as required. Standard modules icons are
identified by a single border. The Setpoint module is an example of a standard module.
Persistent modules
Similar to core modules in that they cannot be added or deleted, persistent modules are standard
modules that have been converted to core modules. These modules are created at the factory,
and can never be removed from the meter frameworks. Persistent modules are represented by
An example of a persistent module is External Pulse module #1 on the ION8600 meter. This
module pulses when the Demand Reset switch is pressed on the meter.
This section describes how to locate an existing module, how to add a new module, and how to
delete a module. It also explains how to create a shortcut to a module and how to view the
contents of a module in text format.
After you have located or added the module you want, you can configure it using the procedure
described in Linking ION modules.
The type and quantity of modules offered on the toolbox varies depending on the type of node you
are configuring; however, the generic tools (the grouping and text objects) are available for all
nodes.
NOTE: To identify a module in the toolbox, point to it with the mouse—the module type is
displayed as a ToolTip and on the status line at the bottom of the screen.
To add a module to your node diagram (and to the node itself), drag its icon from the toolbox into
the diagram window.
1. To display the module tray, right-click the toolbox icon for the type of module you want to
locate. The module tray appears beside the toolbox.
The module tray displays links to all modules of that type that are currently in use on the
node—for example, in the image above, there are 22 Setpoint modules in use by the node.
To identify a link in the tray, point to it—the module's label is displayed on the status line at
the bottom of the screen.
2. To locate a particular module, click its link in the module tray. Designer locates the module
and displays it in the center of the workspace. If the module is located inside a grouping
window, Designer opens the window to display the module.
TIP: To close the module tray, click on any module icon in the toolbox.
Drag the icon of the module you want to add from the toolbox onto the node diagram.
As you drag the icon, the cursor changes shape to indicate you are placing an object.
Designer adds the module and places a pending module icon into the diagram. You can then link
and configure the module.
NOTICE
UNINTENDED DEVICE OPERATION
Do not delete any ION modules without knowing which modules are dependent on it.
Failure to follow these instructions can result in the unintended operation of the
remaining modules.
NOTE: Each time a module is deleted, all of its output registers, setup registers and input links
are deleted as well. Removing this information from the node affects the operation of any
modules that depend on it. For this reason, you should be aware of all dependent modules (also
known as owners) before you delete anything.
You can view a register's owners to quickly identify all dependent modules on the node. You can
determine what purpose the modules serve, and then decide whether to delete them or not.
To view the owners of a module’s setup registers, hold the CTRL key and then right-click
the output symbol.
The dialog lists all of the module's registers and any dependent modules on the node
(dependent modules on other nodes are not displayed).
2. Click a register in the Registers list to display the owners of that register in the Owners list on
the right. Owner information includes the module name or label and its relevant input.
3. If necessary, delete the link between a register and one of its owners. Select the owner from
the Owners list and click Unlink. (See Deleting links for more information on deleting
module links.)
4. When you have finished viewing the register owners, click OK.
Displaying a module's register owners is an effective way to locate dependent modules on the
selected node but it does not show any dependent modules located on another node.
If you remove a module with a dependent module on another node, the dependent module's
inputs are not reset. It continues to look for the deleted output register.
If you are not sure whether a module has dependents on other nodes, check with the person who
programmed them to ensure you do not disrupt the operation of any modules on that node. If you
still want to remove the module, you may want to directly delete the link on the other node first. In
this way the module is not inadvertently linked to the next module to occupy the location of the
deleted module.
In either case, Designer immediately removes the icon from the node diagram and deletes the
module from the node. The difference is, when you delete a module, it is discarded; when you cut
a module, it can be restored (by selecting Edit > Paste).
NOTE: You do not have to select Send & Save Changes to delete a module. Designer
immediately removes the module from both the diagram and the node.
NOTICE
UNINTENDED DEVICE OPERATION
Do not delete any ION modules without knowing which modules are dependent on it.
Failure to follow these instructions can result in the unintended operation of the
remaining modules.
NOTE: If a module has a dependent module on another node, Designer does NOT alert
you of the dependency when you delete it. Before you delete a module, ensure that you are
aware of all links to modules on other nodes.
The summary lists all selected modules, and identifies those in the selection that will be
deleted (including those with dependents on that node) and those that will not. Select a
module in this list to display any additional information available in the field at the bottom of
the dialog.
3. Click OK to remove the selected modules (or Cancel to abort the procedure).
Designer removes the module icon from the node diagram and deletes the module from the
node itself.
NOTE: If you delete a shortcut icon, the original module is not affected. However, when you
delete the original module, all shortcuts to that module are also deleted.
TIP: To select all modules in the node, left-click on the background of the main node
window, being careful not to click on a module icon, then select Edit > Select All.
2. Select Options > View Diagram Text to open the Text View screen. The text of any
modules that are offline appears in red.
• The Text View screen offers several ways to view, sort and find information:
• In the Find text field, type a text string and click Find to find that text string in the data.
To reset the text view after you have made a configuration change, click Refresh. If you want to
print a copy of the text view information, click Print. When you are finished viewing the text view
information, click Close.
A shortcut icon is identified by a symbol in the lower left corner of a module icon.
Hold down SHIFT+CTRL then drag the module icon(s) to the window where you want to place the
shortcut(s).
After you have created a shortcut icon, you can use it in the same way you use the original module
icon. Both icons support the same features. However, if you delete the shortcut icon, the original
module icon is not deleted; whereas if you delete the module icon, it deletes all shortcuts to that
module.
NOTE: You cannot create more than one shortcut icon per window for a single module.
1. Drag a Text Box object ( ) from the toolbox onto the node diagram.
A text box opens in the diagram with the default message: “Your text goes here.”
2. Right-click the text box to replace the default text with your own text. The Text Box
Configuration dialog opens.
Select the Edit Text tab, then do one of the following:
To display the name of the node in the text box, select Use Default.
3. To display your own message, select Use Custom and type your text into the field provided.
The font, size and style of the text used in the text box is based on the default setting specified for
the active window. If you want to use a different font, you can specify a new font for the text box:
1. Right-click the text box to open the Text Box Configuration dialog.
To use a different font, select Custom, then click Font to open the Font dialog. Specify
a font, style, and size. Click OK to continue.
4. Click OK.
1. Right-click the text box to open the Text Box Configuration dialog.
4. Click OK.
1. Right-click the text box to open the Text Box Configuration dialog.
To set the width of the border, type a border width in the “Width in pixels” field in the
Border section.
To add a background color, select Custom in the Background Color section and click
Color to select a background color.
4. Click OK.
In some cases, you may not want to add a new module. For example, if all the modules of a
particular type are already used, you need to re-link one of them to perform the new function. Most
devices are preconfigured at the factory to provide common measurements and calculations. If
any of these factory defaults are unnecessary in your application, you can unlink the modules
involved and reuse them.
Plan ahead before you add new modules. Unlinked modules are wasted resources.
You may find a linked module that you can use to add a new link, in order to augment the function
it is performing. For example, if you have a Setpoint module that triggers a waveform recording,
then later decide to use this trigger to reset a counter, you can link that Counter module to the
same Setpoint that controls the Waveform Recorder module.
You can use the autolinking feature to speed up the process of linking ION modules. Typically,
linking ION modules involves connecting the output register of one module to the input of another.
In many cases, only one of the module's inputs have the same register class as the selected
output register.
If autolinking is enabled, Designer automatically selects the appropriate input and establishes the
link. If necessary, it overwrites an existing link. This relieves you from having to manually select
the input; however, you cannot see what input you are linking to.
By default, autolinking is disabled. You should only use autolinking if you are thoroughly familiar
with all the inputs and output registers of the modules you are working with so that you do not
inadvertently create undesirable links.
Enabling autolinking
To enable autolinking, select Options > Enable Autolinking. A check mark beside the option
indicates it is selected.
Disabling autolinking
NOTE: To cancel a link-in-progress, click anywhere in the background of the window or press
the ESC key.
1. To list a module's output registers, click the output symbol on the right side of the module
icon. To list the module's setup registers, hold the CTRL key while clicking the output
symbol.
Either a menu opens or, if the module has many registers, a dialog opens listing the
available registers.
In the dialog, double-click the register (or click it then click Select).
3. Move the cursor towards the module you want to link to. The cursor changes and a dotted
line follows it across the node diagram. This indicates you are in the process of creating a
link and it shows where the connecting line will appear in the node diagram.
If you link to a module that is in a different window than the original module (either in a
different node diagram or grouping window) the dotted line disappears but the cursor still
indicates that a link is in progress.
If the module you want is obscured by another window, click on the title bar of the window
containing the module. This brings the window to the foreground without canceling the link.
(If you click on the background of the window, the link is cancelled.)
4. Click the input symbol of the module that you want to link to display the module's inputs.
Either a menu opens or, if the module has many registers, a dialog opens listing the
module's inputs.
If the input is already linked, the label of the register it is linked to is displayed beside the
input. If you select the input, the existing link is overwritten.
The inputs that are of a different class than the selected output register are grayed out to
indicate you cannot select them.
In the dialog, double-click the register (or click it then click Select).
6. Select File > Send & Save to save your changes to the node.
The procedure described above can also be performed in reverse order. You can select a
module's input first and then link it to another module's output register.
If the two modules are in the same window, the line remains on the screen to show the link
between the modules—when you save this change to the node, the line changes from a dotted
line to a thin black line to indicate that the link is now programmed on the node.
NOTE: You cannot link modules on one device to another. For example, you cannot create a link
between a module on an ION7330 to a module on a different ION7330 or to a module on another
meter.
1. Open the node diagrams that contain the modules you want to link.
2. Position the diagrams within the workspace so you can see the two modules you want to
link.
3. In the first node diagram, click on the output symbol of the module icon. A menu or dialog
opens listing the module's output registers.
4. In the list of output registers, click the register you want. (In the case of the dialog, click a
register and then click Select.)
5. Drag the cursor from the first node diagram to the module you want to link to in the second
node diagram. The dotted line ceases to follow the cursor if it crosses the window boundary
but the cursor changes to indicate a link is in progress.
6. Click on the input symbol of the module icon in the second node diagram. A menu or dialog
opens listing the module's inputs. Those that are of a different class than the selected output
register are grayed out to indicate you cannot select them.
7. Click the input you want, or in the case of the dialog, click the input then click Select.
Designer does not graphically represent links between modules on different nodes so you
will not see a line connecting the modules.
8. Select File > Send & Save to save your changes to the node.
This procedure can also be performed in reverse order. You can select a module's input first and
then link it to another module's output register.
NOTE: If the input is already linked, the label of the register it is linked to is displayed beside the
input. If you select this input, the existing link is overwritten.
While creating links, you may notice that the circle at the end of the arrow cursor is sometimes
black ( ).
This indicates that Designer is in the process of retrieving information about a module. You can
still click on the inputs or outputs of other modules, but Designer aborts the original request. To
minimize the amount of communications between Designer and the connected nodes, avoid
unnecessary clicking on the input and output symbols.
If you click on several items in a row, you only see the menu for the last item you click; however,
Designer initiates many requests for information, which may impact its performance.
The ION tree is also the only way to select registers from devices that are not ION-compliant (and
use translators to make data available) such as 3000 series meters. For example, if you are
programming a Virtual Processor node and you want to sum data from several 3720 ACMs, you
must access the 3720 ACM register via the ION tree.
Using the ION tree is faster than opening a node diagram. It is useful if you want to link to a
register on a node whose diagram has not yet been opened. It is also useful if you want to link to a
register, but you are not acquainted with the configuration of the node in which it resides. You can
go straight to the register without having to navigate through an unfamiliar node diagram. Also,
since a diagram can only be accessed by one user at a time, you can use the ION tree to link to a
register on another node where the diagram is already open.
1. Click the input symbol of the module icon. A list of the module's inputs is displayed.
3. Click the button in the toolbar. (To link a module's setup register, hold the CTRL key
while clicking this button.)
The Create Link dialog opens, providing access to the ION tree.
4. Specify a node, manager, module and output register: Double-click the node you want in the
Nodes box. All managers within the selected node appear in the Managers box. You can
then double-click the manager you want, and repeat this procedure for the modules and
registers.
5. Click OK. The module whose inputs changed appears grayed-out to indicate it is now
pending. If both modules are in the same window of the same node diagram, a line appears
to represent the link.
6. Select File > Send & Save. The new link is established and the module appears
programmed.
The procedure described above can also be performed in the reverse order. You can click the
button first, select an output register, and then click the input symbol of a module icon to
select one of its inputs.
Deleting links
If you want to disassemble a group of linked modules and use them for another function, you can
delete the links between the modules rather than deleting the modules. Designer provides several
ways to delete links.
Fixed links
Most links between standard modules can be deleted. However, some links between core
modules are fixed and cannot be deleted. These fixed links include:
• Data Acquisition module and all Power Meter modules.
If you attempt to delete a fixed link, Designer informs you that the link cannot be deleted.
Sliding Window Demand module (its color reverses to indicate it is selected) and press Delete.
If there are multiple lines between the same modules and you only want to delete one of the links,
you may want to use the method described in Deleting links that are not visible below.
1. Right-click the input symbol of the module icon to open the Delete Links dialog.
2. Each input and the label of the output register it is linked to are displayed in the dialog. To
delete one or more of these links, select the input and click Unlink. The output register label
is replaced with dashed lines.
3. When you have unlinked all the registers you need to, click OK.
1. Right-click the output symbol side of the module icon to open the Register Owners dialog.
(To list the module's setup registers, hold the CTRL key while right-clicking on the symbol.)
2. Select the output register you want from the Registers section. The Owners section lists all
the module inputs to which the selected register is linked.
3. To delete one or more of these links, select the module input in the Owners list box and click
Unlink. The input name is replaced with a dashed line.
4. When you have unlinked all of the module inputs you want, click OK.
5. Select Send & Save to unlink the module inputs on the node.
NOTE: Owners that reside on a different node are NOT displayed in this dialog. If you need to
delete a link between modules on different nodes, use the procedure described in Deleting a
module's input links.
WARNING
UNINTENDED EQUIPMENT OPERATION
Do not use a controlled output for any safety critical application due to possible unexpected
changes of state during power cycles, power outages, configuration changes, or firmware
upgrades.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Only personnel with a thorough understanding of ION architecture and the system in which the
meters and software are installed can configure ION modules and registers.
Module setup parameters include the module's label; its setup registers, labels and values; and its
output register labels. To access these, right-click the module icon.
The Setup Registers box lists all the setup registers of the module along with their current values
or settings. To change any of the settings or assign a custom label to a setup register, select the
register, then click Modify (or double-click on the register) to open the Modify Register dialog
where you can make modifications.
In most cases, configuring a setup register is a simple matter of entering a number, entering text,
or choosing an option from a list. (To determine the options or ranges available for a setup
register, refer to the module's description in the ION Reference.)
When you have completed all your modifications to the module, click OK to return to the node
diagram. The module icon appears pending until you send and save your changes.
Enumerated registers
To modify a numeric bounded register, type a number in the Value box. The allowable range is
shown under the Value box; you are alerted if you type a number outside this range.
To enter a formatted numeric value, click Format. In the Time Interval Value dialog, you can
enter the numeric value as a date (offset from Jan 1, 1970) or a time interval.
String registers
NOTE: When configuring Database Import Module, ensure DIM1 Connection String setup
register use Provider as SQLNCLI11.
NOTE: Currently, you can only link the address setup register to External Numeric, External
Boolean, and External Pulse registers.
1. Right-click a Distributed Numeric, Distributed Boolean or Distributed Pulse to open the ION
Module Setup dialog.
2. In the Setup Registers section, select a register then click Modify to open the Modify
Address Register dialog.
3. In the Modify Address Register dialog, double-click on the node, manager, module and
output register you want to use. Click OK to continue.
NOTE: You can clear the value of an address setup register. On the Modify Address Register
dialog, select Reset Register Value and then click OK.
If you try to modify a shared setup register, a prompt identifies the register as shared and gives
the name of the parent module.
Navigate to the parent module and change the setup register there.
Creating custom labels allows you to clearly describe what the module and its registers have been
set up to do.
However, carefully consider which modules and registers should be assigned custom labels.
There is a fixed number of labels available, but there are thousands of registers you can assign
them to. Many of these registers do not benefit from custom labels. For example, most setup
registers can be left at their default names since the only place their names might appear is in the
event log.
NOTE: Some devices, such as the ION7330 and ION7700, have a 15-character limit for labels.
The ION Module Setup dialog allows you to edit the module label. The module label is the text that
appears across the top of the module icon in the node diagram. It is also the label that is used in
event logs and in the dialog for the ION tree.
Maximum module, you may want to label the Maximum module's output register as “Va TD
Maximum” (instead of using the default name of “Maximum 1”).
1. In the ION Module Setup dialog, select the output register in the Output Registers area and
then click Modify to open the Modify Label dialog.
1. In the ION Module Setup dialog, select the Boolean output register and then click Modify to
open the Modify Boolean Register dialog.
1. In the ION Module Setup dialog, select the setup register and click Modify.
NOTE: Since adding and deleting modules happens immediately on a node, you cannot undo
the deletion or the creation of a module.
All the changes made to the selected modules since the last time you sent and saved the node
diagram are discarded. Modules not included in the selection are unaffected (that is, if they had
pending changes, the changes are still pending.)
For more information on using the Fast Linker utility, refer to the description for the Log
Acquisition module in the ION Reference.
NOTE: If the Change Standard Meter Security option is disabled, refer to Changes in
security settings of device for more information.
3. Clear the Disable Standard Meter Password check box and type the password in the
Password field then re-type it in the Confirm Password field.
4. Click OK.
2. Right-click the Security Options module icon to open the module setup.
3. Highlight the SOP1 Enable Advanced Security register and click Modify.
NOTE: If the SOP1 Enable Advanced Security register is not listed and the SOP1
Legacy Security Support register is listed, refer to Changes in security settings of device
for more information.
4. Select Enabled in the options dropdown and click OK in the Modify Enumerator Register
dialog.
7. Right-click on the newly added Security Module icon to open the module setup.
8. Click Change Password button to open the Change Advanced Meter Security window.
9. Type the password in the Password field then re-type it in the Confirm Password field.
You can copy modules from one node and paste them into another, as long as the node you are
pasting to supports the selected modules and has sufficient resources. When pasting modules,
you can replace existing modules or add new ones.
You can also copy modules and save them as a framework. You and other users can then reuse
this framework in other nodes. Saving a node's configuration as a framework provides a fast and
easy way to program a large number of nodes at once.
NOTE: Persistent modules cannot be deleted, but they can be overwritten during a framework
paste. Overwriting a persistent module effectively relinks its outputs and rewrites its label, but its
core functionality remains intact (for example, the Master Reset module may be relabeled, but
pulsing this module still initiates a master reset). When pasting a default framework onto a
meter, use lock-paste to ensure that all persistent modules in the "old" default framework are
overwritten by the corresponding persistent module in the "new" default framework. Persistent
modules are listed in the "ION Device Template Reference".
Copying modules
Designer offers two ways to create copies of modules: copy and paste using the product's
clipboard or copy or paste using a framework.
NOTE: The Power Monitoring Expert Clipboard is a temporary storage area that holds any
information cut or copied from Designer. This clipboard should not be confused with the
Windows Clipboard.
When you copy a selection of ION modules, you can use Copy, Cut, or Copy to Framework:
• Copy saves the selection to the clipboard and leaves the original module(s) intact.
• Cut saves the selection to the clipboard and removes the original module(s).
• Copy to framework saves the selection as a file and leaves the original modules intact.
Additional considerations include pasting with shortcuts, modules that cannot be pasted, and
cloning a node (copying and pasting an entire node configuration from one node diagram to
another).
Use the Cut or Copy command to save a temporary copy of the selected modules to the clipboard.
You can then use the Paste command to transfer the selection from the clipboard into any node
diagram. Each copy retains the setup register values, custom labels, link information and layout of
the original selection.
NOTE: When selecting modules to be cut or copied, you can also include grouping icons and
text objects. If you select a grouping icon, all modules within the group are copied, as well as any
nested grouping icons.
To copy the selection to the clipboard and retain the original, select Edit > Copy.
After the selection has been copied to the clipboard, you can select Edit > Paste to paste it into
any user diagram.
You can use the Copy to framework command to create a framework from the selected
modules. A framework is a template that you can use to reproduce a group of modules. Unlike
regular copying and pasting, a framework is stored as a file so you can paste it later.
When you select Edit > Copy to framework, Designer copies the layout, linking and
configuration information of each module in the selected group. It saves the framework as an .fwn
file. You can then use the Paste from framework command to paste the group in another node
diagram.
You can use frameworks to simplify the process of programming multiple devices with similar
configurations. For example, if you wanted to program a single function into several nodes, you
could program the first node and then copy the configuration to a framework. You could then
quickly program the other nodes by simply opening their node diagrams and pasting the
framework you created. You can also use frameworks to program an entire node at once,
considerably reducing the amount of time required to set up a large installation.
Before you save a group of modules as a framework, consider carefully which modules you want
to include. If you include core modules in your framework, you will not be able to paste them
unless you overwrite the existing core modules that correspond to those in your framework.
Another approach is to select the modules “downstream” of the core module and save them as a
framework. Then when you paste the framework into another node diagram, you can use the
Maintain External Inputs option to preserve your links to the original core modules. (See Using the
Paste Summary dialog for more information.)
NOTE: After you have saved a framework, it can be used in another node diagram, as long as
the node supports the modules included in the framework. Although it is possible to create a
framework from one node type and use it with another node type, it is advisable to restrict your
use of frameworks to nodes of the same type.
2. Select Edit > Copy to Framework to open the Copy to Framework dialog.
3. In the File Name field, type a name for the framework, then click Save. The framework
filename extension (.fwn) is added automatically and the selection is saved as a framework
file.
After you have copied a group to a framework, you can select Edit > Paste from framework to
paste it into a node diagram.
Pasting modules is a little more complicated than copying them, because the action of adding
modules to the node may require you to replace existing modules. Whether you choose Paste or
Paste from framework, Designer displays a Paste Summary dialog that explains each aspect of
the proposed changes.
You can use the Paste Summary box to define how to integrate the source modules into the
destination modules. For example, if a source module is being pasted to a destination that is
already occupied, you can either lock paste the new module over the existing one or free paste
the new module into the next available destination.
If you paste a selection that contains a shortcut, Designer may paste the shortcut as a module.
(See Pasting shortcuts for more information.)
In some cases, Designer may not paste every module in your selection. (See Modules that cannot
be pasted for more information.)
When pasting modules, the first thing to do is select the node diagram and window where you
want the modules to go. If you have more than one window open, you can click on the title bar of
the window you want to make it the active window.
NOTE: You can paste modules into the same node diagram they were copied from or into a
different one.
You can paste modules from two sources: the clipboard or a framework. When you paste a
selection from either source, Designer describes the proposed changes in the Paste Summary
dialog. You can use the Paste Summary area to review your changes and make modifications as
necessary.
NOTICE
UNINTENDED DEVICE OPERATION
Do not use the lock paste option to overwrite existing destination modules.
Only use the lock paste option if you are an advanced user familiar with ION architecture.
NOTE: The lock paste option overwrites an existing module but the outputs from that module are
retained as inputs of other modules. Consequently, the module may not operate as expected.
(See Using the Paste Summary dialog for more information.)
1. Open the window where you want the modules to go. Click in the background of the window
to clear any selected modules.
To paste a selection from a framework, select Edit > Paste from Framework. In the
Paste from Framework box, select the file you want and then click Open.
3. The Paste Summary dialog opens. Use the Paste Summary area to review the proposed
changes (see Using the Paste Summary dialog, below, for more information). When you are
satisfied with the summary, click OK to complete the procedure.
The selection is pasted into the active window. The entire selection is automatically selected so
you can easily move it to a clear area in the window. All module icons in the selection appear as
pending until you click Send & Save to save the changes to the node.
The Paste Summary dialog lists each module to be pasted and indicates its destination in the
node. For each module, a short summary of the proposed modification as well as a more detailed
description of how the module is pasted or why it cannot be pasted as requested displays in the
dialog.
The following sections describe the various areas of the Paste Summary dialog.
Source
The Source column lists each module that was copied to the clipboard or framework. Each source
module is listed by its default label unless a custom label has been specified (in which case the
default name appears in brackets after the label). Select a module in this column to view
additional information in the Details area at the bottom of the dialog.
Destination
The Destination column indicates where the copy of each source module will be placed in the
node diagram. The module label listed in the Destination column may or may not match the
module label listed in the Source column. (If the destination module is to be overwritten, it is
reused; otherwise, the next available module is used.)
Summary
The Summary column indicates whether the source module is copied into the destination as a
new module or if it replaces (overwrite) an existing module. This column also indicates if a module
will not be pasted.
NOTE: You can sort the paste summary information alphabetically by source or destination, or
by importance of summary. Click on the Source, Destination, or Summary column headers to
sort the list by the chosen criteria.
Details
The Details area located at the bottom of the dialog provides more detail than the description in
the Summary column. When you click on a module in the Source column, you can view a
description of the proposed transaction in the Details box. This description explains how a module
is pasted or offers reasons why it will not be pasted.
TIP: You can create a copy of the information displayed in the Details section of the Paste
Summary box. To copy it, use the mouse to highlight the text you want, right-click the selection,
then select Copy. You can then paste this selection into a word-processing program.
The Maintain External Inputs check box allows you to paste the module selection with all
external links intact. If this check box is cleared, all external links (links to modules outside the
selection) are discarded.
If you copied the modules on the right but omitted the Power Meter module from the selection, the
link to the Power Meter module would be external. Upon pasting the selection, the external link to
this module would be lost unless you selected “Maintain external inputs” on the Paste Summary
box.
The check boxes to the left of each module indicate the proposed action (that is, how the module
will be pasted):
• An “X” symbol without a check box identifies a module that has no possible destination
and cannot be pasted.
You can click on a check box to change the proposed action. For example, if you click on a “free
paste” or a “will not be pasted” symbol, it changes to a “lock paste” symbol. When you
change the type of paste, the descriptions in the Summary column and the Details box also
change to describe the new action. (See Free paste or lock paste?, below, for more information.)
TIP: To change multiple module check boxes in the paste summary at the same time, click the
first check box in your list, hold down the Shift key, and then click the last check box in the list
you want to change.
The first option in the above example is a free paste. It can be used to paste new modules into a
diagram without deleting any existing modules. This is useful for integrating new functions into a
node without disrupting the node's existing functionality. Although this may seem desirable,
another option is available. By leaving existing modules intact, a free paste can result in needless
duplication of functions. In addition, some groups of modules are interdependent and may require
a lock paste to operate correctly.
The second option in the above example is a lock paste. It instructs Designer to recreate the
source modules exactly, even if this requires Designer to overwrite existing modules in the
diagram. When used to quickly replace old modules with new ones, lock pasting is an efficient
alternative to the time-consuming process of deleting a module, adding a new one and then
configuring it.
You can use a combination of both free paste and lock paste within a single paste operation.
NOTE: You can pre-select modules for Designer to reuse when free pasting. In the actual
diagram where you paste the selection, press the SHIFT key and then click on any module icons
that you don't want. When you paste the new selection, Designer has the option of replacing any
of the selected modules with the new ones.
NOTE: Overwriting a module is not the same as deleting the module and then pasting a
replacement module. If a module is overwritten, links from the outputs of that module are
retained as the inputs of other modules. If a module is deleted, these links are also deleted and
do not exist after the replacement module is pasted.
Pasting shortcuts
Identified by the symbol , a shortcut icon is a representation of a module icon that is located in
another window.
You can copy a shortcut in the same way you copy the original module, but when you paste a
shortcut, one of two things happens: It is either pasted as a shortcut to an existing module (if one
is available) or as a new module. In either case, it continues to perform its function as before.
There is a basic reason for replacing a shortcut with a module: a shortcut cannot exist in a node
without the module it represents. When you paste a selection containing a shortcut, Designer
searches both the selection to be pasted and the destination to locate the module the shortcut
represents. If it finds the module, it pastes the shortcut as a shortcut. If it doesn't find the module, it
replaces the shortcut with a copy of the module. In this way, Designer functions so that the pasted
selection is complete and not dependent on a module that is unavailable in the destination node.
Cloning a node
You can quickly configure multiple nodes by cloning a node. Essentially, cloning a node involves
copying a node's entire configuration to a framework then pasting it onto another node. This
effectively reprograms the node receiving the framework as an exact copy of the original.
NOTE: When you paste an entire node's configuration, the Factory, Communications, and
Diagnostics modules are not pasted because they could disrupt the operation of the device's
communications. If you need to change the settings of these modules, you can do so manually.
1. Open the node diagram of the node you want to copy. Ensure that you are in the main or root
window of the diagram.
2. Select Edit > Select All. All core modules, standard modules, grouping windows and text
icons are selected.
3. Select Edit > Copy to framework to open the Copy to framework dialog.
4. In the File name box, type a name for the framework and then click Save. The framework
filename extension (.fwn) is added automatically and the entire node configuration is saved
in this framework file.
After you have saved the source node's configuration as a framework, you can paste it to other
nodes of the same type. This file can also serve as a backup in case you want to restore the
configuration of the source node.
1. Open the node diagram of the node to which you want to paste the configuration. Ensure
that you are in the main or root window of the diagram.
2. Select Edit > Select All. Press the Delete key to remove the node's existing configuration.
A dialog opens listing the standard modules that will be deleted and the core modules that
cannot be deleted. Click OK to continue.
The standard modules and text icons are deleted, and the core modules (and any grouping
windows containing core modules) remain.
3. Select Edit > Select All to select the remaining module (and grouping) icons.
4. Select Edit > Paste from framework to open the Paste from framework dialog, select the
framework file that contains the node configuration you want to paste, and then click Open.
The Paste Summary dialog opens. (See Using the Paste Summary dialog for information
on using the Paste Summary box.)
5. Select all modules in the list (click last item, hold the SHIFT key, and then click first list item -
the entire list appears highlighted).
6. Change the paste type to lock paste (hold the SHIFT key and then click the paste type check
box until all modules are set to lock paste ).
The selected framework is pasted into the node diagram. All module icons in the selection appear
as pending until you select Send & Save to save the changes to the node.
A Input
B Output
A register is a type of memory bank that stores a module's linking and configuration information.
Each module uses two types of registers:
• Output registers store data that has been processed by the module (such as numeric values,
event log entries, and waveform data).
• Setup registers store the module's configuration information.
Right-click the output symbol. This displays an output register's owners so you can identify all
dependent modules on the node and determine the purpose of each dependent module. This is
useful when determining the effects and consequences of deleting a module.
Press the CTRL key and click the output symbol or right-click the graphic in the center of the
module to display the ION Module Setup dialog.
Press CTRL+SHIFT and click the output symbol or right-click the graphic in the center of the
module to display the ION Module Setup dialog.
Viewing inputs
3. Enter the value you want to set into the Value box or the string into the String box and click
OK in the Modify Register dialog.
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.
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.
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.
• Editing a device
• Deleting a device
Sites
• Adding a site
• Editing a site
• Deleting a site
Network
• Exporting network configuration for use in a different system
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, IP address, and Secure Connection Enabled.
NOTE: Secure Connection Enabled must be enabled only when the selected device
supports Secure ION or Modbus Encryption.
TIP: Click Show Advanced to access advanced configuration settings. These settings
have factory defaults and only need to be changed for specific application needs.
3. If you select Secure Connection Enabled, select one of the following Certificate
Validation types:
Full: PME performs Certification checks. If there are issues with the certificate,
PME notifies certificate status, and then blocks the communication to the meter.
Partial: PME performs Certification checks. If there are issues with the certificate,
PME notifies certificate status, and then connects to the device.
None: PME does not perform Certification checks while establishing a TLS connection.
5. Click OK.
TIP: To add a device directly to a site, click the Sites tab, and then 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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
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
• Exporting network configuration for use in a different system
Device Replacement
TIP: You can open Device Replacement from SETTINGS > System > Device Replacement in
the Web Applications banner.
NOTE: You must have supervisor-level access to use Device Replacement, otherwise the link
on the SETTINGS page is not available.
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.
measurement value until the measurement value reaches the threshold or the device is
replaced. Once threshold is reached or the device is replaced, this processed measurement
aggregates the sum of the threshold value or value until device replace and the newly logged
value. The processed measurement contains the aggregated value of the measurement.
• Configure device replacement. Based on processed measurement device selection, the
device replacement list is generated. You can select the last replacement date and the
replacement period.
Use the processed measurement in place of regular measurement to view historical trends, key
performance indicators, reports, and other information about the power system you are
monitoring without any spikes due to device replacement or threshold limits of measurement
values.
1. In Device Replacement, select the Processed Measurement tab, and then click Create.
3. (Optional) If you want to specify the processing start date, then turn off Start Processing
from Beginning and select the date from the Processing Start Date.
By default, the measurement names are listed in alphabetical order. You can use the
Search field to find measurements by name.
5. For a selected measurement, select the device in the Device Name area.
By default, the device names are listed in alphabetical order. You can use the Search field
to find devices by name.
9. Click Save.
Related topics:
• Creating a processed measurement
2. Select the row of the processed measurement you want to edit and then click Edit in this
row.
4. Click Save.
Related topics:
• Creating a processed measurement
2. Select the row of the processed measurement you want to edit and then click Disable in this
row.
NOTE: On disabled processed measurement, Click View to see the device and
measurement selection.
2. Select the row of the processed measurement you want to edit and then click Enable in this
row.
Related topics:
• Creating a processed measurement
2. Select the row of the device you want to configure and then click Edit in this row. This opens
the Edit Device dialog.
3. In Edit Device, Select the Last Replacement Date and Period for Replacement
(Months).
4. Click OK.
Related topics:
• Creating a processed measurement
NOTE: The Device Type Editor replaces the Modbus Device Importer (MDI) tool that was
available in older versions of the software.
Use the Device Type Editor to create device drivers for Modbus and OPC devices, in Power
Monitoring Expert, for which pre-configured drivers or downloadable add-on drivers do not exist.
You can also edit existing Modbus and OPC device drivers with the Device Type Editor.
NOTE: Before creating a new device type with the Device Type Editor, check if it is available as a
pre-configured device type or as a downloadable add-on.
NOTE: The device types you can create with the Device Type Editor are limited to reading
numeric and Boolean data from the device, and writing simple 16-bit values to the device. These
device types cannot access complex data such as historical logs, event logs, or waveform
captures.
NOTE: Drivers created with the Device Type Editor require mid-range (M) type device licenses.
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.
For information on how to use the Device Type Editor to create device types, see:
For Modbus
• Creating a Modbus Device Type
For OPC
• Creating an OPC Device Type
• Measurement Tree
• OPC Tags
When you create the device type with the Device Type Editor, you first define the Modbus
registers that you want to access on the device, and then you map these registers to ION
managers, modules, and registers. You can enter the Modbus register information manually in the
Device Type Editor user interface, or use Microsoft Excel to define the register list and then copy
and paste it into the Device Type Editor. The mapping of Modbus to ION registers is done by
dragging Modbus registers onto ION registers, or the reverse, using the mouse pointer.
Prerequisites
To create a device type for a device, you need to know the details of its Modbus register map. At a
minimum, you need the Modbus addresses, data formats, and possible scaling values for the
measurements you want to access on the device. You can get this information from the device
documentation or the device manufacturer.
NOTE: Before creating a new device type with the Device Type Editor, check if it is available as a
pre-configured device type or as a downloadable add-on.
References
See the following references for information on how to use the Device Type Editor or information
related to Modbus register definitions:
• Device Type Editor User Interface
• Measurement Tree
1. In Device Type Editor, click File > New > Modbus Device Type to open a New Mapping
template.
2. Enter the Modbus register information into the Modbus Map table in the right display pane, in
one of two ways:
Add each Modbus register manually in the Device Type Editor, using the available
editing controls (right-click to open the context menu).
Use Microsoft Excel to define the register list, copy it, and paste it into the Modbus Map
table.
NOTE: The register list columns in the Excel sheet must match the column content and
positions in the Device Type Editor Modbus Map table. Confirm that the format entries
match one of the supported Modbus Data Formats and that there are no spelling
mistakes, such as added space characters or different capitalization.
3. Map each Modbus register in the Modbus Map to a measurement in the Measurement Tree
in the left pane. To see the measurements in the tree, expand the managers and modules,
for example Current > Phase Current > Current A,B,C, ... . Map the registers in one of two
ways:
Using the mouse, drag the measurement you want to map in the Measurement Tree
onto the corresponding measurement in the Modbus Map.
Using the mouse, drag the Modbus register you want to map in the Modbus Map onto
the corresponding measurement in the Measurement Tree.
NOTE: If you cannot find a suitable measurement in the Measurement Tree, add a new
manager, module, and register to represent this measurement. To do this, right-click any of
the existing managers in the Measurement Tree and choose the appropriate menu
options.
Example: For a device called "PM123", you could use a device type name of "DTE_
PM123". The device type name does not have to include DTE, but it is a good practice to
choose a string that identifies this device type as a DTE type.
b. In the Measurement Tree, click Factory Information > Factory 1 > FAC1 Template to
open the String Register Details dialog for this register. In String Register Details, enter
a template name in the Value box. This name is used to match your new device type
with a default Vista diagram, if you choose to create such a diagram. The template name
should include the device type name followed by a version number that represents the
version of your new device type.
Example: For a device type called "DTE_PM123", you could use a template name of
"DTE_PM123_V1.0.0".
5. (Optional) Click Tools > Clean Measurement Tree to remove any Measurement Tree
elements that have not been mapped to Modbus registers. This makes it easier to find the
relevant measurements in the Measurement Tree in Vista or OPC clients for example.
Related topics
• Creating a Modbus Device Type
References
See the following references for information on how to use the Device Type Editor or information
related to Modbus register definitions:
• Device Type Editor User Interface
• Measurement Tree
1. In Device Type Editor, click File > Open, find and select the device type you want to edit,
and click Open.
2. Modify the Modbus Map registers, the Measurement Tree mappings, or the software logging
to meet your needs.
See Creating a Modbus Device Type for details on how to perform these tasks.
3. Click File > Save, to save the modified device type under the same name. Click File > Save
As, to save the modified device type under a new name.
Related topics
• Creating a Modbus Device Type
NOTE: The data logs are timestamped with the date and time at which the software logs the
value, not the date and time the measurement was taken on the device. Device communications
and system delays determine the time delay between when the measurement is taken by the
device and when it is logged by the software.
1. In Device Type Editor, open the Modbus device type for which you want to add logging.
2. Click Tools > Configure Software Logging to open the Configure Logging and Calculation
dialog.
3. In Configure Logging and Calculation, select the measurements you want to log and
calculate, and set the logging intervals.
NOTE: Only numeric output registers can be calculated and logged. All other types of
registers (for example, enumerated) do not appear on the Configure Logging and
Calculation screen.
See Configuring Logging and Calculation User Interface for information on the controls and
options available in the user interface.
Related topics
• Creating a Modbus Device Type
When you create the device type with the Device Type Editor, you first define the OPC tags that
you want to access on the server, and then you map these tags to ION managers, modules, and
registers. You can enter the OPC tag information manually in the Device Type Editor user
interface, or use Microsoft Excel to define the tag list and then copy and paste it into the Device
Type Editor. The mapping of OPC tags to ION registers is done by dragging tags onto ION
registers, or the reverse, using the mouse pointer.
NOTE: You cannot use the Device Type Editor logging and calculation tool for OPC devices.
Use the Virtual Processor service (VIP) to configure software logging for this devices.
Prerequisites
To create a device type for an OPC server, you need to know the details of its tag list. You can get
this information from the OPC server documentation or the OPC server vendor. You can also get
the tag list by browsing the OPC server with an OPC client such as the OPC Test Client we ship
with PME. You can find the OPC Test Client, OpcTestClient.exe, in ...\Power
Monitoring Expert\system\bin\
References
See the following references for information on how to use the Device Type Editor or information
related to OPC tag definitions:
• Device Type Editor User Interface
• Measurement Tree
• OPC Tags
1. In Device Type Editor, click File > New > OPC Device Type to open a New Mapping
template.
2. Enter the OPC tag information into the OPC Map table in the right display pane, in one of two
ways:
Add each tag manually in the Device Type Editor, using the available editing controls.
Use Microsoft Excel to define the tag list, copy it, and paste it into the OPC Map table.
NOTE: The tag list columns in the Excel sheet must match the column content and
positions in the Device Type Editor OPC Map table. .
NOTE: When entering a tag, only specify the tag name, with a leading period (.), do not
include the OPC server or device name. For example, for the tag
Opcda://Server/OpcDa.1.Channel_1.Powers.Real_Power enter
.Powers.Real_Power as the tag name in the OPC Map.
3. Map each OPC tag in the OPC Map to a measurement in the Measurement Tree in the left
pane. To see the measurements in the tree, expand the managers and modules, for
example Current > Phase Current > Current A,B,C, ... . Map the tags in one of two ways:
Using the mouse, drag the measurement you want to map in the Measurement Tree
onto the corresponding tag in the OPC Map.
Using the mouse, drag the OPC tag you want to map in the Modbus OPC Map onto the
corresponding measurement in the Measurement Tree.
NOTE: If you cannot find a suitable measurement in the Measurement Tree, add a new
manager, module, and register to represent this measurement. To do this, right-click any of
the existing managers in the Measurement Tree and choose the appropriate menu
options.
Example: Use "OPC_ABC" as the device type name, where ABC identifies the server.
b. In the Measurement Tree, click Factory Information > Factory 1 > FAC1 Template to
open the String Register Details dialog for this register. In Edit String Register, enter a
template name in the Value box. This name is used to match your new device type with
a default Vista diagram, if you choose to create such a diagram. The template name
should include the device type name followed by a version number that represents the
version of your new device type.
Example: For a device type called "OPC_ABC", you could use a template name of
"OPC_ABC_V1.0.0".
5. (Optional) Click Tools > Clean Measurement Tree to remove any Measurement Tree
elements that have not been mapped to OPC tags. This makes it easier to find the relevant
measurements in the Measurement Tree in Vista or an OPC client for example.
Related topics
• Creating an OPC Device Type
References
See the following references for information on how to use the Device Type Editor or information
related to OPC tag definitions:
• Device Type Editor User Interface
• Measurement Tree
• OPC Tags
1. In Device Type Editor, click File > Open, find and select the device type you want to edit,
and click Open.
2. Modify the OPC tags or the Measurement Tree mappings to meet your needs.
See Creating an OPC Device Type for details on how to perform these tasks.
3. Click File > Save, to save the modified device type under the same name. Click File > Save
As, to save the modified device type under a new name.
Related topics
• Creating an OPC Device Type
2. Right-click the display window and select New > OPC Device.
3. Enter the Group, Name, Device Type, Site (select the OPC site you previously set up),
and Time Zone.
4. Select OK.
1. In Device Type Editor, click Tools > Install Device Type, to open the Device Type Installer.
2. In Device Type Installer, specify the device type you want to install.
(Optional) Specify a diagram and icon to be used for this device type in the Vista and
Diagrams applications if you want to use the default diagram feature.
(Optional) Specify a measurement extension file for exposing the device measurements
through the OPC server, if desired.
3. Check the Device Type Name and Template. If you need to make changes, exit the Device
Type Installer, open the device type for editing in the Device Type Editor and correct the
names, then run the installer again.
(Optional) Select Ethernet Support if the device has Ethernet communication capabilities.
5. Click Install Device Type, to install the device type on the system.
Related topics
• Creating a Modbus Device Type
Downstream Device Assistant is an advanced application and should only be used by users with
advanced technical skills and a clear understanding of how data is interpreted and stored in the
Power Monitoring Expert databases.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
Power Monitoring Expert automatically detects downstream devices. The Log Inserter component
does this by looking for devices (called “physical sources”) that record or host data coming from
various downstream devices (for example, an ION meter that utilizes a Modbus Import module to
pass through data originating from a “downstream” Modbus device).
Log Inserter resolves the data from each of these downstream devices to the appropriate
measurement (for example, the label “Vll ab” resolves to the measurement “Voltage Phases AB”).
For data that cannot be resolved, Log Inserter creates measurements whose names are based on
the ION register labels.
Log Inserter uses a logical naming scheme to assign names to the downstream devices. For
example, “Modbus.34” is the name assigned to the downstream Modbus device with a slave
address “34”.
IMPORTANT: Before using the Downstream Device Assistant, make sure you save a copy of the
ION_Network and ION_Data databases, in case you need to revert to the original configuration of
these databases.
A message displays to remind you to back up your ION_Network and ION_Data databases.
Click OK to continue.
3. Downstream Device Assistant opens in Basic view or Advanced view, depending on the last
view it was in before it was closed. The first time Downstream Device Assistant is started, it
opens in Basic view.
Columns descriptions
NOTE: It is not recommended that you select the Manual check box. This reserves the ION
register for which Manual is checked for the selected measurement. This mapping remains in
place even if the device is reconfigured such that this register is used in an entirely different
context. This may cause unexpected problems in the ION_Data database. It should be used
only if you are certain that the configuration you have chosen will not change.
Basic view
To switch to Basic view, click View > Options. In the Advanced section of the Options dialog,
clear the enable advanced features check box. Click OK.
In Basic view, when you enter a new name in the Updated Assigned Source column, all rows
that contain the same Assigned Source name are automatically filled in with the new name.
Existing data in the historical database (ION_Data) is also automatically updated to reflect the
change.
Advanced view
To switch to Advanced view, click View > Options. In the Advanced section of the Options
dialog, select the enable advanced features check box. Click OK.
In addition to the columns displayed in Basic view, Advanced view displays all the other columns
for editing individual source-measurement definitions (i.e., Updated Measurement, Handle,
Entered By, Update Historical Database, and Manual). In Advanced view, you can:
• Select and make changes to a specific row without affecting the other rows. For example, you
may want to change the source name for one particular measurement while leaving the
original source name unchanged for all the other measurements.
• Select a different measurement for one that is incorrectly mapped to a particular register
handle.
• Select whether or not to update historical data for a changed source name or measurement
definition, by selecting or clearing the Update Historical Data check box, respectively.
Changing a name or definition automatically selects this check box.
• Select whether or not to allow Log Inserter to resolve the register handle to a particular source
measurement, by clearing or selecting the Manual check box, respectively. The default
setting is cleared (i.e., Log Inserter automatically resolves the register handle to the source
measurement definition). If you want to force the change so Log Inserter does not resolve the
handle to the new measurement, select the Manual check box.
2. Select the check box beside the physical sources you want to display. Select the
Select/Clear All check box to select all physical sources or clear it to select none. Click OK.
NOTE: The Physical Sources are not displayed if you restart Downstream Device Assistant. By
default, only downstream devices are displayed when Downstream Device Assistant is started.
Sorting data
Click a column heading to sort the row entries in ascending or descending alphanumeric order,
according to that column.
Certain options such as “show all measurements” and the “Handles” display options are disabled
in Basic View. To enable them, switch to Advanced View first (see Advanced).
Measurements
This section allows you to select whether to display the default ION label (for example, “Vln avg”)
in the Measurement column or to display the full descriptive name of the measurement (for
example, “Average Voltage Line-to-Neutral”).
In Advanced view only, you can also select whether to display all available measurements or only
the most common measurements in the list when picking a measurement in the Updated
Measurement column.
2. In the Measurements section, select display ION labels to display the ION label or display
measurement names to display the full name of the measurement.
NOTE: In some situations, if "display ION labels" is selected, the displayed label may not match
the label on your meter (for example, if a custom label was used). Instead, it displays the known
default label for that particular measurement.
2. In the Measurements section, select show all measurements to display all available
measurements in the Updated Measurement column. To display only the most common
measurements, clear show all measurements.
Historical data
If the show connection dialog check box is cleared, the ION_Data database is automatically set
as the “Default Connection” (for historical data).
If you want to select a different database, select the show connection dialog. With this setting
enabled, the database connection dialog is displayed every time you save your changes. When
the dialog opens, select Custom Connection and specify your database connection details.
Advanced
The enable advanced features check box sets the view to Basic View if it is cleared or Advanced
View if it is selected.
Handle
Available in Advanced View only, this option specifies whether register handles are displayed as
the hexadecimal value (with the “0x” prefix) or as the decimal value.
To change the setting:
2. In the Handles section, select display hex to display the register handle in hexadecimal
format or display decimal to display it in decimal format.
If you want to manually resolve a register handle to a specific measurement, edit the value in the
Handle cell, then select the Manual check box before saving the changes.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
2. Find the source you want to rename. Enter the new name in the Updated Assigned
Source column. All rows with measurements associated with the renamed source are
automatically updated.
If you do not want to assign the existing data in the database to the new source name, switch
to Advanced View first, then clear the Update Historical Database check box for all
appropriate rows.
4. A dialog opens showing a summary of the changes. Click Yes to continue. or No to cancel.
2. Select the row(s) you want to rename. To select a row, click the area just to the left of the first
column. The row is highlighted to indicate that it is selected.
4. In the Source Rename box, type the new name for the downstream source. Click OK.
NOTE: By default, the Update Historical Database check box is selected for all affected
rows — this applies the change to existing data in the database. To make the change only
to data going into the database from this point forward, clear the Update Historical
Database check box for the affected rows.
5. Click File > Save. A dialog open showing a summary of the changes.
7. When the operation has completed, click OK, then click Close.
Cancelling changes
1. To undo all unsaved changes:
Click Edit > Reset, or
2. Click the Updated Measurement cell that you want to change, then select the new
measurement you want to map from the list.
4. By default, the Update Historical Database check box is selected — this applies the
change to existing data in the database (if, for example, the source and measurement
mapping you are adding already exists). To make the change only to data going into the
database from this point forward, clear the Update Historical Database check box.
5. Click File > Save. A dialog opens showing a summary of the changes. Click Yes.
1. Scroll down to the end of the table and click the last row (the one with the asterisk beside it).
2. Fill in the Updated Assigned Source and Physical Source columns. If the source is a
physical device (i.e., not downstream), the same name must be entered exactly in both
columns.
3. Click the Updated Measurement cell, then select the measurement from the list.
4. In the Handle cell, type the register handle for this measurement.
5. By default, the Update Historical Database check box is selected — this applies the
change to existing data in the database (if, for example the source and measurement
mapping you are adding already exists). To make the change only to data going into the
database from this point forward, clear the Update Historical Database check box.
6. Click File > Save. A dialog opens showing a summary of the changes. Click Yes.
If you cleared the Update Historical Database check box when you saved your changes the first
time, you can update the existing data in the database at a later time, through the use of this csv
file.
To update the existing data in the database with the source-measurement changes contained in
the csv file:
1. Click Edit > Historical Data. The Update Historical Data window appears.
3. Downstream Device Assistant opens the folder that contains the csv files. Select the
Downstream Device Definitions file you want to use, then click Open.
5. The Historical Data Update prompt displays how many source-measurement pairs will be
updated. Click Yes.
You can update only one ION database at a time. To select a different database, first make sure
the show connection dialog check box is selected under View > Options. You can then use the
database connection dialog to specify which database you want to update.
NOTE: If you update address definitions that affect multiple historical databases, only the first
historical database you select is automatically updated. To update the remaining historical
databases, you must import the address definitions to each one, using Edit > Update Historical
Data.
Activity log
The saved changes in the Downstream Device Assistant are stored in a log file named
“Downstream Device Historical UpdatesYYYY-MM-DD_hh.mm.ss.txt”, that contains a description
of the activities carried out when Downstream Device Assistant was updating the source-
measurement definitions.
• Edit > Reset: Clears the modifications made since the last save.
• Edit > Rename Source: Lets you change the name of an Assigned Source. See Renaming
the assigned source.
• Edit > Update Historical Data: Opens the “Update Historical Data” window that allows you
to open a previously-saved source-measurement definition data file (with a .csv file
extension), for the purpose of updating existing data in the database. You can also manually
add, edit or delete data entries. See Updating the historical data at a later time.
• View > Refresh: Loads the current downstream definitions from the database. Functionally
the same as Edit > Reset, as this command clears the modifications made since the last
save.
• View > Options: Displays the Options dialog where you can change the settings that control
what level of detail is displayed for the source-measurement definitions.
• View > Select Physical Sources: Displays the Select Physical Sources dialog where you
can select which physical devices you want displayed in the Downstream Device Assistant.
TIP: For instructions on using filtering, sorting, and column selection to customize the Event
Watcher Manager interface, see Customizing and navigating interface displays.
Creating a template
Before adding an event watcher, you must have a template that defines the conditions to be
watched. You can use one of the default templates or create your own. Use the Templates tab to
define and edit templates.
Event Watcher Manager comes with default templates that can be modified for specific devices.
Test any changes to the default template to ensure that events are available for selection for
report subscriptions. In cases where a device is not supported by the default templates, you can
create custom templates to define what you need.
To define a custom template:
1. Click New in the top right corner of the tab. A new row appears in the main table for the new
template.
2. Type a name for the template. Type a description for the template if desired.
3. Use the Template Conditions section to set the conditions to be watched. See Using the
Template Conditions section, below.
4. Click Apply to save your changes, click OK to save your changes and exit Event Watcher
Manager, or click the Event Watchers tab to set up an event watcher.
1. Add a condition:
To add a condition from the event log, click Select from Event Log to open the Select
Event Log Lines dialog. To select an event, click on the boxes at the left of the table to
select a check box. Click on the check box again to clear the check mark. Click OK to
return to the Templates tab.
To add a condition without selecting from the event log, click New. A new row appears in
the table for the new condition.
NOTE: It is recommended that you use Select From Event Log to add conditions. This
helps ensure that the syntax is correct. If the syntax is not correct, the event watcher will
not work. Conditions only appear in the Select Event Log Lines dialog after they have
occurred in the system.
2. Select the parameters you want to include in the condition by selecting or clearing the check
boxes below the Template Conditions table. The available parameters are: Priority, Cause,
Cause Value, Effect, Effect Value. You must include at least one parameter. If you select
multiple parameters, the event watcher only activates when all parameters are met.
1. Click New to add a new event watcher. A new row appears in the main table for the new
event. Use the Event Watcher Editing Area to define the event watcher.
3. Select the template you want to use from the Template dropdown list.
5. From the Devices table, select the devices you want to include in the event watcher. Click
the check boxes to the left side of the devices to select or clear a device.
NOTE: Checking Select All will include any Query Server, Log Inserter or Virtual
Processor instances in the system. It also includes any devices or software nodes added in
the future.
6. Click Apply to save your changes, click OK to save your changes and exit Event Watcher
Manager, or click the Templates tab to edit the templates.
Use the Generator Performance Configuration Tool to configure the Backup Power Module and
the Capacity Management Module. With this tool you define Generators, Transfer Switches,
Equipment, and Groups for the Generator Activity, Generator Battery Health, Generator Test
EPSS, Generator Load Summary, Equipment Capacity, and Generator Capacity reports. You
also use this tool to generate the EPSS Vista diagrams, and to manage the Run History of the
Generators.
The report templates have different configuration requirements. Not all of the components and
properties available in the configuration tool have to be configured for all of the report templates.
See Backup Power Module configuration and Capacity Management Module configuration for
details.
Prerequisites
• The monitoring devices that are recording the generator, transfer switch, and equipment data
must be configured in the PME Management Console and must be communicating before
you can configure the components and properties in the configuration tool.
The Generator Performance Configuration Tool with EPSS Test Module window contains these
tabs: Groups, Generators, Transfer Switches, Equipment, and Run History.
First Define Generators, Define Transfer Switches, and Define Equipment. Then Define Groups.
After you had the first generator test, you can View the Run History.
Use the following common controls for the tabs:
• Help - Click this to view online help for the tab.
• Revert - Returns a modified record to its original values, if OK or Apply have not been
clicked.
• OK - Saves all changes and exits the configuration tool.
The Modified column in the grid area shows the status of the row data:
Define Generators
Use the Generators tab to add new Generators or edit existing ones.
• Click Clone to add a copy of an existing Generator. The tool copies many of the existing
device settings into the new entry. You can then enter the unique details of the new device.
See Cloning a Generator for details.
• Click Delete to remove records from the system.
• Click Revert (before you click Apply or OK) if you make changes to a record and want to
revert to your initial settings.
Location - (Optional) Add information about the physical location of the generator.
Description - (Optional) Add information about the generator, such as make and model.
Electrical Data
Source - Select the monitoring device that records the electrical data of the
generator.
Prime Nameplate Rating - Enter the rated generator power output. Refer to the
generator's nameplate for this value.
Unit - Select the unit of measurement for the generator rating value.
Engine Temperature Data - Select the check box to enable this property. Complete the
following fields:
Source - Select the monitoring device that records the engine temperature of the
generator.
Unit - Select either F (for Fahrenheit) or C (for Celsius) for the temperature unit of
measurement.
NOTE: The same unit is used for the generator test Evaluation Method setting.
Exhaust Gas Temperature Data - Select the check box to enable this property.
Complete the following fields:
Source - Select the monitoring device that records the exhaust gas temperature of
the generator.
Single Exhaust or Dual Exhaust - Select whether the exhaust gas temperature is
measured for a single exhaust or a dual exhaust generator.
Unit - Select either F (for Fahrenheit) or C (for Celsius) for the temperature unit of
measurement.
Edit Evaluation Method - Set the evaluation method and the pass/fail criteria for
generator tests. See Editing the generator Evaluation Method for more details.
Assign Engine Data - Associate data from the monitoring device with engine data
measurements defined in the tool. See Assigning engine data for more information.
NOTE: You can define Engine data measurements in the Edit Engine Data editor at
the top of the Generators tab. See Editing Engine Data for more details.
Status Measurements - Configure the monitoring device and the measurements used
to record the generator states.
Source - Select the monitoring device that records the generator states.
Starting - Select the check box to enable this property. This state indicates that the
generator is starting. Select the measurement that provides the Starting state input,
and enter the Active Value for the measurement.
Running - This state indicates that the generator is running. Select the
measurement that provides the Running state input, and enter the Active Value for
the measurement.
Stopped - This state indicates that the generator has stopped. Select the
measurement that provides the Stopped state input, and enter the Active Value for
the measurement.
NOTE: Two stop signals could be sent from the generator controller: the initial stop
signal which is followed by 3- to 5-minute cooling period, and the final stop signal
after the cooling period is complete. If the generator has two stop signals, use the
measurement for the first stop signal before the generator goes into the cooling
mode. Do not use the stop signal after the cooling period.
Example:
Assume that the system has been configured with measurements of GENStarting,
GENRunning, and GENStopped. You assign these measurements to the Starting,
Running, and Stopped states respectively and enter 1 as the Active Value for
each.
When the generator starts, the active value for GENStarting becomes 1, and
Starting is the state for the generator.
When the generator is running, the active value for GENRunning becomes 1,
and Running is the state for the generator.
When the generator stops, the active value for GENStopped becomes 1, and
Stopped is the state for the generator.
If there is only one measurement to indicate that the generator is either running or
stopped, then you select that measurement for both the Running and Stopped
states, and assign a different active value for each. For example, if the
measurement used to indicate whether a generator is running or not is
GenRunningStopped, define the states like this:
For the Running state:
Select GenRunningStopped as the measurement.
Tune Signals - For each of the Starting, Running, and Stopped measurements,
click the Tune Signals check box to apply tuning to the status measurement's
timestamp. If Tune Signals is selected, enter the tuning signal in the Time Value +/-
field. The tune signal must be between -30,000 ms and 30,000 ms. Tune signals
work in conjunction with Status Measurements to accurately depict the actual
sequence of events within the EPSS system. Use the signals when there are
recurring inaccuracies in generator signals.
Monitor for EPS Available - Select the check box to enable this property. This
state indicates that the emergency power source (EPS) is available. Select the
measurement that provides the EPS Available state, enter the active value for the
state measurement, and enter the Required Time (Seconds). The Required Time
value specifies the amount of time required to be considered a pass for a generator
test evaluation.
Battery Waveforms - Select the check box to enable this property. Complete the
following fields:
Source - Select the monitoring device that captures the battery voltage signature
(waveform).
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
TIP: Use Clone to define additional generators with similar settings. See Cloning a
Generator.
Editing a Generator
To edit a generator:
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Cloning a Generator
Clone a Generator to create a copy of an existing Generator. When you clone a Generator, many
of the settings are copied into the new Generator. Some settings are reset to default values.
Update the settings for the cloned Generator and save it.
To clone a Generator:
1. On the Generators tab, select the Generator you want to use as the base for the cloned
copy.
2. Click Clone to create a new, cloned Generator. Review the copied settings and update them
as necessary. Update the following settings that have been reset to default values:
Name - Enter a unique name to identify the Generator.
Electrical Data - Source - Select the monitoring device that records the electrical data
of the generator.
Status Measurements - Source - Select the monitoring device that records the
generator states.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
3. Click OK to save the configuration and close the Edit Evaluation Method window.
The following table shows the evaluation methods and their respective pass/fail criteria:
NOTE: Update these values to meet the regulations mandated by your local jurisdictions, or to
meet the manufacturer recommendations.
1. Click Edit Engine Data to open the Edit Engine Data Measurements editor.
5. Click OK to save the new measurement and close the Edit Engine Data Measurements
window.
Next, map the measurements that you create to the registers/measurements recorded by the
monitoring device for the generator engine. See Assigning engine data for details.
1. Click Assign Engine Data to open the Assign Engine Data Measurement editor.
Source - Select the monitoring device that records the engine data of the generator.
Measurement - Select the monitoring device data that you want to map to the engine
measurement.
4. Click OK to save the measurement mapping and close the Edit Engine Data Measurements
window.
TIP: See Editing Engine Data for information on how to define engine measurements.
• Click Revert (before you click Apply or OK) if you make changes to a record and want to
revert to your initial settings.
Location - (Optional) Add information about the physical location of the transfer switch.
Load Data - Select the check box to enable this property. Complete the following fields:
Source - Select the monitoring device that records the electrical data of the transfer
switch.
Measurement - Select the electrical measurement you want to track for the transfer
switch, for example Current Phase Average.
Rating - Enter the rating value for the measurement, such as 400.
Priority Level - Select a priority level for this transfer switch. The Required Transfer
Time associated with the selected priority is displayed below the list box.
NOTE: You can define priority levels in the Edit Priority Levels editor at the top of the
Transfer Switches tab. See Editing Transfer Switch priority levels for more details.
Evaluated Transfer Time - Select the transfer time that will be compared to the
Required Transfer Time to determine the transfer switch test result.
Total Transfer Time - It is the total time it takes the automatic transfer switch to
transfer to the alternate source after loss of normal source.
Calculated Transfer Time - It is the time it takes the automatic transfer switch to
transfer to the alternate source after loss of normal source, negating any features
built into the test transfer sequence that would not be present during an actual
outage. Calculated Transfer Time is available for ASCO ATS only.
Status Measurements - Configure the monitoring device and the measurements used
to record the transfer switch states.
Source - Select the monitoring device that records the transfer switch states.
Normal - This state indicates that the transfer switch is in the Normal position and
power is supplied to the load by the utility. Select the measurement that provides the
Normal state input, and enter the Active Value for the measurement.
Test - This state indicates that the transfer switch is in Test mode. Select the
measurement that provides the Test state input, and enter the Active Value for the
measurement.
Emergency - This state indicates that the transfer switch is in the Emergency
position and power is supplied to the load by the generator. Select the
measurement that provides the Emergency state input, and enter the Active Value
for the measurement.
Monitor for Power Outage - Select the check box to enable this property. Select
the measurement that indicates a power outage occurred, and enter the Active
Value for the measurement.
For example, assume that the system has measurements called EPSS_Norm,
EPSS_Test, EPSS_Emerg, and EPSS_Util. You assign these measurements to
the Normal, Test, Emergency, and Power Outage states and enter 1 as the active
value for each.
When the ATS is in the Normal position, the active value for EPSS_Norm is 1, and
Normal is the state for the ATS. When the ATS is set to the Test mode, the active
value for EPSS_Test is 1, and Test is the state for the ATS. When the ATS is in the
Emergency position, the active value for EPSS_Emerg is 1, and Emergency is the
state for the ATS. If a power outage occurs, the active value for EPSS_Util is 1,
and Power Outage is the state for the ATS.
In the EPSS Test Report, the states for the ATS and the time when they occurred
are included in the Events Summary section.
NOTE: The Transfer Switch states are used to calculate the Transfer Time and
Emergency Time shown in the Generator Test EPSS Report:
Transfer Time = The time (in seconds) it takes to switch from Normal state to
Emergency state. For testing, the switch is triggered by the test signal, for an
actual power outage it is triggered by the power outage signal.
Emergency Time = The duration (in hours, minutes, and seconds) the transfer
switch receives power from the generators. This is the time the generator is in the
Emergency state.
Tune Signals - For each of the Normal, Test, Emergency, and Monitor for
Power Outage measurements, click the Tune Signals check box to apply tuning to
the status measurement's timestamp. If Tune Signals is selected, enter the tuning
signal in the Time Value +/- field. The tuning signal must be between -30,000 ms
and 30,000 ms. Tune signals work in conjunction with Status Measurements to
accurately depict the actual sequence of events within the EPSS system. Use the
signals when there are recurring inaccuracies in ATS signals.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
TIP: Use Clone to define additional transfer switches with similar settings. See Cloning
a Transfer Switch.
1. On the Transfer Switches tab, select the transfer switch in the overview table.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
1. On the Transfer Switches tab, select the Transfer Switch you want to use as the base for
the cloned copy.
2. Click Clone to create a new, cloned Transfer Switch. Review the copied settings and update
them as necessary. Update the following settings that have been reset to default values:
Name - Enter a unique name to identify the transfer switch.
Status Measurements - Source - Select the monitoring device that records the transfer
switch states.
See Adding a new Transfer Switch for information on transfer switch properties.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Required Transfer Time (Seconds) - Enter the transfer time in seconds. This value
indicates the maximum acceptable time for the transfer switch to switch from the Test
state to the Emergency state.
Evaluate this Priority Level when reporting on Power Outages - Select this check
box to include a priority level in the pass or fail grading. Clear the check box to exclude
the priority level from grading. By excluding a priority level, you can exclude non-critical
switches from evaluation.
For example, if a transfer switch has a priority level of Life Safety and it must be graded
because of a power outage, then select this check box. Conversely, if a transfer switch
has a priority level of Equipment, this transfer switch may not have to be graded
because of a power outage. In this case, clear the check box.
Color Picker - Select the display color for the priority level in the report.
4. Click OK to save the configuration and close the Edit Priority Levels window.
Define Equipment
Use the Equipment tab to add new Equipment or edit existing ones. An Equipment represents a
real life apparatus such as a piece of switch gear, or a distribution panel. You can map the
Equipment to a measurement and rating. Equipment can be added to a Group and be included in
the reports.
• Click Clone to add a copy of an existing Equipment. The tool copies many of the existing
device settings into the new entry. You can then enter the unique details of the new device.
• Click Delete to remove records from the system.
• Click Revert (before you click Apply or OK) if you make changes to a record and want to
revert to your initial settings.
Adding Equipment
To add a new equipment:
Source - Select the monitoring device that records the measurement data of the
equipment.
Rating - Enter the rating for the equipment measurement, for example rated current.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Editing Equipment
To edit an equipment:
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Define Groups
Use the Groups tab to add new Groups or edit existing ones. A Group combines generators,
transfer switches, and other equipment. This is used for reporting and generating Vista diagrams.
• Click Revert (before you click Apply or OK) if you make changes to a record and want to
revert to your initial settings.
NOTE: You must define the Generators, Transfer Switches, and Equipment first, before you can
add them to a Group.
To add a group:
Test Frequency - Enter how often, in days, the group should be tested. Select the Time
Zone you want to use for reporting.
Generators - From the list, select the generators you want to include in the group.
Equipment - From the list, select the equipment you want to include in the group.
Transfer Switches - From the list, select the transfer switches you want to include in
the group.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
Editing a Group
To edit a group:
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
NOTE: Before configuring Load Sources, define the Priority Levels for the system. See Editing
Transfer Switch priority levels for details.
4. Click OK to save the configuration and close the Edit Load Sources window.
Click Refresh Run History to update the display to show the latest run activities.
Run Histories are based on Groups. Refresh the Run History after every configuration change to
the Groups, Generators, Transfer Switches, or Equipment. For example, if you remove a
generator from a group, the run history for that group needs to be rebuilt because that generator
may have been the reason for the detection of a run. Now that the generator is not part of the
group, the system needs to build the run history again to have accurate data.
NOTE: When you view the Run History for the first time, the processing of the existing run
information in the database can take some time.
• Edit the details of a run instance. See Editing run history details for details.
Set a minimum run length to prevent commissioning or maintenance activities from being
recorded. Set a maximum run length to eliminate "hanging" runs. A hanging run occurs when the
stop signal for a generator is not recorded.
2. In Run Detection Options, set Minimum Run Length (default = 15 minutes), and Maximum
Run Length (default = 48 hrs).
NOTE: In Run History, click Refresh Run History to update the tab with the run events that
match the new detection criteria.
NOTE: The default Run Name is the start date of the run, such as June 12 2011. If a group
has multiple runs on the same date, the subsequent runs have the same date with the run
number appended, such as June 12 2011 Run 2 and June 12 2011 Run 3.
The default Reason is based on the Transfer Switch Status Measurements, for Test and Power
Outage.
1. Click the run record you want to modify. The run details are shown in the editor below the
grid.
3. In the Reason list, select the correct reason for the run.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
After the Generators, Transfer Switches, and Groups are configured, you can generate the Vista
diagrams for the configured devices. The same information can be built manually in Vista, but the
Generator Performance Configuration Tool with EPSS Test Module provides a way to build these
diagrams automatically.
See Setting up the EPSS template diagram and Generating the EPSS Vista diagrams for
instructions.
After the diagrams are generated, you can open them in Vista and optimize the designs. See
EPSS Vista diagram examples for descriptions and examples of the generated diagrams.
With the template, you can apply linked-button elements to the generated diagrams, which will
help you reduce the amount of time to configure the diagrams.
To set up the EPSS template diagram:
1. Open Vista
3. Add buttons with the appropriate links to the left side of the diagram.
4. Do not link the EPSS button to any diagram, because you will already be on the EPSS
pages when they are generated.
When the configuration tool generates diagrams, the template is read and any objects in the
template are added to every diagram created by the tool.
NOTE: On the generated diagrams, the background image is dynamically created. The
background does not come from the EPSS template diagram.
2. Click Generate Vista Diagramsto open the Vista Diagram Generation dialog.
3. In the Output Path field, enter or select the folder where you want to store the diagrams.
4. (Optional) In the Included EPSS Groups box, select the device groups that you want to
generate diagrams for. Clear the check box for any groups you do not want to generate.
5. (Optional) In the Transfer Switch Options box, select the colors you want to use for normal
and emergency status.
6. (Optional) Check Include Test Button on Transfer Switchesif you want to add a control
object for each ATS on the diagrams. This object allows you to manually test the ATS from
the diagram. The control must be manually linked using Vista after the diagrams have been
created.
7. (Optional) Check Include Links to EPSS Groups... if you want the device diagrams to
have a link to the EPSS Group diagram.
8. In the Diagram Width field, select the horizontal width in pixels of the diagrams.
9. (Optional) Select Facility Logo and enter the image file if you want the diagrams to include
the customer logo at the top-left of every diagram.
10. (Optional) Select Generate Facility Map if you want to include a map with the diagrams. If
you do this, you will be able to add the generator and transfer switch device locations to the
map.
a. Enter the Facility Name to appear on the map.
11. Click Generate Vista Diagrams to generate and store the diagrams in the selected output
folder.
Several diagrams will be created: the homepage that lists all EPSS groups, summary pages that
list all generators and transfer switches, and the detail pages for each EPSS Group, Generator
and ATS in the system.
You can open the diagrams in Vista and optimize the designs if necessary.
One Home Page diagram is generated. This diagram contains a navigation bar that has links for
the facility map, device group diagrams, and device diagrams.
For each group selected on the configuration screen, one group diagram is generated. This
diagram contains an object for each generator or transfer switch in the group. A Oneline diagram
for each group is also generated and linked to the diagrams. You will need to manually configure
the generated Oneline diagrams. Several default objects are included for assistance.
For each generator and transfer switch in a group, a diagram is generated. The device diagram
includes status information for the device, including run status, test parameters, and real-time
electrical data.
Facility Map
This diagram is generated if the option was selected on the configuration screen. This diagram
includes a moveable icon for each generator and transfer switch in all the selected device groups.
On the map diagram, you can drag and drop the device icons to the map to represent the physical
locations of those devices.
Use the Generator Power Configuration Utility to configure the Capacity Management Module.
With this tool you define Generator Systems for the Generator Power Report.
Prerequisites
• The monitoring devices that are recording the load data must be configured in the PME
Management Console and must be communicating before you can configure the components
and properties in the configuration tool.
User Interface
Control Description
Help Opens the help for the utility.
New Creates a new entry in the grid.
Delete Deletes the selected entry from the grid.
OK Saves all changes and exits the utility.
Control Description
Cancel Exits the utility without saving changes.
Apply Saves all changes and leaves the utility open.
TIP: The tool indicates if there configuration errors. Point at the red exclamation icon to see
configuration error details.
• Generator Groups
Name must be unique.
Each generator in the group must have the same nameplate rating (kVA) value.
Each generator in the group must have the same derated nameplate rating (kW)
value.
All generators in the groups must have the same nameplate rating (kVA) value.
All generators in the groups must have the same derated nameplate rating (kW)
value.
• Generators
Name must be unique.
For information on generator redundancy types, see Generator system redundancy types.
1. Click New. The Edit System: New System area appears below the grid.
c. Redundancy Type: Select the redundancy type for the generator system. The different
redundancy types are explained in Generator system redundancy types.
d. Groups: Shows the number of generator groups contained in the generator system.
Click Add to add groups to the generator system. Click Remove to delete groups.
e. Generators Per Group: Shows the number of generators in each generator group in
the system. Click Add to add generators to the group. Click Remove to delete
generators.
NOTE: This property is only available when the system redundancy type is 2N, 2(N+1)
or 2(N+2). To define the number of generators for a system with redundancy type N,
N+1 or N+2, use the generator group properties. See Defining generator groups for
more information.
Related Topics:
• Defining generator groups
• Defining generators
• Defining utilities
c. Generators Per Group: Click Add to increase the number of generators in the group.
Click Remove to decrease the number. This property is available only for system
redundancy types N, N+1 or N+2.
Related Topics:
• Defining generator systems
• Defining generators
• Defining utilities
Defining generators
A generator represents an actual generator device. A group contains at least one generator and
can contain multiple generators. For some system types, each group must contain the same
number of generators. See Generator Power configuration restrictions for more information.
To define a generator:
1. Click on the generator object border. The selected generator will be highlighted in blue and
the Properties screen appears.
c. Nameplate Rating (kVA): Enter the maximum output power (kVA) of the generator.
This value must be greater than zero.
d. Derated Nameplate Rating (kW): Enter the maximum power capacity (kW) that the
generator is expected to support. This value must be equal or less than the nameplate
rating value, and greater than zero.
Related Topics:
• Defining generator systems
• Defining utilities
1. Click the generator load element in the system diagram. The Properties screen appears.
c. Data Source: Select one or more meter sources where load data is logged for this load.
d. Additional Utilities: Click Add to increase the number of utility objects for the load.
Click Remove to decrease the number of utility objects.
Related Topics:
• Defining generator systems
• Defining generators
• Defining utilities
Defining utilities
A utility represents the logical utility provider that feeds a load under normal operation. This logical
utility has no functional purpose in the calculations for power redundancy. It is used to provide a
more complete diagram representation for the generator system. A system may have one or two
utilities represented in the diagram.
To define a utility:
1. Click the utility element in the diagram. The Properties screen appears.
Once the configuration of the generators, loads, and utilities are complete, click Apply to save, or
click OK to save the configuration and exit the utility.
Related Topics:
• Defining generator systems
• Defining generators
• N+1 Type
• N+2 Type
• 2N Type
• 2(N+1) Type
• 2(N+2) Type
Before generator-related reports can be produced you need to define a generator system in the
Generator Power Configuration Utility.
N Type
The N system configuration is for one or more generators that work together to supply power to
the IT load, when the utility or utilities’ power is unavailable. There is no redundancy. The intention
is to size the generator system to match the peak IT load on the utility power.
N+1 Type
The N+1 system configuration is for one or more generators that work together to supply power to
the IT load. There is simple generator redundancy in that one of the generators can stop
functioning or be taken off-line, if the utility power is interrupted. The load is spread among all
generators, but the peak load is such that if one generator stops working, the others will be able to
assume its load. Another way to look at it is, N generators will be able to support the peak IT load.
If the peak IT load is more than N can support, then system design redundancy will be lost.
For example, if three generators are connected to the IT loads, in an N+1 system, the peak utility
load must not exceed the non-redundant capacity of two of the generators. If it does, the designed
redundancy will be lost.
N+2 Type
The N+2 system configuration is for a group of generators that work together to supply power to a
medium voltage substation and is then distributed to low voltage loads. There is simple generator
redundancy in that any two of the generators can stop functioning or be taken off-line, if the utility
power is interrupted. The load is spread among all generators, but the utility peak load is such that
if two generators stop working, the others will be able to assume their load. Another way to look at
it is, N generators will be able to support the peak utility load. If the peak utility load is more than N
can support, then system design redundancy will be lost.
For example, if five generators are connected to the IT loads, in an N+2 system, the peak utility
load must not exceed the non-redundant capacity of three of the generators. If it does, the
designed redundancy will be lost.
2N Type
The 2N system configuration is for two groups of generators that supply power to the IT loads. In a
2N system, an entire group of generators can stop functioning or be taken off-line and the
equipment will still be supplied with power, if the utility power is interrupted. The load is spread
among all generators, but the peak load is such that, if an entire group of generators stop working,
the remaining generators will be able to assume the entire load. Another way to look at it is, N
generators will be able to support the peak utility load. If the peak utility load is more than N can
support, then system design redundancy will be lost.
In this example, there are two groups with three generators in each. In a 2N configuration, one
group of generators can go offline and the system will still have the designed redundancy.
Therefore, the value for N is three. So, the total peak utility load cannot exceed the derated
nameplate of three of the generators.
2(N+1) Type
The 2(N+1) system configuration is for two groups of generators that supply power to the IT loads.
In a 2(N+1) system, an entire group of generators plus one more generator from each of the
remaining groups can stop functioning or be taken off-line, and the equipment will still be supplied
with power, if the utility power is interrupted. The load is spread among all generators, but the
peak load is such that if an entire group’s worth of generators goes offline, plus one more from
each of the other groups stop working, the remaining generators will be able to assume the entire
load. Another way to look at it is, N generators will be able to support the peak utility load. If the
peak utility load is more than N can support, then system design redundancy will be lost.
In this example, there are two groups with five generators in each. In a 2(N+1) configuration, one
group of generators can go offline, plus one more generator from the remaining group and the
system will still have the designed redundancy. Therefore, the value for N is four. So, the total
peak utility load cannot exceed the derated nameplate of four of the generators.
2(N+2) Type
The 2(N+2) system configuration is for two groups of generators that supply power to the IT loads.
In a 2(N+2) system, an entire group of generators plus two more generators from each of the
remaining groups can stop functioning or be taken off-line and the equipment will still be supplied
with power, if the utility power is interrupted. The load is spread among all generators, but the
peak load is such that if an entire group’s worth of generators goes offline, plus two more from
each of the other groups goes offline, the remaining generators will be able to assume the entire
load. Another way to look at it is, N generators will be able to support the peak utility load. If the
peak utility load is more than N can support, then system design redundancy will be lost.
In this example, there are two groups with four generators in each. In a 2(N+2) configuration one
group of generators can stop working, plus two more generators from the remaining group and
the system will still have the designed redundancy. Therefore, the value for N is two. So, the total
peak utility load cannot exceed the derated nameplate of two of the generators.
The utility is a command-line executable that allows you to save, restore, or add hierarchy
content.
The primary purpose of the utility is to give you a way to add a large number of entries to a
hierarchy rather than creating individual entries in Hierarchy Manager. This task consists of:
• Saving a skeleton hierarchy configuration in a CSV file.
• Editing the CSV file to associate the devices listed in the file to the nodes of the hierarchy.
• Populating Hierarchy Manager with the updated contents of the hierarchy configuration CSV
file.
• Refreshing a configuration cache to ensure that all devices are included when you save a
hierarchy configuration.
• Deleting a hierarchy configuration prior to restoring a saved configuration.
2. Click the bin folder and press Shift + Right-click and select Open command window here
on the context menu.
• <file path>: the location of the file that the command runs on.
• <file name>: the name of the CSV or XML file, including the .csv or .xml file extension,
respectively.
Command options
Use the command as follows (type the command and press Enter):
HierarchyConfig.exe
Note that this process creates a header row in the CSV file with percentage, node type
names, and virtual meter column headings. It also includes a list of the devices in the system
that are not included in a hierarchy. This allows you to specify which devices you want to
include in the hierarchy when you import the configuration.
Add the alldevices option at the end of the export config command to create a CSV file that
lists all of the devices, whether or not they are included in a hierarchy. This option ensures
that apportioned devices or devices that constitute a virtual meter are included in the file.
Note that the CSV file created with the alldevices option is intended for reference purposes
only and not for updating an existing hierarchy.
• To add the contents of the updated skeleton configuration CSV file to Hierarchy Manager:
NOTICE
LOSS OF DATA
• Do not use the hierarchy configuration CSV file to incrementally update an existing
hierarchy.
• Use the Hierarchy Manager application to incrementally update an existing hierarchy.
Failure to follow these instructions can result in the corruption of hierarchy data.
You can also add a timestamp to the configuration entries. Adding year, month, and day
information adds a start date to the imported references corresponding to the date entered. If
no date information is provided, the start date of the hierarchy information is the system start
date.
This creates a backup of the hierarchy before you modify the hierarchy entries in Hierarchy
Manager.
• To restore a hierarchy configuration from a backup configuration XML file:
NOTICE
LOSS OF DATA
• Do not use the hierarchy configuration XML file to incrementally update an existing
hierarchy.
• Use the Hierarchy Manager application to incrementally update an existing hierarchy.
Failure to follow these instructions can result in the corruption of hierarchy data.
This process deletes the current hierarchy configuration defined in Hierarchy Manager and
replaces it with the hierarchy configuration in the XML file.
• To refresh a configuration cache to ensure that all devices are included in the saved
configuration:
HierarchyConfig.exe refresh config
• To delete a hierarchy configuration:
Only use this process if you have previously saved your configuration.
The template defines the node names, attributes, and relationships used in Hierarchy
Manager.
• To replace an existing hierarchy template used in Hierarchy Manager with a different one:
Populating a hierarchy
After installing and commissioning PME, you can populate Hierarchy Manager by associating
devices to nodes in a skeleton configuration CSV file and importing the entries into Hierarchy
Manager. Following a successful import, you can use Hierarchy Manager to modify your hierarchy
information. You can then use hierarchies in other PME applications, such as in view-enabled
reports in the Web-based Reports application, and in the Dashboards application.
For illustration purposes, the default hierarchy template in Hierarchy Manager is used as a
reference for this task.
The skeleton configuration CSV file created from the default hierarchy template used in Hierarchy
Manager includes a header row with column headings of Devices_Full Name, _Percentage,
Site_Name, Buildings_Name, Areas_Name, and Virtual Meter_Name. It also includes a list of
the devices in the system that are not included in a hierarchy so that you can associate the
devices to the hierarchy nodes.
Different hierarchy templates can be used in Hierarchy Manager. Each hierarchy template
determines the information that is included in the configuration CSV file. For example, the Site
Building Area Tenant.xml hierarchy template file results in column headings of
Devices_Full Name, _Percentage, Site_Name, Buildings_Name, Areas_Name, Tenants_
Name, Tenants_Contact, Tenants_email, Tenants_Phone, and Virtual Meter_Name in the
configuration CSV file.
(Sample and generic hierarchy templates are located in the:
...\Applications\HierarchyManager\SampleTemplates folder.)
The procedure for updating a skeleton configuration CSV file follows a consistent pattern
regardless of the template used in Hierarchy Manager.
The process for adding a large number of entries to a hierarchy consists of:
• Saving a skeleton hierarchy configuration in a CSV file.
• Updating Hierarchy Manager with the new entries and verifying the outcome.
NOTICE
LOSS OF DATA
• Do not use the hierarchy configuration CSV file to incrementally update an existing
hierarchy.
• Use the Hierarchy Manager application to incrementally update an existing hierarchy.
Failure to follow these instructions can result in the corruption of hierarchy data.
To resolve this situation, it is recommended that you use the Google Sheets spreadsheet
application. Editing and saving a skeleton configuration CSV file with Google Sheets preserves
the UTF-8 encoding, which results in a successful import of the CSV file contents to Hierarchy
Manager.
For illustration purposes in this task, devices are going to be mapped to a physical layout
consisting of 4 areas within a building.
• Install Microsoft Excel, or another spreadsheet application that you can use to open and edit
CSV files on your system. (See Editing and saving a localized version of a CSV file for
information about editing and saving a skeleton configuration CSV file from a localized
version of Hierarchy Manager.)
• Add devices, logical devices, and/or managed circuits to PME. You can add additional
devices at a later time, but you need to have an initial number of devices before you export the
skeleton configuration CSV file.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
Where <file path> is the location for the exported CSV file, and <file name> is the
name of the file, including the .csv file extension. If you do not specify a file path, the current
directory is used.
NOTE: If you include spaces in the CSV file name and/or file path, you must enclose the
file path and file name in quotation marks. For example, HierarchyConfig.exe export
config "C:\test file.csv".
The items in the skeleton hierarchy configuration CSV file includes a list of devices not
included in a hierarchy, the heading _Percentage, headings for the node types, and the
heading Virtual Meter_Name.
2. On an empty row below the list of devices, type the names that you want to use for the site,
the building, and an area association in their respective columns.
As indicated in the previous description of the physical layout, there are 4 building areas.
You now need to define the association of the 3 remaining areas to the building and site.
3. Repeat the previous step for each of Area 2, Area 3 and Area 4, as shown in the following
image.
This completes the association of the 4 areas to the building instance, Building 1, and the
site instance, Test Site.
If there are additional buildings on the site, you can repeat the pattern that you entered. For
example, if there is a Building 2 on the site, your entries would include the same site name,
Test Site, but the building name is Building 2. Note that you should use unique names for
the areas. For example, for Building 2, define the area names like B2-Area 1, B2-Area 2,
and so on.
1. Type the area name that you defined in the previous set of steps, in the Areas_Name
column on the row identifying the device full name.
For example, to associate device Test_Site.Device1 to Area 1, type Area 1 in the Areas_
Name column in that row.
2. Continue to associate any of the remaining devices to their respective areas. Note that you
can assign multiple devices to the same area. For example, the following image shows two
devices assigned to Area 3 and two to Area 4.
1. Type the virtual meter name in the Virtual Meter_Name column on the row identifying each
device full name that you want to associate with the virtual meter.
2. To apportion a percentage of a device's value to the virtual meter, type a percent value for
the applicable device in the _Percentage column. For example, apportion 25% of Test_
Site.Test_8600_C and 75% of Test_Site.Test_8600_D to virtual meter VM1.
3. To associate a virtual meter to a specific area, add the virtual meter name to the Devices_
Full Name column on a row defining the area. For example, to associate VM1 to Area 2,
add VM1 to line 13 (in this example) in the CSV file.
You can also associate a virtual meter (VM1) to another virtual meter by including the virtual
meter name in the Devices_Full Name column and adding the additional virtual meter
name on the same row under the Virtual Meter_Name column.
When you complete your updates in the hierarchy configuration CSV file, you can now update
Hierarchy Manager by importing the contents of the CSV file.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
Where <file path> is the location of the file you are importing, and <file name> is the
name of the file, including the .csv file extension. If you do not specify a file path, the current
directory is used.
The import process provides feedback during each stage of the import. If the import
operation is unsuccessful, the utility provides information about possible reasons for the
unsuccessful operation.
NOTE: If the CSV file name and/or file path contains spaces, you must enclose the file path
and file name in quotation marks. For example, HierarchyConfig.exe import
config "C:\test file.csv".
This lets you back up the hierarchy before modifying it in the Hierarchy Manager application. You
can import the hierarchy configuration saved in the XML file to restore your hierarchy in Hierarchy
Manager.
NOTE: Restoring (importing) a configuration XML file deletes the current hierarchy configuration
and replaces it with the one represented in the file.
NOTICE
LOSS OF DATA
• Do not use the hierarchy configuration XML file to incrementally update an existing
hierarchy.
• Use the Hierarchy Manager application to incrementally update an existing hierarchy.
Failure to follow these instructions can result in the corruption of hierarchy data.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
NOTE: If the XML file name and/or file path contains spaces, you must enclose the file path
and file name in quotation marks. For example, HierarchyConfig.exe export
config "C:\test file.xml".
NOTE: Restoring a configuration XML file deletes the current hierarchy configuration and
replaces it with the one represented in the file.
NOTICE
LOSS OF DATA
• Do not use the hierarchy configuration XML file to incrementally update an existing
hierarchy.
• Use the Hierarchy Manager application to incrementally update an existing hierarchy.
Failure to follow these instructions can result in the corruption of hierarchy data.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
NOTICE
LOSS OF DATA
The new template overwrites the existing template, which permanently removes all information
contained in the original. Export the existing hierarchy template from PME before importing a
new template.
When you import the hierarchy template XML file, the Hierarchy Configuration Utility performs a
validation test on the file. If the file validation is not successful, the utility does not import the file
and provides information indicating where the validation process stopped. Check for any
discrepancies in the file, save the changes and reimport the file.
To import a hierarchy template XML file:
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
NOTE: The file name and folder name cannot contain spaces.
The utility provides feedback for each stage of the import. If the import operation is
unsuccessful, the utility provides information about why the import is unsuccessful.
3. Verify that the template has been successfully imported in Hierarchy Manager.
Hierarchy Manager should now display the nodes defined in the newly imported template.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
NOTE: The XML file name and file path cannot contains any spaces.
3. Navigate to the location you specified to confirm that the XML file is successfully saved.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
The message Configuration cache refresh complete indicates that the refresh
operation has finished.
NOTICE
LOSS OF DATA
Performing this operation permanently removes configuration content from the system. Ensure
that this operation is necessary before proceeding. This procedure cannot be undone.
b. Click the bin folder and press Shift + Right-click and select Open command window
here on the context menu.
2. Type HierarchyConfig.exe delete config. Type yes when prompted. The utility
deletes all hierarchy configuration content. To confirm the deletion, open Hierarchy
Manager. There should be no hierarchy content displayed.
Sample and generic hierarchy templates are included with your software. You can use any of
these templates if they more closely represent the hierarchy organization you want to implement.
However, you need to have a thorough understanding of the structure of a template before
making any changes. Always back up your files before proceeding with any changes. The
additional hierarchy templates are located in:
...\Applications\HierarchyManager\SampleTemplates
NOTE: Any time you change a hierarchy template, you need to import it into Hierarchy Manager
before those changes take effect. See Installing a hierarchy template.
You can localize a hierarchy template XML file to display national language text on the tabs and
views in Hierarchy Manager, and also wherever hierarchies are enabled in the Web Applications
component. For example, localized hierarchy node names will display in the Source Selector in
the Reports application.
To localize the text you need to edit the displayName attribute that is used throughout a hierarchy
template XML file. For example, the display name attribute for Site in the hierarchy template file
is displayName="Site". Change the text within the quotation marks to the national language
equivalent.
The displayName attribute is used in <Type>, <Attribute>, <Reference>, and <View> xml
elements in a hierarchy template file. (See The XML elements in the template file for descriptions
of these elements.) In some cases the same text is used on displayName attributes more than
once in the hierarchy template file. Be sure to change every occurrence in the file.
When you complete the edits, follow the process described in Installing a hierarchy template to
update the hierarchy template used by Hierarchy Manager.
The initial page in Hierarchy Manager shows the node types and attributes defined in the
hierarchy template file. The bottom three node types are configured for devices to be connected
to them.
(See Additional notes for considerations related to associating devices to more that one node
level in a hierarchy.)
The hierarchy view defined in the template is represented on the Hierarchy Manager Tree View
page as a physical layout:
The following table summarizes the major elements in a hierarchy template XML file.
<Template>
The <Template> element is the container for all of the XML tags.
<Types>
This is a containment tag for all <Type> elements. Make sure any <Type> elements are inside
this containment tag.
<Types>
<Type...>
...
</Type>
...
</Types>
<Type>
The <Type> tag contains all the information required to define the Node. Each defined type adds
a tab in Hierarchy Manager. The tab name is defined by displayName. The <Type> tag also
contains one or more <Attribute> and <Reference> tags.
<Types>
<Type displayName="level_1" uri="uri:application-
modules/power/model/type#level_1">
<Attribute... />
<Attribute... />
...
<Reference... />
...
</Type>
<Type>
...
</Type>
</Types>
To change the tab name in Hierarchy Manager from level_1 to new_name, modify
displayName in the template file from:
to:
<Attribute>
The <Attribute> tag defines the characteristics of the <Type>. It uses dataType to determine
the format of the edit dialog that opens in Hierarchy Manager.
You need to define at least one <Attribute> element with attribute#name in the uri:
uri:application-modules.com/power/model/attribute#name.
The datatypes on the <Attribute> element can be such things as name, floor number, or
breaker ratings, depending on the template layout.
• dataType="String" - For short blocks of text (for example, name).
• dataType="LongText" - For long blocks of text (for example, notes, contact information).
<Types>
<Type displayName="level_1" uri="uri:application-
modules/power/model/type#level_1">
<Attribute displayName="id" dataType="String" uri="uri:application-
modules/power/
model/attribute#name" />
<Attribute... />
...
<Reference... />
...
</Type>
<Type>
...
</Type>
</Types>
To add an attribute to a node, determine the characteristic you need to capture with that attribute,
determine the appropriate dataType, and create the attribute. To define Name as one of the
characteristics for a type, the Attribute tag is written as:
<Reference>
The <Reference> tag defines the relationship between types. To establish a relationship, each
<Type> element needs a <Reference> element, and each <Reference> element needs to
refer to the displayName of the related <Type>.
The following example contains references establishing a relationship between the <Type> with
displayName="level_1", and the <Type> with displayName="level_2".
Since the types are in a parent-child relationship, the reference in the child needs to contain
isReverse="true".
The last portion of the <Reference> element includes a relation name. It is used in the
Relation element within the <View> structure to define what appears on the Tree View page in
Hierarchy Manager.
<Types>
<Type displayName="level_1" uri="uri:application-
modules/power/model/type#level_1">
<Attribute displayName="id" dataType="String" uri="uri:application-
modules/power
/model/attribute#name" />
<Attribute... />
...
<Reference displayName="level_2" uri="uri:applications-
modules/power/model/
relation#1_2" target="uri:application-
modules/power/model/type#level_2 />
...
</Type>
<Type displayName="level_2" uri="uri:application-
modules/power/model/type#level_2">
<Attribute displayName="id" dataType="String" uri="uri:application-
modules/
power/model/attribute#name" />
<Attribute... />
...
<Reference displayName="level_1" isReverse="true"
uri="uri:applications-modules/
power/model/relation#1_2" target="uri:application-
modules/power/model/
type#level_1 />
...
</Type>
</Types>
A physical or logical device, or managed circuit can be associated with any type. To configure a
type to connect with a device, create a Reference tag similar to the example below. Note that
meteredBy is a keyword, and it must be entered exactly as shown to correctly reference a device.
<Views>
This is a containment tag for all <View> elements. Views are the means by which other
applications such as Dashboards and Reports discover the set of devices that are aggregated
together. All <View> elements need to be inside this containment tag.
<Types>
<Type...>
...
</Type>
<Type...>
...
</Type>
</Types>
<Views>
<View... >
</View>
</Views>
<View>
The <View> tag defines how a hierarchy can be viewed in PME. These different views provide
different ways that a hierarchy can be displayed, or different ways the device data associated with
the hierarchy types can be grouped together.
The view displayName (for example Generic Layout) is defined here. The name appears on
the Tree View page of Hierarchy Manager. You can select the view as a data source in the
Dashboards and Reports applications.
The <View> tag groups together the <Relation> elements whose order determines how the
view appears.
<Types>
<Type>
...
</Type>
<Type...>
...
</Type>
</Types>
<Views>
<View displayName="Generic Layout"
rootNodeTypeUri="uri:application-modules/power/model/
type#level_1 >
<Relation... />
<Relation... />
...
</View>
</Views>
<Relation>
The <Relation> tag is used to establish how the different views of the hierarchy are structured.
The initial relation is defined in the <Reference> element within a <Type>. Specify the node type
to start at (the initial <Relation> entry), then add <Relation> entries to complete the tree.
If a <View> element contains a <Relation> with reverse="true", then the view presented
follows the relationship in the reverse order.
<Types>
<Type displayName="level_1" uri="uri:application-
modules/power/model/type#level_1">
<Attribute displayName="id" dataType="String" uri="uri:application-
modules/power/
model/attribute#name" />
...
<Reference displayName="level_2" uri="uri:applications-
modules/power/model/
relation#1_2" target="uri:application-
modules/power/model/type#level_2 />
</Type>
<Type displayName="level_2" uri="uri:application-
modules/power/model/type#level_2">
<Attribute displayName="id" dataType="String"
uri="uri:application-modules/
power/model/attribute#name" />
<Attribute... />
...
<Reference displayName="level_1" isReverse="true"
uri="uri:applications-modules/
power/model/relation#1_2" target="uri:application-
modules/power/model/
type#level_1 />
</Type>
<Type...>
...
</Type>
</Types>
<Views>
<View displayName="Generic Layout"
rootNodeTypeUri="uri:application-modules/power/model/
type#level_1 >
<Relation follow="uri:application-modules/power/model/relation#1_2"
/>
<Relation follow="uri:application-modules/power/model/relation#2_3"
/>
<Relation follow="uri:application-modules/power/model/relation#3_4"
/>
<Relation follow="uri:application-modules/power/model/relation#4_5"
/>
...
</View>
</Views>
Additional notes
If devices are associated with more than one node in a parent-child relationship in a hierarchy
tree, only those devices first encountered in the tree are included in generated reports. All devices
lower in the hierarchy tree are ignored in generated reports.
Site 1
and you select Building 1 on the Views page of the Source Selector in a report, the generated
report includes data for the devices associated with Building 1, but not for devices in the lower
node in the tree – Area 1.
Similarly, if you select Site 1, which does not include a device association in the hierarchy, the
generated report includes data for the devices associated with the Building 1 level only, the level
in the hierarchy where devices are first encountered.
If you do not require all the levels provided in the example hierarchy template XML file, you can
comment out the types you do not need, from the bottom type up. Commenting out the type,
rather than just deleting the type preserves the structure of the template file and allows you to
reinstate the type with a minimum of effort. Enclose the <Type> element within the start comment
tag <!-- and the end comment tag --> to comment it out. For example:
If you want to remove one or more view elements defined in a template, add comment tags
around the applicable <View> tags. Remove the comment tags to restore the View elements.
When you import the hierarchy template XML file, the Hierarchy Configuration utility performs a
validation test on the file. If the file validation is not successful, the utility does not import the file
and provides information indicating where the validation process stopped. Check for any
discrepancies in the file, save the changes and reimport the file.
<!-- This is a template for a simple 5 level hierarchy. All the relations and nodes have been pre-configured. To customize for your
purposes, search and replace "level_1" with the name of your top-level type (e.g. Site),
...
"level_5" with the name of your lowest-level type (e.g. Room)
With this template you can attach "devices" to the lower 3 levels.
-->
<Types>
<!-- this is how to create one half of the relationship between two nodes, you need a similar reference on the other end of the
relationship -->
</Type>
<!-- this is how to connect up a logical/physical device to provide metered data to a node this can appear anywhere in the
hierarchy e.g. main meter for building, metering points for specific loads, managed circuits for multi-circuit monitors -->
<Reference displayName="device" uri="uri:application-modules/power/model/relation#meteredBy" target="uri:application-
modules/power/model/type#device" />
</Type>
</Types>
<Views>
<!-- do not need to add the "meteredBy" relation in the View if a "meteredBy" relation has a mapped device no matter what level
of the hierarchy then the aggregation will return the value from the mapped device -->
</Views>
</Template>
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
• 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.
used to modify the hierarchy is similar for most templates. This section provides information
regarding the basic steps to modifying a hierarchy, regardless of the template used.
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 and Customizing Access Level Privileges 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.
percent. The percentage can be a negative, positive, or integer value. The percentage field is
restricted to 15 characters. Time intervals for apportioned meters function in the same way as
devices. See Meter apportionment for more information.
To create an apportioned meter:
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.
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.
• 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.
NOTE: This version of the Insulation Monitoring Tool is for the ANSI market.
Use the Insulation Monitoring Tool to configure the Insulation Monitoring Module. With this tool
you define Isolated Power Panels, Areas, and Groups for the Insulation Monitoring Report (ANSI),
and you generate Vista diagrams (ANSI).
Prerequisites
• The isolated power panel monitoring devices that are recording the panel data must be
configured in the PME Management Console and must be communicating before you can
configure the components and properties in the configuration tool.
User Interface
Each tab contains a grid area and an editor area. The grid area is empty initially, but it will be
populated with entries that you define. Use the editor area to define the settings for new items or
to update the settings for existing items.
The following controls are common for the tabs:
• Help - Click this to view online help for the tab.
• Revert - Returns a modified record to its original values, if OK or Apply have not been
clicked.
• OK - Saves all changes and exits the configuration tool.
The Modified column in the grid area shows the status of the row data:
NOTE: The first time you open the Insulation Monitoring Tool, you must set the Configuration
Type. Choose between ANSI and IEC. For ANSI, you must also set the Total Hazard Current
Threshold. The Initial Configuration Setup dialog is only displayed the first time you open the
tool. After the initial selection, the tool remains in the selected type for future startups. To show
this dialog again and choose different settings, hold down Shift when opening the tool.
Fault Location Devices: (Optional) Select the fault location monitoring devices that are
connected to the Line Insulation Monitor.
Monitoring Options: (Optional) Select the monitoring options that are configured for
the Line Isolation Monitor device.
NOTE: All Fault Location monitoring devices, Bender EDS, that are configured in the
system are displayed automatically in the Fault Location Devices list. If no devices are
displayed, that means that none are configured in the system.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
1. On the Panels tab, click the Isolated Power Panel you want to update.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
1. On the Panels tab, click the Isolated Power Panel you want to delete.
2. Click Delete.
NOTE: Regenerate the Vista diagrams after changing the Isolated Power Panel configuration.
Defining Areas
Associate Isolated Power Panels with areas.
To add a new Area:
Panels: Select the panels that are associated with the area. The panels listed are the
ones you configured on the Panels tab.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
2. Click Delete.
NOTE: Regenerate the Vista diagrams after changing the Areas configuration.
Defining Groups
Combine areas into groups.
To add a new Group:
Areas: Select the areas that you want to be part of the group. The areas listed are the
ones you configured on the Areas tab.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
2. Click Delete.
NOTE: Regenerate the Vista diagrams after changing the Groups configuration.
1. In the Insulation Monitoring Configuration Tool, click the Groups tab, and then click
Generate Vista Diagrams to open the Vista Diagram Generation dialog.
NOTE: At least one group must be configured for the Generate Vista Diagrams command
to be available.
2. In Vista Diagram Generation, select the output path for the diagram files and select the
groups for which you want to generate diagrams.
3. (Optional) Select Include Custom Logo and then select the logo image file for the
diagrams. By default, a Schneider Electric logo is used.
4. Under Options, drag the indicator to define the width of Vista diagrams you generate.
NOTE: The Diagram Width setting determines the width of the actual Vista diagrams, the
width of the background image inside the diagrams, and the width of the boxes that show
the groups, areas, and area details information. Choose a larger value for this setting if you
have many groups or areas. Choose a smaller value if you only have a small number of
groups and areas.
5. Click Generate Vista Diagrams to generate the diagram files, then click OK and Close.
6. Check the Vista diagrams and repeat steps 4.-5. if you need to adjust the diagram width.
NOTE: This version of the Insulation Monitoring Tool is for the IEC market.
Use the Insulation Monitoring Tool to configure the Insulation Monitoring Module. With this tool
you define Isolated Power Panels, Areas, and Groups for the Insulation Monitoring Report (IEC),
and you generate Vista diagrams (IEC).
Prerequisites
• The isolated power panel monitoring devices that are recording the panel data must be
configured in the PME Management Console and must be communicating before you can
configure the components and properties in the configuration tool.
User Interface
Each tab contains a grid area and an editor area. The grid area is empty initially, but it will be
populated with entries that you define. Use the editor area to define the settings for new items or
to update the settings for existing items.
The following controls are common for the tabs:
• Help - Click this to view online help for the tab.
• Revert - Returns a modified record to its original values, if OK or Apply have not been
clicked.
• OK - Saves all changes and exits the configuration tool.
The Modified column in the grid area shows the status of the row data:
NOTE: The first time you open the Insulation Monitoring Tool, you must set the Configuration
Type. Choose between ANSI and IEC. For ANSI, you must also set the Total Hazard Current
Threshold. The Initial Configuration Setup dialog is only displayed the first time you open the
tool. After the initial selection, the tool remains in the selected type for future startups. To show
this dialog again and choose different settings, hold down Shift when opening the tool.
Fault Location Devices: (Optional) Select the IFL device for this power panel.
NOTE: All IFL devices that are configured in the system are displayed automatically in the
Fault Location Devices list. If no devices are displayed, that means that none are
configured in the system.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
1. On the Panels tab, click the Isolated Power Panel you want to update.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
1. On the Panels tab, click the Isolated Power Panel you want to delete.
2. Click Delete.
NOTE: Regenerate the Vista diagrams after changing the Isolated Power Panel configuration.
Defining Areas
Associate an Isolated Power Panels with areas.
To add a new Area:
Panels: Select the panel that is associated with the area. The panels listed are the ones
you configured on the Panels tab.
NOTE: With IEC, you can have only one panel per area.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
2. Click Delete.
NOTE: Regenerate the Vista diagrams after changing the Areas configuration.
Defining Groups
Combine areas into groups.
To add a new Group:
Areas: Select the areas that you want to be part of the group. The areas listed are the
ones you configured on the Areas tab.
4. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
3. Click Apply to save the changes and keep the configuration tool open. Click OK to save the
changes and close the configuration tool.
2. Click Delete.
NOTE: Regenerate the Vista diagrams after changing the Groups configuration.
1. In the Insulation Monitoring Configuration Tool, click the Groups tab, and then click
Generate Vista Diagrams to open the Vista Diagram Generation dialog.
NOTE: At least one group must be configured for the Generate Vista Diagrams command
to be available.
2. In Vista Diagram Generation, select the output path for the diagram files and select the
groups for which you want to generate diagrams.
3. (Optional) Select Include Custom Logo and then select the logo image file for the
diagrams. By default, a Schneider Electric logo is used.
4. Under Options, drag the indicator to define the width of Vista diagrams you generate.
NOTE: The Diagram Width setting determines the width of the actual Vista diagrams, the
width of the background image inside the diagrams, and the width of the boxes that show
the groups, areas, and area details information. Choose a larger value for this setting if you
have many groups or areas. Choose a smaller value if you only have a small number of
groups and areas.
5. Click Generate Vista Diagrams to generate the diagram files, then click OK and Close.
6. Check the Vista diagrams and repeat steps 4.-5. if you need to adjust the diagram width.
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. To view device event log data, use Alarm Views. To view device historical data,
use Dashboards, Diagrams, or Reports.
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
5 relate 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,
11
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.
Export
Export the content of selected system log table entries in .csv file format, for use in
12 another 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.
Page selector.
16 Use the page selector to navigate between pages. Set the number of items that are
displayed on a page.
Before you can create a logical device, the physical device that it references must be created. You
can create one or more logical devices from a single physical device, or you can also create a
single logical device from several physical devices.
After you create a logical device, you can view its real-time data in the following components:
• Vista.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
Each logical device has a logical device type associated with it. Each logical device type is
defined with a collection of output measurements. The measurements defined by the device type
become the output measurements for instances of that device type, that is, for the logical devices.
You use the Logical Device Type Editor to create logical device types. See Using the Logical
Device Type Editor for information about viewing, creating, editing, and deleting logical device
types.
The Logical Device Editor in Management Console allows you to configure specific logical
devices by mapping input registers to output measurements that are defined in the associated
device type. See Using the Logical Device Editor for information about creating, configuring,
editing, and deleting logical devices.
Open the Logical Device editor applications from the Tools menu in the Management Console.
NOTE: Access to this application or function is controlled by user privileges. See Default User
Access Level Privileges and Customizing Access Level Privileges for details.
2. Select Tools > Logical Device > Logical Device Type Editor.
The top portion of the editor contains a logical device type display grid listing the logical device
types that have been defined. The bottom portion is an edit area where you can modify existing
device types and their measurements, or create new ones.
A Display grid area B Edit area - Summary tab C Edit area - Measurement tab
The Type Name column contains the names for the defined device types. Type names must be
unique.
The System Measurements and Custom Measurements columns show the number of
measurements that have been defined for each device type.
The default All in the list displays all of the categories and their respective measurements in
the grid.
• An available measurements grid listing the measurements available for selection when you
define a device type. Measurements that are grayed out indicate that they have been added
to the selected device type. Clicking New opens a dialog for defining a new, custom
measurement. An X in the Custom column identifies the entry as a custom measurement.
The Edit and Delete links give you the option to modify or delete custom measurements only.
NOTE: It is recommended that you add a new custom measurement only if an existing
measurement does not suffice. Factory-defined System Measurements contain
considerable information about their type and usage, which is then used throughout the
system to provide intelligent assistance in Dashboard controls and Report selections. Since
custom measurements do not have this information, their usage may not provide the
expected results.
• A Measurements For grid that lists the measurements that comprise the device type that is
selected in the display grid area. Use the >> button to add a measurement that you selected
in the list of available measurements to the Measurements For list for the device type.
Measurements that you select for a device type are grayed out to indicate that they have been
assigned to the device type. Use the << button to remove a selected measurement from the
Measurements For grid. Measurements that are removed are no longer grayed out in the list
of available measurements and they are available for selection.
Note that if you attempt to delete a custom measurement that has been mapped to any logical
device, a message indicates that the measurement cannot be deleted. You need to unmap
the custom measurement from the logical devices before you can delete it.
In all grids:
• Each of the columns can be sorted in ascending or descending order when you click on the
column heading.
• When you place your cursor on a column heading, a filter icon appears on the right side of the
heading area. Click this icon to open a list of items that are available for filtering. Click the item
that you want to use as the filter. When you do this, the filter condition displays on the left side
of the status area at the bottom of the grid. Click the X icon in the status area to turn off the
filter.
• The blank area immediately below a column heading is an entry field for filtering on an entry
you type in that area. For example, to filter on a specific name, enter a name under the Name
column to automatically filter the entries in the grid.
• You can drag and drop the grid column headers to rearrange the order of the columns in the
grid.
This clears the Type Name field and resets System measurements and Custom
measurements to 0 (zero) on the Summary tab.
All is selected by default in the Available Measurements list on the Measurements tab.
The name appears in the logical device type display grid and an ! (exclamation) appears in
the Modified column to indicate that the device type entry is incomplete.
3. Click the Measurements tab to go to the list of measurements that are available for
selection.
4. Locate and click an available measurement that you want to associate with the device type,
then click >> to add it to the Measurements For list. Repeat this step for each measurement
that you want to associate with the device type.
5. To delete a device type, click the device type in the display grid and click Delete on the top
right of the editor.
Note that Delete is disabled if any logical devices are associated with the logical device
type.
Custom measurements
The following sections describe how to create, modify, or delete custom measurements. Because
factory-defined System Measurements contain considerable information about their type and
usage, custom measurements should only be created in exceptional circumstances, and only with
an understanding of the expected results from their usage.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
1. Click New beside the Available Measurements dropdown list to open the New
Measurement dialog. (You can also edit a new custom measurement by clicking Edit and
modifying the entries.)
2. Enter a descriptive name and an engineering name for the new measurement in the
respective fields. For example, Voltage A-B Low is the descriptive name, and Vll ab
low is the engineering name.
3. Select the unit of measure from the Units list or add a custom unit of measure by typing it in
the Units field.
Note that the combination of the descriptive name, the engineering name, and the unit of
measure must be unique for each custom measurement.
The new measurement is added as an available measurement in the grid and an X in the
Custom column indicates that it is a custom measurement.
You need to select All or Custom in the Available Measurements list to see the custom
measurement in the grid.
Custom measurements that have been associated with a logical device type can be edited
but not deleted. Selecting Delete results in a message indicating that the custom
measurement cannot be deleted because it is mapped either to a logical device type or to a
logical device that is logging data.
3. To modify the custom measurement, click Edit to open the Edit Measurement dialog,
update the entries or selections in the dialog, and click OK to apply to changes.
Note that if you attempt to delete a custom measurement that is associated with any logical
devices, a message indicates that the measurement cannot be deleted.
1. Start Management Console and log in using an account with supervisor-level access.
2. Click the Devices icon, then right-click the Display window and select New > Logical
Device.
The devices defined in Management Console are listed in the Input Devices area of the
Logical Device Editor.
The top portion of the editor consists of a header area that contains instructions, selection lists,
and input fields. The bottom portion is the mapping area that allows you to map the input registers
of a physical device to a list of measurements provided by the associated device type.
The Group field is a combination input field and dropdown list. You can either enter a name for
the group or select a group from the list.
The Name field identifies the name of the logical device that you are defining. Enter the name of
the logical device in the field.
The Logical Device Type dropdown list contains the names of logical device types that are
available for selection.
The Register Mapping grid is populated with a list of the output measurements that are defined
for the logical device type that you select in the Logical Device Type dropdown list. They are
listed under a generic Device Name label pending their mapping to the logical device name that
you specified. Drag an entry from the Input Device Registers list to an output measurement in
the Register Mapping grid to map the two values.
The output measurements defined for the selected logical device type are listed in the
Output Measurement column in the Register Mapping area.
2. Either select an existing group name from the Group dropdown list, or enter a group name
in the field.
3. Enter a name for the new logical device in the Name field.
4. Select one of the input devices from the Input Devices area of the editor.
The registers for the selected input device appear in the Input Device Registers area. Note
that if you choose to display the registers for the input device in an ION tree format, delays in
displaying the registers can occur for devices with a large volume of registers.
The input device registers appear in bold font when they are mapped to an output
measurement.
7. To edit a logical device that is in the Device panel of Management Console, double-click the
device name, or right-click the device name and select Configure Device to open the
Logical Device Editor, or click the device then select Edit > Configure Device.
Note that:
If you choose to edit the configuration of the logical device, delays can occur in
displaying the registers for devices with a large volume of configured registers.
Duplicate and Configure in Management Console's Edit menu cannot be used with
logical devices. See Creating multiple logical devices for information about creating
more than one logical device.
When a logical device is configured, historical data is logged to the logical device and not the
related physical device.
If multiple logical devices include the same input measurement from the same physical device,
historical data from that input measurement is routed to the logical device that was configured
last.
If you right-click the logical device in Management Console and select Configure Device to open
the Logical Device Editor after you have deleted the physical device, a message indicates that the
physical device has been deleted. The Register Mapping grid for the logical device shows the
deleted physical device/ION handle in the Input Register column.
If you re-create the physical device, the input measurement mapping for the logical device is
automatically restored.
If you right-click the logical device in Management Console and select Configure Device to open
the Logical Device Editor after you have renamed the physical device, the Register Mapping grid
for the logical device shows the renamed physical device in the Device Name column.
If you right-click the logical device in Management Console and select Configure Device to open
the Logical Device Editor after you have deleted the site, a message indicates that the physical
device has been deleted. The Register Mapping grid for the logical device shows the deleted
physical device/ION handle in the Input Register column.
• Modifying the CSV file to add multiple logical device configurations based on the original
logical device configuration.
• Importing the CSV file in Management Console to add the logical devices to the system.
1. Use the Logical Device Editor to create at least one logical device in the Devices area of
Management Console.
2. Select one or more logical devices, right-click and select Export to open the Export Status
dialog.
Note that if you choose to export the registers for the logical device, delays in the export
process can occur for logical devices with a large volume of configured registers.
3. Click the browse button on the right of the Selected File field to open the Save As dialog.
4. Navigate to the location where you want to save the file and enter a name for the file in the
File name field.
The Selected File field is populated with the location and file name that you specified.
6. Click Export.
The Status column in the grid area of the dialog indicates Exported for a completed export
operation. If the export operation is not successful, for example if the input registers cannot
be retrieved for the logical device being exported, it is indicated in the Status column. Click
the link to open the log file to view additional information.
Configuration information for all of the selected logical devices is exported to the CSV file.
• Input register
• Output measurement
• Handle - this column heading is required but the entries are not required unless there are
duplicate labels, that is, input registers with the same name but with a different ION handle. In
this case the ION handle is required. You can view the ION handles by exporting the input
measurements from the Logical Device Type Editor.
NOTE: The column headings remain in English for localized versions of the product. This is
required for CSV file-processing purposes.
To create multiple entries for the logical device configuration, use the copy and paste function in
Excel. It is recommended that only users with supervisor-level access create multiple entries.
1. Select the rows that you want to duplicate and press Ctrl+C to copy them.
2. Place the cursor in the left-most cell of the first blank row and press Ctrl+V to paste copies of
the selected rows.
3. Continue the paste operation for as many logical device configurations that you want to
create.
4. After completing the paste operation, be sure that you use unique device names to avoid
duplicates.
You can also export all of the register names of a physical device as well as all of the
measurement names of a logical device type. This gives you the ability to use these additional
CSV files to copy and paste additional register names and measurement names into the CSV file
you are using to create the multiple logical devices.
2. Right-click anywhere in the register list in the Input Device Registers area to open a menu
and select Export Device Input Registers.
1. Open Management Console and select Tools > System > Logical Device Type Editor.
2. Select a logical device type in the logical device types area of the editor.
4. Right-click anywhere in the grid under Measurements For and select Export
Measurements.
1. Open Management Console and select Tools > Import Logical Device in the Devices
panel of Management Console to open the Logical Device Import Form window.
Logical Device Import Form is available only when you are in the Devices panel of
Management Console,
2. Use the Browse button to navigate to and select the CSV file to import.
3. Select Overwrite Existing Devices if you want overwrite logical devices with the same
name that were previously created.
Logical devices with the same name can occur as a result of a previous import operation.
4. Click Import to add the multiple logical devices to the Devices area of Management
Console.
The system performs a validation of the configuration data during the import operation. If an
error occurs during the import operation:
The Status column in the grid area indicates Failed for any logical device that is not
imported. Click Failed to view details about the cause of the unsuccessful import.
Logical devices are created for all correct entries in the CSV file. Logical device entries
that are incorrect are not created in Management Console.
Management Console
Use Management Console to add, remove or configure system components, such as metering
devices, in your Power Monitoring Expert power management system. You can set up different
types of sites (communication links such as Ethernet or serial), and set up connection schedules
for these sites.
In addition, the Management Console Tools menu provides access to device and system
configuration, maintenance and programming tools.
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.
NOTICE
NETWORK INOPERABILITY
Do not make unauthorized changes in the network configuration.
Window title
The window title displays the name of the software program and the current user.
Display window
The Display window shows the contents of the item currently selected in the System Setup pane.
Refresh
To manually refresh Management Console and reload its contents, select View > Refresh (or
press F5).
Options
Select Tools > Options to open the Options dialog. Use this dialog to change display settings for
the System Log Events display window.
Highlighting
Highlighting controls how Error events are displayed in the System Log Events display window.
Select or clear the Enable Highlighting check box to turn highlighting on or off. Click Set Highlight
Color to change the highlight color for Critical or Error events in the System Log Events display
window.
Events
The Events section of the dialog lets you control how many records appear in the System Log
Events display window and how date and time are displayed.
For instructions on using these features, see Customizing and navigating interface displays.
• New displays the options available for adding new network items.
• Duplicate and Configure lets you perform batch cloning of devices. When multiple devices
are selected, this right-click shortcut becomes Configure Selected Devices which lets you
perform setup functions such as batch renaming of devices.
• Delete removes the selected items.
• Connect and Disconnect lets you manually connect to or disconnect from the selected site.
NOTE: You cannot connect or disconnect an individual serial device in a site; you can only
connect or disconnect the site for that serial device.
• Connect Ethernet and Disconnect Ethernet let you manually connect to or disconnect from
the selected Ethernet device.
• Security accesses the Meter Security Settings dialog. This is used by the software to gain
access to security-enabled devices (for example, ION8600 or ION7650); it is only available
from the shortcut menu for the Devices display pane.
• Configure <Network Component> opens the <Network Component> Configuration dialog
(where <network component> is the component selected). Use this dialog to make changes
to the properties for the selected network component.
• Change Group opens the Change Group dialog. Use this to change the device Group.
See Setting up your network in Management Console for information on adding these
components to your network.
NOTE: Do not use names such as CON, AUX, COM1, and LPT1 when naming sites and
devices. Consult Microsoft documentation regarding restrictions for naming files, paths, and
namespaces.
Servers
A server is a computer in the Power Monitoring Expert system that runs administrative software to
control access to the network and its resources, such as metering devices.
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.
Direct site
In a direct site, serial communications occur between a computer and one or more meters. The
standards most commonly used on computers are RS-232 (for connecting one device) and RS-
485 (for connecting a loop of up to 32 devices). When connecting to more than one serial device,
use an RS-232 to RS-485 converter. Note that you should keep the number of devices on a daisy
chain to a minimum to reduce the delay in real-time updates.
Modem site
In a modem site, communications occur between a remote modem (at the Modem Site) and a
local modem (on the server).
NOTE: Remote sites that use radio modems or leased-line modems are configured as Direct
(Serial) Sites, not as Modem Sites.
Modem sites can include traditional hardware modems (those that are configured and controlled
by Power Monitoring Expert or WinModems (Windows modems). If multiple modems are set up in
the modem site, Power Monitoring Expert selects the first available modem to establish
communications (this is referred to as “modem pooling”).
An Ethernet gateway site (for example, EtherGate or Modbus gateway) consists of an RS-485
chain of devices that communicates with an Ethernet network via an Ethernet device. The
Ethernet device acts as a gateway that transfers data between an Ethernet network and the
devices connected to it via RS-485. The gateway device converts RS-232/RS-485
communications to and from Ethernet.
OPC site
An OPC site consists of an OPC client that communicates with OPC-compliant devices on the
network.
Devices
A device is a meter or other component that communicates and gathers data, and is installed on a
network.
Release notes and mapping spreadsheets for device drivers recently added to the product are
included in the product's installation location in ...\Power Monitoring
Expert\system\doc\Device Support\. The release notes provide information about the
firmware versions supported by the device drivers, implementation details, images of Vista
diagrams for the devices, and pertinent safety messages. The device driver mapping
spreadsheets contain details such as modbus register addresses and corresponding ION register
addresses (handles). Register mapping information is also provided for any devices using PC
logging.
Serial devices
Serial devices belong to direct sites, modem sites, or Ethernet gateway sites — they
communicate through a modem, RS-232, RS-485, or Ethernet-to-Serial gateway connection. You
must have the appropriate sites configured first before you can add serial devices.
Ethernet devices
Ethernet devices are those that are directly connected to the network via Ethernet. You can
manually connect or disconnect your Ethernet device through the Management Console.
Logical devices
Logical devices are a collection of measurements from physical and VIP devices grouped into
single sources for use in the system.
OPC devices
OPC devices represent physical devices to which the system is communicating through an OPC
interface.
When a modem site needs to establish communications, it selects a modem from the list of
modems configured in the modem site. You can add hardware modems or WinModems to the
modem list.
NOTE: A WinModem is a modem that is directly controlled by the computer’s operating system.
Connection schedules
Connection schedules are programmed routines for a server to regularly connect to and
disconnect from sites (and their associated devices) and Ethernet devices. See Configuring
connection schedules 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.
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
Site and Device Naming restrictions
The following applies to Site, Device Group, and Device Name naming:
• 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.
Adding a server
Click the Servers icon, right-click the display window and select New > Computer. Fill in the
mandatory Name field.
Adding devices
Setting Up devices for direct serial communications
To set up devices for RS-232 or RS-485 communications on a direct serial loop, first add a direct
site in Management Console and specify a serial communications port on the computer.
Click the Sites icon. Right-click the display window and select New > Direct Site. Fill in the Name
and Serial Port fields. Configure the other fields as you require.
Click the Devices icon. Right-click the display window and select New > Serial Device on Direct
Site. Fill in these fields:
• 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.
• Site: Select the direct 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.
Click the Sites icon. Right-click the display window and select New > Ethernet Gateway Site.
Complete the Name, IP Address or Host Name, TCP/IP Port, and Secure Connection
Enabled 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).
NOTE: Secure Connection Enabled must be enabled only when the selected device supports
Secure ION or Modbus Encryption.
If you select Secure Connection Enabled, select one of the following Certificate Validation
types:
• Full: PME performs Certification checks. If there are issues with the certificate, PME notifies
certificate status, and then blocks the communication to the meter.
• Partial: PME performs Certification checks. If there are issues with the certificate,
Click the Devices icon. Right-click the display window and select New > Serial Device on
Ethernet Gateway Site. Fill in these fields:
• 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.
NOTE: Secure Connection Enabled must be enabled only when the selected device supports
Secure ION or Modbus Encryption.
If you select Secure Connection Enabled, select one of the following Certificate Validation
types:
• Full: PME performs Certification checks. If there are issues with the certificate, PME notifies
certificate status, and then blocks the communication to the meter.
• Partial: PME performs Certification checks. If there are issues with the certificate,
PME notifies certificate status, and then connects to the device.
• None: PME does not perform Certification checks while establishing a TLS connection.
Click the Sites icon. Right-click the display window and select New > OPC Site. Fill in the Name
and Address fields. Configure the other fields as you require.
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.
Before you can use a WinModem, you must first install it on your computer (follow the instructions
that came with the WinModem product). After you restart the computer, set up the WinModem:
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.
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 Renaming devices and groups 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.
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.
The Group column is displayed by default, but you can use the Column Selector to
remove it from the display area. You can now drag and drop the Group column to the
Group By Box area to show the devices organized within each group.
• Use the Data Availability column for inclusion in the display area.
Data Availability indicates All for devices that are active and have real-time and
historical data, and Historical only for devices that have been deleted and only provide
historical data. Historical devices are included in the devices displayed when you select
the Show historical devices checkbox.
• The Show historical devices option displays devices that have been deleted. Since the data
for these devices still exists in the system, they can be displayed when you select this option.
Renaming a device
Complete the following steps to change the display name of a device. The system (internal) name
is not affected by this name change.
1. Right-click the device name in the Devices pane of Management Console and select
Rename in the menu to open the Rename Device dialog.
The appearance of the exclamation icon to the right of the field indicates that there are
instructions or errors associated with the device name. Hover over the icon to display the
text and take appropriate action.
1. Right-click a single group name or select multiple group names (Ctrl + left mouse click) in the
Devices pane of Management Console and select Change Group in the menu to open the
Change Group dialog. (You can also select the devices and click the Change Group
2. Enter a new group name or select a group name from the list of group names currently used
in the system.
The appearance of the exclamation icon to the right of the field indicates that there are
instructions or errors associated with the group name. Hover over the icon to display the text
and take appropriate action.
These sources represent the physical structure in the system. For information about organizing
these circuits and other metering points into a recognizable system-specific hierarchy view, see
Hierarchy Manager and also the online help in Hierarchy Manager.
The first step in creating managed circuits is to add the multi-circuit device to Management
Console and check that it is communicating.
Once this is done, you can create managed circuits as source entries automatically as follows:
1. Right-click the multi-circuit device you added in Management Console to open the menu and
click Configure Managed Circuits.
The Configuring Managed Circuits dialog opens showing a progress bar as the circuits
are being created. The number of circuits created are indicated under the progress bar field.
The multi-circuit device now has an expand control (a plus symbol) on that row.
4. Click the + to expand the entry and view the circuits now associated with the multi-circuit
device.
However, you can keep the configuration up-to-date through the multi-circuit device configuration
changes and then re-running the configure managed circuits process to update the managed
circuits. Any circuits that have not changed remain unchanged. Any circuits that have been
removed in the multi-circuit device are deleted as managed circuits. Any new circuits are created
as new managed circuits.
By mapping managed circuits into a hierarchy, you can specify more recognizable names and
organize them into a view that matches the facility or building.
If you rename the group name or device name for the multi-circuit device, the name changes are
also applied to the managed circuits associated with the device. See Renaming devices and
groups.
If you delete the multi-circuit device, a dialog message indicates that the managed circuits
associated with the multi-circuit device will also be deleted.
If you have a number of multi-circuit devices configured in different ways, and you want to see
which measurements apply to a specific managed circuit, double-click the specific managed
circuit in Management Console to open the Managed Circuit Properties window. It provides:
information about the managed circuit, its parent device, its group name, and the measurements
associated with the circuit.
You can use the Duplicate and Configure option in Management Console to create multiple
devices and add unit IDs for each device. (See Setting up large systems for additional
information.) After multiple multi-circuit devices have been created, you can select them in
Management Console, right-click to open the menu and click Configure Managed Circuits. In
systems with many multi-circuit devices, the managed circuit creation process takes some time,
but the progress bar provides feedback on the progress of the creation process.
1. Right-click the device that has security enabled and select Security to open the Meter
Security Settings dialog.
2. From the Software Access drop down list, select the option as per the following table:
Option Description
Select this option if standard security is configured on the
device.
NOTE: You can configure the device security settings using Designer or ION Setup. See
Configuring Security module for more information.
3. Click Match Password and type the password in the Password field then re-type it in the
Confirm Password field.
4. Select the check box if you want to allow the software to send secure time synchronization
signals to the device. Clear the check box if you do not want to send secure time
synchronization signals to the device.
5. Click OK.
The following sections describe the available tabs and how to configure them.
Sites tab
• Set your Site Connection Settings. To enter the minimum and maximum time to stay
connected, type the time in the fields or use the arrows to change the time.
• Set the Connection Priority. The higher the number, the greater the priority given to that
schedule if there are concurrent connection requests.
Schedule tab
Weekly: Occurs on the selected day at the specified frequency (in number of weeks) and
stays active for the specified duration. For example, if you set Frequency to 2, Day of
week to Sunday and Active Duration to 2, the connection occurs every second Sunday
and stays active for two days.
Monthly - Day of Week: Occurs at the specified frequency (in months), in the week and
on the day specified and for the specified duration. For example, if you set Frequency to
3, Day of Month to 2nd and Sunday, and Duration to 1, the connection occurs every third
month on the second Sunday and stays active for 1 day.
Monthly - Day of Month: Occurs at the specified frequency (in months), on the specified
date of the month, and for the duration specified. For example, if you set Frequency to 2,
Day of Month to 15th and Duration to 2, the connection occurs on the fifteenth day of
every second month and stays active for 2 days.
• Set up the time period for the connection to occur by setting a start and an end time. In the
Start Time and End Time fields, type the time or use the arrows to change the time.
If you configure a full-day (i.e., 24-hour) daily schedule, you need to allow enough time between
the end time and the start of the next connection to avoid connection problems. For example, to
add a 2-minute gap to a 24-hour schedule, set the Start Time to 0:00:00 and the EndTime to
23:58:00.
TIP: For instructions on filtering and sorting columns and customizing the display, see
Customizing and navigating interface displays.
2. In the Show area select the checkboxes for the system components for which you want to
view events (i.e., servers, sites, devices).
If there are no events for a particular system component, that check box is unavailable.
3. Select the minimum priority level of events to be displayed from the Minimum Priority
Level dropdown list (see below for more information on priority levels).
4. Click Modify to change the date/time filter applied to the System Events Log display. See
System Log filter setup.
Priority
Priority classifies what type of event has occurred. The value corresponds to the severity of the
event: the higher the number, the more severe the event.
The priority is contained in the ION_SystemLog database as a number. In the System Events Log
display, the priority levels are displayed as text strings. The priority numbers are mapped to the
text strings as follows:
Diagnostic 0-5
Information 6 - 20
Warning 21 - 63
Error 64 - 191
Critical 192 - 255
By default, the Cutoff setup register of Log Inserter’s System Log Controller module is set to 192.
This means that system events with a priority less than 192 are not transferred to the ION_Data
database and therefore cannot be viewed in Alarms. If you want to view lower priority events in
Alarms, use the above priority mapping as a guide to set the Cutoff setup register to a lower value
(using Designer).
2. Select the time range by which you want to filter from the dropdown list. To set up a custom
filter, select Custom Date Range then use the dropdown lists and arrows in the Select a
Date Range dialog to specify the start and end of the range.
3. Click OK.
NOTE: The Duplicate and Configure function always operates on all devices visible in the table.
When table rows are filtered in the Duplicate and Configure tool, changes done using the
configuration editors on the top pane of the window affect only the devices that are visible in the
Table Editing area. If you want to apply the changes to all devices, clear the filter first before
making the changes.
NOTE: The Duplicate and Configure function cannot be used with logical devices. See Creating
multiple logical devices for information about creating more than one logical device.
• Configure Unit IDs: Use this section to create a sequence of unit IDs to assign to the
duplicates after they have been created.
• Configure Serial Sites: The serial site used in the original device is automatically assigned
to all the duplicates. If required, use this section to select a different serial site for all the
displayed devices in the Table Editing area (changes made in this area are applied to all
devices, including the original).
• Configure OPC Address: Use this section to create a sequence of addresses to assign to
the duplicates after they have been created.
• Configure OPC Sites: The OPC site used in the original device is automatically assigned to
all the duplicates. If required, use this section to select a different OPC site for all the
displayed devices in the Table Editing area (changes made in this area are applied to all
devices, including the original).
See Customizing and navigating interface displays for instructions on filtering and sorting data in
the table.
NOTE: To discard your changes since the last saved state, click Revert. You can also press
CTRL+Z to undo the last action. To redo the last action, press SHIFT+CTRL+Z. You can only
undo your last action (one undo).
For example, you can use a scheme like “FL1_PNL1A.CCT01” to name a device that is
installed on the “1st Floor” of the building, “electrical panel 1A”, and “Circuit breaker #1”.
Type “FL1_PNL1A” as the group name and “CCT01” as the device name when you
configure the first device.
2. Right-click the device you want to duplicate and select Duplicate and Configure. The
Duplicate and Configure interface appears.
1. Select a letter or number in the device name. The Start box displays the selected
number/letter, which is the start value. Use the up or down arrow in the spin box to change
the start value, or simply type it in the box.
2. Click the up or down arrow on the End box edit the range, or type the end value in the box.
To clear the range and start over, click Remove Parameters.
3. For letters, select Upper Case or Lower Case, depending on whether you require upper
case or lower case letters.
4. Set exceptions for individual values or a range of values, if required. Exceptions reduce the
number of names created (i.e., total generated names minus the exceptions). See Setting
exceptions to generated sequences.
Once you have finished configuring names, you can duplicate the device. See Step 3: Duplicating
the device, below, for more information.
Example
For example, if you select the first “1” from the example naming scheme and set the End spin box
to “2”, two names are generated (the original, plus one duplicate). If you select a letter and set its
Start value to “A” and the End value to “C”, three names are generated (the original, plus two
duplicates).
The total number of generated names is the product of the first range multiplied by the next, and
so on until the last range, as indicated in the following graphic.
The Exceptions option applies to the Configure Names and Configure TCP/IP Addresses
sections only.
1. To set exceptions to the range of generated values, click Edit (this button is unavailable until
you change the name or IP value).
2. Use the Add number or Add character (as applicable) spin box to set a value to exclude
from the range you have specified, then click Add. Repeat to set additional values to
exclude. To set a range of values to exclude, select Add number range or Add character
range, then use the Start and End spin boxes to set the range to exclude.
NOTE: You cannot add the same number or letter to the list of exceptions more than once.
If the Add button is disabled, check that the numbers or letters are not already included in
the exceptions list near the top of the window.
3. Use the Remove number or Remove character spin box to remove the exception that was
set for a given value (i.e., put it back in as an acceptable value). Use the Remove number
range or Remove character range spin boxes to remove the exception that was set for a
range of values. Click Remove.
The first device in the list is the original device. The remaining devices are the duplicates.
Asterisks next to the device names indicate pending changes that have not yet been saved.
Click Apply to save your changes and continue editing devices, click OK to save your changes
and return to Management Console, or click Revert to undo unsaved changes.
In Management Console, duplicated devices are always disabled when they are added.
1. If you have closed the Duplicate and Configure interface, select the devices you want to
configure from the Devices display window in Management Console. Right-click and select
Configure Selected Devices (this option is only available if multiple devices are selected).
The Configure Selected Devices interface appears. This interface has the same layout and
controls as the Duplicate and Configure interface; see The Duplicate and Configure
interface for information.
NOTE: Devices affected by a configuration change (that has not been saved) are identified
by an asterisk in the first column of the Table Editing area.
2. Scroll to the right in the Duplicate and Configure area to view the Configure TCP/IP
Addresses, Unit IDs, Ports and Sites sections of the interface (depending on the type of
device being configured). If the number of items in this area does not match the number of
items in the |Table Editing area, a message in red text appears in the area. If the numbers
match, the message text is black. Configure these parameters as described in Configuring
addresses, ports, unit IDs and sites then click Configure at the bottom of the applicable
interface section.
NOTE: Configuration changes only affect the devices that are currently displayed in the
Table Editing area. Use the column sorting and filtering features, described in Customizing
and navigating interface displays, to control which devices are displayed in the table. If you
want to apply the changes to all devices, clear any filtering before making the changes.
3. Click Apply to save your changes and continue working or click OK to save your changes
and return to Management Console.
NOTE: If you changed the name of one or more devices, a message displays with a list of
devices that will be renamed. If data for those devices already exist in the ION_Data
database and you still proceed with the renaming, then the existing data associated with
the old device name is lost (“orphaned”).
Click Continue to proceed or Cancel to go back and edit the device configuration.
4. When you have finished, click OK to save your changes and return to Management Console
or click Cancel to discard your changes.
If you click Cancel, a message prompts you if there are pending (unsaved) changes when
you click Cancel. Click Yes to discard the changes and return to Management Console, or
No to return to the configuration window and continue editing.
If inappropriate values (such as a device that is renamed with the same name as another
existing device) are encountered, a message displays with error details. You cannot save
the configuration changes until you have corrected the errors.
1. Select the section of the IP address that you want to configure. The Start box displays the
selected number/letter, which is the start value. Use the up or down arrow in the spin box to
change the start value, or simply type it in the box.
2. Click the up or down arrow on the End box edit the range, or type the end value in the box.
To clear the range and start over, click Remove Parameters.
3. Set exceptions for individual values or a range of values, if required. Exceptions reduce the
number of addresses created (i.e., total generated addresses minus the exceptions). See
Setting exceptions to generated sequences.
The following instructions apply to serial devices (and Ethernet devices that require a unit ID).
1. Use the up or down arrow in the Start spin box to change the start value, or simply type it in
the box.
2. Click the up or down arrow on the End box edit the range, or type the end value in the box.
NOTE: To edit the unit ID of an Ethernet device, you must first add the Unit ID column to
the table in the Table Editing area.
Configuring sites
1. From the dropdown list, select the site you want to use for the selected serial or OPC
devices.
Configuring ports
1. From the dropdown list, select the port you want to use for the selected Ethernet devices.
First, you need to add a new device in Management Console, then create as many duplicates of
the device as the quantity of items you are pasting.
If you have a Microsoft Excel spreadsheet that contains a list of these devices to add to
Management Console, you can use the Configure Names area to create duplicates of that device
type, then use the Table Editing area to copy and paste the device properties from the Excel
spreadsheet.
1. Confirm that the names in the Excel spreadsheet conform to the naming convention
“[Group].[DeviceName]”.
2. Add the first device and set up its properties in Management Console. You can assign it a
simple device name such as “A.B1” since it will be overwritten when the values are copied
and pasted from Excel. Set the Enabled property to No so that Management Console does
not attempt to connect to the device.
5. Select the “1” in the Configure Names box, then use the End spin box to set the value to 20.
6. In the Hide/Show Columns area, clear the check box of all non-editable columns to hide
those that contain grayed out values. Also hide the columns you do not want to paste over or
those that are not included in the Excel spreadsheet.
7. On the Excel spreadsheet, arrange the columns so they match the order of the columns on
the Table Editing area. Hide all columns on the Excel spreadsheet except those
corresponding to columns on the Table Editing area.
9. On the Table Editing area, click on the first cell under the Name column to select it, then
paste the contents of the clipboard (CTRL+V).
10. Click Apply to save your changes or click OK save your changes and return to Management
Console.
1. Right-click the device table and select Find and Replace (or press CTRL+H).
2. Type the characters you want to search for in the Find box. Do not use wildcard characters
(“*”). Note that the search is case-sensitive.
3. Find in column lists all available columns. Select the column you want to search in.
4. In the Replace box, type the characters you want to use to replace the characters in the
Find box. If you want to delete characters from a column value, leave the Replace box
blank.
5. Click Preview to list the search results in the table. The Replace with column displays the
new name or value resulting from the Find and Replace operation.
6. Use the check box in the Select column to select the rows for which you want to change
values. Click Select All to select all the items or Clear Selected to clear all.
Use Manual Data Editor to edit logged measurement data or to manually enter measurement data
into the PME database. With this tool, you can adjust incorrect data, outliers, roll overs, jitter, and
other unexpected or unwanted data records. You can fill data gaps or enter manually collected
data, such as clipboard readings from mechanical meters. The Manual Data Editor also has the
ability to create new, custom measurements in PME.
NOTE: Manual Data Editor can only be used to edit trend data logs. It cannot be used to edit
waveform logs or event logs.
NOTICE
LOSS OF DATA
Back up the database before making manual database edits.
1. In Manual Data Editor, click Load New Data to open the Load Data dialog box.
NOTE: Load Data opens automatically when you start Manual Data Editor.
2. In Load Data:
Select the Source for which you want to edit the logged data.
Select the Measurement for which you want to edit the logged data.
Click Add Data to Selection to add the source/measurement to the list of items to be
opened in the data editor.
3. (Optional) Repeat step 2 to add additional sources and measurements to the selection list.
4. In Load Data, select the Time Range for the logged data you want to open in the data editor.
Timestamp Format - Set the format for the timestamp display in the data editor.
Number Format - Set the number of decimals that are displayed for the logged data in
the data editor.
Is Interval Data - Select the check box to enable this property. Set the expected logging
interval for the data.
This setting ensures that there is a data row in the editor for every expected log entry. If
there is no data record for an expected entry in the database, then the Manual Data
Editor inserts a timestamped row with a <no data> data values in the editor. This makes
it easier to identify missing records and correct them.
NOTE: The data editor shows all logged records in the selected time range, regardless
of the Interval Data settings. No records are hidden or filtered out.
6. Click Load Data to open the source/measurement data in the data editor.
7. (Optional) In the data editor, click Load New Data to change which data is loaded, the time
range, or the editor options.
8. (Optional) In the data editor, click View Issue Report to see which data issues were
identified with the loaded data by Manual Data Editor.
9. (Optional) In the data editor, use Locate Issues to find and step through the data issues
identified by Manual Data Editor. The data editor uses different color highlights to mark data
issues.
10. Locate data records that you want to edit and use any of the following tools or methods to
edit the data:
Click a data record and edit the data value.
Insert Timestamp - Insert a new data record with a timestamp that you specify. The
timestamp must be in the time range of the data that is loaded into the editor. The new
record has <no data> data values.
NOTE: A historical data log timestamp marks the end of the logging interval. For
example, a data log with a 15 minute logging interval and timestamp of 17:00
represents data for the time interval of 16:45 - 17:00.
Smart Gap Fill - Automatically fill missing data values in a selected time range, or the
entire time range of the loaded data set. You can choose between different interpolation
algorithms to fill the missing data. See Smart Gap Fill UI for more details.
Delete a data record or data value. These options are available in the right-click context
menu.
Set a data value to <null>. This option is available in the right-click context menu.
Copy one or more data values and paste them into an external editor, such as Microsoft
Excel, for bulk editing. Paste the modified data values back into Manual Data Editor. The
copy and paste options are available in the right-click context menu.
NOTE: Only select the data values for copy/paste, not the timestamps.
TIP: Modified data values are shown in bold font in the Manual Data Editor.
11. (Optional) In the data editor, use Locate Changes to find and step through the edited data
records.
12. (Optional) Revert edited data values back to their original value. This option is available in
the right-click context menu. Use Undo all Changes to revert all edits in the loaded data
set.
13. Click Apply Changes to write the data log changes to the database.
NOTE: The Apply Changes command permanently writes the data log changes to the
database. There is no undo option for this command. See Reverting previous data edits for
more information.
14. (Optional) Click View Log to see a historical audit log of all the data log changes.
1. In Manual Data Editor, click Load New Data to open the Load Data dialog box.
NOTE: Load Data opens automatically when you start Manual Data Editor.
2. In Load Data:
Select the Source for which you want to add data.
Select the Measurement for which you want to add data. If the measurement does not
exist, click Create new Measurement to create a new measurement.
NOTE: Check the list of available measurements to see if one exists for your
application before creating a new measurement.
Click Add Data to Selection to add the source/measurement to the list of items to be
opened in the editor.
3. (Optional) Repeat step 2 to add additional sources and measurements to the selection list.
4. In Load Data, select the Time Range for the data you want to add in the data editor.
Timestamp Format - Set the format for the timestamp display in the data editor.
Number Format - Set the number of decimals that are displayed for the logged data in
the data editor.
Is Interval Data - Select the check box to enable this property. Set the expected logging
interval for the data. This setting ensures that there is a data row in the editor for every
expected log entry.
6. Click Load Data to open the source/measurement data entry fields in the data editor.
7. (Optional) In the data editor, click Load New Data to change which data is loaded, the time
range, or the editor options.
8. In the data editor enter the measurement data using any of the following tools or methods:
Click a data record and edit the data value.
Insert Timestamp - Insert a new data record with a timestamp that you specify. The
timestamp must be in the time range of the data that is loaded into the editor. The new
record has <no data> data values.
NOTE: A historical data log timestamp marks the end of the logging interval. For
example, a data log with a 15 minute logging interval and timestamp of 17:00
represents data for the time interval of 16:45 - 17:00. That means that the last data log
for a day has a timestamp of midnight (or 12 AM) of the following day. For example, the
last data log timestamp for January 31 has a timestamp of February 1, 00:00 hrs (or 12
AM).
Smart Gap Fill - Automatically fill missing data values in a selected time range, or the
entire time range of the loaded data set. You can choose between different interpolation
algorithms to fill the missing data. See Smart Gap Fill UI for more details.
Delete a data record or data value. These options are available in the right-click context
menu.
Set a data value to <null>. This option is available in the right-click context menu.
Copy one or more data values and paste them into an external editor, such as Microsoft
Excel, for bulk editing. Paste the modified data values back into Manual Data Editor. The
copy and paste options are available in the right-click context menu.
NOTE: Only select the data values for copy/paste, not the timestamps.
TIP: Modified data values are shown in bold font in the Manual Data Editor.
9. Click Apply Changes to write the new data log entries to the database.
NOTE: The Apply Changes command permanently writes the data log changes to the
database. There is no undo option for this command. See Reverting previous data edits for
more information.
10. (Optional) Click View Log to see a historical audit log of all the data log changes.
1. In Manual Data Editor, click Load New Data to open the Load Data dialog box.
NOTE: Load Data opens automatically when you start Manual Data Editor.
2. In Load Data:
Select the Source for which you want to see the audit log.
Select the Measurement for which you want to see the audit log.
Click Add Data to Selection to add the source/measurement to the list of items to be
opened in the data editor.
3. (Optional) Repeat step 2 to add additional sources and measurements to the selection list.
4. Click Load Data to open the source/measurement data entry fields in the data editor.
NOTE: Ignore the settings for Time Range and Options, they have no influence on the
display of the audit log.
5. (Optional) In the data editor, click Load New Data to change which data is loaded, the time
range, or the editor options.
6. Click View Log to open the audit log for these sources/measurements.
1. In Manual Data Editor, click Load New Data to open the Load Data dialog box.
NOTE: Load Data opens automatically when you start Manual Data Editor.
2. In Load Data:
Select the Source for which you want to revert previous edits.
Select the Measurement for which you want to revert previous edits.
Click Add Data to Selection to add the source/measurement to the list of items to be
opened in the data editor.
3. (Optional) Repeat step 2 to add additional sources and measurements to the selection list.
4. In Load Data, select the Time Range for the logged data you want to open in the data editor.
Timestamp Format - Set the format for the timestamp display in the data editor.
Number Format - Set the number of decimals that are displayed for the logged data in
the data editor.
Is Interval Data - Select the check box to enable this property. Set the expected logging
interval for the data.
This setting ensures that there is a data row in the editor for every expected log entry. If
there is no data record for an expected entry in the database, then the Manual Data
Editor inserts a timestamped row with a null value in the editor. This makes it easier to
identify missing records and correct them.
NOTE: The data editor shows all logged records in the selected time range, regardless
of the Interval Data settings. No records are hidden or filtered out.
6. Click Load Data to open the source/measurement data in the data editor.
7. (Optional) Click Load New Data to change which data is loaded, the time range, or the
editor options.
8. Click View Log to open the audit log for these sources/measurements.
9. Find the log entries that you want to revert. Using the information provided in the Original
Value and New Value columns, identify the values you want the logs to be reset to.
TIP: You can copy the values from the audit log and paste them into the data editor or an
external editor such as Microsoft Excel.
11. In the data editor, locate data records that you want to edit and use any of the following tools
or methods to reset the data:
Click a data record and edit the data value.
Insert Timestamp - Insert a new data record with a timestamp that you specify. The
timestamp must be in the time range of the data that is loaded into the editor. The new
record has <no data> data values.
NOTE: A historical data log timestamp marks the end of the logging interval. For
example, a data log with a 15 minute logging interval and timestamp of 17:00
represents data for the time interval of 16:45 - 17:00.
Delete a data record or data value. These options are available in the right-click context
menu.
Set a data value to <null>. This option is available in the right-click context menu.
Paste the data values from the audit log into the data records. The copy and paste
options are available in the right-click context menu.
NOTE: Only select the data values for copy/paste, not the timestamps.
TIP: Modified data values are shown in bold font in the Manual Data Editor.
12. (Optional) In the data editor, use Locate Changes to find and step through the edited data
records.
13. (Optional) Revert edited data values back to their original value. This option is available in
the right-click context menu. Use Undo all Changes to revert all edits in the loaded data
set.
14. Click Apply Changes to write the data log changes to the database.
1. In Manual Data Editor, click Load New Data to open the Load Data dialog box.
NOTE: Load Data opens automatically when you start Manual Data Editor.
2. In Load Data, click Create new Measurement to open the Create new Measurement dialog
box.
NOTE: Check the list of available measurements to see if one exists for your application
before creating a new measurement.
3. In Create new Measurement, enter the relevant information for the new measurement.
RECOMMENDATION: Use an OPC tunneling application for OPC DA data exchange over a
network
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the OPC Server.
• 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.
OPC DA is supported through the implementation of IONReal Time Data Service, a .NET-based
system that takes the traditional “register handle-based” ION data and transforms it into
structured “measurement-based” data that complies with open standards such as OPC DA. ION
Real Time Data Service facilitates the translation and organization of data in this new
measurement classification system.
Power Monitoring Expert supports OPC DA server and OPC DA client functionality. The OPC DA
server translates ION data into OPC DA data, for exporting and viewing in other third-party OPC
DA client systems. The OPC DA client, on the other hand, takes OPC standardized
measurements from third-party systems and translates them into a data format that Power
Monitoring Expert can use.
This appendix provides basic configuration and operation instructions for the OPC DA server
component of Power Monitoring Expert.
NOTE: The OPC DA client is available in all Power Monitoring Expert installations. However,
due to the number of different third-party OPC DA - compliant servers in the industry, as well as
different methods and syntax for connecting to these servers and accessing their data, it is
highly recommended that you contact Technical Support for assistance in configuring the OPC
DA client.
Management Console has a command that lets you export default measurements from
compatible devices to the OPC DA server. In addition, Designer and Device Type Editor user
interfaces let you view and select which OPC DA measurement data you want the OPC DA server
to expose to OPC DA clients.
4. Click OK.
NOTE: If you add a new device to the ION_Network database at a later date, you must repeat
the above procedure in order to map the new source device’s data to the OPC DA server.
2. Navigate to the ION module that contains the register that you want to expose to OPC DA
server. Right-click to display the module setup dialog.
4. Select (check) the box beside each item you want to expose to the OPC DA server. Clear
(uncheck) the box beside each item you do not want to expose to the OPC DA server.
NOTE: Grayed-out items (such as “PF sign a” in the Power Meter module) cannot be
selected or changed. Those registers cannot be removed using OPC Server Assistant.
Description of commands
This section describes the commands available in the OPC DA Server Assistant.
Command Result
Saves your configuration changes. Items that are selected
File > Export (checked) in the OPC DA Server Assistant are exposed to the
OPC DA server, while cleared (unchecked) items are not.
File > Exit Closes the OPC DA Server Assistant.
Discards your changes and reverts to the last saved configuration
Edit > Reset values
(for the items that are exported to the OPC DA server).
Command Result
Edit > Select All Selects (checks) all registers.
Edit > Clear All Clears (unchecks) all registers that are not grayed out.
Displays the setup registers, in addition to the output registers, for
View > Setup Registers
the module.
Displays a column containing the measurement names associated
View > Measurements
with the registers.
opcda://WORKSTATION3/ION.OpcDaServer
NOTE: Syntax use varies across different OPC DA clients. Refer to your OPC DA client
documentation for details.
OPC UA provides a single, secure, and reliable cross-platform framework for accessing a variety
of data. It is moving away from COM / DCOM to purely binary TCP / IP or alternatively SOAP.
Power Monitoring Expert supports OPC UA server and OPC UA client functionality. The OPC UA
server translates ION data into OPC UA data, for exporting and viewing in other third-party OPC
UA client systems. The OPC UA client, on the other hand, takes OPC standardized
measurements from third-party systems and translates them into a data format that Power
Monitoring Expert can use.
PME exposes the device data from both standard and custom drivers over OPC UA to other
systems.
You can create a custom VIP in PME and expose the values in the VIP over OPC UA to other
systems.
• Alarm Properties, historical data, methods, write Tags are not exposed.
• Extended quality modes Control Inhibit and Tag Override are not available.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the OPC Server.
• 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: OPC UA server should be included and hosted on the PME Server.
Prerequisite
To start the OPC UA server services:
4. Select Start.
This starts the services for OPC UA server for the client.
Management Console has a command that allows you to export default measurements from
compatible devices to the OPC UA server. In addition, Designer and Device Type Editor user
interfaces allows you to view and select which OPC UA measurement data you want the OPC UA
server to expose to OPC UA clients.
4. Select OK.
NOTE: If you add a new device to the ION_Network database at a later date, you must repeat
the above procedure to map the new source device’s data to the OPC UA server.
This section includes an example how to configure the PME OPC UA server through a third-party
test client application. The third-party client shown here is the Unified Automation UaExpert
Client.
3. Under Discovery tab, enter your administrator Username and Password under
Authentication Settings.
5. Go to Advanced tab.
If you want to change the default settings by in the PME configuration file, contact the
System Administrator.
8. Select Sign & Encrypt from the drop-down for Message Security Mode.
9. Select OK.
5. Select Continue.
NOTE: The client should support the OPC UA protocol to support OPC UA communication.
3. Select Tools > System > Update OPC Server in management console.
NOTE: PME's communication with OPC clients is interrupted when the ION OPC Data Access
Server service is stopped, and is automatically restored when the ION OPC UA Server service is
started.
PME as an Open Platform Communications United Architecture (OPC UA) Client serves as a
software application or component that initiates communication with OPC UA servers to read data
and access information.
PME reads the real-time data from OPC UA server and perform PC-based logging to monitor the
data in real-time, setup software-based alarms, and run dashboards and reports on historical
data.
Power Monitoring Expert supports OPC UA server and OPC UA client functionality. The OPC UA
server translates ION data into OPC UA data, for exporting and viewing in other third-party OPC
UA client systems. The OPC UA client, on the other hand, takes OPC standardized
measurements from third-party systems and translates them into a data format that Power
Monitoring Expert can use.
NOTE: The OPC UA client is available in all Power Monitoring Expert installations. However,
due to the number of different third-party OPC UA - compliant servers in the industry, as well as
different methods and syntax for connecting to these servers and accessing their data, it is
highly recommended that you contact Technical Support for assistance in configuring the OPC
DA client.
You can create / update OPC device type in PME Management Console.
• PME does not support variables of enumeration, OptionSet or structure data type.
• Extended quality modes Control Inhibit, and Tag Override are not available.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the OPC Server.
• 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: The server should support the OPC UA protocol to support OPC UA communication.
2. Update the Name, Address, Username, Password, Security Policy and Message
Security Mode for OPC UA site configuration.
3. Replace the existing OPC DA device type tags to OPC UA tags in Device Type Editor.
NOTE: When entering a tag, only specify the tag name, with a leading period (.), do not
include the OPC server or device name.
5. Select Tools > System > Update OPC Server in management console.
5. Select the correct Nodes, Managers, Modules, Output Registers and then select OK.
You can see the real time data through on the PME OPC UA server through PME OPC UA
client.
Use the Power Losses Configuration Tool to configure the Capacity Management Module. With
this tool you define Transformers and UPS Modules for the Power Losses Report.
Prerequisites
• The monitoring devices that are recording the transformer and UPS data must be configured
in the PME Management Console and must be communicating before you can configure the
components and properties in the configuration tool.
User Interface
Control Description
Help Opens the help for the utility.
New Creates a new entry in the grid.
Delete Deletes the selected entry from the grid.
OK Saves all changes and exits the utility.
Cancel Exits the utility without saving changes.
Apply Saves all changes and leaves the utility open.
• Transformers
Zero, one, or more low voltage transformers may be present in the power losses system.
Zero, one, or more medium voltage transformers may be present in the power losses
system.
• UPS Modules
Zero, one, or more UPS modules may be present in the power losses system.
b. Description: (Optional) Enter a description for the transformer. For example: make,
model.
c. Input Side Meter Source: Select a source name from the drop-down list. The source
represents the Power Monitoring Expert device that records the electrical data from the
input side of the transformer.
d. Output Side Meter Source: Select a source name from the dropdown list. The source
represents the Power Monitoring Expert device that records the electrical data from the
output side of the transformer.
e. Low Voltage/Medium Voltage: Select Low Voltage or Medium Voltage from the drop-
down list to indicate the transformer voltage rating type.
b. Description: (Optional) Enter a description for the UPS module. For example: make,
model.
c. Input Side Meter Source: Select a source name from the drop-down list. The source
represents the Power Monitoring Expert device that records the electrical data from the
input side of the UPS module.
d. Output Side Meter Source: Select a source name from the drop-down list. The source
represents the Power Monitoring Expert device that records the electrical data from the
output side of the UPS module.
PQDIF Exporter
PQDIF (Power Quality Data Interchange Format) is a non-proprietary means of exchanging
power quality data between different metering devices and software.
Developed under the guidelines of IEEE P1159.3, PQDIF provides a common ground where
different vendors can export to or import from, using a data format consistent with the defined
PQDIF standard.
Power Monitoring Expert supports PQDIF through the “PQDIF Exporter” add-on. PQDIF Exporter
takes data from the Power Monitoring Expert SQL Server database, converts it to PQDIF, and
stores this formatted file for viewing with any of the various programs that can display PQDIF
data. The PQDIF Exporter allows you to set regularly scheduled exports of ION data to PQDIF, as
well as perform these exports manually.
This guide provides basic configuration and operation instructions for the PQDIF Exporter. It is
assumed that the user already has knowledge of PQDIF. For details on viewing the PQDIF data,
refer to the documentation that came with your PQDIF viewer. For detailed information on the
PQDIF specification, visit the IEEE website.
When you run PQDIF Exporter for the first time, the PQDIF Exporter Configuration dialog opens
with the options to perform the initial configuration steps. To edit these settings at any time, select
Options > Configure PQDIF Exporter. You can also edit the PT/CT Scaling used for the
sources by the PQDIF Exporter; select Options > PT/CT Scaling.
Database options
The Database Options dialog allows you to make changes to the database connection settings
(SQL Server Instance, User Name, and Password). Type your changes in the appropriate fields.
NOTE: Under most conditions, you do not need to change the factory settings.
Click Test These Settings to test your database connection. A prompt displays to indicate
whether or not connection to the database was successful.
Output folder
Click Output Folder to change the folder where PQDIF Exporter stores its output files. Type the
folder path or click Browse to navigate and select the folder (or to create a new folder).
Location
To change the folder location for the log file, type the folder path in the Location field or click
Browse to navigate and select the folder.
Logging Level
Logging Level lists the different options for logging depth. Select the level you want from the
dropdown list:
• Disabled: No messages are stored in the log file.
• Normal: Warning and error messages are stored in the log file.
• Detailed: Warnings, errors, and information are stored in the log file.
• Diagnostic: Warnings, errors, information, and diagnostic messages are stored in the log file.
NOTE: The “Diagnostic” log file option uses a huge amount of system resources. Select this
option only if absolutely necessary.
• Normal: Warning and error messages are stored in the system log.
Email options
Click E-mail Options to set up email notification from PQDIF Exporter.
Type the name of the SMTP server PQDIF Exporter uses to send the email.
Type the address you want to appear in the “From” field in the email message.
E-mail Recipients
Click Add to enter email address recipients for the PQDIF Exporter messages. To delete an email
address from the list, select it then click Remove.
Logging Level
The Logging Level box lists the different options for the amount of information sent in the email
message. If you change this setting, it affects the setting for all email recipients.
• Disabled: No email sent.
When you have finished setting up the email options, click Test These Settings to test the email
connection.
If email settings are configured properly, a test message is sent to your inbox.
Use the up and down arrows and dropdown list to set the frequency.
NOTE: Setting the Exporter Service Frequency Settings to seconds uses a huge amount of
system resources. Select this option only if absolutely necessary.
PT/CT scaling
For a network where the PT/CT ratios on the meters are not set to the actual ratio values (for
example, if the ratios are set to 1:1 for revenue metering purposes), the PQDIF Exporter service
can scale the values to the correct primary measurements when it exports data.
To set the PT/CT scaling for the PQDIF Exporter:
1. Click Options > PT/CT Scaling to open the PT/CT Scaling dialog displaying the current
PT/CT scaling for the sources in your network.
2. Select a source(s) and click Edit PT/CT Scaling for Selected Sources to open the Edit
PT/CT Ratios dialog.
3. Enter the multiplier required to convert secondary values to primary values (for example,
enter 1000 for a 5000:5 CT). Click OK.
From Management Console, click Tools > System > PQDIF Exporter.
Menu items
All the PQDIF Exporter commands are available from the main menu. Some of these commands
are also available when you right-click on the interface background or on a job.
• Sag/Swell: Sag/swell disturbance data for the voltage inputs, including minimum, maximum
and average values.
• Sag/Swell Waveforms: Waveform data for voltage sag/swell.
NOTE: For the Steady-state Waveforms template, you must program the meter to use a
Periodic Timer module to perform periodic waveform recording of the voltage and current
channel inputs. The time interval you specify must be a multiple of 15 minutes.
In addition to the default templates, custom templates can be also be developed — contact
Technical Support if you require customized data templates for your application.
1. Click Jobs > New Job > Scheduled Export to open the Scheduled Export dialog.
2. Type a short but descriptive name in the Job Name field. Use the Job Description field to
give more details about the job.
3. Select the sources for your scheduled data export. Click the box beside each source to
select or deselect it.
Click All Sources to select all available devices that log the type of data specified by the
data templates. When this logged data is detected for a new device, that device is
automatically added to all scheduled PQDIF Exporter jobs that have All Sources selected.
4. Select the Data Templates you want to use when the PQDIF Exporter runs. Click the box
beside each template to select or deselect it.
Click All Templates to select all available data templates for the selected devices. When a
new data template is added, that template is automatically added to all scheduled PQDIF
Exporter jobs that have All Templates selected.
5. Use the Export Time section to specify how frequently the PQDIF Exporter should run, as
well as its start/cut-off time. When a scheduled PQDIF Exporter job runs for the first time (at
the specified start time), it collects historical data to create PQDIF files so that the time
period for that export is consistent (“caught up”) with the time periods of all subsequent
scheduled PQDIF exports.
Example 1: If you saved the scheduled job (1) at 4:25 PM, with the Exporter scheduled
to run daily at midnight, the first PQDIF file is generated at midnight (2) the same day,
and includes data spanning from the previous midnight. PQDIF Exporter runs again next
midnight (3), and includes data spanning the first scheduled export (2).
Example 2: If you set a scheduled job to run PQDIF Exporter every 8 hours, starting at
3:00 AM, then the first PQDIF file is generated at 3:00 AM, and will include data
spanning 8 hours previous to that time (that is, 7:00 PM). The next export starts 8 hours
later, at 11:00 AM, then at 7:00 PM, then at 3:00 AM and so on.
Example 3: To run PQDIF Exporter once a week at 6:00 AM, change Export Time to
“Export every 7 Day(s) at 6:00 AM”. In this example, the PQDIF file contains a full
week’s worth of PQDIF data
NOTE: Exporter Service must be started in order to run scheduled PQDIF Exporter jobs. See
PQDIF Exporter main window.
1. Click Jobs > New Job > Manual Export to open the Manual Data Export dialog.
2. Type a short but descriptive name in the Job Name field. Use the Job Description field to
give more details about the job.
3. Select the sources for your data export. Click the box beside each source to select or
deselect it.
To select all available devices, select the All Sources box.
4. Select the Data Templates you want to use. Click the box beside each template to select or
deselect it.
To select all available templates, select the All Templates box.
5. Use the Export Range From and To boxes to specify the date range of historical data that
the PQDIF Exporter will use. The default time format is local time. If you want to use
Coordinated Universal Time format, select UTC.
6. Use the File Splitting options to specify how PQDIF Exporter exports the data. The default
method is to export the data to a single PQDIF file. You can change this so the data is split
into different PQDIF files — for example, if you want to split the data so each PQDIF file
contains 12 hours worth of data, set the File Splitting to “Export into separate files for each
12 Hour(s) of data”.
7. Click Export Now to run and save this manual PQDIF Exporter job, or click Add Job to
save without running it.
After you enter the manual PQDIF Exporter jobs, you can select and run them:
1. On the PQDIF Exporter interface, select the manual job(s) you want to run.
2. Right-click and select Export Selected Manual Job(s). A command window displays to
indicate the progress of the export. Press the RETURN (ENTER) key when prompted to
return to the PQDIF Exporter interface.
NOTE: To run all manual jobs, click Jobs > Export All Manual Jobs.
1. To edit a job, open the Export Configuration dialog in one of the following ways:
Double-click the job.
Select the job, then click Jobs > Edit Selected Job, or
1. Select the job(s) you want to duplicate, then click Jobs > Duplicate Selected Jobs (or
right-click the job and select Duplicate Selected Jobs).
2. Double-click the copy of the job you want to edit, make your changes, then click Save.
2. To enable the jobs, click Jobs > Enable Selected Jobs. To disable them, click Jobs >
Disable Selected Jobs. You can also right-click the jobs and select Enable Selected Jobs
or Disable Selected Jobs to enable or disable the jobs.
NOTE: You can also disable a job instead of deleting it (that is, Enable = “No”). This way, the job
can be enabled at a later date if required.
If the Exporter Service is stopped when you try to exit, PQDIF Exporter prompts you to start the
service in order to process scheduled jobs. Click Yes to start the Exporter Service.
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).
Remote Modem Setup provides access to a database that contains configuration data for a
variety of modems you can pick from. Remote Modem Setup also provides direct access to your
modem so you can customize settings and troubleshoot its operation.
Preliminary Setup
Follow the instructions in your modem’s documentation to set up and connect the modem to one
of your computer’s serial ports. Select a port that the Power Monitoring Expert Communications
Server is not using.
2. Click Tools > System > Remote Modem Setup to open the Remote Modem Setup
dialog.
3. Set the Port to the serial communications port that the computer uses to communicate with
(and set up) the modem. Set the Baud Rate to match the modem’s baud rate.
NOTE: To reduce possible communication issues, set the computer, modems and meters
to the same baud rate.
To set the modem to answer after a specified number of rings, select Auto Answer,
then type the appropriate number in the Number of Rings box.
To save the modem configuration data in the modem’s onboard memory, select Store
Profile. This feature allows the modem to revert to the saved settings after a power
outage. Clear Store Profile to disable this feature.
To turn on the modem’s internal speaker, select Speaker On, then select a setting from
the Volume list. Clear Speaker On to disable this feature.
If there are DIP switch settings required for the modem that is being configured, a message
displays with instructions on which switches to turn on or off. Set the DIP switches on the
modem as instructed.
The modem is now ready to be used at the remote power monitoring site.
Software Logging
Use Software Logging to add or edit software-based data logging for Modbus device types. This is
intended for device types that do not have onboard data logging capabilities. You can also add
software logging to a device type with onboard data logging to log additional measurements that
are not logged by the device.
RECOMMENDATION: Use onboard data logging when possible. The data log timestamps for
onboard data logs are more accurate than the timestamps for software data logging. Onboard
data logging is also more reliable than software data logging since it does not depend on a
network connection to the device.
The Software Logging link in Management Console opens the same Configure Logging and
Calculation dialog that is available through the Device Type Editor. For more information on
adding software logging see Adding Software Logging to a Modbus Device Type.
Use a system use notification to inform persons accessing the system of authorization
requirements, to get user acceptance of terms and conditions before logging in, or to display any
other information that you want to make your users aware of.
To enable a system use notification:
2. Remove the .sample extension from the filenames. The filenames should now be
PreLoginDialog.html and PreAuthDialog.html respectively. This enables the
system use notification.
NOTE: You can enable the notification for Web Application clients only, or for Engineering
applications only, or for both.
3. Open the system use notification files in a text editor, such as Notepad. Edit the default
messages to meet your needs. You can use inline HTML styles to customize the
appearance of the notifications.
Done
To disable the system use notification:
2. Add .sample to the end of the filenames. The filenames should now be
PreLoginDialog.html.sample and PreAuthDialog.html.sample respectively. This
disables the system use notification.
NOTE: You can disable the notification for Web Application clients only, or for Engineering
applications only, or for both.
Done
Default system use notification message:
NOTE: The default notice is meant as an example and placeholder for your own notice. It has
not been reviewed for completeness or legal accuracy.
A typical TOU has On Peak, Off Peak and Shoulder periods. Since rate schedules vary not only
by day and week, but also by season, the TOU schedules can be set up to match your precise
needs.
Use the navigation pane on the left to navigate through the schedules. Right-click a schedule or
sub-schedule to access menu items. Select an item to display associated tabs in the tab display
pane on the right.
2. Add a sub-schedule, if you need more than one sub-schedule. See Adding or editing a sub-
schedule.
3. Add a season, if you need more than one. See Configuring seasons.
4. Configure special days (such as holidays) to include in your TOU schedule. See Adding
special days.
5. Add day groups, if you need groups other than the default day groups. See Configuring Day
groups.
6. Add TOU names, if you need names other than the default names. See Defining TOU
names.
To view a sample schedule, right-click the navigation pane and select Import Schedule. Select
SampleSchedule.tou from the ...\Power Monitoring Expert\system\etc folder and click Open.
2. Type a name and description for the schedule. Click the arrow beside the effective date to
bring up a calendar where you can select the effective date of the schedule.
3. Click OK. That schedule name appears in the list in the navigation pane.
2. Select Save as New Schedule to open the Save as New Schedule dialog.
4. Click OK. The new schedule appears in the navigation pane with the attributes of the copied
schedule.
Importing a schedule
1. Place the schedule that you want to import into a folder that can be accessed from the
computer.
2. In the navigation pane, right-click an empty area of the navigation pane then select Import
Schedule to open the Open dialog.
3. Navigate to the folder where you placed the schedule. Select the schedule and click Open.
The schedule is imported with the extension “_imported”. For example, a schedule named
“ScheduleA” becomes “ScheduleA_imported”.
Exporting a schedule
To export a schedule to use in another TOU installation:
1. Right-click the schedule you want to export in the navigation pane. Click Export to open the
Save As dialog.
4. Click Save.
The schedule is saved with the extension “.tou”. For example, “ScheduleB” becomes
“ScheduleB.tou”.
1. From the navigation pane, right-click a schedule name then click Edit Schedule to open the
Edit a Schedule dialog.
To change the effective date, you must make the change to the sub-schedule(s). See
Editing a sub-schedule effective date.
3. Click OK.
Deleting a schedule
To delete a schedule, right-click the schedule name in the navigation pane then select Delete
Schedule. This deletes the entire schedule, including any sub-schedules.
Expand a schedule to display its sub-schedule(s). Sub-schedules are listed in order of their
effective dates.
TIP: If you want to have more than one sub-schedule with the same seasons, day groups, TOU
periods, etc., configure the first sub-schedule then right-click it and select Save as New
SubSchedule.
2. Click the arrow beside the effective date to open a calendar where you can choose an
effective date for the new sub-schedule.
3. Click OK.
The sub-schedule displays in the navigation pane. Continue configuring the sub-schedule
by adding seasons and day groups.
To add a new sub-schedule that has the same settings as an existing sub-schedule, see Copying
an existing sub-schedule, below.
2. Click the arrow beside the effective date to open a calendar where you can choose an
effective date for the new sub-schedule.
3. Click OK. The new sub-schedule displays in the navigation pane with the same attributes
(other than effective date) of the sub-schedule you copied.
2. Click the arrow beside the effective date to open a calendar where you can choose an
effective date for the new sub-schedule.
3. Click OK.
Deleting a sub-schedule
To delete a sub-schedule, right-click the sub-schedule name in the navigation pane and select
Delete. This also deletes all seasons in that sub-schedule (and any day groups, special days,
etc., that they contain).
Configuring seasons
Use seasons to create timeframes for presenting data in reports. A newly created schedule has a
single season, called All Year. Expand a sub-schedule to view its seasons.
If you only need one season (All Year), you can skip the steps below and go to configuring special
days.
Configuring seasons
Use the Define a Season tab to set up or edit the time spans for each season.
NOTE: A date can only belong to one season; you cannot overlap dates in one season with
dates in another.
1. From the navigation pane, select the sub-schedule to which the season belongs.
After you add a sub-schedule, the tab displays only one season (All Year) that covers the
entire year. The season is listed at the top of the tab, and the calendar that shows the days
and months that belong to that season is full. To make room to add other seasons, you must
edit the All Year season.
3. Select All Year from the Define a Season tab and click Edit to open the Edit a Season
dialog.
4. In the Season Name field, type the name of one of the seasons you want to define (for
example, Summer).
5. Set the Start Date and End Date for the season. You can specify fixed start and end dates
(For example, 12/31) or relative start and end dates (for example, the last Saturday of
October).
Fixed Date: Click on the month or day portion of the date then either type the new date or
use the up and down arrows beside the date to edit it.
Relative Date: Select the day and month from the dropdown lists.
For the end date, select the Time of Day the season ends (Start of Day or End of Day). If you
select Start of Day, the season ends at 12:00:00 AM on the selected day; if you select End of
Day, the season ends at 12:00:00 AM on the next day so there are no gaps in the schedule.
NOTE: If you use relative dates, you can configure a schedule that may become invalid in
future years. Be careful when you configure the schedule that there will be no missing or
overlapping days in the schedule in future years. For example, rather than scheduling one
season to end on the 1st Sunday in June and the next to start on the 1st Monday in June, it
is better to schedule the first season to end at Start of Day on the 1st Sunday in June and
the next season to start on the 1st Sunday in June.
6. If this is a split season (where there is a gap between two parts of the season), select the
Split Season check box and add a second sets of dates. For example, winter is typically a
split season because it occurs in the first and last months of the year.
7. Click OK.
The calendar on the Define a Season tab now shows one season with the rest of the year
unassigned.
8. Click Add to create additional seasons. Repeat steps 4 to 6 to name the season and define
the start and end dates.
NOTE: Do not leave any dates unassigned: unassigned dates are not calculated in the reports.
Editing a season
1. On the Define a Season tab, select the season you want to edit then click Edit to open the
Edit a Season dialog.
Deleting a season
To delete a season, select the season in the Define a Season tab then click Delete. This also
deletes the day groups and TOU periods configured for that season.
1. In the navigation pane, select the sub-schedule for which you want to define special days.
2. In the tab display pane, select the Define Special Days tab.
Repeat yearly: Enter the date; for example, a holiday that occurs on the same date
every year.
Repeat on: Complete the fields in the Repeat On section to define how the day repeats
and in which months it occurs. Select whether it occurs on a particular date of the
selected month(s) (Day) or a relative day (i.e., Last Saturday) in the selected month(s).
7. Click OK to save your changes and return to the Define Special Days tab.
See Configuring Day groups for instructions on how to apply special days to a sub-schedule.
• special days, such as holidays or other specially designated days (such as inventory days)
Default settings are weekdays (Monday to Friday) and weekends (Saturday and Sunday) but you
can add additional groups. There can be a maximum of 47 day groups in any season.
Make sure that all days have been accounted for since unaccounted time is not included in any
reports.
1. In the navigation pane, select the season for which you want to define day groups. The
Define DayGroups tab appears in the tab display pane.
If the Add button is unavailable, there are no free days to add to a day group. A day can only
belong to one day group. To add another day group, you must first remove days from an
existing day group.
Special Day(s) Only: Select the special day in the Include Special Days list then click to
select or clear the day. Days with a check mark beside them are included in the day
group. You can only include a special day in one day group.
NOTE: You need to define TOU names and periods for each schedule that you create. Be sure
to apply a TOU name to every square on the calendar. Unaccounted time causes your reports to
display inaccurate information.
1. In the navigation pane, select the day group for which you want to define TOU names then
select the Define TOU Names tab.
3. Type the TOU name you want to add then click OK. The TOU name is added to the list of
TOU names.
3. Click OK.
NOTE: If you delete a TOU name, the TOU periods assigned to the name are replaced with
“Unaccounted”. Deleting a TOU name in a particular schedule affects all sub-schedules in that
schedule.
Two TOU names are already defined: On Peak and Off Peak. You can edit or delete these
names, or add new names.
1. In the navigation pane, select the day group for which you want to define a TOU period then
select the Define TOU Periods tab.
3. In the Start Time field, type the time that the period begins, or select the hours and minutes
and use the up and down arrows to set the start time.
4. In the Stop Time field, type the time that the period begins, or select the hours and minutes
and use the up and down arrows to set the stop time.
5. From the Time of Use Name dropdown list, select the TOU name to associate with the time
period.
6. Click OK.
To add a split time period (i.e., a time period that spans from 19:00 to 6:00), you must add two
separate time periods and associate them with the same time of use name.
If you want to expand a time period into time that already belongs to another period, you must first
edit the other time period to clear the time.
Continue adding time periods until the 24 hour period is filled. Unaccounted time blocks cause
your reports to display inaccurate information.
NOTE: You must have supervisor-level access to use Upload Report Template tool.
Use Upload Report Template to upload reports that are not available by default in the software.
You can upload single report template or multiple report templates. The multiple report templates
together are called as Report Pack.
NOTE: Information on how to create custom Report Templates is not provided in this document.
Contact your local Schneider Electric representative for information on custom Report
Templates.
Related topics:
Reports:
• Setting Reports prerequisites
• Copying a report
• Editing a report
• Moving a report
• Deleting a report
• Sharing a report
Subscriptions:
• Subscribing to a report
Other
• Changing the Reports theme
• Reports UI
4. Click Upload.
NOTE: After you uploaded the Report Template, you can access it, together with the default
templates, in the Report Library.
NOTE: Make sure that multiple report templates are zipped as a single .zip file.
4. Click Upload.
NOTE: After you uploaded the Report Template, you can access it, together with the default
templates, in the Report Library.
Use the UPS Configuration Tool to configure the Backup Power Module. With this tool you create
UPS Devices and Groups for the UPS Auto Test Report, and you generate UPS Auto Test Vista
diagrams.
Prerequisites
• The UPS devices must be configured in the PME Management Console and must be
communicating before you can configure the components and properties in the configuration
tool.
2. In the UPS Configuration Tool, click New and add each new UPS that you added in the
Management Console.
3. (Optional) Change the value for the Display Name that appears in the Vista diagram if you
want.
NOTE: This Display Name appears only in the Vista diagram and does not impact the
name that you use in the Management Console.
4. After adding all new UPS devices, click the Groups tab.
6. After you finish adding all UPS device and associated groups, click Apply.
NOTE: The Output Path shows where the Vista diagram DGM file is saved after clicking
Generate Vista Diagrams. The file name or location can be modified from the default
value if desired.
2. Click Include Custom Logo and then navigate to and select the file to include a custom
logo in your diagrams. Otherwise, a Schneider Electric logo appears.
3. Under Options, drag the indicator to define the width and dimensions of Vista diagrams you
generate.
4. Click Generate Vista Diagrams to generate the DGM files, then click Close.
Use the UPS Power Configuration Utility to configure the Capacity Management Module. With this
tool you define UPS Systems for the UPS Power Report.
Prerequisites
• The monitoring devices that are recording the UPS data must be configured in the PME
Management Console and must be communicating before you can configure the components
and properties in the configuration tool.
User Interface
Control Description
Help Opens the help for the utility.
New Creates a new entry in the grid.
Delete Deletes the selected entry from the grid.
OK Saves all changes and exits the utility.
Cancel Exits the utility without saving changes.
Apply Saves all changes and leaves the utility open.
TIP: The tool indicates if there configuration errors. Point at the red exclamation icon to see
configuration error details.
• UPS Groups
Name must be unique.
Each UPS module in the group must have the same nameplate rating (kVA) value.
Each UPS module in the group must have the same derated nameplate rating (kW)
value
Each group is connected to one load only. No other group can be connected to the
same load.
All UPS modules in the groups must have the same nameplate rating (kVA) value.
All UPS modules in the groups must have the same derated nameplate rating (kW)
value.
Depending on the number of groups present in the system, a load may be shared by
two groups.
For information on UPS redundancy types, see UPS system redundancy types.
1. Click New. The Edit System: New System area appears below the grid.
b. Description: Enter a description for the UPS system. This field is optional.
c. Redundancy Type: Select the redundancy type for the UPS system. The different
redundancy types are explained in UPS system redundancy types.
d. Groups: Shows the number of UPS groups contained in the UPS system. Click Add to
add groups to the UPS system. Click Remove to delete groups.
e. Modules Per Group: Shows the number of UPS modules in each group in the system.
Click Add to add UPS modules to the group. Click Remove to delete modules.
This property is only available when the system redundancy type is 2N, 2(N+1) or 2
(N+2). To define the number of modules for a system with redundancy type N, N+1 or
N+2, use the UPS group properties. See Defining UPS loads for more information.
Related Topics:
• Defining UPS groups
c. Modules Per Group: Click Add to increase the number of UPS modules in the group.
Click Remove to decrease the number. This property is available only for system
redundancy types N, N+1 or N+2.
Related Topics:
• Defining UPS systems
1. Click on the module object border. The selected module will be highlighted in blue and the
Properties screen appears.
c. Data Source: Select the meter source in Power Monitoring Expert where load data is
logged for the UPS module. The source must be unique for each UPS module.
d. Nameplate Rating (kVA): Enter the maximum output power (kVA) of the UPS module.
This value must be greater than zero.
e. Derated Nameplate Rating (kW): Enter the maximum power capacity (kW) that the
UPS module is expected to support. This value must be equal or less than the
nameplate rating value, and greater than zero.
Related Topics:
• Defining UPS systems
1. Click the UPS load element in the system diagram. The Properties screen appears.
Related Topics:
• Defining UPS systems
• N+1 Type
• N+2 Type
• 2N Type
• 2(N+1) Type
• 2(N+2) Type
N Type
The N system configuration is for one or more UPS modules which work together to supply power
to the IT load. There is no redundancy, except optionally to the second power supply of each
piece of equipment.
Each UPS system with an N configuration can have multiple UPS groups, where each group is
connected to a different load. The number of modules within each UPS group can be different.
Within each group, all UPS modules must have the same derated nameplate rating value (kW).
N+1 Type
The N+1 system configuration is for one or more UPS modules that work together to supply power
to the IT load. There is simple module redundancy in that one of the modules can be rendered
inoperative or be taken off-line. The load is spread among all remaining UPS modules, but the
peak load is such that if one module stops working, the others will be able to assume its load.
Another way to look at it is, N UPS modules will be able to support the peak IT load. If the peak IT
load is more than N can support, then system design redundancy will be lost.
There is the option to connect the system of modules to the second power supply of each piece of
equipment, but both power supplies are connected to the group of UPS modules.
Each UPS system with an N+1 configuration can have multiple UPS groups, where each group is
connected to a different load. The number of modules within each UPS group can be different.
The modules within a UPS group must have the same derated nameplate rating value (kW).
N+2 Type
The N+2 system configuration is for a group of UPS modules that work together to supply power
to the IT load. There is simple module redundancy in that any two of the modules can be rendered
inoperative or be taken off-line. The load is spread among all remaining UPS modules, but the
peak load is such that if two modules stop working, the others will be able to assume their load.
Another way to look at it is, N UPS modules will be able to support the peak IT load. If the peak IT
load is more than N can support, then system design redundancy will be lost. An example of an
N+2 system is five UPS modules connected to the IT load, but the peak IT load never exceeds the
capacity of three of the UPS modules.
There is the option to connect the system of modules to the second power supply of each piece of
equipment, but both power supplies are connected to the group of UPS modules.
Each UPS system with an N+2 configuration can have multiple UPS groups, where each group is
connected to a different load. The number of modules within each UPS group can be different.
The modules within a UPS group must have the same derated nameplate rating value (kW).
2N Type
The 2N system configuration is for two or three groups of UPS modules that supply power to two
different power supplies in each IT load. For redundancy, an entire UPS group can stop working
or be taken off-line, and the IT equipment will still be supplied with power. It also means that either
one of the two power supplies in an IT load can be rendered inoperative. The load is spread
among all UPS modules, but the peak load is such that if an entire group’s worth of modules is not
working, the remaining modules will be able to assume their load. Another way to look at it is, N
UPS modules will be able to support the peak IT load. If the peak IT load is more than N can
support, then system design redundancy will be lost.
Each UPS system with a 2N configuration can have two or three UPS groups. If there are two
groups, both must be connected to the same load. If there are three groups, then there are three
separate loads and each group is connected to two of the loads. The number of modules within
each UPS group in a UPS system must be the same in a 2N configuration. Additionally, all UPS
modules within a UPS group must have the same derated nameplate rating value (kW).
In the first example, there are two groups with four UPS modules each. In a 2N configuration, one
group can stop working and the system will still have the designed redundancy. Therefore, the
value for N is four. So, the total IT load cannot exceed the derated nameplate rating of four of the
UPS modules.
In the second example, there are three groups with four UPS modules each. In a 2N
configuration, one group’s worth of UPS modules can be rendered inoperative and the system will
still have the designed redundancy. Therefore, the value for N is eight. So, the total IT load (for all
three IT load groups shown below) cannot exceed the derated nameplate rating of eight of the
UPS modules.
2(N+1) Type
The 2(N+1) system configuration is for two or three groups of UPS modules that supply power to
two different power supplies in each IT load. The redundancy provided means that an entire group
of UPS modules, plus one more module from the remaining groups, can stop working or be taken
off-line, and the IT equipment will still be supplied with power. It also means that either one of the
two power supplies in an IT load can be rendered inoperative. The load is spread among all UPS
modules, but the peak load is such that if an entire group’s worth of modules be rendered
inoperative, plus one more from each other group, the remaining modules will be able to assume
their load. Another way to look at it is, N UPS modules will be able to support the peak IT load. If
the peak IT load is more than N can support, then system design redundancy will be lost.
Each UPS system with a 2(N+1) configuration can have two or three UPS groups. If there are two
groups, both must be connected to the same load. If there are three groups, then there are three
separate loads and each group is connected to two of the loads. The number of modules within
each UPS group in a UPS system must be the same in a 2(N+1) configuration. Additionally, all
UPS modules within a UPS group must have the same derated nameplate rating value (kW).
In the first example, there are two groups with four UPS modules in each group. One group plus
one UPS module from the other group can be rendered inoperative, and the system will still have
the designed redundancy. Therefore, the value for N is three. So, the total IT load cannot exceed
the derated nameplate rating of three of the UPS modules.
In the second example, there are three groups with four UPS modules in each group. One group
plus one module from each of the other two groups can stop working and the system will still have
the designed redundancy. Therefore, the value for N is six. So, the total IT load (for all three IT
load groups shown below) cannot exceed the derated nameplate rating of six of the UPS
modules.
2(N+2) Type
The 2(N+2) system configuration is for two or three groups of UPS modules that supply power to
two different power supplies in each IT load. The redundancy provided means that an entire group
of UPS modules, plus two more modules from the remaining groups, can stop working or be taken
off-line and the IT equipment will still be supplied with power. It also means that either one of the
two power supplies in an IT load can stop working. The load is spread among all UPS modules,
but the peak load is such that, if an entire group stops working, plus two more from the other
group, the remaining modules will be able to assume their load. Another way to look at it is, N UPS
modules will be able to support the peak IT load. If the peak IT load is more than N can support,
then system design redundancy will be lost.
Each UPS system with a 2(N+2) configuration can have two or three UPS groups. If there are two
groups, both must be connected to the same IT load. If there are three groups, then there are
three separate loads and each group is connected to two of the loads. The number of modules
within each UPS group must be the same. All UPS modules within a group must have the same
derated nameplate rating value (kW).
In the first example, there are two groups with four UPS modules each. One group can be
rendered inoperative, plus two more UPS modules from the other group and the system will still
have the designed redundancy. Therefore, the value for N is two. The total IT load cannot exceed
the derated nameplate rating of two of the UPS modules.
In the second example, there are three groups with four UPS modules each. One group plus two
modules from each of the other two groups can stop working, and the system will still have the
designed redundancy. Therefore, the value for N is four. So, the total IT load cannot exceed the
derated nameplate rating of four of the UPS modules.
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 the advanced user management function of limiting the
number of invalid login attempts. This function is 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. See Login Options for more information.
• 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 user, Windows user, and Windows group.
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 must be unique in PME.
• Usernames cannot contain any of the following characters: whitespace character, < > : " / \ | ?
*,;@#%'^&()!=+-~.$
• Usernames and passwords must be between 1-50 characters long.
• Email addresses are not checked for the correct format. Any leading or trailing whitespace
characters are removed.
• Multiple email addresses must be separated by a ; (semicolon).
• 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
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 the advanced user management function of limiting the
number of invalid login attempts. This function is 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.
Strong password criteria: A password must have at least 8 characters and contain at least
one character from each of the following:
uppercase letters
lowercase letters
numbers
special characters.
4. Click Add.
Related topics:
Users
• Users
• Changing a username
• Deleting a user
User groups
• User Groups
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
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
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
NOTE: You can only change the password for a standard user in User Manager. You cannot
change the password for a Windows user.
Strong password criteria: A password must have at least 8 characters and contain at least one
character from each of the following:
• uppercase letters
• lowercase letters
• numbers
• special characters.
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
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
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
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 Groups
User groups determine which sources and applications users can access in (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:
• A user is a member of at least one group.
• 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.
• A supervisor-level user can only be a member of the Global 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 Global and Unassigned user groups cannot be renamed or deleted.
• 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
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
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
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
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
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
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
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
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
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
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
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
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 control objects for time-critical functions because delays can occur between the
time a control action is initiated and when that action is applied.
• Do not create a custom control object in Virtual Processor for remote equipment operation
without configuring it with the appropriate access level, and without configuring a status
object to indicate the status of the control operation.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
The Virtual Processor lets you gather the information available from your network of power
monitoring devices, and enables you to categorize, manipulate, and/or customize the data before
distributing the information to the different departments in your company. You could think of the
Virtual Processor as a virtual device, capable of collecting and processing data from several
power monitoring devices, analyzing the information and performing control functions as required.
The Virtual Processor's name implies its characteristics:
• Virtual - The Virtual Processor runs in the memory of your PC, not as a remote device.
• Processor - The Virtual Processor contains a wide selection of ION modules, which it uses to
process information.
2. Register the Virtual Processor as a service from the ...\Power Monitoring Expert\system\bin
folder by typing: vip.exe -Service -N<custom Virtual Processor name>
3. Open Control Panel > Administrative Tools > Services and start the new registered
Virtual Processor.
4. Select the “Allow service to interact with desktop” check box and click OK.
Distributed control
Virtual Processor Distributed Control modules are a means of transferring information between
the different devices in your network. These modules can be used to build frameworks for control
processes such as alarm annunciation, plant-wide demand control, power factor control, load
shedding, paging, and generator switching.
Before you decide to use a Virtual Processor to implement a control system, it is important to
understand the various factors that influence the speed with which the Virtual Processor is able to
generate a control action. Some of these factors include network traffic, the number of polled
devices in your network, the reliability of your communications network, and the Virtual Processor
workstation's CPU usage.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use control objects for time-critical functions because delays can occur between the
time a control action is initiated and when that action is applied.
• Do not create a custom control object in Virtual Processor for remote equipment operation
without configuring it with the appropriate access level, and without configuring a status
object to indicate the status of the control operation.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
The information presented in this section assumes that you are familiar with the various ION
modules and their functions. Refer to the ION Reference for details on Distributed Control and
other modules.
NOTE: ION meters with Advanced Security enabled do not accept control operations from the
Virtual Processor. In order to enable these control operations, you need to provide a device
password in Management Console for these applications to use. See Accessing meters with
security for information on configuring Advanced Security.
The following sections provide some guidelines for improving a distributed control network's
performance.
System configuration
• Minimize the number of devices per site for sites including devices used for distributed
control.
• Minimize the number of applications (such as Vista diagrams) that are requesting data from
the control site.
• Decrease the Virtual Processor's Client Polling Period.
CPU performance
• Dedicate a single Virtual Processor for control purposes; an additional Virtual Processor can
be run for less critical functions.
• Do not run CPU intensive functions on the same workstation as your distributed control Virtual
Processor.
Note that the Distributed Numeric module is disabled if the Data Monitor module detects a
communication problem between the meter “A” and the Virtual Processor (for example, timeouts
or slow network connections). As a result, control actions are only performed based on up-to-date
data.
Note that the Virtual Processor holds only 100 records at a time, that is, it holds about one day of
15 minute data. If the Virtual Processor stops operating, data logging also stops.
The global parameters do not need to be changed for normal operation. The Virtual Processor
operates properly in most applications with the default settings. See Modifying the Global
Parameters for details.
To set up the Virtual Processor’s Modbus network, see Virtual Processor setup.
NOTE: The ION Virtual Processor Service must be restarted for any changes to take effect, as
the Virtual Processor only reads the vipsys.dat file once on startup. The ION Virtual Processor
Service can be restarted, like any other service, using the Services window found via the Control
Panel service applet.
The Virtual Processor (VIP) is the Power Monitoring Expert service (ION Virtual Processor
Service) that provides coordinated data collection and aggregation, control, and mathematical
analysis of power monitoring system data from groups of metering or similar intelligent devices.
Use Virtual Processor Setup to configure a Modbus Slave port when using the VIP as a Modbus
Slave device for exporting data to an external, 3rd-party Modbus Master. . Virtual Processor
Setup can also be used to improve the performance of the ION Virtual Processor Service by
modifying its global operating parameters.
See Virtual Processor service (VIP) for application examples using the Virtual Processor.
You can configure the VIP to act as a Modbus Slave device to an external Modbus Master. The
Modbus Master can read data from the VIP through the VIP Modbus Slave modules. See the ION
Reference for information on how to configure Modbus Slave modules.
For the Modbus Master to be able to access the VIP, you need to configure a Modbus Slave Port.
A Modbus Slave Port can be a serial port, for example COM1, COM2, and so on, or a Modbus
TCP port.
1. Open Management Console and log on with a supervisor level user account.
2. Select Tools > System > ION Virtual Processor Setup. This opens the ION Virtual
Processor Setup dialog box.
3. In ION Virtual Processor Setup, find the VIP for which you want to add a slave port. Double-
click Modbus Network for this VIP. This opens the Network view.
4. Double-click Slave Ports. This shows any configured slave ports for this VIP. If no slave
ports are configured, the list will be empty.
5. Click Add Port. This opens the VIP Setup Modbus Port/Site dialog box.
6. In VIP Setup Modbus Port/Site, select the Port you want to use. Click OK.
7. Double-click the newly added slave port and then double-click Settings. This opens the port
settings.
8. Edit the port settings if required. For more information on port settings, see VIP Modbus
Slave port settings
NOTE: You must restart the VIP for the changes to take effect.
Done
Global
Value Range Description Notes
Parameter
Frequent module updates
contribute to the workstation's
The interval at which
processor load. By increasing
Module Update ION modules inside
50 to 1000 ms the Module Update Period, you
Period the Virtual Processor
reduce the number of times a
are updated.
module executes in a given time
period.
The interval at which
Increasing the Configuration
the Virtual Processor
Saver Period significantly
Configuration 10 to 600 writes its configuration
reduces the processor load if
Saver Period seconds data to the
you have a large Virtual
workstation's hard
Processor configuration file.
disk.
The interval at which
the Virtual Processor
You can increase the period for
gets information from
less time sensitive Virtual
Client Polling 500 to 300000 other nodes in the
Processor applications and
Period ms network (for example,
reduce the period for more time
another Virtual
sensitive applications.
Processor or a
device).
The interval at which
the Virtual Processor Reducing this value increases
responds to requests the rate at which these
Server Polling 200 to 1440000
for information from responses are sent; however,
Period ms
client nodes such as this can also increase network
Vista or the Log traffic.
Inserter.
The ASCO Automatic Transfer Switch Configuration Tool is used to configure the communication
details for devices within ASCO Automatic Transfer Switches (ATSs).
An ATS can contain several communicating components such as a transfer switch controller, a
power meter, and an I/O module. Using this tool, the communication details of each ATS
component can be defined.
When the configuration for an ATS is applied and saved, and a service restart is completed, the
ASCO Gateway Service aggregates the individual device data, allowing the ATS to be
represented as a single logical device in PME.
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.
NOTE: A Windows Administrator account is required to open the configuration tool for the first
time. Make sure to run the tool as an Administrator, so the tool will set the ASCO Gateway
Service to start automatically.
Add a Device
Edit
Delete
Select to save the ATS configuration and apply changes to the database.
Cancel
Service Restart
Select to initiate a restart of the ASCO Gateway Service with the newly applied configuration.
Advanced Settings
Filtering
Select the filter icon next to each column title to filter items displayed in the table below.
Prerequisites
• The communication details (Protocol, IP Address, Port Number, Unit ID) of the ASCO ATS
communication components must be known.
• A Windows Administrator account is required to open the configuration tool for the first time.
• Each ASCO ATS needs its own high-end device license in PME.
• If an ASCO ATS contains a power meter that has its own PME device type (e.g., PowerLogic
PM8000, PowerLogic ION9000), the power meter must have its own high-end device license
in PME.
• A site entry will automatically be created in PME Management Console for the ASCO
Gateway Service. Remove any site entries previously created in PME Management Console
to avoid duplication before you apply and save changes in this tool.
• A device entry will automatically be created in PME Management Console for the ASCO ATS
and any associated power meter that has its own PME device type. Remove any ATS and / or
power meter device entries previously created in PME Management Console to avoid
duplication before you apply and save changes in this tool.
NOTE: Some fields are automatically populated with the values. Confirm that default
values are correct for each field.
Field Description
Define a Device Group or select from existing Device Groups
Group previously defined in this tool or in the PME Management
Console.
Device
Enter a unique name to identify the ATS.
Name
Device
Select the PME device driver associated with the ASCO ATS.
Type
A unique unit ID is automatically assigned to the ATS for use
by the ASCO Gateway Service.
ATS Unit
ID NOTE: This field is for reference only and cannot be
modified.
Port Number - Enter the port number for the ASCO ATS
controller.
Field Description
Power Select the toggle switch to enable this configuration if a Power
Meter Meter is present on the ASCO ATS.
Device Type - Select the type of power meter installed on the
ASCO ATS.
Port Number - Enter the port number for the power meter.
An entry appears in the overview table with the configured ATS’s details.
After you apply and save change to an ATS configuration, two entry types are automatically
created in PME Management Console.
A site entry in PME Management Console for the ASCO Gateway Service.
A device entry will automatically be created in PME Management Console for the ASCO
ATS and any associated power meter that has its own PME device type.
NOTE: If a site entry was previously created for the ASCO Gateway Service or if a device
entry was previously created for an ATS or an associated power meter in PME
Management Console directly, remove the original entries before you apply and save the
ATS configuration.
4. (Optional) Repeat the steps 1 - 3 with additional ASCO Automatic Transfer Switches.
1. In the overview table, select the delete icon in the Actions column for the ATS to be
deleted.
2. Select Delete to permanently delete the ATS. Select Cancel to keep the ATS.
NOTE: Do not delete these devices in the PME Management Console. The recommended
method for deleting entries for ASCO ATS and their associated power meters is to do so directly
in the ASCO Automatic Transfer Switch Configuration Tool by following the steps outlined
above.
NOTE: Only certain fields can be changed after the initial creation of an ATS. If changes are
required for an non-editable field, delete the ATS and add it again with a unique name.
1. In the overview table, select the edit icon in the Actions column for the ATS to be edited.
3. Select Apply and Save Changes to save the configuration changes. The ATS entry is
updated in the overview table.
After you apply and save, the existing ATS entry and any applicable power meter entry will be
updated in PME Management Console.
When configuration changes have been made that require a service restart, a banner appears as
a reminder to restart the service. The banner disappears when a service restart is complete.
If you attempt to close the program after making configuration changes but before a service
restart, a pop-up appears indicating that a service restart is required. Select Exit to exit the
program without a service restart. Select Cancel to go back.
Advanced Settings
1. Select Generate and Save Key to generate an encryption key and save it to the database.
This overwrites any previously generated key and requires an update to the key on all
connected ASCO Quad-Ethernet modules.
The message Encryption Key Detected is displayed along with the date and timestamp
indicating when the key was saved to the database.
2. Select the Enable Encryption toggle switch to enable AES if an encryption key is detected.
4. Select Copy to copy the encryption key to the clipboard when encryption is enabled.
5. Restart the services after the changes to ASCObus II AES Encryption settings are done.
NOTE: To fully enable encryption between the PME ASCO Gateway Service and the
ASCO Quad-Ethernet Modules, the AES settings for the Quad-Ethernet Modules must be
configured.
NOTE: Communications to the ATSs may be disrupted until all updates are applied. Refer
to the installation and user manual of your ASCO Quad-Ethernet Module for further
instructions.
The ASCO Gateway Service Port is set to 502 and cannot be modified.
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 and Customizing Access Level Privileges 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
Alarm Views
Alarms Notifications
Software Alarms (tool)
Personal Preferences
Report Theme
Personalization
System Language
System Theme
Diagnostics and Usage
Registration & Analytics
Registration
Diagrams Control Options
Login Options
Security Real-Time EndPoints
Session Timeout
Authorized Hosts
Integrations (Note: This EWS Client (tool)
setting is a sub category EWS Server (Note: This setting is hidden when EWS is disabled.)
under Security.) Integration Utility
COMTRADE Import
Billing Rates (tool)
Device Manager (tool)
Device Replacement (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) Server 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
Alarm Views
Use the alarm view settings to:
• Change the number of items that are displayed in the alarms display.
• Customize the display of Load Impact events in Alarm and Incident views.
To change how many Incidents, Alarms, and Events are shown in the Alarm Viewer:
1. Under Display Settings, enter the maximum number you want to be displayed for
Incidents, Alarms, and Events in the boxes.
When the Annunciator is turned off, it is not visible in the Web Applications banner.
To change what type of state counts are shown in the Alarm Annunciator:
1. Under Annunciator, select the state type for Show counts for.
To change the Alarm priorities that are shown in the Alarm Annunciator:
1. Under Priority Classification, select or clear the Visible in Annunciator check boxes for
the Alarm priorities you want to include or exclude from the Annunciator.
1. Under Priority Classification, select or clear the Audible in Annunciator check boxes for
the Alarm priorities you want a notification sound to be played for or not.
2. In Select Audio File, select the sound you want, or if the sound is not in the Media Library,
a. Click Upload Audio File and either choose a sound file available on your system by
clicking Choose Files or drag a sound file into the application area.
To change the display color and Alarm priority ranges for the Alarm Viewer:
1. Under Priority Classification, set the Color and Start values for the different alarm
priorities. The End values are adjusted automatically.
To change the display of Load Impact events in Alarm and Incident views:
1. Under Load Impact Display, select or clear the check boxes for the options you want or
not.
EWS Server
EcoStruxure Web Services (EWS) requires a unique set of credentials to connect to the data
exchange service.
To configure the credentials:
1. Click Change Credentials, or Set Credentials, if you are configuring this setting for the first
time, to enable the input fields.
3. Type the password for the user in the Password and Confirm Password entry fields.
Strong password criteria: A password must have at least 8 characters and contain at least
one character from each of the following:
uppercase letters
lowercase letters
numbers
special characters.
4. Click Save to apply your changes or Discard to retain the existing credentials.
NOTE: The EWS Server setting is only visible if EWS is enabled. When EWS is disabled, the
EWS Server setting is hidden.
Personal Preferences
Use the personal preferences settings to update or edit your user profile details, change your
account password, set your personal localization preferences, define a custom start of day, 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.
If the supervisor wants to change the password, the password must meet the strong
password criteria.
Strong password criteria: A password must have at least 8 characters and contain at least
one character from each of the following:
uppercase letters
lowercase letters
numbers
special characters.
By default, in Custom Day Settings, the time will be 12.00 AM. You can define any
Custom Start of Day as required.
2. Click Save to apply the changed settings.
Report Theme
Change the Report theme to customize the Reports colors and the Reports logo.
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:
• Choose the Default theme or a User Defined theme
• 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. See Resources for
link information.
• 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. See
Resources for link information.
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.
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.
COMTRADE Import
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the COMTRADE import and mapping.
• 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.
COMTRADE is an IEEE/IEC industry standard format used to store data from protection relays
and other devices to record the voltage and current formats.
COMTRADE Import allows you to import the waveforms and event data into PME from the
COMTRADE files in the PME installed folder.
NOTE: A COMTRADE device may support different communication protocols that PME does
not support. If the COMTRADE device does not communicate with PME over either ION or
Modbus protocol, it is not visible in either Vista or Event Log Viewer control.
Prerequisite:
1. Start the COMTRADE Processor services:
a. Go to Windows Search.
d. Select Start.
3. Create folder for each device for which the COMTRADE import is required.
RECOMMENDATION: The folder name should follow source naming convention. For
example, Group.Name.
4. Add the CFG and DAT files inside each device folder.
5. Install the Wavewin tool to preview the waveform before COMTRADEconfiguration. For
more details, refer to WAVEWIN Data Management and Analysis System software.
4. Select a Device from the drop-down list for a existing device or click Select to add a new
COMTRADE device.
RECOMMENDATION: The Device name should follow source naming convention. For
example, Group.Name.
5. Select Folder for the COMTRADE import from the drop-down list. Refer to FolderSelection
for folder details.
The date should be the date from when the data should be imported to PME and not from
the date the COMTRADE files are saved in the COMTRADE folder.
NOTE: Device Timezone is the time-zone when a new device is created during the
COMTRADEimport. For an existing device, the time-zone is the time for the device in
Management Console or Device Manager.
8. Select Configure.
Edit icon - To edit the folder path and Import From Date.
After selecting the configuration file, all COMTRADE Channels are listed under
COMTRADE Channel Name.
2. Select Configure icon to select a PME Channel Name to map the COMTRADE channel
with PME.
4. Repeat step 2 and 3 to map all the COMTRADE Channel Names with PME Channel
Names.
5. Select OK.
If the Nominal Voltage is incorrect, the PQ events may not be properly classified. Also, we
cannot re-import a COMTRADE file if the nominal voltage is incorrect to rectify the import
later.
9. Select Configure.
1. Select Configure icon to select a PME Channel Name to map the channel with PME.
3. Select OK.
To edit a channel mapping with new cfg file, follow the steps for Add Channel Mapping.
NOTE: If there is any change in the Device, remapping of the COMTRADE Channel names with
PME Channel Names are required.
1. In the COMTRADE Configure window, select the delete icon to delete a channel mapping.
1. In the COMTRADE Configure window, select Delete All Mappings to delete the entire PME
channel name mapping.
File Processing
File processing will happen only if the devices and channel mappings are configured correctly.
PME needs both cfg and .dat file to import the data. For a cfg file, if dat file is missing, then PMEdo
not pick the file for processing.
Then PME automatically detects new files and any non-processed files in a folder and process
them.
Latest processed file name is shown in the COMTRADE import page. You can refresh the page to
get updated with latest details.
COMTRADElog files
COMTRADE log folder is created at ....\Schneider Electric\Power Monitoring
Expert\config\COMTRADEFiles location when the data imported to PME.
Maintenance
You should delete the processed files from ....\Schneider Electric\Power Monitoring
Expert\config\COMTRADEFiles after the files are imported in PME.
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:
• Manual Login Only
Windows users can log into the system by manually entering credentials on the login page.
• One-select Login Only
Windows users can log into the system by selecting a hyperlink on the login page.
• Manual Login and One-select Login
Windows users can log into the system by manually entering credentials, or by selecting a
hyperlink on the login page.
NOTE: Standard users, if allowed to log in, always have to enter their credentials manually.
If the Login dialog appears very small or the Password entry field is not visible, use one of the
following methods to correct this:
Method 1:
2. Set the slider for Change the size of text, apps and other items to 100%.
3. Select Apply.
Method 2:
1. In Windows Explorer, navigate to the appropriate EXE files (Designer, Vista...) in the
installation directory: ..\Power Monitoring Expert\system\bin.
2. Right-select on the application EXE file (for example Designer.exe), and then select
Properties.
3. Select Compatibility.
6. After changing the properties of all application EXE files, restart the server.
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.
• The information exchanged between PME and the IdP is via SAML assertion.
• PME application should be configured in the IdP, so that IdP administrator can manage user
access to PME in the IdP. For more detail refer to Managing.
• IdP manages authentication (log in credentials) and authorization (user access levels).
• PME verifies user authentication and authorization by validating the SAML assertion.
• Upon verification, PME allows the user log in based on their access level.
Prerequisites
The following prerequisites need to be met to enable the SSO feature in PME:
• An Administrative account of an Identity Provider (IdP): You must have an
Administrative account of an IdP to add PME to the IdP, assign users to PME in the IdP and
manage the user access level to PME in the IdP.
• Session Timeout - PME is set for a definite session time-out at application level. If IdP is not
time-out, PME will still log out based on the session time-out settings for PME.
• SAML App Integration details in IdP:
General and
Advanced Values
Settings
https://XXXXXX/SystemDataService/Security/AssertionConsumerService
General and
Advanced Values
Settings
Location where the logout response will be sent.
Single
https://XXXXXX/SystemDataService/Security/SingleLogout
Logout URL
Replace XXXXXX with the PME domain.
If accessing PME from other machines using IP or using a different domain
name. Add SSO URLs using this option.
Other
Requestable For Example - If the IP (10.168.95.152) is used instead of domain name
SSO URLs used in #1, Add the below URL in Other requestable URL’s
https://10.168.95.152/SystemDataService/Security/AssertionConsumerSer
vice
RECOMMENDATION: Set the MFA Authentication as per the guidelines of the IdP
documentation.
1. Navigate to Settings > Security > Login Options page in PME web.
This enables the SSO login option both in the PME web and desktop applications.
3. Select Configure.
Follow the instructions on the IdP login screen to complete the authentication.
NOTE: You should use the credentials from the IdP configuration to log in to the IdP.
Real-Time EndPoints
Real-Time Endpoint settings to make a real-time communication more secure communication
for PME. PME should trust each endpoint for receiving or giving the data. PME needs to approve
the request coming from the host.
When another host is trying to communicate to PME real-time data services, the communication
is Rejected by default and no communication happens for this host.
The host's name is listed under Rejected state in the Real-Time configuration tab of PME web
application. The same log is generated in the system log of PME.
NOTE: (Applicable for only Trusted Hosts) Real-Time communication Module in PME
validates the host only in the beginning of a session. If a host status is changed from Trusted to
Rejected in the Real-Time endpoints configuration page, it do not rejects the host until the
current session is stopped and restarted. The client (endpoints which raises the real-time
request) should stop the session and start a new session or re-start the real-time services.
NOTE: Reset Internet Information Services (IIS) on the PME server after updating the Real-
Time Endpoint settings.
Syslog Configuration
Syslog is a standard message logging protocol which is supported in different operating systems
(OS) and application for transmitting data. By using this configuration, the message logged in
PME is sent to pre-configured Syslog server.
The message log supported are Audit, Authentication, Configuration, File Upload & file store,
Framework Security and Log On page.
• Verifies for server availability and restart the service after every 10 seconds.
NOTE: You can disable the Validate client certificate if you do not want to have secure
connection over TLS 1.3 or below. The secure connection happens over TCP. The Port
Number is different for TCP connection.
7. Select Save.
5. Select Start.
When you select Start, the service starts to send the logs to the Syslog server.
An example from Kiwi Syslog Server of Syslog Configuration for the device.
If the validation of the certificate is unsuccessful, the System Log captures the error.
For example, if the Certificate Password is incorrect, the following error appears:
If the Certificate Private Key is not known, the following error appears.
You will have to re-upload the certificate to complete the validation process.
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
Administer
This chapter provides information on tasks and tools for ongoing system maintenance in Power
Monitoring Expert (PME).
Use the links in the following table to find the content you are looking for.
Function/Tool Task
Basic administration tasks Run Updates, check database maintenance tasks.
Cybersecurity Provides recommended actions to help secure your system.
Use Configuration Manager to back up the configuration on your
Configuration Manager system. (Note: This is an add-on tool. See Resources for
information on where to get it.)
Archive and trim the ION databases, upgrade a database, create a
Database Manager
new database, or export the database registry settings.
Deactivate alarms that are incorrectly stuck in a permanently
Deactivating alarms
active state.
Diagnostics Viewer Monitor system and network performance.
Reconfigure, reset accounts, export System Key, import System
PME Installer
Key, uninstall.
Add or remove PME users. Change user access level, passwords,
User Manager and account information. Change User Group access to devices
and Web Applications.
Windows Updates Routinely apply Microsoft Windows Updates.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
In Standalone PME systems, the database maintenance tasks for backup, archive, maintenance,
and trim are pre-configured and scheduled to run automatically by default. For Distributed
Database PME systems, we recommend that these scheduled tasks are set up manually.
Check the task outputs regularly and confirm that backups are created as expected. Review and
adjust the schedules to meet your application needs, if required. See Database maintenance for
more information on the scheduled database maintenance tasks.
NOTE: You can perform additional, manual backups using standard SQL Server backup
procedures.
Monitor the database size for systems with SQL Server Express databases
NOTICE
LOSS OF DATA
• Back up or archive the database before trimming it.
• Trim the SQL Server Express database before it reaches the size limit.
Failure to follow these instructions can result in permanent loss of data.
SQL Server Express has a maximum database size limit of 10 GB. The database stops logging
data when this size limit is reached. The scheduled default database maintenance tasks include a
database size notification task. When the size threshold is reached, the task logs a system log
event message and triggers a Critical alarm in PME every time the task runs.
Check the PME system log and Alarms on a regular basis for database size notification
messages. Check the database size on a regular basis and take action before reaching the
database size limit.
Cybersecurity
This section provides information on how to help secure your system during the Administering
phase.
Apply OS updates
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Apply the latest updates and hotfixes to your Operating System and software.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Critical and routine Windows updates can be applied to the operating systems hosting the PME
server and clients without prior approval by Schneider Electric.
Consider implementing best practices, such as:
• Establish a reliable process for finding and applying the latest security updates.
• Use automated scanners for detecting missing patches, misconfigurations use of default
accounts, and so on.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the update, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the update.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Apply the latest updates and hotfixes to your SQL server and individual components shipped
with PME.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
INACCURATE DATA RESULTS
• Before installing the update, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the update.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Critical and routine SQL Server other components patch updates can be applied to the operating
systems hosting the PME server and clients without prior approval by Schneider Electric.
Consider implementing best practices, such as:
• Establish a reliable process for finding and applying the latest security updates.
• Use automated scanners for detecting missing patches, misconfigurations, use of default
accounts, and so on.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the update, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the update.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the update, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the update.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
RECOMMENDATION: Use Windows users instead of standard users in your PME system to
improve cybersecurity. Windows offers the advanced user management function of limiting the
number of invalid login attempts. This function is 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. See Login Options for more information.
NOTE: Network security equipment, such as firewalls, are complex devices and must be
maintained by trained individuals.
Database Manager
Use Database Manager to manually perform operations on the Power Monitoring Expert
databases.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
NOTE: Database Manager does not include manual database operations on the Application
Modules database (ApplicationModules). In a disaster recovery situation or when directed by
Technical Support, the Application Modules database can be restored by using the Restore
database function in the SQL Server Management Studio. See Restoring a database for further
information about this operation. ION databases can be restored using the same process.
Prerequisites
The following user prerequisites need to be met to work with Database Manager and database
functions through SQL Server Management Studio:
• For Database Manager: Since Windows authentication is used to access the SQL Server
databases, the user needs to be a member of the sysadmin SQL Server role, which is set in
SQL Server Management Studio.
• For most database functions available in SQL Server Management Studio: The user needs to
be a member of the sysadmin SQL Server role.
NOTE: If the Windows user that you used to log into the system is not a member of the sysadmin
role, and you want to run Database Manager, you can do so without logging out by completing
the following steps:
2. Locate DatabaseManager.exe.
3. Click the EXE file name to highlight it, then press Shift+Right-click to open the menu.
5. In the User name field, type a user name that has the sysadmin role, then type the
password for that user.
Expand the items in the navigation tree to display the Databases for each instance.
Note that scheduled jobs are available only in Windows Task Scheduler. For further information,
see Database maintenance.
Databases
The Databases section lets you view information about the databases or perform manual actions
on the databases.
For information on the manual actions you can perform, see Manual actions.
To view the properties of a particular database, right-click that database and select Properties.
The properties are:
• Size: The current size of the database.
• Primary File Location: The file path for the primary database (.mdf) file.
• Transaction Log Location: The file path for the transaction log (.ldf) file.
• Creation Date: The date and time when the database was created.
• Last Backup Date: The date when the last backup was performed.
• Disk Space Available: The amount of free space available on the disk where the database
resides.
• Server Version: The type and version of the SQL Server instance that is hosting the
database.
Show archives
Select this check box (lower left-hand corner) if you want the list under Databases to include all
archived databases along with the live databases. After Show Archives is selected, you can
upgrade archived databases or view the properties of the archived databases.
Clear the Show Archives check box to hide the archived databases from view. This also
prevents the database actions from being performed on database archives.
Manual actions
The following sections provide information on the manual actions that you can use to manage
your databases.
To perform an action manually, do one of the following:
• Right-click Databases and select the action from the menu, or
• Right-click the specific database and select the action you want to perform from the pop-up
menu.
When you right-click Databases and select an action, a dialog specific to that action opens. The
databases listed in the dialog are those to which the action applies.
When you right-click a specific database, only the actions that apply to that database appear in
the menu and the database is selected by default in the dialog for the action.
Archive
The Archive action creates an archive of the selected database.
Before proceeding, ensure that you have write access to the archive directory location.
1. Right-click Databases or ION_Data and select Archive to open the Database Archive
dialog. If necessary, select the database that you want to archive.
a. In Save archive to, click the browse button to select the directory where the archive
will be saved.
NOTE: You can only save an archive to a directory on the local machine, not to a
location on the network.
c. (Optional) Edit the default archive filename to follow your naming conventions.
NOTE: The database name is restricted to characters A-Z, a-z, 0-9, and _
(underscore).
NOTE: The database name is restricted to characters A-Z, a-z, 0-9, and _
(underscore).
4. Specify the date range of the data that you want to archive. For Start, select The beginning
of the database or select Date and enter a date and time. Enter a date and time for End
Date.
5. Under Trim after archive select whether or not you want to remove archived data from the
database.
You need to select The beginning of the database for the start date range for trimming the
live database, otherwise the Trim after archive option is disabled.
6. Click OK.
The Progress field displays the current progress of the archive process. If a manual archive does
not succeed, a message appears and the Database Archive dialog remains open with the OK
button grayed out — examine the Progress field to discover where the process did not succeed.
If the archive is successful, the dialog closes automatically.
1. Right-click Databases and select Export Registry Setting to open the Database Registry
Key Export dialog.
2. Type the path and filename for the file or click the browse button to specify the location
for the saved the database registry key.
The directory ...\Power Monitoring Expert\config\cfg\ is the default save location for the
exported database registry key.
3. Click OK.
1. Right-click Databases and select New ION_Data Database to open the New Historical
Database dialog.
NOTE: Do not name it “ION_Data” as this is the default name for the existing ION
database. Database names are restricted to characters A-Z, a-z, 0-9, and _ (underscore).
4. Click OK.
Trim
The Trim action removes data from a database.
NOTICE
LOSS OF DATA
• Back up the database at regular intervals.
• Back up the database before upgrading or migrating the system.
• Back up the database before trimming it.
• Back up the database before making manual database edits.
• Verify correct database behavior after making database or system changes.
Failure to follow these instructions can result in permanent loss of data.
1. Right-click Databases, ION_Data or ION_SystemLog and select Trim to open the Trim
Database dialog.
2. Select the database you want to trim from the Database to trim list.
3. Under Trim Range, specify the date range of data you want to trim (for the ION_Data
database) or set the maximum data age in days (for the ION_SystemLog database).
4. For the ION_Data database, select the data types you want to trim (Data Records,
Waveforms, Events) in the Data Types section. You can select any combination of data
types to trim.
5. Click OK. A message appears to notify you that the selected data will be removed. Click Yes
to continue or No to cancel.
Upgrade Database
The Upgrade Databases action upgrades the selected database to the latest database schema.
1. Right-click Databases and select Upgrade Databases to open the ION Database
Upgrade dialog.
The Power Monitoring Expert installer automatically upgrades your databases with the new
database schemas when you install Power Monitoring Expert on an existing server. If you
install the latest version of the product on a different server so that you can manually copy
older database files to the new computer, you can run this action on the older databases
(that is, on the ION_Data, ION_SystemLog, and ION_Network databases, and archives) to
upgrade them with the new schema.
2. Select the database in the list that you want to upgrade and click OK.
Restoring a database
You can restore a database from a backup by logging in to SQL Server Management Studio as a
user with syadmin access authority for the Restore Database function. (Database backups are
specified as a scheduled job in Windows Task Scheduler. See Database maintenance for more
information.)
2. Open SQL Server Management Studio, enter your password if required and click
Connect to access your SQL Server.
3. In the Object Explorer pane on the left, expand Databases, right-click the database you
want to restore and click Tasks > Restore > Database to open the Restore Database
dialog.
4. Under Source, select Database and click the database you want to restore in the dropdown
list if it is not already selected.
5. Under Backup sets to restore, select the checkbox in the Restore column for the
database you want to restore.
For Recovery state, select RESTORE WITH RECOVERY from the dropdown list.
A message indicates that the database has been restored successfully. If the restore
operation is not successful, the database reverts to its original state.
NOTE: After you restore the database, you need to assign its ownership to the ION user as
follows:
a. In SQL Server Management Studio, right-click the restored database and click
Properties in the menu to open the Database Properties dialog.
c. Click the button on the right of the Owner field to open the Select Database Owner
dialog.
d. Type ION in the field labeled Enter the object names to select and click Check
Names to adjust the format of your entry to [ION].
2. Under Source, select Device and click Browse to open the Select backup devices dialog.
3. Select File in Backup media type list if it is not already specified and then click Add to open
the Locate Backup File dialog.
4. Navigate to and select the backup file you want to restore and click OK.
5. Verify that the file referenced in the Specify Backup dialog is the one you selected and click
OK to return to the Restore Database dialog.
6. Under Select the backup sets to restore, select the checkbox in the Restore column for
the database you are restoring.
Under Recovery state, select RESTORE WITH RECOVERY from the dropdown list.
A message indicates that the database has been restored successfully. If the restore
operation is not successful, the database reverts to its original state.
NOTE: After you restore the database, you need to assign its ownership to the ION user as
follows:
a. In SQL Server Management Studio, right-click the restored database and click
Properties in the menu to open the Database Properties dialog.
c. Click the button on the right of the Owner field to open the Select Database Owner
dialog.
d. Type ION in the field labeled Enter the object names to select and click Check
Names.
Operate
This chapter describes the different applications for accessing power monitoring information in
Power Monitoring Expert (PME). You use these applications on a regular basis to view real-time
data, historical data, and alarm data. The chapter is organized by applications and software
modules. See Introduction to Power Monitoring Expert (PME) for a general overview.
Use the information in the following tables to find the content you are looking for.
By application or function:
Application/Function Function
Alarms View incidents, alarms, and events. Acknowledge alarms
Dashboards View high level ,historical and real-time data in gadgets.
View low level, historical and real-time data in one-line and
Diagrams
graphics diagrams.
Reports Run reports manually, or schedule automatic report generation.
System integration Use PME integrated with other EcoStruxure™ systems.
Trends View trends for real-time and historical data.
Perform control actions in your power monitoring system, for
example reset counters or activate device digital outputs. View low
Vista
level, historical and real-time data in one-line and graphics
diagrams.
Access the Dashboards, Diagrams, Trends, Alarms, and Reports
Web Applications applications. Access Settings and configurations tools. View the
alarm annunciator.
By software module:
Module Application
Backup Power Module Generator and Uninterruptible Power Supply (UPS) performance
operation monitoring and reporting, including battery health.
Breaker Performance
Circuit breaker aging and breaker settings monitoring.
Module operation
Generator and Uninterruptible Power Supply (UPS) capacity
Capacity Management
monitoring and reporting. Includes transformer and UPS loss
Module operation
monitoring.
Energy Analysis
Gadgets for identifying consumption patterns and anomalies and
Dashboard Module
for comparing different consumers over time.
operation
Energy Analysis Reports Reports for energy consumption monitoring and modeling,
Module operation including energy usage by process area or by product output.
Module Application
Energy Billing Module Energy-based billing and reporting, including consumption
operation monitoring and reporting at the branch circuit level.
Event Notification Module
Notifications of power system events via email, SMS, or SNMP.
operation
Insulation Monitoring Monitoring for isolated power systems, such as the ones found in
Module operation hospital operating rooms.
Power Quality
Analysis of power quality events and disturbances and their
Performance Module
impact on the monitored system.
operation
References:
Topic Description
Links to reference information related to the content of the
Operation references
Operating chapter.
The product supports multiple communications standards and protocols available on various
intelligent metering devices. You can also connect to existing power monitoring systems through
industry standard protocols such as Modbus and OPC.
Web Applications
Web applications are the end user facing components of the software. You use web applications
in your daily work with PME. Web Applications has 3 main parts: Apps, Settings, and
Configuration Tools.
Apps
Use Web apps to access power monitoring information. The following apps are included in the
Web Applications:
• Dashboards
• Diagrams
• Trends
• Alarms
• Reports
Settings
Use Settings to tailor the behavior and appearance of the software. The following Web Application
Settings are available:
• Alarm Views
• Authorized Hosts
• EWS Server
• Login Options
• Personal Preferences
• Registration
• Report Theme
• Security Options
• Session Timeout
• System Language
• System Theme
The Settings page also provides links to the following configuration tools:
• Device Manager
• EWS Client
• Hierarchy Manager
• Log Viewer
• Modeling Configuration
• Notifications
• Rate Editor
• Software Alarms
• User Manager
Engineering applications
Engineering applications are the backend components that are used to configure and maintain
the monitoring devices, networks, databases and other elements of the power monitoring system.
It also includes the Vista application which is used to for real-time control and to build diagrams.
The following applications are included:
Management Console
Use Management Console to add and configure network components such as servers, sites
(communication links) and devices. Management Console also provides access to the following
system and database applications, and utilities (listed in menu sequence):
Through Management Console > Tools
• Database Manager
• Reports Configuration
• Deactivating alarms
• PQDIF Exporter
Management Console provides shortcuts to Web Applications configuration tools. See Web
Applications for details.
Vista
Use Vista to reset counters and perform other control actions on monitoring devices. Vista also
displays real-time and historical information using graphical displays. You use Vista to create the
diagrams for the Diagrams Web app.
Designer
Use Designer to perform a wide range of functions, from configuring setup registers of ION
devices on your network to creating complex frameworks using a combination of ION modules
from hardware or software nodes.
The OPC Server Assistant is available during the 90-day trial period. After the trial period, you
need to purchase a Data Exchange Module license and activate it through the License
Configuration Tool to enable OPC server functionality.
Getting started
This section describes how to start, log on to, and exit most of the components of the Power
Monitoring Expert product.
At the logon prompt, type your user name and password in the appropriate box, then click OK.
Some actions are restricted to certain users or groups, depending on how their login permissions
were set up. For information on creating users and user groups, and on setting user access
levels, see the User Manager section in Web Applications Help.
NOTE: For security reasons, using View Only button to login to Vista no longer works and
displays an error message. Alternatively, it is recommended to login to Diagrams application
with Observer access level.
Ending a session
There are two ways to end a session in a component:
• Log off if you want to end the current user session but keep the program running, or
Some components offer both options; some only offer the Exit option.
Logging off
If you attempt to log off without saving your work, you are prompted to save your changes.
Click Yes to save your changes, No to discard them, or Cancel to return to the program.
Exiting
A message appears, prompting you to confirm your intention to exit the application.
If you attempt to exit without saving your work, the program prompts you to save your
changes. Click Yes to save your changes, No to discard them, or Cancel to return to the
program.
Selecting multiple items in tables, tree structures, diagrams and folder structures
To select adjacent items, select the first item, hold down the SHIFT key then click the last item.
To select non-adjacent items, hold down the CTRL key then click to select the items.
To select adjacent items in Vista or Designer diagrams, drag a selection box around the items. All
items in the box are selected.
Resizing panes
To resize panes in a window, point the mouse at the border where the two sections meet. When
the resize handle appears, drag to move the border.
To hide or dock a pane, click the Pin/Unpin button on the pane. When a pane is hidden, it is
minimized to a button at the edge of the workspace.
To temporarily show a hidden pane, hover the mouse over the button for that pane. Move the
mouse away to hide the pane again.
1. In Management Console, hover over the column selector tab on the right side of the display
window. In other interfaces, click the “Select Columns” link.
2. Select the boxes for the columns you want to include in the table. Clear the boxes for the
columns you do not want to include in the table.
Best Fit
To adjust a column width to the best fit with the least amount of white space:
• For one column, right-click a column header and select Best Fit.
• For all columns, right-click the column title area and select Best Fit (all columns).
Arrange columns
To change the order of the columns, drag a column header to the left or right of its original
position.
Group by column
To group data according to the contents of a particular column, drag the column header to the
area above it (marked “Drag a column header here to group by that column”). To expand or
collapse the groups, click the “+” or “-” button. To expand or collapse all groups, right-click the
column header in the Group By Box area and select Full Expand or Full Collapse, respectively.
You can also group by multiple columns in a specific order, with sorting and filtering applied. To do
this drag each column to the Group By Box area in the order that you want to group them.
To ungroup, drag the column header back to its original position (or right-click the column header
and select Ungroup).
To show or hide the Group By Box area, right-click the column header and select or clear Group
By Box.
When the mouse is positioned over a column header, the Filter icon appears in the top right
corner of the header. Click it to select one of the listed filter conditions and apply it to the data in
that column. Select (Custom) to apply one or two logic conditions to filter the data. To cancel
filtering and return the column to its default state, right-click the column and select Clear Filter.
Some tables have a row between the column header and the table data. This is the dynamic filter
area.
To use the dynamic filter area, start typing the entry you want to filter on in the space above the
applicable column. You can use an asterisk (*) at the beginning of the filter as a wildcard. Once
you achieve the filter results you want, you can stop typing. For example, to filter out “DST” from
“disturbance” in System Log Events, you only need to type “di”.
The Filter Builder is an advanced data filtering tool. Use it to create filters with multiple conditions
across multiple columns. To use the Filter Builder:
1. Right-click a column header and select Filter Editor to open the Filter Builder dialog.
The elements of the filter builder are: <Column Header> <Condition> <Value>
Click an element to display the options available, then select the option you want to use.
3. Select the <Column Header> and the <Condition> you want to apply. Type the <Value> to
test for.
5. Select a logic to apply to this new filter (in relationship to the current filter).
6. Repeat step 3.
In the following example, the filter finds all devices in group name containing “Mfg” and whose
types begin with “ION”.
Select the checkbox to turn the filter on; clear it to turn the filter off.
A
Click the "X" to cancel and exit the filter mode.
B Click Edit Filter to configure the filter conditions
Alarms
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.
Overview
The alarm viewer is the user interface (UI) for the Alarms application. Use the alarm viewer to see
software generated and device-based alarms in PME.
The alarm viewer UI has two main areas, the view library and the alarms display. To see alarm
information in the alarms display, you select a view in the view library. The library has predefined
system views and you can create additional custom views. For more information, see: Alarm
Viewer UI
TIP: You can open the alarm viewer from the ALARMS link in the Web Applications banner.
View types
There are two types of views, status views and history views.
Status views
Use status views to see existing alarm definitions in the system, their present state, how often
they occurred, their priority, and other relevant information. The following predefined status views
are available in PME:
History views
Use history views to see a record of Incidents, alarm instances, and events that happened in the
past. The following predefined history views are available in PME:
• Viewing incidents
• Incident history UI
Alarms
Alarms provide information on the state and history of alarm conditions that are defined for
specific sources and measurements in the system. Use alarms to monitor the state of your power
system and to investigate specific details as part of an Incident analysis.
For more information, see:
• Alarms
• Viewing alarms
• Alarm status UI
• Alarm history UI
Events
Events are records of activities in the system. Activities are performed by users, the system
software, or the connected devices. Events are logged and displayed as they happen in the
system without any processing or aggregation. PME uses event records to determine alarm types
and states. Use events for low level investigations and detailed root cause analysis.
For more information, see:
• Events
• Viewing events
• Event history UI
Alarm Acknowledgment
You can acknowledge alarms in status views and history views. If you acknowledge alarms
through an incident history view, all alarms that are part of this incident will be acknowledged.
Whenever you acknowledge an alarm, from any of these locations, you are acknowledging the
alarm definition itself, not an instance of it. That means acknowledging an alarm marks it as
Acknowledged and resets its Unacknowledged occurrence counter. For more information, see
Acknowledging alarms.
Analysis tools
The alarm viewer includes tools for analyzing the causes and impacts of alarm events. Some of
these tools are for very specific alarm types, others can be used for a broad range of alarms.
Load Impact
• Load Impact
Timeline analysis
• Timeline analysis
• Timeline analysis UI
Voltage Tolerance
• Voltage Tolerance
Waveforms
• Waveforms
• Waveform analytics
• Viewing waveforms
• Waveforms UI
Time display
See Time Display in Web Applications for information on how time is displayed in a system where
the monitoring devices, the PME/Web server, and the Web client (browser) are in different time
zones.
Terminology
See Alarms terminology for definitions of the terms used in the Alarms application.
Viewing incidents
View incidents to investigate system issues, to analyze what happened during a power
disturbance or to identify root causes.
To view incidents:
1. In the alarm viewer, open an existing incident view from the view library or add a new View.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Viewing alarms
View Alarm Status to assess the state of the monitored power system and to respond to important
events and issues. View Alarm History for root cause analysis and to understand the sequence of
events.
To view Alarm Status or Alarm History:
1. In the alarm viewer, open an existing alarm status or alarm history view from the view library
or add a new View.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Viewing events
View events to investigate system activities in PME or to troubleshoot unexpected system
behavior.
To view events:
1. In the alarm viewer, open an existing event view from the view library or add a new View.
TIP: Double-clicking an event in the events display table opens the associated alarm.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
NOTE: Disturbance Direction analysis is only available for alarm instances and incidents, not for
alarm status. Also, the data associated with the alarm or incident must include disturbance
direction information.
1. In the alarm viewer, open an existing alarm history or incident history view from the view
library or add a new View.
TIP: Add a Disturbance Direction filter to your view to identify disturbance direction relevant
alarms and incidents. You can add this filter in View Settings > Categories > Power
Quality.
NOTE: The Disturbance Direction filter settings only apply to the following Power Quality
alarm or incident types: Interruption, Under Voltage, Over Voltage, Sag, Swell,
Unclassified Disturbance, Transient.
2. Find the alarm instance or Incident for which you want to view Disturbance Direction and
TIP: Alarms or incidents with Disturbance Direction information are tagged with an
Upsteam or Downstream indicator.
3. In the details window, view the Disturbance Direction information of the representative
disturbance for this alarm or incident.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
NOTE: Load Impact analysis is only available for alarm instances and incidents, not for alarm
status. Also, the data associated with the alarm or incident must meet the prerequisites. See
Load Impact for more information.
1. In the alarm viewer, open an existing alarm history or incident history view from the view
library or add a new View.
TIP: Add a Load Impact filter to your view to identify load impact relevant alarms and
incidents. You can add this filter in View Settings > Categories > Power Quality.
NOTE: The Load Impact filter settings only apply to the following Power Quality alarm or
incident types: Interruption, Under Voltage, Over Voltage, Sag, Swell, Unclassified
Disturbance, Transient.
2. Find the alarm instance or Incident for which you want to view Load Impact and click Open
TIP: Alarms or incidents with Load Impact calculations are tagged with a Load Loss
or Load Gain label. You can enable or disable the display
of the label in Web Applications > Settings > Alarms > Alarm Views.
3. In the details window, view the Load Impact information related to this alarm or incident.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
1. In the alarm viewer, open an existing incident view from the view library or add a new View.
2. Find the incident for which you want to view the analysis, and click Open Timeline Analysis
1. In the alarm viewer, open an existing Incident view from the view library or add a new View.
2. Find and select the incidents for which you want to view the analysis.
TIP: Use Ctrl+Click to select individual alarms, use Shift+click to select a block of
alarms.
3. From the in the Options menu at the top of the alarms display pane, select Open
Timeline Analysis on selection.
1. In the alarm viewer, open an existing alarm history view from the view library or add a new
View.
2. Find the alarm for which you want to view the analysis and click Open Details.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
NOTE: Voltage Tolerance analysis is only available for alarm instances and incidents, not for
alarm status. Also, the data associated with the alarm or incident must include voltage
disturbance measurements.
1. In the alarm viewer, open an existing alarm history or incident history view from the view
library or add a new View.
TIP: Add a Voltage Tolerance filter to your view to identify alarms and incidents that fall into
a certain area of the ITIC/CBEMA curve. You can add this filter in View Settings >
Categories > Power Quality. See Voltage Tolerance for more information.
NOTE: The Voltage Tolerance filter settings only apply to the following Power Quality
alarm or incident types: Interruption, Under Voltage, Over Voltage, Sag, Swell,
Unclassified Disturbance, Transient.
2. Find the alarm instance or Incident for which you want to view Voltage Tolerance, and click
3. In the details window, select Tolerance Chart in the display selector on left side of the
window.
For an alarm instance, a single voltage disturbance is displayed in the chart. For incidents, all
available voltage disturbances for the alarms that are part of the Incident are displayed.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Viewing waveforms
View waveforms to investigate power quality events and identify root causes of disturbances.
To view waveforms:
1. In the alarm viewer, open an existing Incident history view or alarm history view from the
view library or add a new View.
2. Find the incident or alarm for which you want to view waveforms and click Details . You
can also open Details by double-clicking the incident or alarm instance.
TIP: Click Open Representative Waveform to see the representative waveform for this
Incident or alarm instance.
(Optional) Click Inspect a waveform to see more details and to analyze the waveform.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Acknowledging alarms
Acknowledge alarms to show that these alarms are managed. Record relevant information
related to the alarms, as part of the acknowledgment, for future reference. There are many ways
to acknowledge alarms.
NOTE: You can acknowledge alarms in status views and history views. If you acknowledge
alarms through an incident history view, all alarms that are part of this incident will be
acknowledged. Whenever you acknowledge an alarm from any of these locations, you are
acknowledging the alarm definition itself, not an instance of it. That means acknowledging an
alarm marks it as Acknowledged and resets its Unacknowledged occurrence counter.
1. In the alarm viewer, open an existing alarm status view from the view library or add a new
View.
2. In the alarms display pane, find the alarm definition you want to acknowledge.
(Optional) In the view library, right-click the view name or click Options , and select Edit to
open the view settings. You can also open the view settings by double-clicking the view
name. Adjust the settings for View Type, Priority, State, Sources, and Categories to
customize the view if necessary. Save the modified view settings or click Cancel to discard
the changes.
3. In the Acknowledgment column for this alarm definition, click Acknowledge. This opens
the Acknowledge Alarms window. You can also open the details for this alarm definition and
click Acknowledge in the details window to open Acknowledge Alarms.
TIP: To later view the acknowledgment notes, open the alarm details and click History on
the top right. The acknowledgment with the note is shown in the alarm instance history
display.
1. In the alarm viewer, open an existing alarm status view from the view library or add a new
View.
2. In the alarms display pane, find and select the alarm definitions you want to acknowledge in
the alarms table.
TIP: Use Ctrl+Click to select individual alarms, use Shift+click to select a block of
alarms.
(Optional) In the view library, right-click the view name or click Options , and select Edit to
open the view settings. You can also open the view settings by double-clicking the view
name. Adjust the settings for View Type, Priority, State, Sources, and Categories to
customize the view if necessary. Save the modified view settings or click Cancel to discard
the changes.
3. Click Options in the top right corner of the alarms pane, and then click Acknowledge
Selected in the options menu. This opens the Acknowledge Alarms window.
TIP: To later view the acknowledgment notes, open the alarm details, for any of the alarms,
and click History on the top right. The acknowledgment with the note is shown in the alarm
instance history display.
1. In the alarm viewer, open an existing alarm status view from the view library or add a new
View.
2. Click Options in the top right corner of the alarms pane, and then click Acknowledge
All in the options menu. This opens the Acknowledge Alarms window.
TIP: To later view the acknowledgment notes, open the alarm details, for any of the alarms,
and click History on the top right. The acknowledgment with the note is shown in the alarm
instance history display.
1. In the alarm viewer, open an existing alarm history view from the view library or add a new
View.
2. In the alarms display pane, find the alarm you want to acknowledge.
(Optional) In the view library, right-click the view name or click Options , and select Edit to
open the view settings. You can also open the view settings by double-clicking the view
name. Adjust the settings for View Type, Priority, State, Sources, and Categories to
customize the view if necessary. Save the modified view settings or click Cancel to discard
the changes.
3. Open the details for this alarm by clicking on Open Details or double-clicking the alarm.
4. In Alarm Details, click Acknowledge. This opens the Acknowledge Alarms window.
TIP: To later view the acknowledgment notes, open the alarm details and click History on
the top right. The acknowledgment with the note is shown in the alarm instance history
display.
1. In the alarm viewer, open an existing incident history view from the view library or add a new
View.
2. In the alarms display pane, find the incident you want to acknowledge.
(Optional) In the view library, right-click the view name or click Options , and select Edit to
open the view settings. You can also open the view settings by double-clicking the view
name. Adjust the settings for View Type, Priority, State, Sources, and Categories to
customize the view if necessary. Save the modified view settings or click Cancel to discard
the changes.
3. Open the details for this incident by clicking on Open Details or double-clicking the incident.
4. In Incident Details, click Acknowledge. This opens the Acknowledge Alarms window.
TIP: To later view the acknowledgment notes, open the alarm details, for any of the alarms,
and click History on the top right. The acknowledgment with the note is shown in the alarm
instance history display.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Incidents
Incidents in PME represent real world power events, such as disturbances or faults. An incident
combines alarms, waveforms, and burst data from many sources in the system into a single
representation of the power event. Instead of having to analyze each data point individually, you
can look at an incident and see how the different pieces of information are linked together.
PME uses alarm types and alarm start times as criteria to determine which alarms to group into a
specific incident. The start of an alarm marks the beginning of an incident. Any alarm of a similar
type, that starts within a certain time interval is considered part this same incident. The grouping
time interval is always based on the most recent alarm in the incident, which means that the
counter is restarted every time a new alarm is added to the incident. If there is no more alarm that
falls inside the interval, the incident is complete. The maximum duration for an incident is 24 hours
and the maximum number of alarms in an incident is 500. A new incident is started the next time
an alarm is recorded. See Alarm to incident mapping for more information.
The incident grouping time interval is different for different alarm types. For example, Over
Voltage alarms have a time interval of 5 minutes. If a new Over Voltage alarm occurs within 5
minutes, for any source, it is grouped into the same incident. To make it easier to analyze
incidents, PME categorizes them into types. The incident types are based on the alarm types.
The following table shows the Incident types and the grouping time intervals for each type:
* These grouping intervals time settings are default settings. The defaults are extended
automatically to include power quality alarms that are outside the interval but close enough that
they could be related to the incident.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Alarms
An alarm is a defined condition for a source in PME. The software or the device monitors this
condition and records when the condition is met and when not. For example, you can define an
Over Voltage alarm for a certain monitoring device in the system. When the voltage threshold is
exceeded on this device, the alarm goes active. When the voltage drops below the threshold, the
alarm goes inactive. The next time the voltage on this device goes above the threshold again, the
same alarm goes active again. An alarm is always associated with a single source and a single
measurement.
Some alarms are based on instantaneous events such as a voltage transient, others are based on
a condition that lasts a certain period of time such as an over voltage condition. For lasting
conditions, the alarm goes from an inactive state to an active state while the condition lasts and
then back to an inactive state when the condition is over. Instantaneous alarms are always shown
in an inactive state.
The following diagram shows an alarm that is based on a lasting condition. The alarm goes active
at the time T1 and inactive at T2. The time interval between T1 and T2 can be short or long.
The following diagram shows an instantaneous alarm. For this alarm, the start time T1 and end
time T2 are identical.
After an alarm has gone active, it can be acknowledged in the alarm viewer. When you
acknowledge an alarm, the date and time of the acknowledgment is recorded together with an
optional note that you can enter in the acknowledge window.
An alarm stays unacknowledged until you acknowledge it. After you have acknowledged an
alarm, it stays acknowledged until the next time it goes active. At that point it is reset to
unacknowledged and is waiting for you to acknowledge it again.
PME counts the number of times an alarm goes through an inactive to active state transition. The
number of these transitions is displayed as Occurrences in the alarm viewer in the alarm status
view. There are two counters for each alarm. One counter for the total number of occurrences,
and one for occurrences since the alarm was last acknowledged.
The time period during which an alarm is active, starting when it goes active, ending when it goes
inactive, is called an alarm instance.
Alarm conditions are defined either as software alarms in the Software Alarms tool, or as device-
based alarms in the monitoring devices, using the appropriate device configuration tool.
To make it easier to analyze alarms, PME categorizes them into types and combines alarms of
similar types into incidents, based on the alarm start times.
The following table shows the different alarm categories and types in PME:
Category Type
Flicker
Frequency Variation
Harmonics
Harmonics (Current)
Harmonics (Power)
Harmonics (Voltage)
Interruption
Over Voltage
Power Quality
Sag (Voltage)
Swell (Voltage)
Transient
Unbalance
Unbalance (Current)
Unbalance (Voltage)
Unclassified Disturbance
Under Voltage
Arc Flash
Backup Power
Over Current
Protection
Asset Monitoring
Sag (Current)
Swell (Current)
Thermal Monitor
Under Current
Category Type
Air
Demand
Electricity
Energy Management Gas
Power Factor
Steam
Water
General Event
General General Setpoint
Unassociated Dropout
Clock / Time
Communication Status
Diagnostics Device Settings
Device Status
System Status
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Events
An event is a record of an activity or a condition that is logged in PME. Events are generated by
users, the system software, or the connected devices. Examples of events include resetting a
measurement, logging into PME, making a configuration change in a device, or a setpoint going
active on a device. Some of these events are logged automatically, for others logging must be
setup manually. Each event record that is logged has a timestamp and several fields that describe
the activity. Each event record describes one single activity or condition, for example, a setpoint
going active in a monitoring device.
Events are logged and displayed as they happen in the system without any processing or
aggregation. For example, an Over Voltage setpoint going active and then inactive in a device will
cause 3 events to be logged, one for the pickup, one for the dropout, and one for the extreme
voltage value measured during the time the setpoint was active.
Here is an example of the event records for an over voltage setpoint:
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Disturbance Direction
Disturbance Direction identifies the origin of a voltage disturbance (sag/swell/transient).
Disturbance direction calculations are done by the monitoring devices. A device determines the
direction of the origin of a disturbance as either Upstream or Downstream from the device
location. It is possible to identify the likely origin of a disturbance within a power system by
combining the direction information from multiple devices in the network. For alarms, the
disturbance direction shown in the software is the direction determined by the device that is
associated with the alarm. For incidents, it is the direction determined by the representative
device for the incident.
Use Disturbance Direction to analyze the likely origin of voltage disturbance events in your power
system.
Prerequisites
The monitoring devices must be capable of detecting and logging the disturbance direction.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Load Impact
Load Impact identifies changes in the steady state electrical loads of a power system triggered by
a voltage disturbance, such as a voltage sag or interruption.
Loads can be affected by voltage disturbances in different ways. Some loads might shut down
and not automatically restart after the disturbance. Other loads might experience changes in their
operational state and draw more or less power. It is even possible that the power flow reverses,
for example if backup power generation is triggered by the disturbance.
Use Load Impact analysis to identify changes in steady state electrical loads in your power
system triggered by a voltage disturbance.
NOTE: Load Impact identifies changes in loads that persist after the disturbance. It does not
identify changes in loads during the disturbance event.
Prerequisites
Load Impact calculations are only available for data captured by the following monitoring device
types:
• ION 9000 (all firmware versions)
• Current and voltage waveforms, for each phase, for the voltage disturbance events.
NOTE: Load Impact calculations are done automatically by the software for any applicable alarm
or incident. No special configuration is required.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Timeline analysis
Timeline analysis is a sequence of event analysis for items that are associated with one or more
incidents or alarms. The items are shown on a timeline, in chronological order. Items include
alarms, waveforms and burst data recordings. The tools available in timeline analysis allow you to
add or remove items from the timeline, add notes, zoom in or out, and include alarms previously
not associated with this incident. You can save a timeline analysis as new view in the view library
for future reference.
Use timeline analysis to investigate the sequence of events during an alarm or incident. See
Timeline analysis UI for more information.
Prerequisites
None. Any incident can be displayed using timeline analysis.
NOTE: Alarms and data measurements during an incident occur in very short time intervals. To
show the correct sequence of events in the timeline analysis, the timestamps must be accurate.
Consider using monitoring devices with Precision Time Protocol (PTP) or GPS time
synchronization for accurate time stamping.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline Analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Voltage Tolerance
Voltage Tolerance is available in PME as an analysis tool and as a filter for alarm history and
Incident history views.
Analysis tool
Voltage Tolerance uses a graphical display of the magnitude and duration of a voltage
disturbance to analyze potential impacts of the event on equipment. The voltage magnitude
during the disturbance and the duration of the event are plotted in a Cartesian coordinate system.
A voltage susceptibility curve is overlaid to show how the disturbance compares to established
equipment tolerances. You can plot multiple disturbances in the same chart. The tool provides
two susceptibility curves, ITIC/CBEMA (for information technology equipment) and SEMI F47-
0706 (for semiconductor processing equipment).
Use Voltage Tolerance analysis to investigate potential impacts of a voltage disturbance on the
equipment in your facility.
Prerequisites
The monitoring device data associated with the alarm or incident must include sag, swell, or
transient voltage disturbance measurements.
Examples:
ITIC/CBEMA
SEMI F47-0706
View filter
Use the Voltage Tolerance filter to create alarm history or incident history views that select alarms
and incidents based on specific voltage disturbance characteristics. For example, you could
define a view that only includes alarms or incidents with voltage sags of a magnitude between 70 -
90% of nominal voltage, and a duration of 0.1 - 2 seconds.
NOTE: You can add this filter in View Settings > Categories > Power Quality.
NOTE: The Voltage Tolerance filter settings only apply to the following Power Quality Incident
types: Interruption, Under Voltage, Over Voltage, Sag, Swell, Unclassified Disturbance,
Transient.
Example:
NOTE: The Voltage Tolerance view filter only supports the ITIC/CBEMA voltage susceptibility
curve.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Waveforms
Waveforms are graphical representations of voltage and current that show their variations over
time. The waveform displays in PME are based on logged, historical measurements that were
recorded by a monitoring device. The measurements recorded by a device for a waveform
capture are called samples and the speed with which these samples are taken is called sampling
rate. The higher the sampling rate, the more accurately the waveform capture represents the
actual voltage or current waveform. Captures taken by different device types can have different
sampling rates, depending on the capabilities and settings of the device.
Use Waveforms to analyze power quality events by viewing the individual wave shapes, the
magnitudes, the phase angles between voltage and current, and the timing of wave shape
variations. Waveform data is also used to show voltage and current phasors and the individual
harmonic components.
Prerequisites
The monitoring device data associated with the alarm or incident must include waveform
captures.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Waveform analytics
Use waveform analytics to help determine the cause of power quality events within an electrical
system. In Alarms, you can access waveform analytics from All Alarms, Recent Events, Recent
Alarms, Recent Incidents, and Active Alarms within the alarm viewer.
2. Find the incident or alarm for which you want to view waveform analytics, and click Details
. You can also open Details by double-clicking the incident or alarm instance.
The Waveform Analysis Information section will provide data and information to help determine
the cause of the event. Events may be caused by:
• Upstream Voltage Sag: This is an RMS event recorded when the source of a voltage sag is
upstream of the monitoring location. The upstream voltage sag could be due to a fault, load
start, transformer inrush, etc., and cause downstream loads to be impacted. One clue that the
cause of a voltage sag is upstream from a monitoring location is that the downstream load
current increases after the voltage sag ends. The temporary increase could be due to the
downstream load recovering from the voltage sag.
• Downstream Load Start: This is an RMS event recorded as a voltage sag caused by the
energizing of a downstream electrical load. For example, during electric motor start-up,
measured current may be four times or more compared to the current measured under full
load. This increased current results in a drop in voltage for a duration of milliseconds to
seconds.
• Downstream Fault: This voltage sag is due to a downstream electrical fault in which one or
more conductors make inadvertent contact with the ground. This may be caused by damage
to an electrical conductor or due to internal damage to an electrical load. The duration of a
fault is dependent upon the magnitude of the fault current. Larger fault currents typically trip a
breaker or fuse more quickly. Additionally, the user interface will indicate whether the
downstream fault is a single-phase fault, subcycle fault, three-phase fault, or two-phase fault.
• Downstream Inrush Event: PME can detect a downstream inrush event, which can be
caused by a downstream power transformer being energized. The characteristic signature of
inrush current is produced by saturation of the magnetic core of a transformer.
• Capacitor Switch Event: Capacitor switch is to maintain desired system voltage levels as
reactive loads are connected and disconnected to the utility system. This event causes
several impacts at distribution network like low frequency decaying, voltage and current
distortion, resonance, inrush current and voltage transient.
When the waveform does not include needed data, notifications will display under Waveform
Analysis Information.
DANGER
EQUIPMENT ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
• Apply appropriate personal protective equipment (PPE) and follow safe electrical work
practices. See NFPA 70E in the USA, CSA Z462 or applicable local standards.
• Turn off all power supplying the power meter and the equipment in which it is installed before
working on it.
• Always use a properly rated voltage sensing device to confirm that all power is off.
• Replace all devices, doors and covers before turning on power to this equipment.
Failure to follow these instructions will result in death or serious injury.
One or more of the three voltage Verify that the monitoring source is measuring a valid voltage
phases has an RMS value for its signal on all three phases.
first cycle that is less than 100
volts.
Low Positive-Sequence
Voltage
One or more of the three voltage Verify that the monitoring source is measuring a valid voltage
phases has a positive-sequence signal on all three phases.
voltage that is less than 100
volts.
High Negative-Sequence
Imbalance
The ratio of negative-sequence Verify the connections of the meter to see if phases need to
voltage to positive-sequence be swapped.
voltage for the first cycle is too
high.
High Zero-Sequence
Imbalance
The ratio of zero-sequence Verify that all three voltage channels are connected and
voltage to positive-sequence measuring a valid voltage signal.
voltage for the first cycle is too
high.
High Voltage THD
The voltage total harmonic The first cycle of one or more waveforms is too non-
distortion for the first cycle of sinusoidal. Verify that the monitoring source is measuring a
one or more of the phases is too valid voltage signal.
high.
Related topics:
• Viewing incidents
• Viewing alarms
• Viewing events
• Viewing waveforms
• Acknowledging alarms
• Incidents
• Alarms
• Events
• Disturbance Direction
• Load Impact
• Timeline analysis
• Voltage Tolerance
• Waveforms
• Waveform Analytics
• Alarms terminology
• Alarms UI
• Timeline analysis UI
• Waveforms UI
Dashboards
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.
Time display
See Time Display in Web Applications for information on how time is displayed in a system where
the monitoring devices, the PME/Web server, and the Web client (browser) are in different time
zones.
For information on how use the Dashboards application, see:
• Viewing Dashboards
• Dashboard Slideshows
• Playing a Slideshow
• Gadgets
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
• Gadgets
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
• Gadgets
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
• Gadgets
Gadgets
Gadgets are graphical display objects used in the dashboard display pane for charting trends over
time, or in comparison with correlated measurements or similar functionality. The gadgets
available for a dashboard are listed in the Gadget Setup dialog, which opens when you click Add
Gadget in the Dashboard Controls area.
TIP: When the gadget is displayed in the dashboard, you can click an item in the gadget legend
to toggle the graphical display of data for that item on and off. When you place the pointer on an
item in the gadget, a tooltip provides information related to that item. You can also click the
maximize gadget icon to fill the browser page with the gadget. Click the Restore icon to
return the gadget to its original size on the dashboard.
Use the following links to jump to the descriptions of the different gadget types:
Related topics:
• Viewing Dashboards
• Dashboard Slideshows
• Playing a Slideshow
• Gadgets
TIP: Place your pointer on a bar in the chart to open a tooltip showing the measurement value.
Click a series in the legend to hide or show this series in the chart.
Table gadget
This gadget shows real-time data from devices in the system. The information is shown in table
format.
Example:
TIP: The measurements can be arranged in rows or in columns. The real-time data aggregation
can be defined and data values can be highlighted for the defined threshold.
NOTE: User authentication is required if the table gadget is used in the slideshow. See Using
Table gadget in Slideshow for more information.
TIP: Place your pointer on a column in the chart to open a tooltip showing the measurement
value. Click a series in the legend to hide or show this series in the chart.
TIP: Place your pointer on a section in the chart to open a tooltip showing the measurement
value. Click a section in the pie to separate it from the pie. Click a series in the legend to hide or
show this series in the chart.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
TIP: Place your pointer on a column in the chart to open a tooltip showing the measurement
value. Based on the target line configuration, the tooltip also displays the value over the defined
target value. Click a series in the legend to hide or show this series in the chart.
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.
NOTE: When you configure the Web Viewer gadget to access a website, you should be careful
that the website does not include hidden malware, viruses, or content that could compromise
your web client computers. It is recommended that the target site specified in the gadget be
secured with the SSL or TLS protocol (accessed via HTTPS).
Example:
NOTE: These gadgets are part of the Power Quality Performance Module. This Module requires
a separate license.
See Power Quality Performance events and disturbances, in the Reference section of this
document, for a definition of power quality events.
Use the following links to jump to the descriptions of the different Power Quality gadget types:
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the power factor and the estimated power factor surcharge, based on the
billing rate, over a selected time period. The information is shown as a graphic display of the
power factor and the estimated surcharge.
Example:
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the estimated power factor surcharge, based on the billing rate, over a
selected time period. The information is shown in a column chart, grouped by aggregation period.
Example:
TIP: Place your pointer on a column in the chart to open a tooltip showing the estimated
surcharge.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows a breakdown of the power quality events, by type, over a selected time period.
The information is shown in a pie chart, as a percentage distribution of the events.
Example:
NOTE: The colors in the chart are shown dimmed if the events had no expected impact. The
colors in the chart are shown solid if one or more events had an expected impact.
TIP: Place your pointer on a section in the chart to open a tooltip showing the number of events
in each category. Click a section to separate it from the pie.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the number of power quality events, over a period of time, that might have had
a process impact, compared to those that most likely did not have an impact. It is a simplified
representation of the CBEMA/ITIC curve in a pie chart format. Events that are inside the curve are
shown as “no impact events” and those outside the curve are shown as “likely impact events”.
Example:
NOTE: The colors in the chart are shown dimmed if the events had no expected impact. The
colors in the chart are shown solid if one or more events had an expected impact.
TIP: Place your pointer on a section in the chart to open a tooltip showing the number of events
in each category. Click a section to separate it from the pie.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the number of power quality events, over a selected time period, grouped by
location of origin (external, internal, undetermined). In addition, it indicates whether the events
had a likely process impact or not. The information is shown in a column chart, grouped by impact
assessment.
Example:
TIP: Place your pointer on a column in the chart to open a tooltip showing the number of events
and their likely process impact.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the cost of power quality events with a process impact, over a selected time
period. The information is shown in a column chart, grouped by location of power quality event
origin (external, internal, undetermined).
Example:
TIP: Place your pointer on a column in the chart to open a tooltip showing the event duration.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the aggregated cost of power quality events with a process impact, over a
selected time period. The information is shown in a stacked column chart, grouped by
aggregation period. The location of power quality event origin (external, internal, undetermined) is
shown by the color of the columns.
Example:
TIP: Place your pointer on a column in the chart to open a tooltip showing the event origin, cost,
and duration. Click a series in the legend to hide or show this series in the chart.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows a power quality rating in the form of a letter grade (A to F). The rating is a
summary of multiple types of power quality disturbances. The information is shown as a graphic
display of the letter grade, with a % power quality rating and a list of the main contributing
disturbances.
Where:
• PQ.Indicators.Value is a number indicating each power quality indicator status (green = 2,
yellow= 1, red = 0).
• PQ.Indicators.MaxValue = 2 for each individual indicator.
• Weight Factor is an adjustable value (default=1) for assigning different weight to each
individual indicator as per your needs.
The power quality rating is mapped to the letter grades in the following way:
• PQ.Rating >= 95% à "A"
NOTE: The ratings are based on established thresholds and limits defined in IEEE 519, IEC
61000-4-30, EN 50160, and IEEE 1159 standards.
Example:
For information about configuring Power Quality gadgets, see Configuring Gadgets.
NOTE: This gadget is part of the Power Quality Performance Module. This Module requires a
separate license.
This gadget shows the power quality rating, over a selected time period. The information is shown
in a column chart, grouped by aggregation period.
Example:
TIP: Place your pointer on a column in the chart to open a tooltip showing the date and the power
quality rating.
For information about configuring Power Quality gadgets, see Configuring Gadgets.
Sankey gadget
NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.
This gadget shows a flow diagram, in which the width of the arrows is proportional to the data
values. The diagram starts as a combined flow for all the selected consumers, and then breaks
out into individual flows for each consumer.
Use this gadget to show WAGES consumption broken down by load type, or to visualize
consumption costs by consumer. You can also use it to show power losses.
NOTE: The Sankey gadget must be used with hierarchy data. The Sankey gadget automatically
removes nodes with missing data from the display. A message is displayed in the chart if a node
is removed.
TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,
hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.
Example:
TIP: Drag individual nodes horizontally or vertically in the chart for a better view.
NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.
This gadget shows consumption data, by consumer, for multiple consumers, over a selected time
period. The information is shown in a combined column and line chart. The columns are arranged
from highest consumption to lowest consumption. The chart includes a cumulative curve based
on the aggregation period consumption values. The chart also contains a configurable marker line
which is used as a target or threshold indicator.
Use this gadget to perform an 80/20 analysis, identifying those consumers that together make up
the largest portion, or 80% of the overall consumption.
TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,
hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.
Example:
NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.
This gadget shows consumption data for multiple consumers, over a selected time period. The
information is shown in a combined column and line chart, grouped by aggregation period. The
columns are arranged from highest consumption to lowest consumption. The chart includes a
cumulative curve based on the aggregation period consumption values. The chart also contains a
configurable marker line which is used as a target or threshold indicator.
Use this gadget to perform an 80/20 analysis, identifying those aggregation intervals and
consumers that together make up the largest portion, or 80% of the overall consumption.
TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,
hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.
Example:
NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.
This gadget creates a graphical representation of your data where the individual values are
represented as colors in a matrix format. The graphical display makes it easy to identify patterns
in complex data sets.
Use this gadget with consumption data to identify usage patterns and anomalies.
TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,
hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.
Example:
NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.
This gadget shows consumption data, by consumer, for multiple consumers, over a selected time
period. The information is shown side-by-side in a column or bar chart and a doughnut chart. The
columns or bars are arranged in order of consumption. The chart includes the aggregated total
consumption.
Use this gadget to compare the consumption of different consumers over a period of time.
TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,
hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.
Example:
NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.
This gadget shows consumption data for multiple consumers, by aggregation period, over a
selected time period. The information is shown side-by-side in a column or bar chart and a
doughnut chart. The columns or bars are arranged in order of the aggregated consumption. The
chart includes the aggregated total consumption.
Use this gadget to compare the consumption of consumers during specific time intervals, for
example by hour, by day of week, or by day.
TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,
hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.
Example:
KPI gadget
NOTE: This gadget is part of the Energy Analysis Reports Module. This Module requires a
separate license.
This gadget shows a single value that is based on calculated input data. The information is shown
as a numeric value with unit, a custom text, and a custom graphic. The gadget is highlighted for
the defined threshold.
Example:
Diagrams
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.
TIP: You can open the Diagrams application from the DIAGRAMS link in the Web Applications
banner.
Use the Diagrams application to view Vista diagrams in the Web Applications interface. You can
view the network diagram and any custom diagrams created in Vista. In addition, the Diagrams
application provides a Devices diagrams view with device type specific diagrams for each device
that is configured in the system. Objects that can be displayed in the browser include real-time
numeric data, full or partial gauges, background graphics or diagrams, and basic views of event,
data and waveform logs.
You can also perform manual control actions such as resetting values on devices or changing
device configuration settings.
NOTE: See Time Display in Web Applications for information on how time is displayed in a
system where the monitoring devices, the PME/Web server, and the Web client (browser) are in
different time zones.
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Diagram Library
The Diagram Library contains all the diagrams that are configured in the system. Diagrams can be
listed individually, or they can be organized within folders. The Devices diagram folder is a
system folder that is automatically generated. It cannot be edited or deleted. You use the Diagram
Library to select the diagram you want to view.
TIP: To hide the library, click the Hide Library icon ( or ) in the top right corner of the library.
To show the library, click the Show Library icon ( or ) at the top of the library ribbon, or
click anywhere in the minimized library ribbon.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
User authentication
If you access Diagrams through the Web Applications framework, you are automatically
authenticated, using the Web Applications login.
If you access Diagrams from outside the Web Applications framework, through a browser using
the URL http://server_name/ion (where server_name is the fully-qualified name of the
server or its IP address), you are prompted to log in using your Power Monitoring Expert user
name and password.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
1. Click the meter icon to open its diagram, then click the link or tab that contains the button for
the trending information you want to view.
2. Click the Data Log Viewer button that corresponds to the data log you want to view.
When the data log table opens, 30 rows of data are displayed initially. As you scroll or page
down, 30 additional rows of data at a time are added to the table.
3. Click Change Date Range to change the timeframe for the data and select one of the
available options for the data that you want to view. To specify a custom date range, select
Between these dates then click the calendar icons to set start and end dates.
The new date range is applied when you view the graph. Click Show Table to return to the
data log table. (When you return to the data log table, your previous table header selections
are cleared.)
If you select a custom date range, a maximum of 6000 rows of data are displayed initially. If
the custom date range includes more than 6000 rows of data, you can display the additional
records in increments of 30 rows at a time by scrolling down or pressing End.
4. Select the check boxes for the items in the table header for the parameters that you want to
graph.
b. To restore the graph to its original display size, double-click anywhere in the graph.
7. Click:
a. Device Diagram to return to that page.
b. Change Date Range to select a different date range for the data log table. The new
date range is applied when you view the graph.
c. Show Table to return to the data log table. (When you return to the data log table, your
previous table header selections are cleared.)
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
NOTE: You cannot acknowledge alarms on the screens generated by the Diagrams application
since control functions are not supported. To acknowledge alarms, click the ALARMS icon in the
Web Applications component to open the Alarm Viewer.
1. Click the meter icon to open its diagram, then click the link or tab that contains the Meter
events button.
2. Click the Meter events button to open a table showing the meter events.
When the meter events table opens, 30 rows of data are displayed initially. As you scroll or
page down, 30 additional rows of data at a time are added to the table.
3. Click Change Date Range to change the timeframe for the data and select one of the
available options for the data that you want to view. To specify a custom date range, select
Between these dates then click the calendar icons to set a start and end date.
If you select a custom date range, a maximum of 6000 rows of data are displayed. If the
custom date range includes more than 6000 rows of data, you can display the additional
records in increments of 30 rows at a time by scrolling down or pressing End.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
The network diagram appears in the workspace containing icons that represent groups of
devices on your system.
4. Click one of the grouping objects and display the node icons contained within.
5. Click a node icon to display the user diagram for the associated device.
NOTE: To perform any control object function, enter the device password. The username is set
to default. See Performing manual control actions for more information. If username is prompted
when performing any control object function, see Changes in security settings of device for more
information.
NOTE: You cannot view device data in the user diagram in Diagrams for devices with advanced
security enabled. Control object functions for advanced security enabled devices are not
supported in Diagrams.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
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 use Diagrams to perform manual control actions on devices. Manual control actions
include actions such as resetting values on devices or changing device configuration settings.
For you to be able to perform control actions, the following must be true:
• Control in Diagrams must be enabled. See Set Diagrams control options for information on
how to enable control.
• Your Web Applications client (= web browser) must use an HTTPS connection to the PME
server.
• Your user access level must be at the level required by the control object, or higher. See
Controlling system functions in Vista for information on control object configuration.
• The device you are trying to control does not use Advanced meter security. Control in
Diagrams does not support Advanced security on devices.
1. Open the diagram for the device you want to control in Diagrams.
2. Click on the control object you want to trigger or change. This opens a confirmation dialog.
NOTE: There can be a time delay until Diagrams displays a new control value or state after it has
been written to the device.
TIP: Control actions in Diagrams are recorded in the PME system log. Use Log Viewer to see
system log entries.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
NOTE: See the "Identifying Stale Data" topic in the Vista section of the online Power Monitoring
Expert Help for information on stale data. Although you can change the stale data and error flag
colors in Vista , the color indicators for these flags do not change in the Diagrams application.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Power Quality Performance diagrams provide an overview of the power quality of your system.
Two sets of Vista diagrams are available; indicator diagrams and equipment diagrams:
• Indicator diagrams present an aggregated and simplified view of historical power quality data.
• Equipment diagrams provide a real-time summary of the operational status of the corrective
equipment installed in support of your system.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
NOTE: See Power Quality Performance events and disturbances, in the Reference section of
this document, for a definition of power quality events.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Diagrams
Power Quality Performance Indicator diagram is organized into 3 levels and a setup page:
1. Landing page
2. Details pages
3. Information pages
4. Setup page
1. Landing page
This page shows a high-level power quality summary. The landing page first opens to the LAST 7
DAYS viewing period. The other time periods are LAST 24 HOURS, LAST 30 DAYS, and LAST
12 MONTHS.
The indicators on the page are color-coded based on the state of the specific power quality item.
The color classifications are defined by configurable limits, set for each item. The color coding
indicates how well your system performed, with regards to power quality, over a certain period of
time:
• Green means there are no power quality issues.
• Yellow means there are a few power quality issues, which might be investigated.
• Red means there are frequent power quality issues, which should be investigated.
In diagrams, click the grouping object that links to the page , or click the Power Quality
Performance tab in the Web Applications banner. Which of these two options have been
implemented depends on how your system has been configured.
2. Details page
This page shows a breakdown of the specific event or disturbance, by time period. It provides the
following details:
• Counts for events with No Impact and Likely Impact.
The details page also includes a description of the event or disturbance type and potential
impacts. There is a Learn More link to access additional, related information.
On the landing page, click an event or disturbance to open the details page for that item.
3. Information page
This page shows the color classification limits used to determine whether the event or disturbance
is flagged with a green, yellow, or red color.
On a details page, click the information icon . Click X to return to the details page.
4. Setup page
This page has controls to trigger an update of the power quality indicators and the indicator limits.
Use the Initialize/Update Indicators control to manually update all indicators in the Power
Quality Performance diagrams. This triggers an immediate update instead of waiting for
automatic updates (15 minutes to 1 hour).
Use the Import Indicator Limit Information control to update the Power Quality Performance
indicator limits after the limit table in the database has been updated.
The OTHER (OPTIONAL) area is intended for custom controls. This area is empty by default.
On the landing page, click the Setup icon . Click the Back icon to return to the landing
page.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Diagrams
Power Quality Equipment diagram is organized into 3 levels:
1. Landing page
2. Group page
3. Details pages
1. Landing page
This page shows the status for each equipment type and a count for the number of devices of that
type.
(Optional) Click Corrective in the top navigation area of the page to view only the corrective
equipment types, click All Types to see all equipment.
On the Power Quality Performance Indicator diagrams landing page, click Equipment in the left
navigation pane.
You can also click one of the buttons under CORRECTIVE EQUIPMENT STATUS on that page,
to open the equipment group page for the devices grouped under the equipment type. The default
types are Capacitor Banks, Active Harmonic Filters, and UPS.
2. Group page
This page shows operational summary information for the equipment, such as load current and
harmonics. Each piece of equipment is shown with its own display area.
On the landing page, click one of the equipment types. Click the Back icon to return to the
landing page.
3. Details page
This page shows detailed operational information for the equipment, including device status, and
maintenance indicators.
On a group page, click inside a specific equipment area to open the details page for that item.
To view additional measurements for the device, click the folder icon in the OVERVIEW area on
the details page to open a device diagram for this equipment.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
The Insulation Monitoring diagrams show insulation status and other insulation related
measurements. Use these diagrams to monitor and analyze the insulation status of your
ungrounded IT power system.
Different diagrams are provided for ANSI and IEC applications:
• Insulation Monitoring diagrams for ANSI
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
• Data logs
Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
The Facility Summary diagram shows each group that contains a number of areas.
The Facilities Summary diagram shows all the groups of areas that were configured for the
facility. Each box in the main area represents a group of areas. This diagram provides a status
overview and links to areas in the facility, as shown next:
A Group Icon – Click the group icon to see the area diagram.
Status Indicator – This indicator is green or red to show the general status of the
isolated power system:
• Green – Normal condition. The Total Hazard Current measurements for all areas
in this group are below the limit.
• Red – Alarm condition. The Total Hazard Current measurement in one or more
areas in this group exceeds the limit, or a LIM-IG6 is in test mode.
NOTE: A LIM-IG6 test lasts 5 to 30 seconds. When the test is complete, the
B
status indicator changes back to green. If an insulation fault has occurred, the
indicator remains red until the fault is corrected.
1. Click the Group icon to open the Areas diagram. One or more area boxes will show an alarm
condition.
2. Click the specific area icons to open the Area Details diagrams. One or more panel boxes
will show an alarm condition. If the optional circuit fault locator devices are installed, the
panel box also indicates each circuit that has a resistance fault.
NOTE: Some types of electrical faults can occur and not be indicated by the individual
circuit fault locators. Only the area status indicator turns red. See Indicators for capacitive
faults for details.
3. Notify the responsible person that can address the condition for the area and specific
circuits.
The Summary of Areas diagram shows an overview of each area in the facility. Each box
represents a single area.
Example:
Each box represents a single area and contains the following information:
A Area Icon – Click the area icon to see LIM-IG6 and circuit details for the area.
Area Status Indicator – Indicates the general conditions of the area. This indicator is
B either green "Normal" or red "Alarm". If the indicator is red, one or more IG6 monitors are
in test mode or the Total Hazard Current measurement exceeds the limit.
LIM-IG6 Status and Current Indicators – Displays the insulation status and real-time
Total Hazard Current, in mA, for each LIM-IG6 in the area. Up to six LIM-IG6 monitors
can be installed in an area. The indicator changes to red if the LIM-IG6 is in test mode or
if a THC measurement exceeds the limit. When in test mode, the THC measurement
C
changes to 10.0 mA and the red "Testing" label appears next to the LIM-IG6 name. The
test lasts 5 to 30 seconds. When the test is complete, the color changes to green. If a
LIM-IG6 detects an insulation alarm, the THC measurement shows the real-time
THC value.
The Area Details diagram shows the details for each LIM-IG6 and connected devices in an area.
The Area Details diagram can show up to 3 LIM-IG6 monitors. If more than 3 monitors are in the
diagram, click the arrow in the upper right corner to see other monitors.
NOTE: For 208/240V systems, one LIM-IG6 can be shared between 2 areas. In this case, the
monitor appears on both area diagrams.
For example, the following image shows a diagram of the area and LIM-IG6 details:
Each LIM-IG6 area contains these sections to provide specific information about the circuit
conditions:
LIM-IG6 Status – Displays the name and status of the monitor, real-time
THC measurement, and test status. The THC measurement is taken directly from the
LIM-IG6.
This indicator is either green "Normal" or red "Alarm". If the indicator is red, one or more
A panels are in test mode or circuits in the area have THC measurements above the limit.
The red "Test In Progress" label appears when someone starts a LIM-IG6 test. A test is
started by pressing the test button on the LIM-IG6 or by pressing the test button on the
remote test device. This label remains visible during the test.
See Indicators for Test Mode and Alarm condition for details.
Circuit Status – Appears only if the optional circuit fault locator is connected to the LIM-
IG6. This area shows the status for each circuit being monitored. If the LIM-IG6 detects
a resistance fault, the circuit monitor identifies the specific circuit and the circuit indicator
turns red. When any indicator turns red, the alarm status propagates up to the top-level
C
Facility Summary diagram. If the LIM-IG6 is in test mode, all circuit indicators turn red.
Event Log and Data Log – Contains links to the historical data log and event log for
D
the panel measurements. See Data logs for more information.
LIM-IG6 in test mode, with circuit fault locators (left) and without circuit fault locators (right):
LIM-IG6 in alarm condition, with circuit fault locators (left) and without circuit fault locators (right):
DANGER
EQUIPMENT ELECTRIC SHOCK, EXPLOSION, OR ARC FLASH
• Do not ignore the main device hazard indicator when all circuit fault locator icons show
green status.
• Determine and correct the cause of the fault if the main device hazard indicator shows a
hazard.
Failure to follow these instructions will result in death or serious injury.
In some cases, such as when too many equipment items are connected to circuits, the LIM-IG6
detects a capacitance fault that exceeds the total hazard current (THC). For this situation, the
room Status area shows the hazard, as shown next. However, if the optional circuit fault locators
are installed, the circuit indicators do not indicate the capacitive fault, because they show only
resistance faults, as shown next:
If all the circuit fault indicators are green, as above, and the room Status area shows a hazard,
appropriate personnel must determine and correct the cause of the fault.
• Data logs
Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Data logs
When you need details about circuit measurements and details, the Area Details diagram
provides links to the historical data log and the event log. These logs provide measurement data
for the 5-minute polling interval of the LIM-IG6. You can filter the data in the logs by date range.
When using the event log, you can also generate a graph that shows THC measurements plotted
across time. If any THC measurement exceeds the hazard threshold, the graph includes a callout
at the specific event point.
• Change Date Range – Click this to view data for different dates. See "Select Date Range"
below for more information.
• Show Graph – Select one or more column headers in the table and click this to see a graph
of the data. The graph shows the data at 5-minute intervals. For example, you can check the
Total Hazard Current option in the table and see the values. Click a point on the data line to
see details for that value, as shown next.
The following figure shows the historical log table from the Vista client view:
Event Log
• Change Date Range – Click this to view data for different dates. See "Select Date Range"
below for more information.
2. Select an available range or click Between these dates and select specific dates in the
calendar.
If you select a date range of more than one week, a message appears to inform you that the table
will be very long.
• Data logs
Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
• Data logs
Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
The Facility Summary diagram shows each group that contains a number of areas.
The Facilities Summary diagram shows all the groups of areas that were configured for the
facility. Each box in the main area represents a group of areas. This diagram provides a status
overview and links to areas in the facility, as shown next:
A Group Icon – Click the group icon to see the area diagram.
Status Indicator – This indicator is green or red to show the general status of the
isolated power system:
• Green – Normal condition. The insulation resistance measurements for all areas
in this group is above the limit.
• Red – Alarm condition. The insulation resistance measurements for one or more
B areas in this group are below the limit.
1. Click the Group icon to open the Areas diagram. One or more area boxes will show an alarm
condition. .
2. Click the specific area icons to open the Area Details diagrams. One or more panel boxes
will show an alarm condition. If the optional circuit fault locator devices are installed, the
panel box also indicates each circuit that has a resistance fault.
3. Notify the responsible person that can address the condition for the area and specific
circuits.
The Summary of Areas diagram shows an overview of each area in the facility. Each box
represents a single area.
Example:
Each box represents a single area and contains the following information:
Area Icon – Click the area icon to see the details for the insulation monitoring device
A
measurements for this area.
Area Status Indicator – Indicates the general conditions of the area. This indicator is
B either green "Normal" or red "Alarm". If the indicator is red, the insulation resistance
measurement from the insulation monitoring device is below the limit.
Area Information and Status Indicators – Displays the area name, the insulation
monitoring device, and the status indicators. If an alarm occurs in the room, these
indicators show the specific type of alarm.
• Insulation Status – Normal condition is green. If the impedance is lower than the
threshold, the indicator turns orange. The impedance threshold is set on the
C insulation monitoring device.
• Electrical Status – Normal condition is green. If the current transformer load or
temperature exceed the threshold set on the insulation monitoring device, this
indicator turns red.
• Wiring Status – Normal condition is green. This indicator turns red if the
device cannot monitor the isolation transformer.
Circuit Status – Appears only if the optional Insulation Fault Locator (IFL) device is
installed. This area shows the status for each circuit being monitored. If the IFL detects a
resistance fault, the circuit monitor identifies the specific circuit and the circuit indicator
D turns red. When any indicator turns red, the alarm status propagates up to the top-level
Facility Summary diagram.
The Area Details diagram shows the details for the insulation monitoring and fault locator devices.
Example:
Device Name – The group and name of the device in the area.
Event Log and Data Log – Contains links to the historical data log and event log for
C
the panel measurements. See Data logs for more information.
Circuit Status – Appears only if the optional Insulation Fault Locator (IFL) device is
installed. This shows the status for each circuit being monitored. If the IFL detects a
D resistance fault, the circuit monitor identifies the specific circuit and the circuit indicator
turns red. When any indicator turns red, the alarm status propagates up to the top-level
Facility Summary diagram.
• Data logs
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Data logs
When you need details about circuit measurements and details, the Area Details diagram
provides links to the historical data log and the event log. These logs provide measurement data
for the 15-minute polling interval of the Vigilohm IM20-H. You can filter the data in the logs by date
range.
The following image shows the historical log table from the Power Monitoring Expert view:
• Change Date Range – Click this to view data for different dates. See "Select Date Range"
below for more information.
• Show Graph – Select one or more column headers in the table and then click Show Graph
to see a graph of the data. The graph shows the data at 5-minute intervals.
The following figure shows the historical log table from the Vista client view:
Event Log
The following figure shows the event log table from the Power Monitoring Expert view:
• Change Date Range – Click this to view data for different dates. See "Select Date Range"
below for more information.
2. Select an available range or click Between these dates and select specific dates in the
calendar.
If you select a date range of more than one week, a message appears to inform you that the table
will be very long.
• Data logs
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
Overview
The diagrams show status and operational details for the UPS devices.
Diagrams
UPS Auto Test diagrams are organized into 3 levels:
TIP: Click the group icon for a group in the groups summary page to open the respective group
details page.
(The colored outline boxes around the measurements indicate that the diagram in this example is
not linked to an actual UPS device.)
TIP: Click a battery icon for a UPS in the group details page to open the respective device details
page.
(The colored outline boxes around the measurements indicate that the diagram in this example is
not linked to an actual UPS device.)
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
EPSS diagrams
NOTE: These diagrams are part of the Backup Power Module. This Module requires a separate
license. The module must be configured before the diagrams can be used.
Overview
The diagrams show status and operational details for the generators and transfer switches that
are part of the EPSS system.
Diagrams
EPSS diagrams are organized into 3 levels:
In addition, there are summary pages for all the generators and all the transfer switches in the
system.
TIP: Click the group icon for a group in the groups summary page to open the respective group
details page.
(No data is shown in this example because the diagram is not linked to actual devices.)
TIP: Click a device icon for a generator or transfer switch in the group details page to open the
respective device details page.
(No data is shown in this example because the diagram is not linked to actual devices.)
Summary pages
These pages show details for all the generators and all the transfer switches that are defined in
the system.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
The breaker aging diagrams show aging and wear related details for the breaker devices. There
are three different types of diagrams: Group summary diagram, group details diagram, and
switchboard details diagram.
Example:
TIP: Click the group icon for a group in the groups summary page to open the respective group
details page.
TIP: Click the switchboard icon for a switchboard in the group details page to open the device
details page.
Related topics:
• The Diagrams user interface
• User authentication
• EPSS diagrams
For information on how to configure Diagrams, see Diagrams and graphics configuration.
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.
• Reports UI
• 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.
The following table shows the default templates and folders.
NOTE: Some report templates are part of add-on software modules for PME. Those reports are
enabled through the module licenses.
Use the following links to find the descriptions of the different report templates:
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.
Time display
See Time Display in Web Applications for information on how time is displayed in a system where
the monitoring devices, the PME/Web server, and the Web client (browser) are in different time
zones.
Terminology
See Reports Terminology for definitions of the terms used in the Reports application.
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
• Report descriptions
• Reports
• Reports UI
• Reports Terminology
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
• Report descriptions
• Reports
• Reports UI
• Reports Terminology
Report descriptions
Use the following links to find the descriptions of the different report types:
Related topics:
• Generating a report
• Downloading a report
• Report descriptions
• Reports
• Reports UI
• Reports Terminology
NOTE: These reports are part of the Backup Power Module. This module requires a separate
license.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The Generator Activity Report shows run information for backup generators, such as run times,
durations, run reason, and overall run hours. Use this report to understand and manage your
backup generator operation.
Details
• Running hours broken out into categories for Test, Power Outage, Load Shedding.
• Bar graphs for generators with the number of hours of non-emergency run time.
• A table with non-emergency and emergency run hours for each generator.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• EPSS Group
• Reporting Period
• Threshold
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The Generator Battery Health Report compares the generator starter battery voltage, during start-
up, with a reference voltage signature. Use this report to check the generator starter battery
performance and to plan preventive maintenance.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Exclude Sources
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The Generator Battery Health Export Report gives the same data as the Generator Battery Health
Report but in a CSV file format. Use this report for sharing the battery performance data with other
systems.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Exclude Sources
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The Generator Test EPSS Report shows load measurements and the sequence of events for
generator test runs. You can configure it to meet the requirements of an Emergency Power
Supply System (EPSS) test, including Automatic Transfer Switches (ATS). Use this report to
assess the performance of your backup generation systems during test runs. You can also use
this report to evaluate pass/fail criteria for EPSS testing.
NOTE: Emergency Power Supply System (EPSS) is a North American term used in the
healthcare segment. It describes an arrangement of generators and automatic transfer
switches, designed to provide backup power in case of a utility power interruption.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Company Name
• Technician Name
• Report Group
• Exclude Sources
• ATS Summary
• Generator Summary
• Events Summary
• Comments
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The Generator Load Summary Report shows load (kW, PF, Iavg, and so on) measurements
recorded during generator runs. Use this report to understand the electrical performance and
loading of your backup generator operations.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Exclude Sources
• Reporting Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The UPS Auto Test Report shows test information for UPS systems, such as test times, pass/fail
evaluation, and event logs. Use this report to assess the performance of your UPS systems
during test runs.
NOTE: You can only use this report with certain types of UPS systems. See Backup Power
Module configuration for details.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• UPS Group
• Reporting Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Backup Power Module. This module requires a separate license.
Summary
The UPS Battery Health Report compares the UPS battery voltage, during test conditions, with a
reference voltage signature. Use this report to check the UPS battery performance and to plan
preventive maintenance.
For information on the terms and calculations used in this report, see UPS Battery Health Report
calculations.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Select Waveforms
• Voltage Threshold
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Billing Reports
NOTE: These reports are part of the Energy Billing Module. This module requires a separate
license.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
For information about changing the unit cost values in a rate file used for billing reports, see the
Rate Editor tool.
Billing Report
NOTE: This report is part of the Energy Billing Module. This module requires a separate license.
Summary
The Billing Report shows a single bill with itemized energy and demand cost based on a customer
defined rate structure. It can be configured to include taxes and other charges. Use this report to
produce individual tenant energy bills, allocate cost to departments or processes, or verify utility
bills.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Tenant
• Reporting Period
• Rate
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Billing Module. This module requires a separate license.
Summary
The Billing Summary Report shows a listing of the consumption costs for multiple consumers in
one report and gives an overall total cost. Use this report to see the costs for multiple consumers
in a single report, for example for an office building with different tenants.
Details
You can select multiple tenants and multiple rates to create a single report for all your tenants.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Reporting Period
• Tenant Filter
• Order By
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Billing Module. This module requires a separate license.
Summary
The Billing Verification Report shows the difference between two bills, generated from different
data sources, or between a generated bill and a manually entered cost value. Use this report to
compare a utility bill with an internally generated bill.
Details
You can configure the report to send out an email notification if the difference in the bill values
exceeds a programmable limit.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Private Source
• Check Source
• Reporting Period
• Rate
• Notify On
• Email Address
• Email Subject
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Billing Module. This module requires a separate license.
Summary
The Multiple Billing Export Report gives the same data as the Multiple Billing Report but in an XML
file format. Use this report for sharing the billing data with third-party billing systems.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Stylesheet (optional)
• Order By
NOTE: This report is part of the Energy Billing Module. This module requires a separate license.
Summary
The Multiple Billing Report gives the same output as the Billing Report, but for more than one
consumer. Use this report to create bills for more than one customer, rather than running the
Billing Report multiple times.
Details
The output of this report is a single file, so if you choose to save or subscribe to a PDF file, then
each bill appears on its own page for review and printing purposes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Notes
• Order By
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: These reports are part of the Breaker Performance Module. This module requires a
separate license.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
NOTE: This report is part of the Breaker Performance Module. This Module requires a separate
license.
Summary
The Circuit Breaker Aging Report shows the aging and wear related status of circuit breakers.
Use this report to check the condition of your breakers and to plan preventive maintenance.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Select Group
• Grouped By
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Breaker Performance Module. This Module requires a separate
license.
Summary
The Circuit Breaker Settings Report shows the protection settings for your breakers and highlights
changes in these settings between report runs. Use this report to analyze and plan your protection
schemes and to confirm or detect protection settings changes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Select Group
• Baseline Date
• Trip Settings
• Protection Modes
• Maintenance Status
• Change Summary
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: These reports are part of the Energy Analysis Reports Module. This module requires a
separate license.
• KPI Report
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
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
See Configuring the Energy Modeling report, in the Configuring chapter of this guide, for more
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
• Dependent Variable
• Independent Variable(s)
• Reporting Period
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 Duration Curve Report shows the load (kW) levels in a system and the duration this load
persisted over the reporting period. Use this report to find opportunities for reducing peak demand
and for lowering base load.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• n % Crossing
• Reporting Period
• Target Line
• Source Label
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The Energy Regression Analysis Report uses simple regression analysis to model load behavior
with respect to an influencing driver, such as weather. Use this report to compare the
performance of your facility or of a load to the expected (modeled) behavior.
Details
See Interpreting the Energy Regression Analysis Report results for more information on this topic.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Regression Type
• Aggregation Interval
• Deviation Type
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The Energy Usage per State Report shows energy consumption for a process or load based on
certain state variables of this process or load. Use this report to understand the energy
consumption pattern of complex processes and find opportunities for efficiency improvements.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Energy Measurements
• State Measurement
• State Labels
• Rollup
• Aggregation Interval
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
KPI Report
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The KPI Report calculates a Key Performance Indicator (KPI) based on one or more input
parameters. The input parameters can be electrical and non-electrical consumption data, weather
data, and business-related data. Use this report to translate energy consumption into business
relevant information that you can use to benchmark and improve your energy productivity.
Details
To calculate the KPI, you must specify the input parameters, the formula that is used to calculate
the KPI from the input parameters, the measurement that is used to represent the KPI output
value, and a number for processing instructions. See the report inputs list below for details.
The KPI data calculated by the report can be stored in the Power Monitoring Expert database to
be used in applications such as Dashboards, Reports, VIP, ... .
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Rollup
• KPI Source
• KPI Measurement
• KPI Formula
• Reporting Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The KPI by TOU Report shows the relative energy consumption for one or more loads based on
time of use schedule. Use this report to translate energy consumption into business relevant
information that you can use to benchmark and improve your energy productivity.
Details
You can configure the report to send out an email notification if any target values (static or
calculated) are exceeded in any of the defined periods.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Multiplier
• Scale Source
• Scale Measurement
• Scale Multiplier
• Precision
• Reporting Period
• Rollup
• Chart Type
• Auto-scale Y-Axis
• Email Address
• Email Subject
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The Multi Equipment Operation Report shows how much time different equipment spends in a
certain state, the number of activations, and the average activation duration. Use this report to
gain an understanding of the operations of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
• Title
• State Measurements
• State Labels
• Reporting Period
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The Power Usage per State Report shows the power (kW) consumed by different equipment in
certain states. Use this report to gain an understanding of the operations of your facility or
processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
• Title
• Logged Measurement
• State Measurement
• State Labels
• Reporting Period
• Rollup
• Aggregation Type
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The PUE Summary Report shows the Power Usage Effectiveness (PUE) index and the average
power consumed for a data center facility. It also shows the average power consumed for the IT
equipment running in the facility. Use this report to check the efficiency of your data center facility.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• IT Equipment Source
• PUE Category
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The Single Equipment Operation Report shows how much time an equipment spends in a certain
state, the number of activations, and the average activation duration. Use this report to gain an
understanding of the operations of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
• Title
• State Measurement
• State Labels
• Reporting Period
• Rollup
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
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
• Display Mode
• Reporting Period
• Insert Data
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
• Profile Report
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
Summary
The Calendar Trend Month Report shows a daily demand profile for a load for each day of a
month. Use this report to see out-of-hours usage, benchmark performance targets, and to find
peak and off-peak usage patterns.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Start Hour
• End Hour
• Highlight Start
• Highlight End
• Reporting Period
• Target Line
• Source Label
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Calendar Trend Week Report shows a daily demand profile for a load for each day of the
week. Use this report to see out-of-hours usage, benchmark performance targets, and to find
peak and off-peak usage patterns.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Start Hour
• End Hour
• Highlight Start
• Highlight End
• Reporting Period
• Target Line
• Source Label
• Auto-scale Y-Axis
• Show Notification
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Consumption Ranking Report shows the relative ranking of energy consumption for one or
more loads. Use this report to gain an understanding of the operations of your facility or
processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Multiplier
• Scale Source
• Scale Measurement
• Reporting Period
• Select
• Select Number
• Source Label
• Include Chart
• Include Gauges
• Include Tables
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Device Replacement Report shows the device last replacement date and the next date for
replacement. Use this report to understand and manage your device replacement operation.
Prerequisites
Report inputs
• Title
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Energy Comparison Report converts different types of energy measurements to a common
energy unit and then normalizes it by criteria, such as area. Use this report to benchmark building
or process energy performance.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Energy Measurements
• Rollup
• Reporting Period
• Chart Type
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Energy Cost Report shows energy and demand cost based on time of use and flat rate
energy and demand charges. Use this report for internal cost allocation or utility bill verification.
Details
or
• Set a flat rate on the Energy and Demand tab of the Energy Rates dialog. See Rates report
input description for more information.
NOTE: This report is intended to be used for positive power flow applications only (where kW
and kvar are both positive). Use with bi-directional flow gives incorrect results.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Rates
• Reporting Period
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Energy Period over Period Report shows energy consumption for one or more loads for two
different time periods. Use this report to detect changes in consumption over time, for example
this month vs. the same month last year.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurement
• Auto-scale Y-Axis
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Energy Usage Report shows energy consumption for one or more loads, rolled up by day,
week, month, or year. Use this report to compare energy consumption for different loads and gain
an understanding of the operations of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Rollup
• Start Hour
• End Hour
• Source Label
• Include Gauges
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Energy Usage by Shift Report shows energy consumption for one or more loads broken
down by shifts. Use this report to compare energy consumption for different loads and gain an
understanding of the operations of your facility or processes.
Details
NOTE: If you generate a report before the end of a shift that spans midnight, a portion of the
usage data for that shift is included under the equivalent shift for the current day.
Example:
3. You generate the report on day 8 before 7:00 a.m., that is, before the end of
Shift 3 for day 7.
The generated report will include usage data under Shift 3 for day 8. However, this
shift 3 usage data is the portion of shift 3 from the previous day (day 7) that occurred
after midnight. In addition, this allocation of usage data to the next day for shift 3
from midnight to 7:00 a.m. occurs for all the days throughout the reporting period.
To avoid this situation, select specific days (Fixed Date) for the Reporting Period.
Prerequisites
Report inputs
• Title
• Sources
• Measurement
• Reporting Period
• Rollup
• Shifts
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Energy Usage by TOU Report shows energy consumption for one or more loads based on a
Time of Use (TOU) schedule. Use this report to compare energy consumption for different loads
and gain an understanding of the operations of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Rollup
• Chart Type
• Source Label
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Load Profile Report shows demand or load levels, including peak demand, over the reporting
period. Use this report to understand the power consumption patterns of your facility or
processes.
Details
The Load Profile report template uses similar measurements as the Energy Cost report template
but does not use a TOU schedule.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurements
• Reporting Period
• Auto-scale Y-Axis
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Measurement Aggregation Report gives aggregated logged measurement data in tabular
format. The aggregation intervals are configurable, and the report supports aggregation by time of
use. Use this report to understand the consumption patterns of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurements
• Reporting Period
• Rollup
• Source Label
• Show Totals
• Show Header
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Data Exchange Module. This module requires a separate
license.
Summary
The Measurement Aggregation Export Report gives aggregated logged measurement data in
tabular format. It provides the same data as the Measurement Aggregation Report but in CSV,
RepGen compatible, or Tidy file export formats. Use this report to share consumption data with
third-party systems or for use in existing RepGen reports.
NOTE: RepGen is a Microsoft Excel based reporting system that was part of earlier versions of
PME.
NOTE: The output file of this report is saved to the PME server, not the web client computer.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Sources
• Measurements
• Reporting Period
• Rollup
• Base Interval
• Overwrite File
• Export Format
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Measurement Statistics Report gives a statistics of logged measurement data in tabular and
chart format. The statistics intervals are configurable and the report supports statistics by time of
use. Use this report to understand the consumption patterns of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurements
• Reporting Period
• Statistics Period
• Include Chart
• Sort By
• Sort Order
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Data Exchange Module. This module requires a separate
license.
Summary
The Measurement Statistics Export Report gives a statistics of logged measurement data in
tabular format. It provides the same data as the Measurement Statistics Report but in CSV file
export format. Use this report to share consumption data with third-party systems.
NOTE: The output file of this report is saved to the PME server, not the web client computer.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurements
• Reporting Period
• Statistics Period
• Sort By
• Sort Order
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Profile Report
Summary
The Profile Report shows all measurements over the reporting period. Use this report to
understand all the measurements patterns of your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Auto-scale Y-Axis
• Target Line
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Scaled Energy Usage Report shows the relative ranking of energy consumption for one or
more loads, rolled up by day, week, month, or year. Use this report to compare energy
consumption for different loads and gain an understanding of the operations of your facility or
processes.
Details
This report provides the same data as the Energy Usage Report and additionally sources and
measurements can be scaled with another source and measurement. The report also provides
tabular information with raw and normalized values of the measurements. All normalization
calculations are made at interval level. Each interval level is calculated individually to
accommodate for frequently changing scale date.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Multiplier
• Scale Source
• Scale Measurement
• Reporting Period
• Rollup
• Start Hour
• End Hour
• Source Label
• Include Gauges
• Include Tables
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
General Reports
PME includes the following general report templates:
• 100 ms Report
• Dashboard Report
• Tabular Report
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
100 ms Report
Summary
The 100ms Report shows 100 ms measurements from PowerLogic™ Circuit Monitors, for
example CM4000 in a tabular format. Use this report to analyze high speed data samples from
these devices.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurements
• Reporting Period
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Continuous Thermal Monitoring Report shows the status of the thermal monitoring system.
The thermal monitoring system includes Low Voltage Switchboards, Medium Voltage
substations, and Low Voltage Busways, which are equipped with temperature and environmental
sensors. The report shows the alarm status, communication error, and normal data points
information. Use this report to understand and manage the thermal monitoring system status.
Prerequisites
The thermal monitoring system must be connected to PME. See Thermal Monitoring of Low
Voltage (LV) Busways and Thermal Monitoring of Medium Voltage (MV) Substations for more
information.
Report inputs
• Title
• Sources
• Reporting Period
• Include Chart
• Auto-scale Y-Axis
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Dashboard Report
Summary
The Dashboard Report shows screen captures of a dashboard slideshow in a landscape page
layout. Use this report to share dashboard and Web content in any of the supported report
formats, such as PDF and so on.
Details
You can include the screen capture of an additional, custom page, by specifying the page URL.
TIP: Create separate slideshows for each dashboard page you want to report on.
Prerequisites
Report inputs
• Title
• Page Size
• Slideshows
• Custom URL
Summary
The Dashboard - Portrait Report shows screen captures of a dashboard slideshow in a portrait
page layout. Use this report to share dashboard and Web content in any of the supported report
formats, such as PDF and so on.
Details
You can include the screen capture of an additional, custom page by specifying the page URL.
TIP: Create separate slideshows for each dashboard page you want to report on.
Prerequisites
Report inputs
• Title
• Page Size
• Slideshows
• Custom URL
Summary
The Data Export - Extended Report gives logged measurement data in CSV file format. Use this
report to import and analyze data in a third-party application, such as Microsoft Excel.
NOTE: This report has more details than the Data Export - Standard Report, but it supports a
smaller data set.
Details
The data is organized in columns labeled Timestamp UTC, Timestamp, Value, Source,
Measurement, and Unit. This makes it easier to create an Excel pivot table for analyzing the data
in the file. The data is listed for each source and measurement by date and in the specified time
segments for the data. This report can export 80 source measurements for 10 months.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Include Duplicates
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Data Export - Standard Report gives logged measurement data in CSV file format. Use this
report to import and analyze data in a third-party application, such as Microsoft Excel.
NOTE: This report has fewer details than the Data Export - Extended Report, but it supports a
larger data set.
Details
The data is organized by column, with column A labeled Timestamp. The remaining columns are
labeled with the source name and measurement. The data is listed by date and in the specified
time segments for the data. This report can export 600 source measurements for 11 months.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Include Duplicates
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Event History Report gives a tabular list of event log entries for the selected sources. Use this
report to analyze system events, for example for root cause analysis or sequence of events
analysis.
Details
If no event has occurred that matches the inputs entered when generating the report, no data is
returned.
Prerequisites
• None
Report inputs
• Title
• Sources
• Reporting Period
• Priority
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The System Configuration Report shows details about the monitoring devices in your network,
including communications information. Use this report for device and communications network
inventory and planning.
Prerequisites
• None
Report inputs
• Title
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Tabular Report
Summary
The Tabular Report gives logged measurement data in tabular format. Use this report to analyze
logged data.
Details
You can create a report with multiple measurements from multiple sources. You can also select
the option to include duplicate data in the report. This data can then be exported for use in another
program, such as Microsoft Excel. If you want to only export your data to an Excel file, use the
Data Export - Extended report or the Data Export - Standard report.
NOTE: The Tabular Report is limited to 30 source-measurement pairs. Multiple reports are
required if the number of source-measurement pairs exceeds 30. Alternatively, consider using
the Data Export - Standard report or the Data Export Extended report to generate a CSV file
containing the data for the selected sources and measurements.
The generated report contains the following information: source; measurement; timestamp; and
values.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Source Label
• Include Duplicates
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: These reports are part of the Insulation Monitoring Module. This module requires a
separate license.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
NOTE: This report is part of the Insulation Monitoring Module. This Module requires a separate
license.
Summary
The Insulation Monitoring (ANSI) Report shows Total Hazard Current, relevant event log entries,
and logged insulation related measurements, over the reporting period. Use this report to analyze
and report on the insulation status of your ungrounded IT power system.
Details
• A data log table, showing Total Hazard Current measurements and other meter data.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Area
• Reporting Period
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Insulation Monitoring Module. This Module requires a separate
license.
Summary
The Insulation Monitoring (IEC) Report shows resistance, transformer load, relevant event log
entries, and logged insulation related measurements, over the reporting period. Use this report to
analyze and report on the insulation status of your ungrounded IT power system.
Details
• A data log table, showing measurements for impedance, load, and temperature.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Area
• Reporting Period
NOTE: This example only shows selected content from the report, it does not show the entire
report.
IT Billing Reports
NOTE: These reports are part of the Energy Billing Module. This module requires a separate
license.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
NOTE: This report is part of the Energy Billing Module. This module requires a separate license.
Summary
The Energy by IT Customer Report gives consumption data for different IT customers, down to
the rack and circuit level. Use this report to understand the consumption of IT customer loads in
your data center, and for exporting billing system information.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Facility Name
• Facility Location
• Customers
• Reporting Period
• Report Type
• Timestamp Coincidence
• Display Billing ID
• Show Errors
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: These reports are part of the Capacity Management Module. This module requires a
separate license.
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The Branch Circuit Power Report shows branch circuit loading for different IT customers. Use this
report for proactive capacity management, incident management, customer expansion planning,
and Service Level Agreement (SLA) management.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Facility Name
• Facility Location
• Customers
• Reporting Period
• Primary Sort
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The Equipment Capacity Report shows loading (kW) and available capacity for equipment such
as transformers, transfer switches, and so on. Use this report for capacity analysis and planning.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• EPSS Group
• Exclude Sources
• Reporting Period
• Threshold
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The Generator Capacity Report shows loading (kW) and available capacity for backup generator
systems. Use this report for generator system capacity analysis and planning.
Details
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• EPSS Group
• Exclude Sources
• Reporting Period
• Aggregation Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The Generator Power Report shows system loading compared to backup generator rating and
redundancy design limits. Use this report for backup power system capacity analysis and
planning.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Facility Name
• Facility Location
• Report Data
• Reporting Period
• Aggregation Data
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The Power Load Demand & Capacity Report shows a comparison of the load capacity and the
applied load, for example for an automatic transfer switch (ATS). The peak load vs. capacity is
shown for preset reporting intervals (last: 5 minutes, hour, 24 hours, 30 days, 12 months) and per
month for the entire available data range. Use this report to analyze and monitor the loading and
compliance of equipment such as an ATS.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
NOTE: This report is designed to be used with Active Power (kW) measurements.
• Title
• Demand Rating kW
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The Power Losses Report shows losses (kW and cost) in transformers and UPS systems. The
cost calculations are based on a configurable flat rate energy cost. Use this report to analyze and
quantify the power losses in your transformer and UPS networks.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Facility Name
• Facility Location
• Reporting Period
• Aggregation Data
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Capacity Management Module. This Module requires a separate
license.
Summary
The UPS Power Report shows system loading compared to UPS backup power rating and
redundancy design limits. Use this report for backup power system capacity analysis and
planning.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Facility Name
• Facility Location
• Report Data
• Reporting Period
• Aggregation Data
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: The Power Quality Analysis and Power Quality Impact reports are part of the Power
Quality Performance Module. This module requires a separate license.
• EN50160:2010 Report
• IEC61000-2-4 Report
• IEC61000-4-30 Report
• SARFI Report
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
EN50160:2000 Report
Summary
The EN50160:2000 Report shows an analysis of the compliance of selected sources based on
the EN50160:2000 power quality standard. Use this report for an analysis and compliance
assessment of your facility against the EN50160:2000 power quality standard.
NOTE: This report needs data from monitoring devices with EN50160:2000 monitoring
capabilities.
Details
EN50160:2000 is a set of power quality standards used by certain energy suppliers and energy
consumers.
The EN50160:2000 report uses the following measurements:
• Supply voltage dips
• Temporary overvoltage
• Harmonic voltage
• Interharmonic voltage
• Frequency
• Voltage magnitude
• Flicker
The compliance summary in the report is based on the EN50160 2000 limits for each observation
period.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Evaluation Limits
• Reporting Period
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The EN50160:2000 Mains Signaling Report shows an analysis of the compliance of selected
sources based on the mains signaling specifications of the EN50160:2000 power quality
standard. Use this report for an analysis and compliance assessment of your facility against the
EN50160:2000 power quality standard.
NOTE: This report needs data from monitoring devices with EN50160:2000 monitoring
capabilities.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs:
• Title
• Sources
• Signaling Voltage
• Reporting Period
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
EN50160:2010 Report
Summary
The EN50160:2010 Report shows an analysis of the compliance of selected sources based on
the EN50160:2010 power quality standard. Use this report for an analysis and compliance
assessment of your facility against the EN50160:2010 power quality standard.
NOTE: This report needs data from monitoring devices with EN50160:2010 monitoring
capabilities.
Details
EN50160:2010 is a set of power quality standards used by certain energy suppliers and energy
consumers.
The EN50160:2010 report uses the following measurements:
• Supply voltage dips
• Temporary overvoltage
• Harmonic voltage
• Interharmonic voltage
• Frequency
• Voltage magnitude
• Flicker
Prerequisites
The measurement data must be available as historical data logs in the database.
Use the EN50160:2010 report template to create a report containing comprehensive analysis of
all EN50160 2010 compliance data logged by multiple meters. The compliance summary is based
on the EN50160 2010 limits for each observation period: each default EN50160 measurement
indicates a pass or did not pass on the compliance test with a Y (yes) or N (no) respectively.
Report inputs
• Title
• Sources
• Evaluation Limits
• Reporting Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The EN50160:2010 Mains Signaling Report shows an analysis of the compliance of selected
sources based on the mains signaling specifications of the EN50160:2010 power quality
standard. Use this report for an analysis and compliance assessment of your facility against the
EN50160:2010 power quality standard.
NOTE: This report needs data from monitoring devices with EN50160:2010 monitoring
capabilities.
Prerequisites
The measurement data must be available as historical data logs in the database.
Use the EN50160:2010 Mains Signaling report template to create a report for signal line
frequency statistics for multiple sources, for each observation period.
Report inputs:
• Title
• Sources
• Signaling Voltage
• Reporting Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Harmonic Compliance Report shows an analysis of the harmonic compliance of selected
sources based on the IEEE 519-1992 standard. Use this report for an analysis and compliance
assessment of your facility against the IEEE 519-1992 harmonics standard.
NOTE: This report needs data from monitoring devices with IEEE 519-1992 monitoring
capabilities.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Comments
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Harmonic Compliance Report shows an analysis of the harmonic compliance of selected
sources based on the IEEE 519-2014 standard. Use this report for an analysis and compliance
assessment of your facility against the IEEE 519-2014 harmonics standard.
NOTE: This report needs data from monitoring devices with IEEE 519-2014 monitoring
capabilities.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Comments
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
IEC61000-2-4 Report
Summary
NOTE: This report needs data from monitoring devices with IEC61000-2-4 monitoring
capabilities.
The IEC61000-2-4 report shows the following types of disturbances and the corresponding
compatibility level:
• Voltage deviations
• Voltage unbalance
• Harmonics up to order 50
• Transient overvoltages
Prerequisites
• The measurement data must be available as historical data logs in the database.
• Devices PM8000 and ION9000 are only supported. The custom framework for these devices
should be deployed. The custom framework for these devices are available in {root
install folder}\config\fmwk\IEC61000-2-4.
NOTE: On deployment, the custom framework replaces the entire existing framework and
the existing framework is lost. To deploy the custom framework, see Pasting a node's entire
configuration into another node.
Report inputs
• Title
• Environment Class
• Reporting Period
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
IEC61000-4-30 Report
Summary
The IEC61000-4-30 Report shows an analysis of power quality relevant measurements that were
taken in compliance with the IEC61000-4-30 standard. Use this report for a power quality analysis
of your facility based on the IEC61000-4-30 measurement standard.
NOTE: This report needs data from monitoring devices with IEC61000-4-30 monitoring
capabilities.
• THD profile
• Unbalance profile
• Flicker profile
• Frequency profile
• Summary table
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Measurement Interval
• Reporting Period
• Source Label
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Power Quality Report shows the number and severity of voltage sags, swells, and transients
over a period of time. It includes waveform signatures and susceptibility curve plots, such as
CBEMA (1996), CBEMA (Updated), ITIC, or SEMI F47. Use this report to analyze power quality
(PQ) incidents, to assess possible impacts of PQ events on your facility or processes, and to help
identify causes of PQ events.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Sources
• Incident Interval
• Reporting Period
• Source Label
• Sub-reports
Incident details:
When you use the Generate Dynamically sub-reports option, you can view details of an incident
by clicking the link in the TimeStamp column in the table.
Detailed information about a single power quality incident is displayed, including:
• A CBEMA (1996), CBEMA (Updated), ITIC, or SEMI F47 curve containing the power quality
disturbances for the selected incident. (The curve used in the plot is dependent on the overlay
options you select for the report.)
• The timestamps, types, phases, duration, and magnitude of disturbances in the selected
incident, with the worst event in the selected incident highlighted (worst event = largest
magnitude x duration).
• The power quality settings of the device that registered the disturbance (for example,
sag/swell limits, transient threshold, and so on).
To return to the summary report, use the report section back button on the report toolbar.
Waveform details:
When you use the Generate Dynamically sub-reports option, you can view the waveform details
of an incident by clicking the waveform icon in the incident details table in the Incident sub report.
The waveform details include all the waveforms that were recorded for a disturbance. It displays a
waveform chart along with an optional table with waveform values.
The following waveform plots and data are displayed, based on the timestamp selected:
• A summary waveform plot, displaying a plot of the V1, V2 and V3 waveforms.
V2 and I2
V3 and I3
• If the source queried has digital input logging enabled over the time interval of the waveforms,
a waveform showing the digital input status.
• The timestamp for the time the waveforms were triggered.
To return to the summary report, use the report section back button on the report toolbar.
NOTE: For incident sub-reports with multiple events, some events might reference the same
waveform recording. This can happen if the time interval between events is very short. In that
case, the waveform and event trigger times for these events do not match exactly.
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
SARFI Report
Summary
The System Average RMS Variation Frequency Index (SARFI) Report shows the count of voltage
sags and / or swells for the selected sources based on the SARFI indices. Use this report to
analyze voltage sag and / or swell incidents, to assess possible impacts on your facility or
processes, and to help quantify the performance of power system.
Details
SARFI index is a power quality index that provides a count of voltage sags and / or swells for one
or more selected sources. There are two types of SARFI indices: SARFI-X and SARFI-Curve:
• SARFI-X corresponds to a count of voltage sags and / or swells below or above a specified
voltage threshold. This report supports the following SARFI-X indices:
SARFI 10
SARFI 50
SARFI 70
SARFI 80
SARFI 90
SARFI 110
SARFI 120
SARFI 140
For example, SARFI-70 counts the voltage sags that are below 70% of the reference
voltage. SARFI-110 counts the voltage swells that are above 110% of the reference
voltage. SARFI indices assess duration of RMS variation based on the selected duration.
• SARFI-Curve corresponds to a rate of voltage sags below an equipment compatibility curve.
This report supports the following SARFI Curves:
SARFI ITIC
SARFI SEMI
For example, SARFI ITIC counts voltage sags that are below the lower ITIC curve. SARFI
SEMI counts voltage sags that are below SEMI curve.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Source Filter
• Duration (sec)
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The System Average Interruption Frequency Index (SAIFI) / System Average Interruption
Duration Index (SAIDI) report is use to measure the Distribution System Reliability.
• average outage
• reliability factors
SAIFI / SAIDI reports are generated based on the data from ION meters selected in the report
configuration.
Supported devices are ION 7300, ION 7330, ION 7350, ION 7500, ION 7600, ION 7700, PM8000,
ION 8400, ION 8500, ION 9000, ION 8300, ION 7550, ION 7650, ION 8600, ION 8800, ION 8650,
ION 8600C, ION 8650C, ION 8800C, ION 7400, ION 7400 Essential, PM8000 Essential.
RECOMMENDATION: Select the meters at the feeder level and not at the sub-feeder level.
Details
SAIFI is the average number of sustained interruptions per consumer per year / average number
of times, in a system outage during a period. It is the ratio of the annual number of interruptions to
the number of consumers.
SAIDI is the average duration of interruptions per consumer per year / month / day. It is the ratio of
the aggregate annual duration of interruptions (sustained) to the total number of consumers
served.
SAIDI = (Number of consumers * Total Sustained Interruption Time) / (Total number of consumers
including all feeders)
Prerequisites
A configuration settings must be done in the PME web Settings > System > SAIFI SAIDI
Configuration page for:
• Sustained Interruption - Set the outage duration between 1 - 59 minutes only.
• Adding / editing / removing the ION devices and adding the number of consumers:
Select the ION devices for which you want to have the report.
To add / edit a device, select the device and you will get a new window. Enter the Name
and Number of consumers. select OK, then select Save Configuration to save the
data.
To remove a device, unselect the device. select OK, then select Save Configuration to
save the data.
The devices added in this configuration file are listed in the SAIFI / SAIDI report sources.
For example:
Report inputs
• Title
• Sources
• Reporting Period
Example:
Item Details
Total time Number of days * 24
Total Available time Total time - (momentary + sustained) interruption time
% of availability Total Available time / Total time
(Number of consumers at feeder level * Number of interruptions) /
SAIFI
(Total number of consumers including all feeders)
(Number of consumers * Total Sustained Interruption Time) /
SAIDI
(Total number of consumers including all feeders)
Data Notification It provides you the details of the notification.
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Power Quality Performance Module. This Module requires a
separate license.
Summary
The Power Quality Analysis Report shows power quality (PQ) summary information, such as
breakdowns of PQ event types, impact, and location. It also includes information on disturbances
(harmonics, unbalance, and so on) and power factor. Use this report to help you understand the
power quality in your facility, reduce downtime, and increase equipment reliability and availability.
Details
Depending on the events and disturbances you select, the generated report provides data
categorized as follows:
• Power Quality Event Summary, consisting of Power Quality Events Breakdown, Power
Quality Events Impact, and Power Quality Events Location.
Power Quality Events Breakdown shows the percent distribution of the events in a pie
chart.
Power Quality Events Impact shows a percent distribution of the events with a likely
impact and no impact in a pie chart.
Power Quality Events Location shows the distribution of the number of events in a bar
chart with likely impact and no impact identified for each of the External, Internal, and
Undetermined locations.
• Power Quality Events — Details, consisting of events impact and events location for each
detected event. and Disturbance Details for each detected disturbance.
Events Impact shows the number of each event type with a likely impact and no impact.
Events Location provides a distribution of the number of each event with a likely impact
and no impact in External, Internal, and Undetermined locations.
• Power Quality Disturbances — Details, consisting of a graphical representation of the
distribution for each disturbance followed by a data table containing measurement and value
details.
See Power Quality Performance events and disturbances for additional information.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Related
• Power Quality Events Breakdown, Power Quality Events Impact, and Power Quality Events
Location gadgets – provide a graphical representation of power quality events.
Report inputs
• Title
• Sources
• Reporting Period
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
NOTE: This report is part of the Power Quality Performance Module. This Module requires a
separate license.
Summary
The Power Quality Impact Report shows the financial impact of power quality related downtime.
The impact calculations are based on a configurable, flat rate downtime cost. Use this report to
see the cost of power quality related events to your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Related
• Power Quality Impact gadget – provides a graphical representation of external. internal, and
undetermined power quality events.
• Power Quality Analysis Report– provides summarizes power quality events and disturbances
occurring in a production environment.
Report inputs
• Title
• Group
• Reporting Period
• Event Location
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
• Trend Report
CAUTION
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.
Failure to follow these instructions can result in injury or equipment damage.
Summary
The Hourly Usage Report shows the consumption rate, per hour, of various types of utilities, such
as electricity, water, and so on, for different consumers for a specific day. Use this report to check
and analyze resource consumption in your facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Reporting Period
• Target Line
• Source Label
• Include Chart
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Multi Device Usage Report shows daily consumption for various types of utilities, such as
electricity, water, and so on, for different consumers. Use this report to check and analyze
resource consumption in your facility or processes.
Details
NOTE: The measurements that you select for the devices need to provide equivalent data
results. For example:
• Correct:
The report provides a summary of consumption by one or more sources, an interval usage table,
and a pie chart.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Rollup
• Reporting Period
• Source Label
• Chart Type
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Multiple Trend Report shows aggregated logged measurement data from multiple loads in a
tabular and visual display and as a trend plotted on separate axes. The aggregation intervals are
configurable. Use this report to compare different loads.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Left Axis High Target Line and Right Axis High Target Line
• Left Axis High Target Name and Right Axis High Target Name
• Left Axis Low Target Line and Right Axis Low Target Line
• Left Axis Low Target Name and Right Axis Low Target Name
• Reporting Period
• Rollup
• Chart Type
• Source Label
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Summary
The Single Device Usage Report shows daily consumption of a certain type of utility, such as
electricity, water, and so on, for a certain consumer. It includes a trend display showing the daily
consumption side-by-side. Use this report to check and analyze resource consumption in your
facility or processes.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Rollup
• Reporting Period
• Source Label
• Auto-scale Y-Axis
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
Trend Report
Summary
The Trend Report shows logged measurement data for multiple loads as a trend plot on the same
axis. Use this report to compare different loads.
Details
NOTE: The Trend Report is limited to 30 source-measurement pairs. Multiple reports are
required if the number of source-measurement pairs exceeds 30.
NOTE: The Trend Report was upgraded in Power Monitoring Expert 7.2.1 to include two new
parameters: Include Data Table and Include Duplicates.
Trend Reports with subscriptions created prior to version 7.2.1 need to be updated and saved
with the new parameters. To update a Trend Report:
• Open each saved Trend Report. The new parameters are visible in the display pane.
Prerequisites
• The measurement data must be available as historical data logs in the database.
Report inputs
• Title
• Chart Type
• Reporting Period
• Source Label
• Target Line
• Auto-scale Y-Axis
• Include Duplicates
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
System integration
This section provides information on how to use Power Monitoring Expert with other
EcoStruxure™ systems.
Use the links in the following table to find the content you are looking for:
Topic Content
Detailed configuration information on accessing data in an
Integration with EBO
integrated system of PME with EcoStruxure Building Operation.
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.
2. Accessing Reports
See Reports for details on how to use reports.
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.
Trends
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 Trends application to monitor current system conditions by displaying real-time data in a
graphical format. You can configure trends to view historical data, or you can combine real-time
data and historical data in the same trend. In addition, you can save the trend data as a csv file.
TIP: You can open the Trends application from the TRENDS link in the Web Applications
banner.
Time display
See Time Display in Web Applications for information on how time is displayed in a system where
the monitoring devices, the PME/Web server, and the Web client (browser) are located in different
time zones.
For information on how use the Trends application, see The Trends user interface.
Vista
Vista is the PME component that displays and controls your power monitoring system.
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.
For information on starting and logging on to Vista or ending your Vista session, see Getting
started.
For information on opening or generating a Vista diagram, see Generating, opening and closing a
user diagram.
The following image illustrates the Vista interface with a user diagram showing real-time values.
Toolbar
The toolbar offers quick access to the commands that are used most frequently. Each command
on the toolbar is also available from the menus.
A Open G Cut
B Save H Copy
C Zoom I Paste
D Fit to window J Layout
Restore to
E K Up One Level
100%
Plot Selected
F L Help
Data
Zoom
Select View > Zoom In or click the Zoom button to change the mouse pointer to a crosshair. Use
this pointer to drag an outline around the area you want to enlarge.
Restore to 100%
Select View > Restore to 100% or click the Restore to 100% button to return to the normal view.
Fit to Window
Select View > Fit to Window or click the Fit to Window button to force the user diagram to fit in
the current window.
Up One Level
Select File > Up One Level or click the Up One Level button to return to the previously displayed
window. Note that this also closes the current window. If you want to be prompted when you reach
the top level of a diagram, make sure Options > Browse closes active window is selected.
Workspace
The main area in the center of the Vista screen is the workspace. The workspace is used to
display information such as user diagrams and data and event viewers.
Status Bar
The status bar displays:
• The status line, which describes any active processes and provides a brief description of the
currently selected command or toolbar button.
• The current time on the workstation.
Toolbox
In Edit mode, the toolbox also appears on the screen. You can add objects to the user diagram
using the toolbox. See Creating and customizing a user diagram for more information on the
toolbox and Edit mode.
Select Options > Browse closes active window to have each window that you open replace
the previous one. This option is selected by default. Without this option selected, any previously
opened windows remain open.
Arrange All
Select Window > Arrange All to tile all open windows in the workspace.
When instructed to click a diagram object, either single-click or double-click, depending on the
mode you are in.
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: To configure a grouping object to open a grouping window, see Specifying an action
for numeric, status, or grouping objects.
• Grouping windows are a type of folder or “sub-window” that contain diagram objects. Vista
uses grouping windows to logically organize diagram objects within a user diagram. When
closed, a grouping window is usually represented by a grouping object icon.
TIP: It is better to use grouping objects to open other user diagrams rather than to open grouping
windows. Large numbers of grouping windows in a user diagram can slow the performance of
Vista.
You can create as many user diagrams as you want and edit each one to suit your needs. You
can share user diagrams with multiple users over your network, and users can view them
simultaneously and share the same information. For more information on creating user diagrams,
see Creating and customizing a user diagram.
The default diagram displays real-time data. It includes a simple power system illustration that
displays the various real-time parameters measured by the device.
The network diagram displays your entire power monitoring system by linking to individual default
user diagrams that display data from each device in your system. When you generate a network
diagram, Vista automatically locates all devices in your system and displays them. This diagram is
saved with the default name “network.dgm”.
The network diagram appears in the workspace containing icons that represent groups of
devices on your system.
2. Click on one of the grouping objects to open a window and display the node icons contained
within.
3. Click a node icon to display the user diagram for the associated device.
NOTE: Regenerating a network diagram and saving it overwrites the previously saved
(network.dgm) file.
2. Navigate to the user diagram you want to open and select it from the Open Diagram dialog.
To set a specific Vista workspace and set of diagrams to open every time a given user logs on:
5. Locate the .wsu file for the user you are setting up (i.e., <username>.wsu). Right-click and
select Properties.
NOTE: Applying the Read-only attribute prevents the workspace information from being
modified, so Vista opens the same way for a given user every time. The user can still modify and
save user diagrams (if allowed by their access level).
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.
There are seven types of diagram objects: grouping, text, numeric, status, data log viewer, event
log viewer, and control. Each type of object performs a specific type of function.
In most cases, you can identify an object's function by a caption, a label, or both (the text object
does not use a caption or a label).
• By default, the caption is usually located below the diagram object and identifies the node to
which the diagram object is connected. The caption can be modified to display a custom
description. See Caption options for more information.
• When a label is used, it is usually displayed to one side of the diagram object. By default, the
label identifies the register (on the node) to which the diagram object is connected. The label
can be modified to display a custom label name. See Text options for more information.
TIP: To toggle between default labels and custom labels, select or clear Options > Show
Default Labels. You can identify the type of diagram object by pointing to it with the mouse. The
object type appears on the status line.
The stale data settings are user-configurable on a per-diagram basis, and can be customized by
anyone with the necessary access level.
To change the amount of time (in seconds) that Vista uses to identify stale data:
1. Ensure that the Toolbox is open (Options > Show Toolbox), right-click the background of
the diagram and click Properties.
2. Click the Updates tab and change the settings in the Stale Data section.
3. Click OK.
2. Click the Edit button for the flag color you want to change, select the new color and click OK.
To increase the timeout period of a Vista query, a new entry to the registry of ION_SERVER
needs to be created, and the Query Server connect timeout period needs to be increased.
NOTICE
IRREVERSIBLE OPERATING SYSTEM DAMAGE OR DATA CORRUPTION
Before making any changes, back up your Windows Registry in a network folder or other
remote location.
Failure to follow these instructions can result in irreparable damage to the operating
system of the computer and all existing data.
NOTE: Registry edits must be performed only by qualified and experienced personnel.
1. Select Start > Run and type regedit in the Run window to open the registry.
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Schneider Electric\Power
Monitoring Expert\x.x
3. Right-click an empty area in the pane on the right and select New > DWORD Value.
The timeout period is 60 (for 60 seconds) by default. You can increase the value to 120
initially. If timeouts still occur, modify the value to 180.
NOTE: If your system installation includes Client machines running Vista, you need to update
the registry for each one.
1. Open the Power Monitoring Expert folder and double-click the Designer icon to start
Designer.
2. Select File > Open > QUERYSERVER.host_name (where host_name is your workstation
name) to open the Query Server node.
3. Double-click the Query Modules grouping object, then right-click the query module to open
its setup dialog.
Depending on their configuration, numeric objects can display data in different formats:
alphanumeric, dial, horizontal or vertical bar, or scrolling graph.
See Customizing the display of a numeric object for more information on configuring numeric
objects.
When used on a dial display, flags appear as colored areas on the dial. When used on other types
of numeric objects, flags change the object's background color to indicate that a Low, Low Low,
High, or High High limit is currently exceeded. To view or change the default colors, select
Options > Flag Colors.
The following image depicts a Low Limit of 140, a Low Low Limit of 60, a High Limit of 260, and a
High High Limit of 340. The portion of the dial between 140 and 260 is transparent in Vista (the
background color fills that portion of the dial), and is white in the Web-based Diagrams
application.
NOTE: To see changes made in Vista appear in Web Application Diagram, after modifying flag
colors or any other changes close Vista. When you close Vista, ..\Program Files
(x86)\Schneider Electric\Power Monitoring
Expert\config\cfg\ud\supervisor.wsu gets updated, which is used by Web Application
Diagram.
TIP: If you need only Low Low and High High limits, set the Low limit equal to the Low Low limit
and the High limit equal to the High High limit.
Flag colors are stored in the workspace file on a per-user basis. They are configurable and can be
customized by anyone who has the necessary access level. See Display options for more
information on configuring flags.
The default status object appears as an indicator light that changes color to indicate various
conditions. Gray indicates the status object is not linked or not receiving data.
Like most diagram objects, status objects can be modified by any user with an appropriate access
level. Depending on how a status object has been configured, its appearance and function can
differ significantly from the default settings.
You can specify that it appear as an alphanumeric display or you can select custom images
representing different conditions, for example for ON, OFF, and Unconnected. See Customizing
the display of a status object for more information.
NOTE: In some cases, the active state of a status object may have been changed (inverted) so
that an active state appears as inactive and vice versa. See Customizing a diagram object for
more information.
and alarms associated with the active user diagram. Each Event Log Viewer is associated
with a single user diagram.
You can select any data displayed in a Data Log Viewer and plot it as a graph or copy it to another
application (for example, Microsoft Excel) where you can perform advanced calculations or
include it in a report.
See Using the Query options for information on log viewer configuration.
Click on a Data Log Viewer object in your user diagram. The Data Log Viewer appears.
Each Data Log Viewer displays data as a table of columns and rows. Each labeled column
contains a single type of data and each numbered row represents a single data record.
1. Highlight the cells containing the data that you want to plot. The range of data can be
selected in one of three ways:
To graph trends for all parameters over a particular time span, select a group of rows.
To graph the trend for a specific parameter using all available records, select the entire
column.
To graph multiple parameters over a specific time span, click on the first cell in the
desired range then drag to highlight the last cell of the range.
The Log View Plotter window appears, displaying a graphical representation of the selected
data. See Plotting logged data for more information.
TIP: To quickly plot a single waveform, double-click on its waveform symbol in the Data Log
Viewer.
2. Select Edit > Copy or click . This copies the selection to the Windows Clipboard.
associated with a single user diagram, so alarms only update when the user diagram is open.
See Using the Query options for information on log viewer configuration.
Click an Event Log Viewer object in your user diagram to open the Event Log Viewer.
The Event Log Viewer displays logged events in a table of columns and rows. Each labeled
column contains a single category or event description and each numbered row represents a
single event record.
Typically, Event Log Viewers display the following information:
• Timestamp: This indicates the event’s date and time.
• Priority: This determines the relative significance of the event. Each type of event has a
numeric value assigned to it that represents its relative priority level.
• Cause: This is the label and value describing the cause of the event. For example, if the label
is “Setpoint #1” and the value is “Active,” then the event was caused by setpoint #1 changing
to an active state.
• Effect: This is the label and value describing the effect of the event. For example, if label is
“Relay #1” and the value is “Forced On,” then the effect of the event was to force relay #1 on.
• Ack Time: This is the date and time that an alarm was acknowledged.
NOTE: Because Event Log Viewers are associated with a single user diagram, they only update
when the user diagram is open. All Event Log Viewers need to be re-opened if a diagram is
closed or the software is shut down.
Acknowledging alarms
Every type of event has a prioritized value that identifies its relative significance on a scale of 0
(zero) to 255. By default, Vista identifies any event with a priority of 128 (default) or greater as an
alarm.
The event record is highlighted in red, and identified under the Ack Time column as "ALARM".
The Cause column lists the source of the alarm and the Effect column describes the event.
By default, Vista plays a "beep" to annunciate an event with a priority range of 128-191, and a
beep combined with a flashing display to annunciate an event with a priority range of 192-255. To
customize these options, see Alarming options.
When you acknowledge an alarm, Vista records the time the alarm was acknowledged (in the Ack
Time column) and your user ID (in the User Name column).
The alarm acknowledgement function is also available in the Alarms application in the Web
Applications component. See the online help for the Alarms application for information about
acknowledging alarms.
NOTE: In some cases, your access level may not be sufficient to acknowledge an alarm; for
example, a critical alarm may require Supervisor access. This is a user-configurable option. See
Alarming options for more information.
Acknowledging an alarm
1. Open an Event Log Viewer, then do one of the following:
To acknowledge a single alarm, click the word ALARM in the Ack Time column or
highlight the row containing the alarm.
To acknowledge all alarms to date, click the Ack Time column heading.
A confirmation box appears, asking if you want to acknowledge the selected alarms.
If you acknowledge the alarm but do not have a sufficient access level, the alarm remains
unacknowledged and the message "Insufficient Authorization" appears in the status line.
NOTE: When an alarm has been acknowledged in the Web-based Alarms application, and you
view the entry in the Event Log Viewer, the Ack Time and User Name columns are populated
with the appropriate acknowledgement entries for the ON value. However, these columns
remain blank for the related OFF value even though the alarm has been acknowledged.
Silencing alarms
If you are not ready or able to acknowledge an alarm, you can silence it until it can be
acknowledged by selecting Options > Silence Outstanding Alarms.
NOTE: Acknowledging an alarm does not change the operating condition that caused the alarm.
You must ensure that the cause is corrected to remove the alarm condition.
To view user diagram in Vista for devices with standard security enabled,
The network diagram appears in the workspace containing icons that represent groups of
devices on your system.
2. Click on one of the grouping objects to open a window and display the node icons contained
within.
3. Click a node icon to display the user diagram for the associated device.
NOTE: To perform any control object function, enter the device password. The user name is set
to default. Refer for Controlling system functions more information. If user name is prompted
when performing any control object function, then refer to Changes in security settings of device
for more information.
To view user diagram in Vista for devices with advanced security enabled,
The network diagram appears in the workspace containing icons that represent groups of
devices on your system.
2. Click on one of the grouping objects to open a window and display the node icons contained
within.
3. Click a node icon to display the user diagram for the associated device.
NOTE: All control object functions can be performed without entering credentials.
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.
Each control object in your user diagram is configured to perform a single function. When you
click a control object, it performs the specified function. For example, you could click a control
object to clear an energy accumulator, toggle a relay, reset a counter, or adjust the value of an
analog output device.
The default appearance of a control object depends on the function it has been configured to
perform:
Regardless of their appearance, all control objects are used the same way—to use a control
object, click it.
NOTE: For information on configuring the message, appearance and access level of control
objects, see Customizing the action for a control object and Customizing the display of a control
object.
When you click on a control object, one of the following happens, depending on how the control
object is configured:
• Vista performs the specified action immediately.
• Vista displays a confirmation message. Click Yes to proceed or No to cancel the operation.
• Vista requests a password. Type the logon password then click OK to proceed.
Depending on the function, a dialog prompting for the meter password may also open. If so, type
the meter password then click OK to proceed.
NOTE: There can be a time delay until Vista displays a new control value or state after it has
been written to the device.
TIP: You can copy information displayed by Vista Log Viewers to the Windows Clipboard and
paste it into other Windows applications.
NOTE: To plot high speed transient waveforms, use the Web Applications waveform viewer in
Diagrams or Alarms. High speed transient waveforms cannot be displayed correctly in Vista.
To graph a trend for a specific parameter using all available records, select an entire
column.
To graph multiple parameters over a specific time span, select the first cell in the desired
range and drag to highlight to the last cell of the range.
Vistaplots the data and displays it in the Log View Plotter window.
The default display is the Plot Display tab. Depending on the type of data selected, the Log View
Plotter may also offer a Harmonics Analysis tab and a Phasor Diagram tab.
In all cases, the Log View Plotter offers additional information in two floating boxes: the Legend
and the Calculations window.
The Legend
Each line or bar in the graph is represented by a pattern of the same color in the legend.
TIP: Click on the curve sample in the legend to select its equivalent in the graph.
2. Select Graph Options in the menu to open the Graph Options dialog.
The Calculations window updates automatically, displaying a range of calculated values based on
the currently selected parameter. By default, all values displayed in the Calculations window are
calculated from the first parameter. To view the calculations for a different parameter, select the
line or bar you want.
For example, to view the calculations for a curve on the Plot Display tab, click on the curve line in
the graph or on its line pattern in the legend. When you click a different tab, the Calculations
window displays the values relevant to that tab.
2. Select Graph Options from the menu to open the Graph Options dialog.
1. Right-click the graph background then select Graph Options. The Graph Options box
appears.
Type a name for the graph in the Title box. This name appears in the title bar of the Log
View Plotter window. The default is Log View Plotter.
Select or clear the Show legend and Show calculations check boxes to show or hide
the legend and Calculations window.
Select the Align triggers check box to align the trigger times of all waveforms in the
graph. (When multiple waveforms are plotted, their trigger times may not always be
correlated.)
NOTE: See Calculating Harmonics using more than one cycle for more information on the
System Frequency and # of cycles for harmonics options.
1. Right-click the curve line in the Plot Display or Harmonic Analysis tab and select Data
from the menu.
Plot Display tab: The data points are displayed. The X column lists the x-axis
coordinates and the Y column lists the y-axis coordinates. The first column (#) assigns a
number to each set of points.
Harmonic Analysis tab: A window appears listing each harmonic number and the
magnitude of each harmonic for each parameter. The first column numbers the rows.
The X column lists the harmonics number and the Y1, Y2, Y3, etc., columns list the
harmonic values for each bar in the harmonics histogram. Rows where the X value is not
an integer (i.e., .5, 1.5, 2.25) contain sub-harmonic values.
2. Click Format to change the number of significant digits displayed in the X and Y columns or
to change the width of these columns.
Width defines the number of characters the column can display.
3. Click Copy to copy columns to the clipboard. This allows you paste a copy of the data into
another application, such as a spreadsheet program or a text file.
NOTE: The Log View Plotter can only display one data table at a time. If you want to display
tabular data for another curve (from the same graph or a different one), you must first close any
open data window.
Each parameter is plotted in a different color. The legend identifies the color of each curve in the
selection and what it represents. Click on a curve to select it or right-click it to display additional
options. The timestamp at the top of the tab identifies the first point in the selected curve.
The vertical axis (y-axis) represents the specified range; the horizontal axis (x-axis) represents
time. Vista automatically adjusts the scale of the y-axis and x-axis to accommodate the largest
parameter(s) in the selection. Right-click either axis to change the scale of its properties; right-
click the axis numbers to change their format.
The time unit indicator in the lower right corner identifies the time scale of the x-axis (for example,
“h” indicates an hourly scale). Possible time scale units include months, days, hours, minutes, and
seconds.
To zoom in on the Plot Display tab, click on the Zoom button then drag a selection box
around the area you want to view. To view the entire plot, click the Restore to 100% button .
The Calculations window updates automatically, displaying the following values for the currently
selected curve:
1 The last three values (Avg, RMS, INT(H)) on the Calculations window are only available on plots
where the x-axis represents time. They are not offered on other types of plots (for example,
CBEMA plots).
Both numeric data and waveform data can be plotted in the same graph. On waveform plots, the
trigger time is represented by a red vertical line.
To define a new start point, drag Cursor 1 along the curve to the new start point. Repeat this
procedure with Cursor 2 to define a new end point. You can also use the arrow keys to move the
active cursor left or right. The active cursor is identified by a small box that appears where the
cursor line meets the curve. Use the TAB key to switch the active cursor between Cursor 1 and
Cursor 2.
As the cursor line moves from point to point along the curve, the information in the Calculations
window is updated. You cannot drag Cursor 1 past Cursor 2 or vice versa.
The new axis automatically assumes a scale appropriate for the selected parameter. In this way,
you can plot parameters of different magnitudes on the same graph (such as voltage and current).
1. Right-click the graph background to display the menu. In the last section of the menu,
highlight the curve you want to change.
The curve's sub-menu appears. (You can also access the sub-menu directly by right-clicking
on the parameter curve or on its curve sample in the legend.)
2. Select Options from the sub-menu to open the Curve Option dialog.
3. Choose one of the four axis options for the selected parameter. The axis is indicated by the
location of the tick marks.
Specify a Y-offset if required. This shifts the selected parameter up the y-axis (or down for a
negative number) by the amount you specify.
4. Click OK. A new axis appears with a default title and a scale appropriate for the selected
parameter.
The scale of the default axis can also be adjusted to accommodate the remaining curves. A
parameter has an asterisk after it in the legend if it has been offset.
Repeat these steps for each parameter that you want to de-index from the default axis. You can
assign more than one parameter to an axis and the scale adjusts accordingly to incorporate each
new parameter. For example, if you have plotted three voltage parameters and three current
parameters, you can select the current curves and assign each of them to another common axis,
leaving the three voltage curves to share the default axis.
1. Right-click the vertical axis or right-click the graph background and select the axis after you
have plotted the power factor data.
2. Select Power Factor Display from the menu. A check mark appears beside the option to
indicate that it is selected.
You can plot other non-power factor data on the same graph; however, you should not plot the
new data on the same axis as the power factor data. De-index the new data on a separate axis as
described in De-indexing a parameter or offsetting a parameter on the Y-axis.
NOTE: The cycle used is the first full cycle to the right of Cursor 1on the Plot Display tab.
The total harmonic distortion (THD), K-factor and Crest factor values for this waveform are
displayed in the Calculations window.
To view the calculations for another parameter, click on it in the graph or on its curve sample in the
legend. The Calculations window updates automatically. The currently selected parameter is
indicated above the calculations.
By default, the harmonics are calculated using one cycle. You can increase the number of cycles
by any power of two cycles (i.e., 2, 4, 8, 16, 32 or 64) up to the maximum number of cycles
available for the waveform.
1. Right-click the background of the graph area then select Graph Options to open the Graph
Options dialog.
2. Select the number of cycles over which harmonics calculations are to be performed from the
“# of cycles for harmonics” list.
3. Select the appropriate frequency in the “System Frequency” box, if the waveform you are
analyzing came from a system with a frequency other than 50Hz or 60Hz. (For example, if
the waveform was captured from a 400 Hz system using a 3710 ACM, specify “400Hz” in
this box.)
NOTE: The Harmonics Analysis tab is only available for waveform records. Vista does not
perform a harmonics analysis for trend data or for waveforms with less than eight samples per
cycle. You cannot display the harmonics of more than 16 parameters at a time.
You can use a phasor diagram to evaluate important aspects of your power system such as
voltage balance, per-phase loading, and type of load (or generator operating mode). A phasor
diagram also provides a way to identify PT or CT wiring problems.
NOTE: The timestamp at the top of the Phasor Diagram tab is based on the time of Cursor 1 on
the Plot Display tab.
To display a phasor diagram, select the Phasor Diagram tab from the Log View Plotter window.
The Phasor Diagram and calculations are derived from a one-cycle window starting at Cursor 1
on the Plot Display tab. The magnitude and angle of the selected phase is displayed in the
Calculations window.
NOTE: The Log View Plotter conforms to the convention where all phasors are plotted with
respect to V1 (always at 0°) and rotate in a positive counter-clockwise direction. On a balanced
power system, all three phases should appear 120 degrees apart.
To edit a phasor displayed on a phasor diagram, right-click a parameter in the legend to display a
menu where you can change the phasor's color or delete the phasor from the diagram.
Symmetrical components
The Log View Plotter calculates the symmetrical components of your power system — the
positive, negative, and zero sequences relative to the first phase — for the cycle selected. If you
have plotted waveforms for three voltages and/or currents, you can access their symmetrical
component calculations. To produce correct symmetrical components, the waveforms must have
been plotted in the correct order (for example, V1, V2, V3 — not V1, V3, V2).
The analysis of an unbalanced system, such as determining the effects of a system fault, is made
simpler by using symmetrical components. Symmetrical components are a mathematical tool that
allows any system of three unbalanced phasors to be represented by three balanced phasor
systems. The total current or voltage in any phase wire is expressed as the sum of three
balanced, three-phase components.
Positive Sequence Components (1) - these consist of three phasors that are equal in magnitude
and displaced from each other by 120º and have the same phase sequence as the original
phasors.
Negative Sequence Components (2) - these consist of three phasors that are equal in magnitude
and displaced from each other by 120º and have the phase sequence opposite to that of the
original phasors.
Zero Sequence Components (0) - these consist of three phasors that are equal in magnitude and
with zero phase displacement from each other.
If the original phasors of voltages are Va, Vb, and Vc, then the symmetrical components would be
as follows:
• Va = Va1 + Va2 + Va0
The symmetrical components function, as implemented inside some ION meters, is useful for
steady state analysis (unbalance), since the parameters are updated every second. However,
when determining the symmetrical components during a fault, per-cycle analysis is required. For
this application, you do not need real-time updates from the meter, because you are only
interested in the relatively short time before, during, and after a system fault. This information is
contained in the waveforms recorded when triggered by a disturbance.
1. From a waveform Data Log Viewer (such as Waveforms/Sequence of Events), select all
three phases of a fault (voltage or current).
4. Click on the Phasor Diagram tab to view the Symmetrical Components in the Calculations
window.
When the waveform is displayed, you may need to zoom in to view the area of the waveform you
are interested in. To zoom in, drag a selection box around the area you are interested in.
NOTE: To plot high speed transient waveforms, use the Web Applications waveform viewer in
Diagrams or Alarms. High speed transient waveforms cannot be displayed correctly in Vista.
When adding waveforms to the log view plotter, you can correlate all of their trigger times. See
Overlaying curves in the Log View Plotter for more information.
1. Select the range of cells you want to plot. Ensure that it contains the same type of
information (timestamps) as the data already being plotted.
3. Click on the title bar of the existing Log View Plotter window then select Edit > Paste. The
parameters you selected are added to the graph.
If you want to plot waveforms on the same graph as historical data, the historical data should
originate from high-speed data recorders and span a short time range, typically a few waveform
cycles (<1 second).
1. Select the row(s) you want to add in the Event Log Viewer.
3. Click on the title bar of the existing Log View Plotter window then select Edit > Paste. The
copied event records are added to the graph.
Each event is represented in the Log View Plotter as a diamond symbol. A diamond symbol is
added to the legend and diamond symbols appear at the appropriate areas along the top of the
diagram.
Point to a diamond symbol to display a description of the event in the status bar at the bottom of
the screen.
Ensure that the first column of data in the spreadsheet or text file is the same type as the first
column in the data log viewer from which the log plot originated. In particular, for timestamps,
make sure the entire timestamp is contained in a single column and that it uses the same date and
time format as defined in the Windows Control Panel. If the date portion of the timestamp is in one
column and the time is in another, or if the format is different in any way, the data cannot be
pasted into the Log View Plotter.
When you paste data into a graph, from both spreadsheets and text files, the Log View Plotter
interprets the first row of data in the selection as a heading. The first row in your selection is used
to label the parameter in the legend. So, if the first row is not already used for column headings,
insert a row and type in the label you want to appear in the Log View Plotter.
To copy data from a text file, the text file must be formatted correctly. Each column in the text file
must be separated by a tab and there must be a hard return at the end of each row.
2. Copy the range of values you want to plot, including the first column and the first row.
Include other columns in your selection, if required.
3. Click on the title bar of the Log View Plotter window then select Edit > Paste.
The parameters you copied and pasted are added to the graph. The axis scales are
adjusted automatically to include the new data.
You can define a trigger for waveform records containing timestamps when you copy records
from other applications. Simply add an exclamation mark to the end of the timestamp to indicate
that it is the trigger time. For example, the exclamation mark at the end of
22/05/2015@02:00:41.035 PM! indicates that the trigger occurred at this time.
Customizing an axis
After you have plotted data in the Log View Plotter, use the following instructions customize the
axis or gridlines, change an axis label’s format or add an axis title, or change the font or color used
on all axes. You can also change the scale of an axis.
Configuring an axis
1. Right-click the graph background to display the menu. Highlight the axis from the menu to
reveal the sub-menu. You can also right-click the axis to access the sub-menu directly.
2. Select Axis Properties from the sub-menu to open a dialog with the following options.
Range: Make changes in the From and To boxes to adjust the axis range.
Ticks: Make changes in the Major every and Sub-divided by boxes to adjust the
frequency of major and minor ticks respectively.
Grid: Select or clear the Major and Minor check boxes to turn graph gridlines on or off.
Click the Style buttons to change to the line style or width of major and minor gridlines.
Logarithmic scale: Select this check box to enable the logarithmic scale option.
Line: Click this button to display the Line Parameters dialog and change the line style
or the width of the axis.
NOTE: The axis range and the frequency of the major ticks are not stored in the diagram but are
recalculated for every new plot.
1. Right-click the graph background to display the menu. Highlight the axis from the menu to
reveal the sub-menu. You can also right-click the axis to access the sub-menu directly.
2. Select Axis Color, Major Grid Color, or Minor Grid Color from the sub-menu to open the
Color dialog.
3. Select the color you want or click Define Custom Colors for more options.
The axis or the major or minor gridlines change to the color you selected.
1. Right-click the graph background to display the menu. Highlight the axis from the menu to
reveal the sub-menu. You can also right-click the axis labels to access the sub-menu
directly.
2. Select Axis Labels from the sub-menu to open the Axis Labels dialog.
3. Select the format in which you want the axis labels to appear.
Decimal is used by default (for example, .01, .02, .03) but if the labels are too large or too
small, select Scientific (1.0 x 10-2, 2.0 x 10-2, 3.0 x 10-2...) or Engineering (1m, 2m, 3m...).
4. Determine the axis title: select None to have no axis title or Text to enter your own title.
For time-based plots, the default x-axis title is “s” if the timestamps of the data spans a
number of seconds, “mn” for minutes, “h” for hours, “d” for days, “m” for months. (This
applies to the Plot Display tab only.)
For non time-based plots (CBEMA or harmonics), you can change the title. Select Text and
type the title in the edit box. The title must be nine characters or less.
NOTE: If the first column of the source data includes a space or @ sign, the Log View Plotter
assumes time on the horizontal axis and automatically determines the units based on timestamp
information. The axis title is updated whenever the window is updated.
1. Right-click anywhere in the graph background and select Graph Font to open the Font
dialog.
2. Specify the font, style, size, effects and color options that you want to use for the axes
labels.
If color is not enough to distinguish one curve from another—for example, if you plan to print the
graph on a black and white printer—you can change the curve style after you have plotted data in
the Log View Plotter.
By default:
• Each curve is shown by a thin line that connects each point of data. You can customize the
style of each curve independently and show or hide the coordinates of each data point.
• Harmonics are displayed in a bar graph. You can distinguish between parameters by
customizing the display style of each parameter. Display options include bar type, hatching,
width and color.
Use the following instructions to customize curve styles, bar styles, and curve colors.
1. Right-click the graph background to display the menu. Highlight the curve from the menu to
reveal the sub-menu. You can also right-click the parameter curve in the diagram or its entry
in the legend to access the sub-menu directly.
2. Select Curve Properties from the sub-menu to open the Curve Style dialog.
Select the type of curve you want from the Type list. Vista offers seven curve types: a
simple line, a line with symbols, a scatter plot of markers, horizontal or vertical bars, or
Select Spline (available for Line or Line + Symbol types) if you want the line that
connects each point to be a smooth curve. If you leave it cleared, each pair of points is
connected by a straight line.
Select Fill Area (available for Line type) to fill the area under the curve with the line
color. Clear the check box to leave the area under the curve transparent.
The Marker section is available for Line + Symbol and Scattered types of lines. Specify
the shape, size, and style of the marker used for the points. The Style options apply only
to geometric shapes (for example, circles, boxes, diamonds, etc.).
For any line type, click Line to change the width and the style (for example, solid, dotted,
dashed, etc.) of the line. For bar graph types, a dialog opens where you can specify the
hatching pattern and the width of the bars.
1. Right-click the bar (or on its curve sample in the legend) and select Curve Properties to
open the Bar Graph Configuration dialog.
2. Select the type of bar to use from the Type list. This selection is applied to all bars in the
graph. Three bar styles are available:
Group Bars: Shows bars side-by-side
Stacked Bars: Shows bars stacked one on top of the other vertically
3. Select a hatching style for the selected bar from the Hatching list. This selection is applied to
the currently selected bar only.
4. Set how wide you want each bar to be in the Width text box. The specified width is applied to
all bars in the graph. The default depends upon the number of parameters.
1. Right-click the graph background to display the menu. Highlight the curve from the menu to
reveal the sub-menu. You can also right-click the curve in the diagram or its entry in the
legend to access the sub-menu directly.
2. Select Curve Color from the sub-menu to open the Color dialog.
3. Select the color you want or click Define Custom Colors for more options.
1. Right-click anywhere in the graph background and select Background Color to open the
Color dialog.
2. Select the color you want or click Define Custom Colors for more options.
2. Specify the font, style, size, effects, and color options that you want to use for the legend
text.
1. Right-click the graph background to display the menu. Highlight the curve you want to
remove from the menu to reveal the sub-menu. You can also right-click the curve in the
diagram or its entry in the legend to access the sub-menu directly by right-clicking on the
curve.
2. Select Delete Curve from the sub-menu. The curve is deleted without further prompting.
NOTE: Most Vista queries are plotted against timestamps (with the timestamp as the x-axis);
however, any query that uses the ION Sag/Swell module must be plotted against duration.
When plotting sag/swell data, select Duration as the X-parameter of the Log View Plotter.
Vista provides common curves or voltage tolerance envelopes that can be used as overlays in the
Log View Plotter:
• CBEMA/ITIC: These curves (for CBEMA, described by the IEEE standard 446-1987, and for
ITIC, described by the IEEE 1100-1999 standard) define an upper and a lower bound on the
types of disturbances that electrical equipment is likely to tolerate. It plots disturbance
magnitude against disturbance duration and indicates at what points a voltage disturbance is
likely to disrupt or damage equipment. Points near or outside the voltage tolerance envelope
indicate events that could interrupt or damage electrical equipment.
• SEMI F47-0200: This specification defines the voltage sag tolerance capability required for
semiconductor processing equipment, though it is now used by other industries. According to
the specification, equipment must tolerate sags to 50% of nominal voltage for up to 200
milliseconds, sags to 70% of nominal voltage for up to 0.5 seconds, and sags to 80% of
nominal voltage for up to 1 second. Points above the voltage tolerance curve indicate
disturbances that exceed these specifications.
To overlay one of the provided curves, you need a data log viewer that contains the magnitude
and duration values for the sag/swell disturbances. The Duration column must be set as the X-
parameter for the Log View Plotter—it appears in blue in the data log viewer table (See X-
parameter for Log View Plotter for more information on setting the X-parameter for Data Log
Viewers). The Magnitude values can be in any one of the other columns.
2. Select Edit > Plot Selected Data. The Log View Plotter window appears with Duration as
the x-axis and Magnitude as the y-axis.
3. Right-click the graph and select Overlay Curve from the menu to open the Overlay Curve
dialog.
4. Select the text file containing the curve data that you want to overlay (from the ...\Power
Monitoring Expert\config\lvp directory).
You can review each point in your data and see where it falls in relation to the curve.
• The various types of diagram objects and how to use each type to add function to your user
diagram.
NOTE: You must have the appropriate security clearance to edit or create a user diagram. To
determine if you can edit a diagram, select Options > Show Toolbox. If you can select this
option, then you can edit a diagram. Consult your network administrator if you need to change
your access privileges.
NOTE: Any changes you make to a default diagram affect all other devices using the same
diagram.
1. Select File > Save to save a new or existing user diagram, or File > Save As to open the
Save New Diagram dialog.
2. Type a name for the diagram in the File name field and click Save.
By default, Vista points to the root of the \ud directory when you attempt to save a new diagram. If
required, you can create a new folder within that directory to store your customized diagrams,
rather than storing them in the \ud folder.
NOTE: This \ud directory should be located on a networked drive where it can provide multiple
users with access to saved user diagrams.
NOTE: You should notify users of the Diagrams application in the Web Applications component
of the location of the new custom network diagram if they want to use it instead of the
automatically generated diagram. Users of the Diagrams application need to update the registry
settings on their computer to specify the location of the new custom network diagram. See
"Custom network diagram setup" in the Diagrams section of the Web Applications online help.
NOTE: The Show Toolbox option must be selected for the Enable Undo option to become
active — it remains unselectable otherwise.
Grouping Object:
To add a function to a user diagram, choose the type of diagram object you want, drag it into the
user diagram then link it to the appropriate register in a node. The following sections explain how
to add and link a diagram object.
See Monitoring your system in Vista for more information on the function and basic use of each
type of diagram object.
2. Click on the diagram object you want and drag it from the toolbox to the diagram.
In most cases, the object appears in the window as the icon from the toolbox. However,
there are two exceptions:
A text box appears in the window as a rectangular box that displays the default
message: “Your text goes here.”
A numeric object appears in the window as a rectangular box with a colon (:). This
indicates that the object is not yet linked to a node.
The object is now ready to be linked to a real-time or logged data source. See Linking a
diagram object to a data source for details on linking an object to a source.
NOTE: When a diagram object is placed in a window, it automatically uses the same node as the
window. If you want to change this source, either relink each diagram object or change the
default window link before placing the objects.
You can paste the copy as many times as you like to create multiple versions of an object. Each
copy retains all of the attributes and linkage information of the original.
To retain the original, select Edit > Copy. The selection is copied to the Power
Monitoring Expert clipboard.
NOTE: The Power Monitoring Expert clipboard is a temporary storage area that holds any
information cut or copied from Vista. It should not be confused with the Microsoft Windows
Clipboard.
After the object is copied to the clipboard, you can paste it into the active window.
2. Select Edit > Paste. The object appears in the active window.
When you select Edit > Copy to framework, Vista saves the selection (including the type and
location of each diagram object) as a file. You can then use the Paste from framework command
to copy the group layout to another diagram or grouping window. This is useful for replicating a
single configuration on multiple workstations. You can store a saved framework with its own
filename and retrieve it anytime.
2. Select Edit > Copy to framework to open the Copy to framework dialog.
3. Type a name for the framework in the File name box then click Save. The framework file
extension (.fwu) is added automatically.
After you save a group of objects as a framework, you can paste it to another window.
2. Select Edit > Paste from framework to open the Paste from framework dialog.
3. Navigate to the framework you want to paste and click Open. The framework selection
appears in the active window.
You can also use the arrow keys on the keyboard to move the selected diagram object(s) one
space at a time.
When diagram objects overlap, use the Send to Back command to place one object beneath the
others. Select the object then select Edit > Send to Back (or press CTRL+K).
Select Shrink to smallest or Grow to largest to adjust the width and/or height to
match that of the smallest or largest object in the selected group.
You can also combine horizontal and vertical options on a single selection. For example, if
you select Shrink to Smallest in the Horizontal section and 30 pixels in the Vertical section,
the entire selection is resized to the width of the shortest object and the specified height of
30 pixels.
3. Select the Align tab to specify the horizontal and vertical alignment of the object(s).
The options in the Horizontal and Vertical areas determine the criteria by which you can
align diagram objects. For example, if you select Left sides under Horizontal and Space
evenly under Vertical, Vista aligns all objects in the selection by their left sides (using the
leftmost object for reference) and distributes them evenly along a vertical axis.
Grid size in pixels activates the grid. Type a number in the “Grid size in pixels” box to
specify the size of the grid (distance between grid lines).
2. Select the appropriate tab and make your changes. Repeat this step for the other tabs until
you have made all your desired changes.
The options available vary depending on the tab and the object selected. See the sections below
for details on the options available for different tabs and objects.
For some tabs, you access dialog boxes by right-clicking on the image in the Preview pane (for
example, the Display tab of a numeric object). More information is given in the relevant sections
that follow.
Diagram Objects
Available Option
Grouping Text Box Numeric Status Data Log Event Log Control
Tabs
Object Object Object Object Viewer Viewer Object
Caption x x x x x x
Text x x x x
Edit Text x
Link (or Node)1 x x x x
Query Server2 x x x x x x
Display x x x x
Action x x x x
Box x x
Annunciation x
Query3 x x
Alarming x
1 Node is the tab available with Grouping Objects.
2 Query Server is only available on Grouping, Numeric,Status, and Control objects when the Action is set to something other
than none.
3 See Querying the database for information on configuring this option.
Caption options
To view caption options, right-click the object then select the Caption tab.
Use the Caption tab to add custom, user-defined text to a diagram object. The Caption tab is
available for the following diagram objects: Grouping, Numeric, Status, Data Log Viewer, Event
Log Viewer, and Control.
The Caption tab contains three sections: Caption, Font, and Position.
The Caption section determines whether a diagram object displays a textual comment along with
the diagram object’s icon. This section has three options:
• Select None to display no caption.
• Select Use default to display the default Vista caption (i.e., the device name or data source).
• Select Use custom to display the text that you type into the field provided.
The Font section allows you to change the font used in a caption. This section has two options:
• Select Inherit from parent window to use the default font.
• Select Custom to specify a custom font. Click Font to open the Font dialog and change the
font, size, style or color.
Text options
Some diagram objects have a text label integrated into the display. To edit the appearance of this
label, use the options offered on the Text tab. The Text tab is available for the following diagram
objects: Numeric, Status, Control, and Text.
NOTE: You can edit the text displayed in a text label. For a numeric, status or control object, use
the Label section of the Link tab. For a text box object, use the Edit Text tab.
To view the Text options, right-click the object then select the Text tab. The Text tab has two
sections: Font and Position.
The Font section has two options:
• Select Inherit from parent window to use the default font
• Select Custom to specify a custom font. Click Font to display the Font dialog and change the
font, size, style or color.
The Position section has three options — Left, Center and Right — to define the alignment of
the text in relation to the diagram object. Use the Preview area located beside the Text tab to view
your proposed changes.
Use the Edit Text tab to specify a text message for the text box. The Edit Text tab is available on
the text box object only.
The Edit Text tab has two options:
• Use default displays the window link information (i.e., the node).
If you select custom, use the text box to enter your text. The text box supports multiple lines of
text. If your message appears incomplete or truncated after you enter text and click OK, you can
adjust the dimensions of the text box object. To resize a text box, select it then drag its handles.
The font used in the text box is based on the default setting specified for the active window. Use
the Text tab to specify a different font or position for the text box. Use the Box tab to specify a
border style or change the background color.
Link options
To view the link options, right-click the object then select the Link tab.
Use the Link tab to link a diagram object to a real-time source, and to specify a new text label. The
Link tab is available for the following diagram objects: Numeric, Status, and Control.
NOTE: To set a real-time source for a grouping object, use the Node tab.
Use the Link section to specify a real-time source for the diagram object. See Linking a numeric,
status or control object for more information.
Use the Label section to change the object's text label. The Label section has three options:
• Select None to display no label.
• Select Use node label to display the node's register label. This is the default.
• Select Custom to display the label that you type into the text field provided. The custom
labels you create are stored in the user diagram and are only available to users of your
diagram.
TIP: If you have specified custom labels in your diagram, or custom labels have been applied to
an ION meter at the device level, you can display the default labels at any time by selecting
Show Default Labels from the Options menu. This displays the default label of the data source
instead of the label assigned in the device or in the user diagram.
The Query Server tab is also available on grouping objects and any object configured to open a
grouping window or user diagram. In this case, use the Query Server tab to specify a default
Query Server for the associated grouping window or user diagram. See Query Server: setting a
default Query Server for a window for more information.
Display options
Use the Display tab to customize the appearance of a diagram object. The Display tab is
available for the following diagram objects: Numeric, Status, Control, and Grouping.
The Display tab offers a unique set of options for each type of diagram object. To view the display
options, right-click the diagram object then select the Display tab.
The Display style box lets you select a new style from the list of available choices. The following
styles are available:
• Alphanumeric: Default style. General-use text display.
• Scrolling Graph display: General use. Displays recent readings on a scrolling graph.
• Arc Meter Display: General use voltage, current, harmonic distortion, etc.
• Timestamped display: Displays the value, and the date and time the value was measured by
the device. Useful for min./max. values.
• Timestamp Only: Same as timestamped, but does not display a value. Can be used as a
clock.
• PC Timestamped Display: Displays the value, and the date and time the value was received
by Vista.
Use the Units box to type the unit name for the measured value (for example, “Volts” or “Amps”).
This name is displayed on the numeric object.
In certain cases, the value is scaled. For example, if the unit name begins with K, M, or G (for
example, kV or MVolts), the displayed value is adjusted accordingly. However, if the unit contains
certain letters (i.e., kW or kVA), the scaling factor is reduced by 1,000 (for example, if the unit
begins with K, the value is not scaled and M is scaled by 1,000). The reason for this is that most
devices provide these values already scaled.
Use the Resolution box to specify the number of decimal places to be displayed for a numeric
object. The default value is 1, but this can be increased to take advantage of any extra resolution
available from the data source.
NOTE: Specifying higher resolution does not result in higher accuracy than the specified
accuracy of the device.
Use the Ticks Labels Font section to define font options (such as style, size, and color) for the
numeric object. This section has two options:
• Select Inherit from parent window to use the default style.
• Select Custom to specify a custom style, then click Font to open the Font dialog and make
your changes.
Setting Flags
Use the Flags button to display the Normal Operating Range dialog. Use this dialog to set a Low
Low Limit, Low Limit, High Limit, and High High Limit, and define a normal operating range to be
displayed on the numeric object. After flags have been set, you can use them to quickly determine
whether a reading is within the normal range you defined.
The effect of setting these limits depends on the display style you have specified. For example, on
the Partial Dial, Full Dial, and Arc Meter displays, flags appear as colored ranges on the dial. On
other types of numeric objects, the flag function changes the object's background color whenever
a limit is exceeded.
To view or change the default colors, select Options > Flag Colors.
NOTE: The flags used in Vista are not linked to setpoints in ION meters. Setpoint activity is
automatically logged by the Log Inserter. Setpoint status can be monitored using a status object
and/or data log viewer.
Other display options for Partial Dial, Full Dial and Arc Meter displays
To configure meter parameters on partial dial, full dial or arc meter displays, right-click anywhere
in the Preview section of the Display tab.
Set the Range, Arc Position, Ticks, and dial Position. For full and partial dial displays, set the label
position to inside or outside. Click Line Attributes to set the style and width of the dial.
• Right-click the vertical axis labels to display the Axis Labels dialog. Select the Format
(Decimal, Scientific, or Engineering) and determine the Axis Title (none or custom text).
• Right-click the graph background to display the Scrolling Graph dialog where you can set the
Sample Interval and Relative Reset.
The sample interval determines the resolution of the X-axis in seconds. It should be set
between one tenth and one hundredth of the X-axis range; for example, when extending the
range to one hour (3600 seconds), the sample interval should be set to approximately 60
seconds.
The relative reset is a percentage that determines the amount the scrolling graph shifts back
upon filling the plotting area. (For example, a relative reset of 0.5 shifts back 50%; a relative
reset of 0.99 scrolls the most smoothly.)
To view the display options of a status object, right-click the object then select the Display tab.
NOTE: To invert the default color scheme, select “Invert active state” from the Annunciation tab.
For each item selected under Condition (ON, OFF, and Unconnected), click Browse to
locate and select the image you want to associate with the condition. To hide the status object
in a given state, leave the image field blank.
Currently, the custom image option supports the following graphic file formats: BMP,
animated GIF, transparent GIF and PNG, WMF (Windows Metafile), EMF, JPG, AVI (without
audio and uncompressed or compressed using RLE8 compression).
NOTE: GIF, JPG, and PNG images need to be in \config\diagrams under the product's
installation location or they will not be shown in the Web-based Diagrams application.
You can use three different files to represent the three display states (ON, OFF, and
Unconnected) of a status object. Each of these files can also be of a different type (for
example, BMP, GIF, and JPG), however you cannot mix AVI and animated GIF images within
a status object.
• Select Alphanumeric to display the Boolean state or multi-condition state labels stored in the
device and choose custom colors to visually indicate the corresponding states.
For example, suppose “Running” has been stored in a meter as the label for the Boolean
register that stores the ON condition of a motor relay and “Stopped” for the OFF condition.
You can show this register label together with the status label using the alphanumeric display
style. You can override the meter labels on the Link tab.
Click ON Color and OFF Color to specify the colors associated with each condition.
You can also have multi conditions if you link the status object to an enumerated register
instead of a boolean. You can do this for BCPM devices.
To view the display options of a grouping object, right-click the object then select the Display tab.
The Display tab has three options:
• Select Default image to use the default image for a grouping object that appears in the
toolbox.
• Select Custom image to display a custom image. Enter the filename of the image you want
to use or click Browse to locate and select an image. The filename should include the file's
extension (.bmp, .jpg, .png, .gif, .emf, .wmf, or .avi).
• Select None to hide the grouping object. With no image specified, the grouping object is
transparent unless you select it (displaying the handles). If you move the mouse over a
transparent object, the status line displays the size and object type (for example,
“30x30:Grouping Object” in the status line means the hidden object is a grouping object and
its size is 30 pixels by 30 pixels).
Hiding a grouping object is especially effective when using a custom background image; you
can integrate your transparent grouping objects into the image by placing them at the
appropriate points on the drawing. Users can display site-specific information by double-
clicking on the appropriate spot in the background. See Image: Displaying a background
image for information on using a custom background.
To view the display options of a control object, right-click the object then select the Display tab.
External Numeric
A control object that is linked to an External Numeric module appears as an alphanumeric display
box. The Display tab has the following sections: Border and Background Color.
In the Border section, select Hide to show no border or select Show to display a border. If you
select Show, you can specify the width in pixels and click Color to choose a color for the border.
In the Background Color section, select Transparent for no background or select Custom then
click Color to define a color for the background.
External Pulse
A control object that is linked to an External Pulse module appears as a button icon, by default.
The Display tab has three options: Default image, Custom image and None.
Select Default image to display the button icon. Select Custom image and click Browse to select
a different image. Select None to show no image (the control object is hidden but still functions).
External Boolean
A control object that is linked to an External Boolean module appears as a switch icon, by default.
The Display tab has two options: Default image or Custom images.
Select Default image to display the switch icon. Select Custom images then click Browse to
define custom images for ON, OFF and Unconnected. To hide the control object for a given state,
leave the appropriate box blank. Currently, the custom image option supports the following
graphic file formats: BMP, JPG, PNG, GIF, EMF, WMF (Windows Metafile), and AVI (without
audio and uncompressed or compressed using RLE8 compression).
Note that you cannot mix AVI and animated GIF images within a control object.
Action options
To view the action options, right-click the diagram object then select the Action tab.
Use the Action tab to specify the response of a diagram object when it is clicked (in Display mode)
or double-clicked (in Edit mode).
The Action tab is available for the following diagram objects: Numeric, Status, Grouping, and
Control objects. Depending on the type of diagram object, the Action tab displays one of two sets
of options:
• Specify an action for a numeric, status, or grouping object
NOTE: If you change the action for a grouping object that is already associated with a grouping
window, the existing window (and any objects within it) is deleted. Vista displays a message
before performing this action.
When you right-click a numeric, status, or grouping object, the Action tab displays the available
options:
• Select None if you do not want the object to support an action. This is the default for numeric,
status, and grouping objects.
• Select Open Grouping Window to open a grouping window when the object is clicked. You
can use this grouping window to display additional information. For example, if a numeric
object displays a total value (such as total kW), you can display specific information (such as
kW readings for each phase) in an associated grouping window.
• The Open Diagram for Meter Template option is used by default each time a network
diagram is generated. Each meter icon in the network diagram is set to open the default
diagrams that match that meter's configuration.
• Select Open User Diagram to open a user diagram when the object is clicked. Type the full
path and filename into the field provided or click Browse to locate the diagram you want.
Using this action, you can choose a diagram object that displays a representative reading
from an independent diagram and use it to open the other diagram when clicked.
• Select Open File to open a file when the object is clicked. Type the full path and filename into
the field provided or click Browse to locate the file you want. The file can be a third-party
program or some other document; if a document is specified, then the program associated
with the file extension is launched and the specified document is loaded into the application.
• Select Open Web Page to open a specified webpage in your default web browser when the
object is clicked. Type the entire address into the field provided.
NOTE: When you select any action other than None, the Query Server tab is added to the top of
the object configuration box. You can use this tab to specify a source of logged data for the new
user diagram or grouping window. If you enter only the filename into the field provided (and do
not specify a directory), Vista defaults to
...\Power Monitoring Expert\config\diagrams\ud.
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.
The Action tab offers three options that you can use to define how the control object responds
when clicked:
• Select No confirmation to have no confirmation message displayed.
• Select Message box confirmation to display a message box when the object is clicked. The
message box requires the user to click either OK or Cancel.
• Select Password confirmation to request the user’s logon password when an object is
clicked.
The Level to operate list allows you to specify the access level required to perform the action.
Box options
To view the Box options, right-click the object then select the Box tab.
Use the Box tab to add a border or background color to a diagram object. The Box tab is available
for the following diagram objects: Numeric, Text Box, and any status object that has been
configured as an alphanumeric display
The Box tab has two sections:
• Border lets you adjust a border’s width and color as well as whether or not it is displayed.
Select Hide to remove the border or Show to display it. If you select Show, click Color to
define a border color and type a number in the Width in pixels field to change the line
thickness.
• Background Color lets you set the background color of an object. Select Transparent to
use the background color of the parent window or select Custom and click Color to select
another color.
NOTE: A Numeric Object uses the diagram background color in Vista when set to
Transparent, which makes it look transparent. In Diagrams (web application), this same
Numeric Object is displayed as truly transparent. Text Box Objects are truly transparent in
Vista and Diagrams when set to Transparent.
Annunciation options
To view the annunciation options, right-click the Status Object to open the Status Object
Configuration dialog, then select the Annunciation tab.
Use the Annunciation tab to specify how users are notified of a change of status. The
Annunciation tab is available only on the Status Object.
NOTE: The Annunciation feature requires that the Status Object’s diagram is displayed; if the
display is closed or minimized, then the annunciation feature does not work.
The Annunciation tab has three options that set the action that Vista performs when a status
object becomes active:
• Select Command line to automatically launch another application in the event of a change in
status. Type the program's executable (.exe) command into the field provided or click
Browse to locate the appropriate file.
• Select Message box to specify an annunciation message. Type your message into the field
provided. The first line of text appears as the title of the message box.
• Select Invert active state to change the way the status object reacts to an active state. When
this option is selected, the status object treats an active state as inactive and vice-versa. This
is useful, for example, in cases when you want to be notified if a function (such as a cooling
fan) switches off.
NOTE: If you select the Invert active state check box, this also inverts the default colors of the
status object.
Alarming options
Every type of event that occurs in a Power Monitoring Expert network has a prioritized value that
identifies its relative significance on a scale of zero to 255. By default, Vista identifies any event
with a priority of 128 or greater as an alarm.
To view the Alarming options, right-click the Event Log Viewer then select the Alarming tab.
Use the Alarming tab to create or delete a priority range, specify the security level required to
acknowledge an alarm, or customize the way Vista annunciates an alarm.
The Alarming tab has three main sections:
• Priority ranges lists the currently configured alarm ranges. When you select a range in the
Priority ranges section (for example “Range 192-255”), the other sections (Level to
Acknowledge and Annunciation) display the current settings for that range. You can proceed
to modify any of these settings for the specified range. (Your changes affect only the currently
selected priority range.)
Click New to add a new priority range. In the Priority dialog box, type a number representing
the lower limit of the new range then click OK. The upper limit of the new range is
automatically defined by the lower limit of the existing range. For example, if you have an
existing range of 128-191, you can type 100 then click OK and the range 100-127 appears.
To delete an existing range, select it and click Delete.
• The Level to acknowledge list specifies the access level required to acknowledge alarms in
the selected range.
• Annunciation lets you customize the way Vista annunciates an alarm:
Select Beep to play a beeping sound.
Select Command line to have Vista to automatically launch another application in the
event of an alarm. Type the program's executable (.exe) command into the field provided
or click Browse to locate the appropriate file. This option can be used to automatically
alert other users of specific events through paging systems, fax transmissions, or any
other command line capable application.
Select Message box to display an annunciation message. When you select this option,
type your message into the field provided. The first line of text appears as the title of the
message box and the remaining text appears as the content of the message box.
By default, Vista uses a beeping sound to annunciate an event with a priority between 128-191
and a beeping sound combined with a flashing display to annunciate an event with a priority
between 192-255.
NOTE: If your computer is equipped with a sound card, you can replace the default alarm sound
with a custom sound. Save the sound file you want to use as “alarm.wav” and store it in the
...\Power Monitoring Expert\system\etc directory.
1. Right-click the diagram object you want to link to open the Configuration dialog.
The Link tab contains two sections: Link and Label. Use the Label section to define a label
for the diagram object (see Link options for information on the Label section) and use the
Link section to choose a real-time source.
Custom: Allows you to select a new node. Select ION to choose a different device than
that used by the parent window.
b. Double-click the manager you want (for example, Power Meter modules) from the
Managers box.
c. Double-click the module you want from the Modules box (for example, Power Meter).
d. Double-click the output register you want from the Output Registers box (for example,Vll
avg).
The Create Link dialog closes and the new link information is displayed along the lower
edge of the Configuration dialog.
1. Right-click the Event or Data Log Viewer object you want to link.
Select Custom Query Server and click Edit Link to open a dialog where you can select
a new Query Server link.
3. Select Custom Query Server and click Edit Link to open the Create Link dialog.
Use this dialog to specify the Query Server, Query Manager, Query module, and Query
register.
Double-click the Query Server that you want from the Nodes box.
Double-click the Query module that you want from the Modules box.
Double-click the Query Register that you want from the Output Registers box.
The name of the selected ION Query Service is displayed as the Group Name on the Query
Server tab of the Configuration dialog.
After you have linked a diagram object to a log server, you need to define a query to specify the
type(s) of logged data that you want the object to display. See Querying the database for more
information.
NOTE: If the Query Server has multiple Query modules that are accessing multiple databases,
you need to select the Query module that is connected to the database that contains the data of
interest.
A query is a set of instructions that the log viewer uses to request particular data from the
database. Each log viewer has its own individual query. Editing this query information changes
what data the query retrieves and the way a log viewer displays that data.
Right-click the data or event log viewer object and select the Query tab to view the query options
or access the Query Wizard. Use the query options to define the way a viewer displays data and
the Query Wizard to edit the actual query.
NOTE: Anytime you place and link a new Data Log Viewer or Event Log Viewer, you need to
specify a query for it. You can specify a query using the Query Wizard.
To view the query options for an Event Log Viewer or Data Log Viewer, right-click the viewer
object to open the Configuration dialog. Select the Query tab.
The upper section of the Query tab offers two buttons:
• Edit Query starts the Query Wizard, a user-friendly interface that helps you edit the query.
• Edit SQL accesses the SQL statement via Windows Notepad so you can edit the query
directly using SQL, if preferred.
NOTE: If you edit a query directly (i.e., by editing the SQL statement), your changes may not
be accessible to the Query Wizard. This is not a problem unless you intend to use the Query
Wizard as well.
The Options section of the Query tab offers the following options:
• Records uploaded at a time: This option specifies the number of records Vista uploads into
active memory (RAM) when you first open a Data or Event Log Viewer. The maximum value
is 9999. As you scroll down the list of records, Vista uploads additional records as needed.
You may want to change this default value if, for example, you want to select a large number
of records for plotting, without scrolling down repeatedly.
• Update automatically: This option is disabled (cleared) by default. The Data or Event Log
Viewer does not display any new records; rather, the Log Viewer initially uploads the specified
number of records (for example 100) and does not update again unless it is closed (and its
query results deleted) then reopened.
With this option selected, the Log Viewer continually receives and displays new records up
to a maximum of 1000 records; the Log Viewer checks for new records every 20 seconds.
However, the updates can consume a noticeable amount of CPU power, especially if
several Log Viewers remain open simultaneously or if Log Viewers are uploading
waveform data.
• Delete query on close: This option is enabled (selected) by default. The Log Viewer clears
its temporary records from active memory (RAM) upon closing so that every time a Log
Viewer is opened, the database is queried again and all available records are displayed. (This
option does not affect any original records stored in the database.)
If this option is disabled, Vista caches the record set returned to the Log Viewer, meaning that
if the Log Viewer is closed then reopened, the table is populated from memory and not from
the database. Any new records inserted into the database during the time the Log Viewer was
initially open do not appear.
NOTE: Since it is recommended that Update automatically remain disabled in all but the
most compelling circumstances, it is important that the Delete query on close option
remains enabled.
• Use parent node: With this option selected, the log viewer uses the same node linkage as
the parent window. The node is also pre-selected in the Query Wizard - you should not select
this option if you intend to query more than one node.
For a Data Log Viewer, the X-parameter for Log View Plotter section is offered at the bottom of the
Query tab. Use this section to specify a column to be used on the X-axis of the Log View Plotter.
This section offers two options:
• Timestamp is selected as the X-parameter by default. In some cases, you may need to
specify a different X-parameter. For example, when you are plotting disturbances, you need
to plot your data against the Duration column.
• Use column # lets you specify a new x-parameter. In the field provided, type the column
number that you want to use as the X-parameter (for example, 3). When you click OK on the
Data Log Viewer Configuration box, the specified column changes to blue.
NOTE: In the Data Log Viewer, the column specified for the X-parameter is colored blue for easy
identification.
The Query Wizard consists of four steps designed to guide you through the process of
editing a query. These steps are described in more detail in the following sections.
Selecting the node(s) to query.
Depending on the type of query (new or existing), you may not need to perform all four
steps. When you start the Query Wizard, it automatically opens on the appropriate step in
the process.
4. Use the four buttons at the bottom of the Query Wizard to move through or exit the Query
Wizard:
Use the Back and Next buttons to navigate through the wizard.
Click Cancel to quit the Query Wizard and discard your changes.
Click Finish to quit the Query Wizard and save your changes.
5. When finished, click OK to save your changes and close the viewer configuration box.
The following example describes each step in the process of creating a typical query: configuring
a Data Log Viewer to display waveforms for three phases (V1, V2, V3).
1. Click Edit Query on the Query tab of the Log Viewer Configuration dialog to start the Query
Wizard.
2. Highlight the name of the node that you want from the Available list and click Add. The node
appears in the Selected list. Repeat this procedure to add additional nodes for this query, if
required.
If you want to remove a node from the Selected list, highlight the node and click Remove.
The node disappears from the Selected list.
NOTE: If you want to view or edit a node's SQL statement directly, highlight the node in the
Selected list and click the SQL button. The Windows Notepad displays the SQL statement for
the specified node.
1. The Available list displays the logs available on the specified node. The Selected list
displays the currently selected logs.
2. Highlight the name of the log(s) that you want from the Available list and click Add. The log
(s) appears in the Selected list.
NOTE: Check for additional tabs. If you selected more than one node in step 1, this box
requires you to specify logs for each node. Each tab is labeled “Node 1,” “Node 2,” etc. and
is identified at the top of each tab. Select “Advanced log view” to access any logs whose
configuration has changed over time. This check box enables access to old configurations
of snapshot logs.
If you selected multiple logs in step 2, this box contains a tab for each log. Specify the column and
filter information for each tab.
The Available list displays the available columns and the Selected list displays the currently
selected columns. The Selected list displays the columns in the same order (left to right) that they
will appear in the log viewer (top to bottom).
To specify the columns to appear in the Log Viewer:
1. Highlight the name of the column(s) you want then click Add. The column(s) appears in the
Selected list.
Select the asterisk (*) at the top of the Available list to select all available columns.
For example, if you want to select some basic columns for the first waveform log you
chose in the last step, you could highlight timestamp, node, and V1 in the Available list.
NOTE: The * column option shows all inputs connected to a recorder for Data Log Viewers.
For example, use the * option if you are using a framework and the configuration of the
data log is different for several meters. The * option is not available if more than one table is
selected, as in the example.
2. Repeat this procedure for each column that you want (and for each tab).
3. Adjust the order of the items in the Selected column—highlight the column name you want to
move in the Selected (in order) list then click the up or down arrows to move it. The
columns are listed from top to bottom in the order they will appear from left to right.
For example, if you want the Timestamp column to be the first (leftmost) column in your log
viewer, highlight “timestamp” in the Selected (in order) section then click the up arrow to
move it to the top of the list.
After you have selected the columns you want, proceed to specify filter settings.
Specifying a filter
Use the Filter section to construct one or more filter statements for your log viewer. Filters are
useful for restricting the scope of your query or specifying a priority range for alarms.
For example, if you want to instruct the log viewer to display data for the past month (excluding
today), you could use the following procedure:
5. Click Insert.
The following filter definition appears in the area below the filter controls:
“timestamp” BETWEEN last_month_to_date() and today_12AM()
If you wanted to instruct an Event Log Viewer to display only unacknowledged alarms, create a
filter that only displays alarms that have no acknowledgement time (ack-time).
3. Click Insert.
The following filter appears in the box below the filter controls:
“ack_time” IS NULL
As you construct a filter statement, each field offers options based on your selection in the
previous field(s). For example, if you select “priority” in the first field, the third field becomes a text
field where you can type a numeric value; if you select “timestamp” in the first field, the third field
displays time-based options (i.e., now, today 12AM, yesterday, etc.).
Function Description
now_() The current time.
today_12AM() Today at 00:00:00.
yesterday() Yesterday at 00:00:00.
last_week() Seven days ago at 00:00:00.
this_month() The first day of this month at 00:00:00.
last_month_to_date() The same date of the month one calendar month ago at 00:00:00.
last_month() The first day of the last calendar month at 00:00:00.
last_quarter_to_date() The first day of the month three calendar months ago at 00:00:00.
Note that time-related functions only return one record. To return all of the records for the time
period, you also need to specify < today_12AM(). For example, specifying a filter of
=yesterday() returns only one record, but a filter specifying >=yesterday() AND <today_
12AM() returns all of yesterday's records.
The second field offers a standard set of operators.
Operator-specific data
If you select an operator that requires additional information, Vista displays a dialog where you
can specify the required data.
For example, if you select the “node” column in the first field then select the “IN” operator from the
second field, a dialog opens requesting that you specify the node you want to use.
If you specify any column other than “node” then select “IN”, a box appears requesting numeric
values.
1. Highlight the name of the column to sort by in the Available Columns list then click Add. The
column appears in the Sort Order list.
2. Double-click on the column in the Sort Order list to select either an ascending or descending
sort order.
The Sort Order list displays the column(s) that dictate the order in which the records are
sorted.
3. Click Finish to save your changes and quit the Query Wizard.
In many cases, Vista uses the properties specified for the parent window as the default settings
for any diagram objects or grouping windows contained within. By modifying a setting in the
parent window, you automatically modify the same property on all objects inside the window that
share this setting. (For example, any object with an option set to Inherit from parent window
shares this information.) This can be useful when adding multiple diagram objects that are all
linked to the same source.
To access any of these options, right-click anywhere in the background of the user diagram or
window that you want to customize.
Default font
The font you select becomes the default setting for all captions and text labels within the window.
1. Right-click the background of a user diagram and select Default Font to open the Font
dialog.
2. Set the default font, style, size, effects, color, and format that you want.
Background color
The default background color is gray. However, you can display any solid color as a background
for any window in your user diagram.
1. Right-click the background of a user diagram and select Background Color to open the
Color dialog.
2. Select the color that you want or click Define Custom Colors for more options.
The Window Properties Configuration dialog opens with five option tabs: Image, Query Server,
Node, Action and Updates.
You can create your own background image using a scanned photograph or a drawing created
within a standard graphics program. Some ideas include:
• An engineering drawing of your installation depicting the power distribution system and the
location of critical elements.
• A single line diagram illustrating the power distribution network or the individual components
of your facility.
• An aerial photograph of your facility depicting the approximate location of your monitoring
equipment.
• A satellite image or geographical map depicting your transmission and distribution network.
The following illustration depicts a sample Vista background with hidden diagram objects (here
the object is visible by the handles because it is selected in Edit mode):
You can integrate your diagram objects into the image by placing them at the appropriate points
on the drawing. Users then display site-specific information by clicking on the appropriate spot in
the background.
1. Right-click the background of the window you want to customize and select Properties to
open the Window Properties Configuration dialog.
4. Select the image file you want to use and click Open.
2. Click the Query Server tab in the Window Properties Configuration box.
Select Custom Query Server then click Edit Link to open a dialog where you can select
a new Query Server link.
When you click the Edit Link button, the Create Link dialog opens.
1. Double-click the Query Server that you want from the Nodes box.
3. Double-click the Query that you want from the Modules box.
4. Double-click the query register that you want from the Output Registers box.
The name of the selected Query Server and register are displayed as the Group Name on the
Query Server tab of the Window Properties Configuration dialog.
1. Right-click anywhere in the background of the window and select Properties from the pop-
up menu to open the Window Properties Configuration dialog.
Select Custom to select a different node. Select ION and click Select to display the
Select Node dialog. Select a default real-time source for the window from the nodes
available.
1. Right-click the background of the user diagram or grouping window and select Properties to
open the Window Properties Configuration dialog.
2. On the Action tab, select Command line on open or Command line on close.
3. Click Browse to open the Browse dialog, locate the program you want, select the .exe file,
and click Open.
The specified file and path name appears in the box below the selected option.
NOTE: To remove an action, clear the check box beside the option.
• Stale Data allows you to specify whether data is highlighted and how old data must be to be
considered “stale”.
NOTE: The Update Period and Stale Data settings also apply to Diagrams.
1. Right-click the background of the window and select Properties to open the Window
Properties Configuration dialog.
3. Enter a numeric value in seconds in the Update data period or Stale data timeout fields to
set the intervals.
4. Select or clear the Highlight stale data check box to enable or disable checking for stale
data.
To change the color of the stale data border, close the Window Properties Configuration dialog,
then select Options > Flag Colors to open the Flag Colors dialog. Click Edit beside “Stale Flag
Color” to open a dialog where you can select a different color.
Web Applications
TIP: 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
Overview
Web Applications is the main interface for accessing PME power system information. Use Web
Applications to view real-time data, alarms, historical trends, key performance indicators, reports,
and other information about the power system you are monitoring. Web Applications also
provides several configuration settings and tools to configure and customize your PME system.
The following is a list of applications for accessing power system information through Web
Applications:
Application Function
Alarms View and analyze Incidents, Alarms, and Events; Acknowledge alarms.
Dashboards View high level, historical and real-time data in dashboards and gadgets.
Diagrams View low level, historical and real-time data in one-line and graphics diagrams.
Reports Run reports on demand or scheduled.
Trends View trends for real-time and historical data.
For a list of configuration tools and settings, see Web Applications settings.
When you open Web Applications, you are prompted to log in with your username and password.
The access level assigned to your username determines which applications and which functions
are available to you. See Default User Access Level Privileges and Customizing Access Level
Privileges for details.
/#Dashboards /#Alarms
/#Diagrams /#Reports
/#Trends
• Logout link: Logs you out of Web Applications and returns you to the log in page.
• Help link: Opens the browser-based online help for the Web Applications component and the
integrated applications.
Alarm Annunciator
The Alarm Annunciator shows information on the number of active and unacknowledged Alarms.
It is displayed in the banner area of the Web Applications and is visible from any of the PME Web
apps. The Annunciator alerts you to any new alarms that are occurring in the system. You can
configure it to play a sound when certain alarm conditions are met.
When you select on one of the priority colored areas in the Annunciator, from anywhere in Web
Applications, it opens the Alarm Viewer and automatically filters the view to show all alarms with
that priority. You can customize the behavior of the Annunciator, including the alarm sound, on
the Web Applications settings page.
The presence of the speaker icon indicates that it is configured to play a sound when new active
and unacknowledged alarms occur. select the speaker icon to mute or unmute the alarm sound.
NOTE: You must have controller, operator, or supervisor-level access to see the Annunciator. If
you have observer or user-level access, it is not displayed.
Library Pane
The library pane contains items and configuration options for the selected application. To show or
hide the library pane, select the bar on the right or left side of the display area.
Display Pane
The display pane loads the data visualization selected in the configuration pane.
PME supports configurations where the devices/sources, the server, and the client are in different
time zones. For example, a user in time zone A accesses the PME server which is in time zone B.
The monitoring devices that are providing the data are located in time zone C.
The following table shows how the different Web Applications display time with regards to time
zone:
* Alarms has tooltips that show the time in both the device/source time zone, and the Web client
(browser) time zone.
NOTE: Web Applications uses Management Console or Device Manager time zone settings for
the device / source time zone. The time zone settings in Management Console or Device
Manager are set per device and must be configured correctly, for Web Applications to show the
correct time. The time zone settings in Management Console or Device Manager are
independent of time zone settings on the devices themselves. Web Applications does not use
the time zone settings on the devices themselves.
Disabling the time zone option Adjust for daylight saving time automatically in the Windows
Date & Time settings on the PME application server affects the PME Windows applications, not
the web clients. To disable daylight savings time for all the PME applications, perform the
following:
1. On the PME application server, in the Windows Date & Time settings select an alternate
time zone without Adjust for daylight saving time automatically option.
For example: If your existing Windows time zone is (UTC-08:00) Pacific Time (US &
Canada), which has the Adjust for daylight saving time automatically option then select
(UTC-8:00) Coordinated Universal Time-08, which does not have the Adjust for
daylight saving time automatically option.
2. On the Management Console for existing devices, set the Time Zone as the selected
Windows time zone.
NOTE: For new devices, the Management Console Time Zone is set to the Windows time
zone automatically.
Software Modules
Software modules combine different software features and capabilities to create a specific set of
deliverables. Software modules are designed around a particular application. Examples of
software modules include the Power Quality Performance Module, the Energy Analysis Reports
Module, and the Breaker Performance Module.
This section provides information on how to use the Software Modules in Power Monitoring
Expert.
Use the links in the following table to find the module you are looking for:
Module Application
Backup Power Module Generator and Uninterruptible Power Supply (UPS) performance
operation monitoring and reporting, including battery health.
Breaker Performance
Circuit breaker aging and breaker settings monitoring.
Module operation
Generator and Uninterruptible Power Supply (UPS) capacity
Capacity Management
monitoring and reporting. Includes transformer and UPS loss
Module operation
monitoring.
Energy Analysis
Gadgets for identifying consumption patterns and anomalies and
Dashboard Module
for comparing different consumers over time.
operation
Energy Analysis Reports Reports for energy consumption monitoring and modeling,
Module operation including energy usage by process area or by product output.
Energy Billing Module Energy-based billing and reporting, including consumption
operation monitoring and reporting at the branch circuit level.
Event Notification Module
Notifications of power system events via email, SMS, or SNMP.
operation
Insulation Monitoring Monitoring for isolated power systems, such as the ones found in
Module operation hospital operating rooms.
Power Quality
Analysis of power quality events and disturbances and their
Performance Module
impact on the monitored system.
operation
The Backup Power Module provides generator and Uninterruptible Power Supply (UPS)
monitoring and reporting. It reports on generator and UPS performance and battery health.
The Generator Test EPSS Report can be configured to conform to the requirements for an
Emergency Power Supply System (EPSS) test, including automatic transfer switches (ATS). For
example, the report shows the transfer time of the lead ATS and indicates whether the transfer
time passes or does not pass the test requirements. See Emergency Power Supply Systems for
more information on EPSS.
Use the Backup Power module to:
• Identify generator problems that could prevent a transfer to backup power.
For information on how use the Backup Power diagrams and reports, see:
• Backup Power Reports
• EPSS diagrams
Related topics:
Backup Power Module topics
• Backup Power Module design
The Breaker Performance Module monitors aging and wear of circuit breakers and reports on
breaker protection settings. It provides historical and real-time information for aging and wear
related breaker parameters. You can also set up alarming on these parameters.
Use the Breaker Performance module to:
• Monitor circuit breaker health related to wear and aging.
For information on how use the Breaker Performance reports and diagrams, see:
• Breaker Performance Reports
Related topics:
Breaker Performance Module topics
• Breaker Performance Module Design
The Capacity Management Module provides generator, Uninterruptible Power Supply (UPS), and
general equipment monitoring and reporting. It also includes transformer and UPS loss
monitoring and reporting. The losses are reported in terms of energy and cost.
• Understand if the generator and UPS loading compromises the design redundancy of the
backup supply system.
For information on how use the Capacity Management Module reports, see Power Capacity
Reports
Related topics:
Capacity Management Module topics
• Capacity Management Module Design
The Energy Analysis Dashboard Module includes dashboard gadgets that help you break down
consumption by load type, visualize consumption cost, and do an 80/20 analysis to identify the
largest consumers. You can identify consumption patterns and anomalies and compare different
consumers over time.
• Sankey gadget
Related topics:
Energy Analysis Dashboard Module topics
• Energy Analysis Dashboard Module design
The Energy Analysis Reports Module includes reports that help you understand energy usage
patterns to find energy waste, analyze transformer and circuit capacity and assess energy usage
by process area or by product output. Use the energy modeling capabilities in this module, to
forecast consumption, identify unexpected changes in your consumption, or identify actual
savings as a result of energy management measures.
• Analyze transformer and circuit capacity as configurations change and loads are added.
• KPI Gadget
• KPI Report
For information on how to use the Energy Analysis Reports Module reports, see Energy Analysis
Reports.
Related topics:
The Energy Billing Module is a fully functional energy-based billing reporting system. It also
provides load and consumption monitoring and reporting at the branch circuit level, which is
typically used in data center applications.
Use the Energy Billing Module to:
• Allocate energy costs to consumers.
For information on how use the Billing reports (except Energy by IT Customer Report), see Billing
Reports
For information on how use the Energy by IT Customer Report, see IT Billing Reports
Related topics:
Energy Billing Module topics
• Energy Billing Module design
NOTE: This module requires a separate license. See Licensing for more information.
Use the Event Notification Module (ENM) to notify recipients about critical power system events.
ENM can send notifications of power system events through email, SMS or SNMP. ENM uses the
Alarms application to detect system events. You can set up notifications for activity in any of the
event, alarm, or incident views. The notification details are defined in a notification rule. A
notification rule can be enabled or disabled, and you can use a schedule to determine when the
rule is applied. You can define more than one notification rule.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not rely solely on Event Notification Module use for alarm notification where human or
equipment safety relies on the operation of the control action.
• Do not use Event Notification Module to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and
status feedback.
• Consider the implications of unanticipated transmission delays or failures of
communications links.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
NOTE: Other parts of the overall communication system, such as email servers, cellular phone
systems and SNMP servers, could fail and result in notifications not being delivered. If
notifications are not delivered to recipients, conditions that cause alarming may persist and
result in safety critical issues.
Notifications are sent out automatically based on the configuration of the module. See Event
Notification Module configuration for information on how to configure notifications. See Event
Notification Module Design for prerequisites and design considerations.
Related topics:
Event Notification Module topics
• Event Notification Module Design
The Insulation Monitoring Module provides monitoring for isolated (IT) power systems, such as
the ones found in hospital operating rooms. It also helps in locating isolation faults. The module
can be configured for applications based on the IEC standard, and for applications based on the
ANSI standard.
• Vista diagrams for group, area, and area details levels (ANSI and IEC)
For information on how to use the Insulation Monitoring diagrams and reports, see:
• Insulation Monitoring diagrams
Related topics:
Insulation Monitoring Module topics
• Insulation Monitoring Module Design
The Power Quality (PQ) Performance Module analyzes power quality event and disturbance data
as well as power factor measurements. It determines the potential impacts of power quality on the
monitored power system and displays the results in graphical formats, with color coding to
highlight problem areas. The module combines standard software features with specialized
components to produce its outputs. The module can also analyzes power quality event and
disturbance data as well as power factor measurements based on the hierarchy sites, which are
assigned to a user group.
The following reports, diagrams, and Dashboard Gadgets are part of this module:
• Power Quality Impact report
For Power Quality Performance Module for multiple sites, all listed reports, diagrams, and
Dashboard Gadgets except Standardized Equipment diagrams is part of this module.
For information on how use the Power Quality Performance gadgets, diagrams, and reports, see:
• Power Quality Impact Report
Related topics:
Power Quality Performance Module topics
• Power Quality Performance Module Design
Troubleshoot
This chapter provides information on how to troubleshoot Power Monitoring Expert (PME) and
how to resolve problems and issues.
1. Search the Schneider Electric Knowledge Base/FAQ for a resolution. Use search keywords
including product, version, component and specific issue. See Resources for information on
how to access the knowledge base.
2. (EcoXperts and Schneider Electric employees) Search the Exchange Community for a
resolution. Use keywords including product, version, component and specific issue. See
Resources for information on how to access the Exchange Community.
3. Use the information in this chapter to find a solution to the problem yourself
4. If steps 1-3 don’t resolve your problem, contact Technical Support. See Resources for
information on how to contact technical support.
When you contact Technical Support, be prepared to provide the following information:
• Problem overview.
• Relevant PME system history, for example upgrades, expansions, IT policy changes, and so
on.
• Screen captures or videos of the problem.
NOTE: The more information you can provide, the less time it will take to resolve the issue.
• Diagnostics Viewer
Use the Event Viewer to see Windows event logs for Application, Security, Setup, and System.
These logs might include messages related to the problem you are trying to solve, for example
entries about services shutting down or other unexpected events.
Open Event Viewer in Windows from Control Panel > Administrative Tools, or search for
Event Viewer in Windows search.
Use the browser tools to investigate issues that happen in the PME web applications interfaces.
When an error happens in the web client, it is not always recorded in the PME or Windows event
logs. For example, when a PME user account is deleted from the system, the web application
sends a HTML request to the PME application server to delete the user. If, for some reason, this
request is not received by the server, it will not be recorded in the PME system log. Web browser
developer tools can help troubleshoot these kind of issues. It is also possible to record a web
session with the tools. This recorded session (saved as .HAR file) can then be viewed by
Technical Support to analyze the web browser activity.
To open the web browser developer tools: Press F12 on your keyboard while the web browser is
open.
Use the Diagnostics tool to retrieve diagnostics information from the system databases, files, and
libraries. The information collected by the tool is packaged in a way that makes it easy to send it to
Technical Support.
To open the Diagnostics Tool: Start Diagnostics Tool.exe from ...\Power Monitoring
Expert\Diagnostics Tool\
Use the system log to find information on system activities, including warnings or errors.
Use application modules diagnostics to find information on issues related to Web Applications.
Use a Modbus test utility to monitor and troubleshoot communications between devices and the
software. For example, a Modbus test utility can help you identify if device communication issues
originate outside the software through wiring, incorrect device configuration, or other causes.
To find a Modbus test utility, search the Internet for products that meet your needs.
Diagnostics Viewer
The Diagnostics Viewer is a built-in feature of PME.
NOTE: Diagnostics Viewer and Diagnostics Tool are two different applications in PME.
Use Diagnostics Viewer to find information on the operation of PME services and on device
communications. For example, you can view Log Inserter and Siteserver interactions with the
devices in the system. See Diagnostics Viewer for more information on this tool.
Open Diagnostics Viewer in PME from Management Console > Tools> System.
Use a packet analyzer for network troubleshooting and analysis. For example, you can monitor
the communications between an Ethernet power monitoring device and PME as part of your
troubleshooting activities.
To find a packet analyzer, search the Internet for products that meet your needs.
NOTE: Wireshark, an open-source product, and Fiddler, a freeware product, are examples of
well known packet analyzers.
Diagnostics Viewer
Diagnostics Viewer is a tool you can use to troubleshoot network communications problems and
related network errors.
TIP: For instructions on using filtering, sorting, column selection, and pin/unpin to customize the
Diagnostics Viewer display, see Customizing and navigating interface displays.
Navigation pane
Diagnostics information is grouped as follows:
• Service Diagnostics: Contains diagnostics information for certain services (ION Network
Router Service, ION Site Service and ION Log Inserter Service).
• Communication Diagnostics: Contains diagnostics information for the sites, hardware
devices, and software nodes.
If you add a new device to the system while Diagnostics Viewer is open, you can refresh the tree
view to display the new device by collapsing then expanding the root node of the tree.
Service Diagnostics
Service Diagnostics records communication problems and similar events occurring with the
product's software components.
TIP: The blank area below the Description column header is a dynamic filter field. Type the
wildcard character (*) in front of the text you want to search (for example, to display only
messages prefixed with WARNING, type *warning). The diagnostics information pane
automatically displays only those records that match the text you typed in the box.
• Connection Status displays the current status of the software components connected to
Network Router.
• Tree States displays the ION tree status of all nodes (hardware devices and software nodes).
In the Select Nodes pane, select the check box beside a node to display its diagnostics
information. Clear the check box to hide that node’s diagnostics information.
TIP: If there are many nodes and you want to display only a few of them, right-click the Select
Nodes area then click Clear All. Select only the nodes you want to display. To display all the
nodes again, right-click the Select Nodes area and click Select All.
Node details
The following table summarizes the columns on the Node Information tab:
Column Description
Node The name of the device, VIP, or Log Inserter.
The device type of the associated node that is returned by the device
DeviceType
itself. The Log Inserter uses this to detect device swap outs.
The serial number of the device that is returned by the device. The
SerialNumber
Log Inserter uses this to detect device swap outs.
The requested polling interval in effect. It can be configured either
Configured Polling from the log upload control or from the custom Windows Registry
Interval (s) value. All of the nodes for which polling is disabled are identified with
Polling Disabled in this column.
Column Description
A weighted average time between polled results for the device. The
most recent interval accounts for 20% of the value, and the previous
average accounts for the remainder. If the value deviates from the
average by more than 30s, then the old average is discarded and the
Average Update Interval current interval is used. By default, the expected value for devices
(s) that support logs is the Configured Polling Interval (s) value. The
expected value for devices that do not support logs is 60 seconds.
If the Log Inserter is selected but it is not configured to collect data
from its System Log Controller, it appears in the diagnostics and
shows 300s for Average Update Interval. Initially this value is n/a.
The time in seconds since the last communication with the node. This
Time Since Update (s) time includes polling updates, record uploads, and configuration
loads.
Column Description
Can be one of the following values:
• alive – The node is communicating.
Column Description
Under steady-state conditions, this is blank. While the Log Inserter
attempts to upload configuration information, this can contain a string
value indicating that the Tree is in use by another client.
This indicates that the Log Inserter cannot process the device until the
Comments
aforementioned client releases it. If the client is ION Designer, it is not
released until the node is closed in Designer or Designer is closed. If
the client's name ends with -not-clean, the node is currently being
evaluated by Treemon/Validator.
The aggregate setup count of the device. The Log Inserter uses this
AggregateSetupCount
to detect configuration changes.
The number of ION registers, modules, and/or managers that have
been requested from the tree. The Log Inserter needs to upload
configuration information to determine which logs need to be
processed, which labels should be used for measurement mapping
and source resolution, and which labels to use for event cause and
effects.
The Log Inserter retrieves the currently cached tree from Treemon,
populating as needed by communicating directly with the device. The
tree is locked for the duration of this process, and this prevents
RequestedIONs
Designer from opening the tree.
If the value is:
• none – No configuration information is currently required. This is
typical in a steady-state condition.
• cache – Only the currently cached configuration is required. This
is typically seen at startup.
• A number – The Log Inserter needs specific information and that
number of ION objects has been explicitly requested.
Column Description
The status of the tree requests can include one of the following
values:
• ready – The Log Inserter does not require any configuration
information.
• requesting – The Log Inserter requires configuration
information and is in the process of gathering it. The value in
Request Update Time indicates how long it has been
processing this request.
• retrying – A previous tree request was not successful. (See the
Comments column for the reason.) The request is retried, as
shown by the value in Request Update Time. The amount of
wait time before retrying a request depends on the nature of the
unsuccessful tree request:
Tree in use by another node – 10 seconds.
The following table summarizes the columns on the Node Performance tab:
Column Description
Node The name of the device, VIP, or Log Inserter.
Indicates whether or not the node is responding. For a VIP, this
includes all external nodes connected, directly or indirectly, to the
Responding
input of a Recorder. The responding state is used to determine
whether or not the download of the log is caught up.
All Logs Polling Indicates if log upload is disabled for all recorders on the device. A
Disabled Yes in the column indicates that log upload is disabled.
The total number of Data Recorders, Waveform Recorders, Event
Log Controllers, and System Log Controllers that the Log Inserter is
TotalLogs configured to collect data from a given node. Note that when
automatically detecting these modules, this number may change as
the Log Inserter gathers configuration information.
The total number of records that the Log Inserter has requested from
PendingRecords
the node but has not yet received.
The total number of records not yet uploaded based on the last read
OutstandingRecords position counter on the device and the position of the last uploaded
record, taking into account the maximum depth of each log.
The number of records that have been inserted into the database.
ProcessedRecords Note that a record typically corresponds to a number of DataLog
entries. The term "record" refers to records at the device level.
An estimate of the number of new records being generated per
Generated Rec. per sec
second.
Retrieved Rec. per sec An estimate of the number of records being uploaded per second.
The average round-trip time in seconds taken to retrieve a record
Avg Retrieval Time (s)
from a device.
Avg Processing Time The average time in seconds necessary to insert a record into the
(s) database.
The total number of logs that the Log Inserter is configured to gather
RestoredLogs
information for.
The total number from the value in RestoredLogs that is being
ManagedLogs
monitored by an enabled Log Acquisition Module (LAM).
The total number from the value in RestoredLogs that are Recorders
ConfiguredLogs and have source inputs or are Event Log Controllers or System Log
Controllers.
The total number from the value in RestoredLogs for which the
ConfirmedLogs
current configuration is known.
The total number from the value in RestoredLogs for which the node
NumCaughtUp
is responding and there are no records outstanding or pending.
The following table summarizes the columns on the Log Performance tab:
Column Description
Node The name of the device, VIP, or Log Inserter in question.
LogHandle The handle of the Log Register or Event Log Register for this Node.
Indicates whether or not the node is responding. For a VIP, this
includes all external nodes connected, directly or indirectly, to the
Responding
input of a Recorder. This state is used to determine whether or not it is
caught up.
Indicates which individual recorders are excluded from polling
Polling Disabled requests. A Yes in the column indicates which recorders are
excluded.
The total number of records that the Log Inserter has requested from
the node but has not yet received. This number includes event
PendingRecords records that have been uploaded but are cached internally pending
configuration information necessary to complete the processing of the
cause and/or effect ION objects.
The total number of records not yet uploaded based on the last read
OutstandingRecords position counter on the device and the position of the last uploaded
record, taking into account the maximum depth of each log.
The number of records that have been inserted into the database.
ProcessedRecords Note that a record typically corresponds to a number of DataLog
entries. In this context, "record" refers to records at the device level.
An estimate of the number of new records being generated per
Generated Rec. per sec
second.
Retrieved Rec. per sec An estimate of the number of records being uploaded per second.
The average round-trip time in seconds taken to retrieve a record
Avg Retrieval Time (s)
from a device.
Avg Processing Time The average time in seconds necessary to insert a record into the
(s) database.
This is always yes. If the log is not "restored", it does not appear in the
Restored
list.
Managed A Log Acquisition Module (LAM) is enabled that is monitoring this log.
The log is a Recorder that has source inputs or it is an Event Log
Configured
Controller or a System Log Controller.
The latest configuration for the log has been uploaded. For a VIP
Recorder that references external devices, directly or indirectly, the
Confirmed
configuration information includes information from the external
device.
The node is communicating, the current configuration is known, and
CaughtUp there are no outstanding or pending records. For a VIP, any device on
which the log depends for information must also be responding.
Alarm Service
Alarm Service provides the status of alarms that you configure and enable in the Software Alarms
application.
The information is organized in a grid. The column labels indicate the type of information
provided, such as Rule Name, Alarm Name, Alarm Status, and so on. See the Software Alarms
Help (accessible from the Software Alarms application) for further information about configuring
alarms for multiple sources and measurements.
Log Inserter writes log data into a message queue instead of writing it to SQL Server directly.
Another process (the Log Subsystem Router Service) reads the messages from the queue and
writes the data to SQL Server.
Previously, the Log Inserter would wait for database writes to complete before processing the
next piece of data. This effectively limited the rate of data insertion to something that SQL Server
could handle. Writing to MSMQ is much faster: MSMQ can store messages in the queue faster
than Log Inserter can retrieve them from the devices. However the performance of SQL Server
has not changed, which means that data can accumulate in the queue faster than it can be
inserted into the database. Allowing the message queues to become full (they have a limited
storage capacity) results in failure modes that are difficult to handle automatically. To avoid this
scenario we monitor the size of the inbound data message queue and prevent writes when it
contains more than a set number of bytes. If the message queue reaches a specified capacity,
then no future messages will be accepted from LogInserter and the write thread is "put on hold"
until the message queue has dropped below a specified capacity. This ensures that LogInserter
never considers data written that may be missed in the message queue due to over capacity.
The following table summarizes the columns on the Pipeline Status tab:
Column Description
Identifies the message queue (Primary or Secondary) and the type of
Name
data being tracked.
Total time that the diagnostics have been counted. In practice this
Duration
value will be identical for all rows.
Number of messages that have been processed from this queue
Message Count
since the service was started.
Messages Per Minute Number of messages that have been processed in the last minute.
Messages Per Minute
Average of the messages per minute over the last hour (60 samples).
Average
Messages Per Minute Maximum number of messages per minute over the last hour (60
Max samples).
Messages Per Second Number of messages that have been processed in the last second.
Column Description
Messages Per Second Average of the messages per second over the last minute (60
Average samples).
Messages Per Second Maximum number of messages per second over the last minute (60
Max samples).
Processing Time
Average time taken to process each message (milliseconds).
Milliseconds Average
Processing Time
Maximum message processing time (milliseconds).
Milliseconds Max
Time Since Last Elapsed time since a message was last processed.
Start Time Utc Time in UTC at which the service was started.
The following table summarizes the columns on the Message Queues tab:
Column Description
Identity Identity of the message queue.
Queue Type Data or Control
Message Count Number of messages currently in the queue.
Message Kilobytes Size of messages currently in the queue (kilobytes).
Maximum size allowed for the queue. Note that a value of
4294967295.00 (4GB) is the maximum amount of data that the entire
Maximum Kilobytes
MSMQ service can support. This effectively indicates that no queue-
specific limit has been defined.
The Message Queues tab allows you to inspect messages flowing through the pipeline. Enabling
message capture increases the load on the pipeline so this should not be left activated
indefinitely.
The controls on the top select which messages are written to the table. This filtering only occurs
as the messages arrive at the tab; once a message is displayed in the table it will not be removed
when the Message Type or Source Filtering fields are changed. Rows already in the table may be
filtered by the fields below the header.
The viewer buffers messages as they arrive to avoid locking up the receiving thread. If the buffer
fills (which indicates that messages are arriving faster than the viewer can process them) a
message indicating how many messages were missed will be written to the table.
Communications Diagnostics
Communications Diagnostics provides diagnostics information for sites and devices connected to
the workstation.
Site overview
Diagnostics information for the sites are contained in these tabs:
• Device Summary displays communications statistics for each site.
• NetUser Status displays the number of ION programs currently in the ION Network Router
Service queue (awaiting processing) and the total number of ION programs already
processed.
NOTE: Requests and responses transmitted between the software components are referred to
as “ION programs”.
Site/Device Diagnostics
Diagnostics information for sites and devices are summarized in these tabs:
• Communication Status displays error rates and connection statistics for the selected site or
device. The following information is available from the Communications Status tab:
Column Description
Column Description
• Site Status displays site statistics such as connection status and totals.
• Polling Status displays the number of programs currently in the ION Site Service queue
(awaiting processing) and the total number of programs already processed.
“Total Errors” in the Communication Status tab is an ION Site Service derived statistic, while
“Bad Responses” in the Site Status tab is a client derived statistic.
To explain this difference, consider a situation where a direct site is experiencing timeouts.
Communications with the device is attempted according to two parameters: Connect Attempts
(an advanced site property) and Maximum Attempts Multiple (an advanced device property).
Multiplying the values of these two properties determines the number of attempts made to re-
establish communications with the device.
For instance, if Connect Attempts is set to 1 and Maximum Attempts Multiple is set to 3, the
device will go offline after 3 attempts (that is, 1 x 3).
The “Total Errors” statistic increases by one every time ION Site Service detects a timeout.
However, the “Bad Responses” statistic only increments every time a response is sent back to a
client.
Using the previous example, consider the case where four timeouts occurred and the device went
offline. In this case, “Total Errors” increases by four, while “Bad Responses” only increases by
one. If only two timeouts occurred, “Total Errors” would increase by two, while “Bad Responses”
would not change.
Column Description
Column Description
Last Response The time when the last response was received.
Last Attempt The last time that a request was sent to the device.
The total number of requests to the device sent by the Real Time Data
RT Data Reqs
Service.
The total number of requests to the device sent by the TreeMon
TreeMon Reqs
service.
The total number of one shot requests to the device sent by a Vista
VISTA Reqs
client (control, label requests...).
The total number of requests to the device sent by the LogInserter
LogInserter Reqs
service.
The total number of requests to the device sent by ION real-time
IONSERVICE Reqs
services.
Note that the last five columns on the Site Status tab are dynamic. That is, the columns are only
shown when requests were sent to the device from a Power Monitoring Expert service or client.
Additional commands
The following sections describe additional display options and shortcut menus available in
Diagnostics Viewer.
Diagnostic Details
In the tabs on the diagnostics information pane, double-click a row to display its Diagnostic
Details screen. This displays the diagnostic information for the selected item only.
Use the Previous and Next buttons to view the details of other rows in that tab of the diagnostics
information pane.
To copy information to the clipboard, select the rows you want to copy, then press CTRL+C.
Decommission
Decommissioning removes PME files to prevent potential disclosure of sensitive, confidential and
proprietary data and software from your system. You risk disclosing your power system data,
system configuration, user information, and other sensitive information if you don’t decommission.
We strongly recommend you decommission your system at the end of its life.
WARNING
UNINTENDED EQUIPMENT OPERATION
Before decommissioning, verify that the system is not performing critical control actions that
may affect human or equipment safety.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
Before decommissioning, verify that the system data results are not used for critical decision
making that may affect human or equipment safety.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
Overwrite: Choose this if you still need to use your hard drives for other software. This method
uses a commercial tool to put random data in place of PME files on your hard drives.
Applications
Use the information provided in this chapter to build applications based on Power Monitoring
Expert.
Use the links in the following table to find the content you are looking for.
Application Description
This application (also known as DDD Indicators), can help you
Disturbance Direction identify power quality disturbances, their type, and the likely
Indicators in Vista location of origin. The disturbance information is shown with visual
indicators that are integrated into an electrical one-line diagram.
This application provides continuous monitoring of the thermal
Thermal Monitoring of Low conditions of low voltage busways. You can see temperature data
Voltage (LV) Busways in real-time, analyze historical temperature trends, and set up
alarming based on temperature thresholds.
This application provides remote, continuous monitoring of the
Thermal Monitoring of
thermal conditions of MV substations. You can see temperature
Medium Voltage (MV)
data in real-time, analyze historical trends, and receive alarms and
Substations
notifications.
NOTE: The examples and screen captures shown in this application description are for
illustration purposes only. They are not intended to give guidance on configuration settings or
application details. For guidance on configuration of your system or other application details,
consult a qualified professional.
Examples:
Below is an example of a one-line diagram showing a voltage sag that originated outside the
network.
This is an example of a one-line diagram showing a voltage swell that originated inside the
network, most likely in "Building Loads TR16b".
NOTE: The red frames and yellow highlights were added to the images in this document to
highlight the disturbance indicators. The frames and highlights are not displayed in the actual
diagram.
Components
The DDD Indicators application is based on the following system components and features:
• Power Monitoring Expert 2024 software.
• Power monitoring devices with Disturbance Direction Detection (DDD) functionality. (See
Prerequisites for a list of compatible devices.)
• A one-line diagram of your electrical network.
NOTE: Creating the basic one-line diagram, without indicators, is outside the scope of this
application description. For information on how to create diagrams in PME, see Creating and
customizing a user diagram.
Prerequisites
The following is required to set up the DDD Indicators application:
• PME must be installed and commissioned.
• Power monitoring devices with DDD functionality must be installed in your electrical network
in those locations where you want to monitor for voltage disturbances. The devices must be
connected to PME and must be communicating. The following devices are compatible with
this application:
ION9000
PM8000
ION7400
9410 series
9810 series
ACCESS 9610
• The internal clock of the monitoring devices must be time synchronized. The standard
synchronization (± 1s) between the PME server and the monitoring devices is good enough.
High accuracy (± 1ms) time synchronization (for example, GPS, IRIG-B, or PTP) can also be
used, but is not needed for this application.
• Power quality event detection for Sag/Swell and Transients must be enabled in the power
monitoring devices for which you want to show the disturbance indicators in the one-line
diagram.
• You need a one-line diagram for each electrical network that you want to include in this
application. For information on how to create diagrams in PME, see Creating and customizing
a user diagram.
Limitations
To create the voltage disturbance indicators for the one-line diagram, we use the DDD Indicator
Wizard. This tool has the following limitations:
• A maximum of 30 power monitoring devices can be included in this application.
TIP: For information on how to set up this application to support more than 30 devices, see
the How do I extend the DDD Indicators Application to support more than 30 devices
application note. See Resources for link information.
• You can display data for the last 5 voltage disturbance Incidents.
Design
The voltage disturbance indicators in the electrical one-line diagram show the type of the
disturbance (sag/swell/transient) and its direction, relative to the monitoring device
(upstream/downstream). This information is based on DDD event records that are recorded by
the devices and uploaded into the PME database. A VIP framework triggers database scripts that
run every 5 minutes and scan the database for DDD event records, going back in time. Events
that occurred within a short time interval (< 60s between events) are grouped together into an
Incident. The scripts continue to scan for DDD events until 5 Incidents have been found, or the
event data is older than 180 days. The DDD information for each of the Incidents is then
processed by the VIP for display in the one-line diagram.
We create 5 identical copies of the one-line diagram, one for each disturbance Incident. The
diagrams are linked together so you can navigate between them using the Incident Navigator.
Example:
Configuration
Before configuring the DDD Indicators application, confirm that the Prerequisites are in place for
your system.
New Application
Configuring the DDD Indicators application for the first time in your PME system, requires the
following steps:
• Setting up the DDD Indicator framework in the VIP.
NOTE: The VIP.DDD is part of the default PME install. Only use this VIP for the DDD
Iindicators application. Do not use the VIP.DDD for any application other than the DDD
Indicator. At this point of the configuration process, the VIP.DDD should only contain the
EventLogCtl 1, Diagnostics 1 and VIP ION core modules. If there are other modules in
the VIP.DDD that are not related to this application, then move these modules to a different
VIP, or delete them, before installing the DDD framework. Do not install the DDD
framework into the VIP.DDD as long as it contains other, non-core modules. See Upgrade
from a pre- 9.0 version of PME, if your PME system was upgraded and contains a VIP
configuration for an earlier version of the DDD Indicators application.
NOTE: You must lock paste the framework or the DDD Indicator Wizard will not function
correctly.
TIP: For information on lock pasting ION modules, see Copying and pasting ION modules.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before pasting an ION framework verify that the system is not performing critical
control actions that may affect human or equipment safety.
• Do not overwrite an existing ION framework in the VIP using lock paste.
• Verify correct system operation after pasting an ION framework.
Failure to follow these instructions can result in death, serious injury, or
equipment damage.
9. In Designer, Send & Save the changes again. No message box should appear this time.
View of the DDD framework after pasting and saving:
This completes setting up the DDD Indicator framework. Close the VIP.DDD node in
Designer.
4. Follow the steps in the DDD Indicator Wizard to complete the configuration.
TIP: Later, to simplify the copying of the DDD Indicators from the wizard to the one-line
diagrams, select Window > Arrange All in Vista to show the wizard and the diagrams
side-by-side.
A. Maintain or extend the application, using the methods that were valid in the older version of
PME for which it was first configured.
See the System Technical Note: "How can I …Indicate a Disturbance's Direction Using a
Power Monitoring Expert's One-Line Diagram?" for details.
B. (Recommended) Remove the existing DDD Indicators configuration and rebuild it with the
new PME 2024 methods.
To remove the existing DDD Indicators configuration and rebuild it with the new PME 2024
methods:
Delete the existing (old) DDD Indicators VIP framework.
Delete the DDD Indicators and the Incident Navigators from the existing one-line
diagrams.
TIP: Make a note of the devices that were used for this application so you can use that
information when building the new DDD Indicators.
Disable or remove the automatic DDD database table updates. This was done with an
SQL Server Agent job for systems SQL Server Standard, or a task in the Windows Task
Scheduler for systems with SQL Server Express. See the System Technical Note: "How
can I …Indicate a Disturbance's Direction Using a Power Monitoring Expert's One-Line
Diagram?" for details on how this was setup.
Follow the New Application steps to recreate the previous DDD Indicators application.
NOTE: You cannot mix the old ways of configuring this application with the new DDD Indicator
Wizard configuration. The old and the new methods for Incident grouping are not compatible.
TIP: PME 2024 uses a wizard to configure large portions of the DDD Indicators application. This
makes it much easier and faster to implement this application as compared to previous versions.
We recommend you recreate existing DDD Indicators applications in PME 2024 instead of
maintaining them using the old, manual methods.
Operation
After you have configured the application you can view the voltage disturbance indicators in your
one-line diagram:
You can view the last 5 disturbance Instances by using the Incident Navigator:
If your PME database does not have disturbance data for a device for a particular Incident, then
the Indeterminate Event icon is shown for that device:
NOTE: The red frames and yellow highlights were added to the images in this document to
highlight the disturbance indicators. The frames and highlights are not displayed in the actual
diagram.
Below is a list of the different disturbance indicator icons that can be displayed, depending on the
type of disturbances and the capabilities of the monitoring devices:
Maintenance
No maintenance is needed for the DDD Indicators application. However, you can customize
certain aspects of the application to better meet your specific needs.
3. Edit the Update DDD Table Database Import module that is part of the DDD Indicator
framework.
3. Edit the Update DDD Table Database Import module that is part of the DDD Indicator
framework.
The TGML DDD latest PQ Incidents component filters incidents based on the access of the user
group assigned to the source. A user has access only to the sources included in the group that
they are a member of.
Components
The DDD Indicators application is based on the following system components and features:
• Power Monitoring Expert 2024 software.
Prerequisites
The following is required to set up the DDD Indicators application:
• PME must be installed and commissioned.
• The devices must be connected to PME and must be communicating. The following devices
are compatible with DDD:
ION9000
PM8000
ION7400
Limitations
To create the PQ disturbance indicators for the one-line diagram, we use the Graphic Editor.
However, you can only view the data for the latest 5 PQ disturbance incidents.
Configuration
Before configuring the DDD Indicators application, confirm that the Prerequisites are in place for
your system.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
5. Drag and drop the DDD Horizontal Indicator / Vertical Indicator component to the
workspace.
8. Do the steps from 1 to 5 of Configuring DDD Latest PQ Incidents View to add the Incident
Summary.
1. Open the Graphics Editor: select Start > Power Monitoring Expert > Graphics Editor.
5. Drag and drop the DDD Latest PQ Incidents View component to the workspace.
Operation
When you configure the application, you can view the PQ disturbance indicators in your PME web
application.
3. Select the saved TGML file in the Diagram Library menu for the DDD Horizontal Indicator /
Vertical Indicator or DDD Latest PQ Incidents View component.
4. Select DDD Horizontal Indicator / Vertical Indicator to get the details for all the recent 5
PQ incidents.
NOTE: Incident summary is timed out every 10 seconds. New data is available every 10
seconds.
5. Select the PQ Indicator to get the details for the PQ for the source.
• When you have access to particular sources at the user group level and the PQ event is from
another source
• When there are no PQ events in the top 5 recent incidents.
Indicator description
The different disturbance indicator icons that can be displayed, depending on the type of
disturbances and the capabilities of the monitoring devices.
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: The examples and screen captures shown in this application description are for
illustration purposes only. They are not intended to give guidance on configuration settings or
application details. For guidance on configuration of your system or other application details,
consult a qualified professional.
Examples:
The above is an example of a real-time trend showing busway temperature over the last hour.
The above is an example of a trend report showing the busway temperature over the last 24
hours.
The above is an example of an alarm incident history view showing thermal monitoring related
incidents.
Components
The Thermal Monitoring of LV Busways application is based on the following system components
and features:
NOTE: The diagrams include a sample user diagram. This sample diagram is intended as a
starting point for the development of end user diagrams. Creating customized end user
diagrams is outside the scope of this application description. For information on how to
create diagrams in PME, see Creating and customizing a user diagram.
NOTE: The Easergy CL110 is an environmental sensor that can measure temperature and
humidity. For this application we only use the temperature measurements.
Prerequisites
The following is required to set up the Thermal Monitoring of LV Busways application in PME:
• PME must be installed and commissioned.
• The busway temperature sensors must be connected to the ZBRN32 access point and must
be communicating.
• The ZBRN32 access point must be connected to an Ethernet Gateway, such as the Link150.
NOTE: Each ZBRN32 access point needs a mid-range device license in PME.
• You must know the temperature sensor locations on the busway to be able to assign
meaningful names to the equivalent sources in PME.
Limitations
There are no specific, software-based limitations for this application in addition to the general
PME performance and scalability limits.
Design
Easergy CL110 or TH110 sensors, attached to the busway, wirelessly transmit real-time
temperature measurements to a Harmony ZBRN32 access point. The access point is connected
to PME through an Ethernet Gateway, such as the Link150. PME provides support for the access
point, through an add-on Harmony ZBRN32 access point device driver.
After the access point has been configured in PME, the driver creates individual sources for each
of the sensors that are connected to the access point. The driver also supports software logging of
the temperature measurements. This is similar to how branch circuit monitors are handled in
PME. One access point can support up to 60 temperature sensors.
The real-time and historical temperature data is available for display and processing in any of the
relevant PME applications such as Dashboards, Diagrams, Trends, and Reports.
NOTE: The selection, installation, and configuration of the sensors, access point, and gateway
is outside the scope of this application description. See Prerequisites for more information.
Configuration
Before configuring the Thermal Monitoring of LV Busways application, confirm that the
Prerequisites are in place for your system.
NOTE: Each ZBRN32 access point needs a mid-range device license in PME.
• Setting up Dashboards, Diagrams, Trends, Alarms, and Reports for temperature data.
To add the Ethernet Gateway and ZBRN32 access point in Management Console:
Set the Name and IP Address for the gateway. For TCP/IP Port select ModbusTCP
Device|502.
Example:
Set the Group, Name, Unit ID, and Time Zone for the access point. For Device Type select
ZBRN32 (CL110/TH110). For Site select the Ethernet Gateway Site added in step 2.
Example:
TIP: For information on how to set up sites and devices in Device Manager, see Device
Manager.
The diagram shows information for 60 possible temperature sensors. Only those sensors
that are installed and connected to the ZBRN32 access point show a temperature
measurement.
Example:
4. Select Setup in the lower right-hand corner of the diagram to open Setup view.
5. Select Options > Show Toolbox from the Vista menu, and then change the names of the
installed sensors by double-selecting the name field, editing the default name, and then
pressing Enter on your keyboard. See Selecting Sensor Names for tips on choosing a
sensor name.
NOTE: Complete the sensor naming before moving to step 6. If you rename the sensors
after enabling logging, this will affect the source names under which the data is logged.
6. Enable the Log. The device driver for the ZBRN32 access point in PME will start logging
temperature measurements for all installed and connected sensors on a 15 minute interval.
2. Add a new alarm rule for the thermal alarm, with the following details:
Alarm Template: Select the Realtime Setpoint template under the All or Common
category.
Priority: Select a priority that is appropriate for this alarm, for example High.
Enter other alarm information as required. See Adding a new Alarm Rule for information on
how to add alarm rules.
3. Add a new alarm rule for a thermal pre-alarm. Use the same details as for the thermal alarm,
but set the temperature thresholds lower so that the pre-alarm is activated before the main
alarm.
You can set up the Web Applications, or any other relevant data display or processing application
to use the busway temperature data. Follow the standard workflow for configuring these
applications. For details see:
• Dashboards configuration
• Trends configuration
• Alarms configuration
• Reports configuration
The ZBRN32 access point device driver includes a sample diagram for the display of temperature
sensor real-time measurements and alarm status. You can use this diagram as a starting point for
creating custom end-user diagrams. Find the diagram under
...\config\diagrams\ud\default\ZBRN32_CL110_TH110_V1.0.0\zbrn32_cl110_
th110_v1.0.0_example.dgm.
TIP: Save your diagrams under ...\config\diagrams\ud or a sub-folder of ud but not in the
ud\default folder. This makes it possible to add your diagram to the Diagrams Web
application. The ud\default folder is not visible in Diagrams.
Below is an example of a partially customized diagram based on the diagram provided with the
add-on device driver. The alarm status displays for each sensor have been linked to the pre-alarm
and alarm status measurements.
The ZBRN32 access point device driver in PME monitors the temperature sensor communication
status and generates alarms on communication interruptions. The alarms are categorized as
Asset Monitoring > Thermal Monitor.
RECOMMENDATION: Configure an alarm view for Asset Monitoring > Thermal Monitor to track
and monitor temperature sensor communication issues. See Alarms configuration for
information on how to setup alarm views.
NOTE: The thermal monitoring data registers (temperature, humidity, and so on) display "NA"
values when communication with the sensor is interrupted.
Operation
After you have configured the application and created views in the Web Applications, you can
monitor the busway temperature. The following are examples of temperature data displayed in
the different Web Applications.
Dashboards:
The above is an example of a dashboard showing busway temperature measurements for the last
24 hours.
Diagrams:
The above is an example of a diagram showing sensor data for a ZBRN32 access point.
Trends:
The above is an example of a real-time trend showing busway temperature over the last hour.
Alarms:
The above is an example of an alarm status view showing thermal monitoring related alarms.
The above is an example of an alarm incident view showing thermal monitoring related incidents.
Reports:
The above is an example of a trend report showing the busway temperature over the last 24
hours.
You can also generate Thermal Monitoring report. See Continuous Thermal Monitoring Report for
more information.
Maintenance
No maintenance is needed for the Thermal Monitoring of LV Busways application. However, the
ZBRN32 access point device driver includes a diagnostics diagram that shows the sensor battery
voltage (only for CL110 sensors, TH110 sensors are self-powered) and the signal strength. You
can use this diagram to monitor the health of the sensor network.
To open the diagnostics diagram in Vista:
1. Open Vista.
4. Select Diagnostics in the lower right-hand corner of the diagram to open Diagnostics view.
Example Diagnostics diagram:
For more information on the value of Continuous Thermal Monitoring see the EcoStruxure Power
Digital Applications for Large Buildings & Critical Facilities Design Guide. See Resources for
download 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.
NOTE: The examples and screen captures shown in this application description are for
illustration purposes only. They are not intended to give guidance on configuration settings or
application details. For guidance on configuration of your system or other application details,
consult a qualified professional.
Examples:
The above is an example of a real-time trend showing cubicle and transformer temperature and
humidity measurements over the last hour.
The above is an example of a trend report showing a 1-week cubicle temperature trend.
The above is an example of an alarm status view showing thermal monitoring related alarms.
Components
The Thermal Monitoring of MV Substations application is based on the following system
components and features:
• Substation with Substation Monitoring Devices (SMDs), Harmony ZBRN32 access points,
Easergy TH110 thermal sensors and Easergy CL110 environmental sensors
NOTE: The device type for the SMD is called Switchgear Monitoring Device in PME.
Prerequisites
The following is required to set up the Thermal Monitoring of MV Substations application in PME:
• PME 2024 must be installed and commissioned.
• The TH110 and CL110 sensors, the ZBRN32 access points, and the SMDs in the substation
must be configured, connected, and communicating.
NOTE: This application supports SMD v4.0 and v3.0. SMD v2.0 is not supported.
Limitations
There are no specific, software-based limitations for this application in addition to the general
PME performance and scalability limits.
The SMDs and ZBRN32 access points have the following limitations:
• Each SMD can support up to three ZBRN32 access points.
For each transformer, the SMD can support sensors for MV taps, LV taps, windings, and
tapping links.
NOTE: Only those cubicles, transformers, and sensor locations that are configured in the SMD
are shown in PME (non-configured ones are hidden in the diagrams).
NOTE: The selection, installation, and configuration of the sensors, ZBRN32 access points, and
SMDs is outside the scope of this application description. See Prerequisites for more
information.
NOTE: This application description only covers certain measurements available from the SMD.
Consult the SMD documentation for information on additional measurements and functions.
Design
Easergy CL110 and TH110 sensors are installed in the substation. The sensors wirelessly send
measurement data to the ZBRN32 access points. The access points are connected to SMDs
through Modbus serial communications. The SMDs are connected to PME through an Ethernet
connection.
PME has a pre-configured device driver for the SMD. This driver creates individual sources in
PME for the SMD parent device and for each of its configured cubicles and transformers. You can
access thermal and environmental measurements, pre-alarms, and alarms. The driver also logs
data from the SMD and creates event log records. This is done through driver-based Setpoint
modules. The real-time and historical data is available for display and processing in any of the
relevant PME applications such as Dashboards, Diagrams, Trends, and Reports.
NOTE: The selection, installation, and configuration of the sensors, ZBRN32 access points, and
SMDs is outside the scope of this application description. See Prerequisites for more
information.
NOTE: This application can also be used with a PME and Power Operation (PO) integrated
system, known as PO with Advanced Reporting and Dashboards. See the PO System Guide
for details. See Resources for link information.
Configuration
Before configuring the Thermal Monitoring of MV Substations application, confirm that the
Prerequisites are in place for your system.
• Setting up Dashboards, Diagrams, Trends, Alarms, and Reports for the thermal monitoring
data.
• (Optional for systems with multiple SMDs) Creating a SMD summary diagram that shows all
the SMDs in the substation with high level status information.
• (Optional) Setting up alarm views for temperature sensor communication alarms.
Set the Group, Name, IP Address, and Time Zone for the SMD device. For Device Type
select Switchgear Monitoring Device.
Example:
NOTE: The date and time are set manually in the SMD. You cannot set the time in the SMD
through PME.
TIP: For information on how to set up sites and devices in Device Manager, see Device
Manager.
Example:
b) If you want to use a generic Vista Network Diagram to access the SMD information, go to
File > Generate Network Diagram.
Example:
NOTE: When you save the generated network diagram, it will overwrite any existing
network diagram. If the existing network diagram was customized, then these
customizations will get lost.
3. Select the SMD grouping object in the Vista diagram to open the SMD device diagrams.
4. (Optional) Customize the sensor display labels. Select the icon in the SMD device
diagram to edit the display labels for the sensor names.
NOTE: The sensor names for the thermal monitoring points, for example Cubicle 01,
Cubicle 02, Transformer 01, and so on, are fixed in PME. These names match the names
used in the SMD for local display. If necessary, you can define custom labels for the
sensors in Vista and Diagrams. These custom labels only appear in Vista and Diagrams.
Other PME applications will continue to display the default names.
You can set up the Web Applications, or any other relevant data display or processing application
to use the substation temperature and environmental data. Follow the standard workflow for
configuring these applications. For details see:
• Dashboards configuration
• Trends configuration
• Alarms configuration
• Reports configuration
NOTE: Thermal measurement related functions and settings are configured in the SMD. PME
reads the measurements from the SMD and displays them as they are, including max values
and alarm/pre-alarm statuses.
The configuration of the SMD determines which measurements are available. Only configured
cubicles and transformers are shown in PME.
2. Create a new diagram. Add labels and status indicators for each SMD as shown in the
following example:
Use status objects to show the pre-alarm and alarm statuses. Link the pre-alarm indicator to
Substation > Global Substation Alarm > Global Status Pre-Alarm in the SMD node.
Link the alarm indicator to Substation > Global Substation Alarm > Global Status Alarm
in the SMD node.
Use text boxes to hard-code the cubicle and transformer numbers. Overlay the SMD name
text boxes with transparent grouping objects linked to the SMD diagrams.
The SMD device driver in PME monitors the sensor communication status and generates alarms
on communication interruptions. The alarms are categorized as Asset Monitoring > Thermal
Monitor.
RECOMMENDATION: Configure an alarm view for Asset Monitoring > Thermal Monitor to track
and monitor sensor communication issues. See Alarms configuration for information on how to
setup alarm views.
NOTE: The thermal monitoring data registers (temperature, humidity, and so on) display "NA"
values when communication with the sensor is interrupted.
Operation
After you have configured the application and created views in the Web Applications, you can
monitor the Substation conditions. The following are examples of temperature and environmental
data displayed in the different Web Applications.
Dashboards
The above is an example of a dashboard showing cubicle and transformer temperature and
humidity measurements for the last 24 hours.
Diagrams
The above is an example of a top-level diagram for a SMD which has Cubicle 1-3 and
Transformer 3 configured.
The diagram includes the following elements:
• Event and Data log icons providing access to alarm and communication events, and logged
temperature and humidity measurements.
The above is an example of a cubicle diagram. Only those components that are configured in the
SMD, display data in the diagram. In this example, only the busbar and environmental sensors
are configured.
The above is an example of a cubicle details diagram for a SMD which has busbar and
environmental sensors configured.
Trends
The above is an example of a real-time trend showing cubicle and transformer temperature and
humidity measurements over the last hour.
Alarms
The above is an example of an alarm status view showing thermal monitoring related alarms.
The above is an example of an alarm incident view showing a thermal monitoring related incident.
Reports
The above is an example of a trend report showing a 1-week cubicle temperature trend.
You can also generate Thermal Monitoring report. See Continuous Thermal Monitoring Report for
more information.
Maintenance
No maintenance is needed for the Thermal Monitoring of MV Substations application in PME. For
maintenance of the devices installed in the substation, follow any maintenance procedures
outlined in the documentation for SMD, ZBRN32, and sensors.
Reference
This chapter contains reference information related to planning, deploying, and using PME.
Use the following links to find the content you are looking for:
Cybersecurity Reference
Planning references
Installation and Upgrade references
Configuration References
Operation references
Decommissioning Reference
Applications References
Cybersecurity Reference
This section contains reference information related to cybersecurity.
Data encryption
At Rest
PME encrypts the passwords of its user accounts, as well as the Windows and SQL Server
accounts using SHA-512 and AES-256 cryptography. PME uses a unique encryption key for each
installation. The key is generated during the installation of PME. The PME installer offers
functionality for exporting/importing encryption keys for the installation of PME clients or system
upgrades.
The power monitoring data that is collected by PME, and system configuration data are not
encrypted.
In Transit
PME uses Transport Layer Security (TLS) 1.2 for an encrypted, authenticated connection using
HTTPS between the server and the web clients. Both self-signed and authority issued certificates
are supported. PME is installed with a self-signed certificate and a self-signed certificate is
configured automatically. We recommend that you replace this with a security certificates from a
Certificate Authority (CA).
The communication between PME and connected monitoring devices is not encrypted.
PME accounts
The following types of accounts are required for a PME system:
PME Users
A user account in PME provides access to the system. There are 3 different types of users -
standard users, Windows users, and Windows groups. Each user has an access level, which
determines the actions the user is allowed to perform in PME. There are no pre-configured user
accounts or user groups in the system. One supervisor account is created with a user defined
password during the installation of the software. Additional user accounts and groups must be
created manually after installation. Users are created and managed through User Manager. PME
supports Windows Active Directory integration for Windows users and groups.
TIP: Use Windows users and groups to take advantage of Windows account security features
such as maximum login attempts or minimum password requirements.
If SQL Server Express is installed with SQL Server Authentication, through the PME installer, a sa
account with a unique, default password is created automatically during install. The password can
be changed at any time through SQL Server Management Studio.
PME Services
PME uses a number of services to perform the background server tasks. The services use the
Local Service and NT AUTHORITY\System accounts, or the Windows account used for Windows
Integrated Authentication, if that is configured.
Network shares
PME Engineering Clients and Secondary servers require that the Power Monitoring Expert
folder on the PME server is shared with change and read permissions. This file share must be
manually set up before installing Engineering clients or Secondary servers. See Create a file
share for Engineering clients and Secondary servers for more information.
Session timeout
PME automatically times out inactive client sessions. Web Applications clients are logged out and
Windows application clients (Vista, Designer, Management Console) are locked after a period of
inactivity. The timeout period is configurable, it is set to 20 minutes by default. See Web
Applications settings for details on how to set the timeout.
To restart or unlock the session you must enter the login credentials. A session is considered
inactive, if none of the following actions are detected:
• Mouse movement
• Mouse select
• Keyboard activity
NOTE: If custom content links are added to the Web Applications framework, then the custom
content must either implement the idle detection, or activity on that content is not registered and
the web client session can time out unexpectedly. See Adding idle detection to custom Web
Application links for details.
Specify which web applications of PME needed to integrate with third-party systems based on the
generated links. The generated links are authenticated. This is configurable in the PME Web
Applications settings. See Web Applications settings for details on how to generate links.
1. Right-clickthe file and select Properties. This opens the Properties dialog.
4. Verify that the digital signature is OK and that the signer name shows Schneider Electric.
Example:
Planning references
This section contains reference information related to the content in the Planning chapter of this
guide.
Use the following links to find the item you are looking for:
NOTE: The database uses Universal Coordinated Time (UTC) time. When you import data into
Excel, the Clock module’s Time Zone Offset register for the meter is applied.
1. To create a database query in Excel, Select Data > From Other Sources > From
Microsoft Query.
2. To create a new data source, select <New Data Source> from the list and select OK.
3. Type the name you want to give the data source. Once you type a name, the list of drivers
for the database type becomes available. Select <SQL Server> from the list. Select
Connect.
4. Choose your server from the list. Provide your LoginID and Password and select OK. Select
a default table for your data source (optional). select OK to continue.
6. After you have selected the data you want to view, the Query Wizard opens. Use this to
filter and sort the data.
7. Follow the steps in the Query Wizard to add data to the spreadsheet.
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.
Web
ION
Web Services
ModelingConfig
Web Reporter App Pool NetworkService *
reporter
* When PME is installed with Windows Integrated Authentication, then the Windows account that
is used to access the database, is also used to run the IIS Application Pools, instead of the Local
System account.
NOTE: The .NET Trust Level for PME web applications and Default Web Site must be set to Full
(internal), in IIS Manager.
Hardware devices
The following insulation monitoring components are available for all ANSI markets:
The single isolated power panel is a single-voltage, single-system panel. There is no provision for
receptacles, ground jacks, or circuit control. This panel contains one LIM-IG6 and one
transformer. A TCP gateway and other optional devices are available.
The single isolated power panel can be configured with power receptacles and ground jacks on
the faceplate of the panel. This panel configuration is suited for areas that require a central
location for receptacles and ground jacks.
The dual-voltage isolated power panel provides two different output voltages simultaneously from
one isolation transformer. The typical configuration contains the following output voltages:
• One side configured for 208 V or 240 V fixed at 15 kVA.
This panel type contains two LIM-IG6 monitors, one for each power supply side. Additional
components of the dual-voltage panel include:
• 2 reference ground buses
• Provision for two 2-pole branch circuit breakers for 208 V or 240 V side.
Duplex isolated power panels provide two separate voltage outputs from two isolation
transformers. This system is equivalent to two independent single isolated power panels in one
enclosure. The duplex panel contains the following:
• 2 single-phase isolation transformers
• 2 LIM-IG6 monitors
See the isolation power transformer documentation for wiring diagrams, installation, and other
information about the transformer.
IGC Gateway
The IGC gateway, formerly known as COM460IP, can be included in the isolated power panel for
data communications. The IGC gateway converts data from the Bender serial BMS protocol to
Modbus TCP so the data can be recorded and stored by PME. See the IGC gateway
documentation for more information about the gateway.
Circuit Transformers
The SWT3 or SWT4 circuit transformer can be installed for performing load monitoring from the
LIMIG6. The software can display information about the transformer load when this device is
installed.
• STW3 type current transformers monitor up to 100 A load current.
See the SWT3 or SWT4 documentation for more information about the circuit transformers.
Temperature Sensor
A temperature sensor can be installed to monitor the temperature of the isolation power panel.
The temperature sensor must be connected to the digital input of the LIM-IG6. The software can
display temperature information when this device is installed. See the temperature sensor
documentation for more information about the temperature sensor.
Electrical diagrams
This section provides details for electrical connections of the components in the isolated power
panel and the hardware configurations that could be commissioned on site. The following figure
shows the typical configuration for a single isolated power panel with one 120V isolation
transformer, one LIM-IG6 and TCP gateway.
Each isolated power panel can have optional transformer load monitoring, temperature
monitoring, and EDS151 or EDS460 circuit fault locators as shown next.
In order to have the transformer load monitoring and circuit fault location, the panel requires these
components:
• SWT or SWT4 current transformers. These devices perform transformer load monitoring and
are connected to the LIM-IG6 connector plate input 1S1 and 1S2. See the LIM-IG6
documentation for connection details.
• EDS 151 circuit fault locators: Each circuit can have one EDS151 to detect the presence of
insulation faults. See the EDS151 documentation for more information.
In the Insulation Monitoring Module, one area can have a maximum of six LIM-IG6 monitors. This
enables the following panel combinations:
• 6 single isolated power panels. Each panel has 1 LIM-IG6.
Network communication
This section shows a network diagram and describes the network communication between the
devices in the isolated power panel and the power monitoring system.
This network diagram shows a distributed power monitoring system: the databases are on
different servers from the primary server. The system could also have a client server, where users
can view their system and generate reports. Other client PCs with dashboards can be included in
the system.
The LIM-IG6 is connected to other Bender devices in the isolation power panel using RS485
serial cable. The LIM-IG6 communicates with other Bender devices, such as the EDS151,
through the propriety Bender serial bus protocol.
The IGC gateway converts the Bender protocol to Modbus TCP. PME communicates with the IGC
gateway through port 502, the standard Modbus TCP/IP port. The software can also connect to
the IGC gateway through the Silverlight port 4530. Up to three Silverlight ports can be used
simultaneously. See documentation for the IGC gateway for more details.
The LIM-IG6 continuously measures the leakage impedance between isolated line and ground
and calculates the Total Hazard Current (THC). When the THC increases to a hazardous level of
5 mA (USA) or 2 mA (Canada), the LIM-IG6 activates alarms internally and on remote devices if
available. If an EDS151 is connected to the LIM-IG6, the EDS151 is activated automatically after
an alarm is generated by the LIM-IG6. A test signal is sent to the EDS151. The signal flows
through the location of the ground fault. Current transformers placed around each sub feeder or
load will pick up on this test signal. The EDS151 device will then evaluate the results. The location
of the fault is displayed on the EDS151 via an LED bar graph.
All the information above is also available through Modbus TCP protocol. PME gets the real-time
data and the event log through Modbus TCP. The software performs software logging every 5
minutes for the following measurements:
• Total hazard current
• Line voltage
• Leakage resistance
• Leakage impedance
When PME is installed on the system, drivers for the LIM-IG6 and EDS151 are installed on the
primary server. The Insulation Monitoring Configuration Tool is also installed.
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
Licensing resources
Use the following links and contacts to find additional information and tools related to licensing.
https://community.exchange.se.com/t5/EcoStruxure-Power-
This is a summary post on the Exchange community.
Sales Portal Overview Advisor/Introducing-Sales-Portal-Resources-amp-Links- This post provides links to an overview presentation,
user documentation and instructional videos.
Formerly-known-as/m-p/184497/thread-id/353
Sales Portal Technical Use this email address to contact the Sales Portal
[email protected]
Support technical support team.
Licensing Technical
https://www.se.com/ww/en/work/support/ This is a global website for technical support.
Support
You might have other systems installed on the same server for which licensing is based on
Floating License Manager.
To use Floating License Manager after system upgrade, perform the following steps:
1. Copy Floating License Manager folder from the backup folder ( ...\Power Monitoring
Expert\PowerMonitoringExpert_9.1_Backup\Floating License Manager)
NOTE: This backup folder location is based on the system upgrade from PME 2020 to
2024.
3. Launch FloatingLicenseManager.exe.
PME Databases
Power Monitoring Expert uses four databases to store device communication parameters, system
configuration settings, and logged historical data.
ION_Network database
Sometimes called the NOM (Network Object Model), the ION_Network database stores device
information, such as, device name, device type and connection address (for example, IP address
and TCP/IP port or device/Modbus ID). It also contains information about the optional Application
Module settings, other ION Servers, Sites, Dial Out Modems, and Connection Schedules. There
is only one ION_Network per system.
ION_Data database
The ION_Data database contains the historical data, events and waveforms from devices
connected to the system. This includes: onboard logging configured on devices; and, PC-based
logging configured in the device translators and the Virtual Processors.
• Plus many other Warnings and Errors relating to PME system functions.
Startup Log On
Service Name Description
Type Account
Allows the Event Notification Module (ENM) to
ION Application read alarms directly from the ION_Data
Local
Modules Alarm Manual database.
System *
Services Host Starts on demand from other services (for
example, from the Event Notification Module).
ION Application
Modules Core Local Hosts common web services used by the Web
Automatic
Services Host (x32 System * Applications component.
bit)
ION Application
Modules Core Local Hosts common web services used by the Web
Automatic
Services Host (x64 System * Applications component.
bit)
ION Application Hosts web services that provide low-level
Modules Data Local access to system data (that is, real-time,
Automatic
Services Host (x32 System * historical, alarming, and authentication) for the
bit) Web Applications component.
ION Application Hosts web services that provide low-level
Modules Data Local access to system data (that is, real-time,
Automatic
Services Host (x64 System * historical, alarming, and authentication) for the
bit) Web Applications component.
ION Application Hosts web services that provide data
Local
Modules Provider Automatic processing for the Web Applications
System *
Engine Host (x32 bit) component.
ION Application Hosts web services that provide data
Local
Modules Provider Automatic processing for the Web Applications
System *
Engine Host (x64 bit) component.
Automatic
ION Cloud Agent Local
(Delayed Manages interaction with cloud services.
Service System *
Start)
Locates local and remote product components.
ION Component Local
Manual Starts shortly after startup by request of ION
Identifier Service Service *
Connection Management Service.
Startup Log On
Service Name Description
Type Account
Determines the connection status of sites and
devices in the system, and handles allocation
of resources such as modems. This service
manages the state of site and device
connectivity for the system. In order to
ION Connection Local establish the most appropriate state for the
Manual system, each connection and disconnection
Management Service Service *
request is evaluated against the overall state of
the system and availability of communications
channels.
Startup Log On
Service Name Description
Type Account
Serves real-time OPC data (OPC DA) to OPC
client applications.
ION OPC Data Local
Manual Starts on an OPC client request for data, if the
Access Server Service *
Data Exchange Module license has been
activated.
Serves real-time OPC data (OPC UA) to OPC
client applications.
Local
ION OPC UA Server Manual Starts on an OPC client request for data, if the
Service *
Data Exchange Module license has been
activated.
Translates power quality data from the ION_
ION PQDIF Exporter Local
Manual Data database into PQDIF file format and
Service Service *
manages scheduled PQDIF exports.
Provides historical data retrieval from the ION_
Local
ION Query Service Automatic Data database for client applications (for
Service *
example, Vista and Diagrams).
Manages and provides access to real-time data
ION Real Time Data Local
Automatic for all client applications (Vista, Diagrams,
Service Service *
Trends, and so on).
Startup Log On
Service Name Description
Type Account
ION Virtual Provides aggregation, control, and
Local
Processor Service - Automatic mathematical analysis of power monitoring
Service *
NVIP.DEFAULT system data.
Serves up data for the Power Quality
ION Virtual
Local Performance diagrams. Functions only when
Processor Service – Automatic
Service * the Power Quality Performance module is
NVIP.PQADVISOR
licensed and configured.
Serves up data for the Disturbance Direction
ION Virtual
Local Indicators application. Functions only when the
Processor Service – Automatic
Service * Disturbance Direction Indicators application is
NVIP.DDD
configured.
Manages subscriptions to XML data for Vista
user diagrams. This service is used only by the
ION XML Local Diagrams application. When you open a Vista
Automatic
Subscription Service Service * user diagram in a web browser, the ION XML
Subscription Service creates a subscription
and delivers the real-time data in XML format.
Stores XML data subscriptions for the power
ION XML
Local monitoring devices on the network. This
Subscription Store Automatic
Service * service is used only by the Diagrams
Service
application.
Provides storage, processing and controlled
access of data, and rapid transaction
Local
SQL Server (ION) Automatic processing for the ION_Data, ION_Network,
System
ION_SystemLog, and the ApplicationModules
databases.
Converts data from ASCO equipment to a PME
compatible format. Starts automatically after
ION Software ASCO Local
Automatic Service Restart is selected for the first time in
Gateway Service Service *
ASCO Automatic Transfer Switch
Configuration Tool.
You can import COMTRADE waveforms from
ION Comtrade Local
Automatic the 3rd party devices into PME system and
Processor Service
analyze the PQ data.
Syslog is a standardized message logging
ION Syslog Server Local protocol supported for transmitting data.
Automatic
Service Service Messages configured in PME will be sent to
configured Syslog server.
* When PME is installed with Windows Integrated Authentication, the Windows account that is
used to access the database is also used to run the PME services.
Server
Login Authentication Database Membership
Role
AMUser SQL Public ApplicationModules AMApplicationRole
ApplicationModules db_owner
ION_Data db_owner
ION SQL Public
ION_Network db_owner
ION_SystemLog db_owner
ION_Data ION_DSD_Reader
ionedsd SQL Public
ION_Network NOM_DSD_Reader
db_backupoperator,
ApplicationModules db_ddladmin,
Maintenance
db_backupoperator,
ION_Data db_ddladmin,
Maintenance
IONMaintenance* Windows Public
db_backupoperator,
ION_Network db_ddladmin,
Maintenance
db_backupoperator,
ION_SystemLog db_ddladmin,
Maintenance
* This account is only created on standalone servers where the SQL Server software and PME
are installed on the same computer.
Server
Login Authentication Database Membership
Role
ApplicationModules db_owner
Account used for
ION_Data db_owner
Windows Integrated Windows Public
ION_Network db_owner
Authentication
ION_SystemLog db_owner
db_
backupoperator,
ApplicationModules
db_ddladmin,
Maintenance
db_
backupoperator,
ION_Data
db_ddladmin,
Maintenance
IONMaintenance * Windows Public
db_
backupoperator,
ION_Networks
db_ddladmin,
Maintenance
db_
backupoperator,
ION_SystemLog
db_ddladmin,
Maintenance
* This account is only created on standalone servers where the SQL Server software and PME
are installed on the same computer.
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Other
PME must have access to the master and tempdb System Databases.
The PME Database Manager tool requires that the Windows account that is used to run it has
sysadmin permissions on the PME SQL Server instance. The Database Manager is an optional
tool, used for managing the PME databases.
Windows accounts
The following tables provide information on the Windows accounts used by Power Monitoring
Expert (PME):
* This account is only created on standalone servers where the SQL Server software and PME
are installed on the same computer.
NOTE: For information on which accounts are used to run the PME Windows services, see PME
Windows services and IIS Application Pools.
For installations using Windows Integrated Authentication, the following additional accounts and
permissions are required:
NOTE: When PME is installed with Windows Integrated Authentication, the Windows account
that is used to access the database is also used to run the PME services and the IIS Application
Pools.
Use the following links to find the content you are looking for:
• 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 select 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. Select 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 Select 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 select OK to close the
dialog.
Setup Types
Installer Pages
Standalone Application Server Engineering Client
Application Language * Y for all setup types
Welcome Y for all setup types
License Agreement Y for all setup types
Setup Type Y for all setup types
System Key Y Y n/a
Import System Key n/a n/a Y
Export System Key Y Y n/a
User Information Y for all setup types
Web Application Y Y n/a
Application Server n/a n/a Y
Diagnostic and Usage Y Y n/a
File Destination Y for all setup types
Supervisor Account Y Y n/a
Windows Accounts Y Y n/a
Database Accounts Y Y n/a
Database Software Y Y n/a
Database Files
Y Y n/a
Destination
Check System Y for all setup types
Ready to Configure Y for all setup types
Copy Files Y for all setup types
Configure System Y for all setup types
Complete Y for all setup types
* - Verify that the PME installation and the OS language are same to avoid any conflicts later.
PME Installer
The PME installer is the installer of the new PME version. It automatically performs an In-Place
upgrade if it detects an existing, supported PME installation on the server. The PME installer is
part of the .iso install file or DVD for PME.
Upgrade Map
The Upgrade Map is a Microsoft Excel based tool that shows the supported upgrade paths and
prerequisites for In-Place and SBS upgrades. The Upgrade Map also shows which tool to use for
the upgrade.
Configuration Manager
The Configuration Manager is a standalone tool that is used for Side-by-Side (SBS) upgrades of
PME. It reads the configuration of the old PME system and copies it to a new PME system. Some
manual steps are needed to complete the upgrade when using the Configuration Manager. The
tool comes with instructions for the manual SBS upgrade steps.
See Resources for information on where to get the tools and resources.
NOTE: Time estimates are for engineers who are experienced in deploying and customizing
PME.
To perform a ping test, open a command prompt on each computer and type ping <computer_
name>, where <computer_name> is the name of the other computer you want to contact.
A successful response shows 4 attempts to contact the computer, lists the IP Address, indicates
Packets: Sent = 4. Received = 4, Lost = 0 (0% loss), plus timing data. If this is
not the case, it indicates that the computers cannot communicate and that you need to resolve the
connectivity situation.
NOTE: The ping utility requires that Internet Control Message Protocol (ICMP) is enabled on
your network.
1. Select Start > All Programs > Microsoft SQL Server 20xx > Configuration Tools >
SQL Server Configuration Manager, where 20xx is the SQL Server version.
2. Expand SQL Server Network Configuration in the left pane and Select Protocols for
ION.
or,
b. Select Properties to open the TCP/IP Properties dialog, select Yes for Enabled, and
select OK.
When you enable the TCP/IP protocol, an informational message indicates that you
need to restart the service before the change takes effect.
4. Select SQL Server Services in the left pane under SQL Server Configuration Manager.
5. Select SQL Server (ION) to select it and then select the Restart service icon in the toolbar
to stop the service and restart it.
1. Go to Windows Explorer and search for Registry Editor. A new window appears with the
regedit application
2. In the Connections pane (left pane) expand server name > Sites > Default Web Site.
Right-select Default Web Site and select Edit Bindings... from the context menu.
5. In the Edit Site Binding dialog, select Disable TLS 1.3 over TCP.
b. Friendly name: (Enter the name under which the certificate will be displayed in Windows
menus and UIs, example: Power Monitoring Expert Certificate.)
2. In the Connections pane (left pane) expand server name > Sites > Default Web Site.
Right-Select Default Web Site and Select Edit Bindings... from the context menu.
TIP: To find the “Issued To” name of the certificate, Select View, after Selecting the
certificate in the drop down (step b).
b. Set SSL certificate to the security certificate you want to use with PME.
6. In the Site Bindings dialog remove any existing http binding. Close the dialog.
4. Find the entry in the result set with the following values:
a. ItemType = Web Framework
b. Item = Server
c. Key = LocalServerAddress
5. Update the Value column to include the server Fully Qualified Domain Name (FQDN) and
port number (if required).
Example:
If the security certificate is issued for the host mysampledomain.com with the default
port, then update the Value column to: https://mysampledomain.com/.
If the security certificate is issued for the host mysampledomain.com with the port
number 567, then the correct value would be: https://mysampledomain.com:567.
6. Find the entry in the result set with the following values:
a. ItemType = Web Framework
b. Item = Url
c. Key = RemoteAccessHost
7. Update the Value column to include the server Fully Qualified Domain Name (FQDN) and
port number (if required).
Example:
If the security certificate is issued for the host mysampledomain.com with the default
port, then update the Value column to: https://mysampledomain.com/.
If the security certificate is issued for the host mysampledomain.com with the port
number 567, then the correct value would be: https://mysampledomain.com:567.
4. Find the entry in the result set with the following values:
a. Module = Reporting
c. Item = WebServiceUrl
5. Update the Value column to include the server Fully Qualified Domain Name (FQDN) and
port number (if required).
Example:
If the security certificate is issued for the host mysampledomain.com with the default
port, then update the Value column to:
https://mysampledomain.com/ionreportdataservice/ReportDataService
.asmx.
If the security certificate is issued for the host mysampledomain.com with the port
number 567, then the correct value would be:
https://mysampledomainc.om:567/ionreportdataservice/ReportDataSer
vice.asmx.
2. Edit the Web.config file using any editor. The recommended tool is Notepad++.
4. Comment out the default http endpoint bindings and remove the comment on the https
endpoint bindings.
-->
<endpoint binding="webHttpBinding"
contract="PowerQuality.EventProcessor"
behaviorConfiguration="RESTBehavior" bindingConfiguration="https" />
</service>
<service name="PowerQuality.DowntimeService.Impact">
<!--<endpoint binding="webHttpBinding"
contract="PowerQuality.DowntimeService.Impact"
behaviorConfiguration="RESTBehavior" bindingConfiguration="http" />
-->
<endpoint binding="webHttpBinding"
contract="PowerQuality.DowntimeService.Impact"
behaviorConfiguration="RESTBehavior" bindingConfiguration="https" />
</service>
</services>
The domain name should match with the host name to which security certificate is issued.
For example: If the security certificate is issued for the host mysampledomain.com, then
add the following:
<add domainName="mysampledomain.com" allowed="true"/>
2. Edit the hosts file using any editor. The recommended tool is Notepad++.
For example: If the security certificate is issued for the host mysampledomain.com, then
the entry should be the following:
# 127.0.0.1 mysampledomain.com
If the correct entry is not reflecting, flush the local DNS cache by either of the following:
Open a windows Command window (cmd.exe) and run ipconfig /flushdns.
Example:
If the security certificate is issued for the host mysampledomain.com with the default
port, then the correct value would be: https://mysampledomain.com/Web.
If the security certificate is issued for the host mysampledomain.com with the port
number 567, then the correct value would be:
https://mysampledomain.com:567/Web.
Reset IIS
1. Open a windows Command window (cmd.exe) and run iisreset.
2. Open the windows Services console, and restart the following service: ION Application
Modules Core Services Host. select Yes when asked to restart the ION Application
Modules services.
1. Open SQL Server Management Studio (SSMS) and connect to the PME SQL server.
4. Close SSMS
6. Close all PME Web client browser instances to remove any caching of previous HTTPS
connection information.
NOTE: To enable the automatic redirect, follow the same instructions as above but set the value
for the IsSecureConnectionRequired key in the script to True.
2. In the Connections pane (left pane) expand server name > Sites > Default Web Site.
Right-Select Default Web Site and Select Edit Bindings... from the context menu.
3. In the Site Bindings dialog remove any bindings to port 443 (https).
4. Select Close.
1. Open SQL Server Management Studio and connect to the PME SQL server.
4. Find the entry in the result set with the following values:
a. ItemType = Web Framework
b. Item = Server
c. Key = LocalServerAddress
6. Find the entry in the result set with the following values:
a. ItemType = Web Framework
b. Item = Server
c. Key = IsSecureConnectionRequired
1. Open SQL Server Management Studio and connect to the PME SQL server.
4. Find the entry in the result set with the following values:
a. Module = Reporting
c. Item = WebServiceUrl
7. Open the windows Services console, and restart the following service: ION Application
Modules Core Services Host. Select Yes when asked to restart the ION Application
Modules services.
NOTE: This section is applicable only for PME 2021 CU1 and later. For versions before
PME 2021 CU1, this step is not required.
2. Edit the Web.config file using any editor. The recommended tool is Notepad++.
<authentication mode="Forms">
</authentication>
<sessionState cookieName=".APPLICATIONSESSIONID"
cookieSameSite="None" />
</authentication>
7. Edit the Web.config file using any editor. The recommended tool is Notepad++.
1. Open a Windows explorer window and navigate to: Desktop -> Power Monitoring Expert
C - Reset IIS
1. Open a windows Command window (cmd.exe) and run iisreset
The setting that controls the historical Power Quality data range to be processed is stored in the
database. This setting defines the start date from which on the data is processed. The default
start date is set to 1980-01-01 (yyyy-mm-dd).
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.
1. On the PME server, open the Windows Services panel. Find the ION Log Subsystem Router
Service and stop this service.
2. On the PME database server, open SQL Server Management Studio (SSMS).
4. Execute the script on the ApplicationModules database. This returns the settings for the
Alarm Service Processing.
5. Find the OldestConsideredPQEventTimeUtc setting in the Key column and check the
date it is set to.
6. Open a new query window in SSMS and copy in the following SQL script:
UPDATE [ApplicationModules].[Configuration].[ConfigurationSettings]
SET Value = 'Enter the start date in the format yyyy-mm-dd'
WHERE [key]= 'OldestConsideredPQEventTimeUtc'
7. Replace the Enter the start date in the format yyyy-mm-dd text with the start
date for the data processing and then execute the script.
9. Close SSMS.
10. Open the Windows Services panel. Find the ION Log Subsystem Router Service and start
this service.
When you open the Alarms Web application for the first time, it will start processing existing power
quality events starting with the date you set above.
NOTE: To use this procedure you must use Mixed Mode Authentication for the SQL Server. This
procedure does not work if you use SQL Integrated (Windows) Authentication for the SQL
Server.
The following describes how you can install PME without having to provide SQL Server account
credentials with sysadmin privileges in the PME installer. This involves using the software installer
and performing manual configuration steps on the database server.
NOTE: The user account that is used on the database server to run the SQL scripts that are part
of this procedure, must have sysadmin privileges on the SQL Server. However, you do not have
to enter information for this account in the PME installer.
Overview
Installing PME with manual installation of the databases consists of the following steps:
1. Running the PME installer to install and configure the application files.
2. Manually running scripts on the database server to create the databases and setup the
database accounts.
Prerequisites
• You need the PME install DVD or ISO file.
• You will need to set a password for the three SQL accounts (ION, ionedsd, AMUser) that
PME uses to access the database. This password must comply with the password policies of
the Windows server and the SQL server.
• You need the following SQL server accounts on the database server:
An account that can connect to the SQL server instance. This account does not require
sysadmin privileges. This account is used for the installation of PME and future password
resets.
An account that has sysadmin privileges on the SQL Server. This account is used to run
the SQL scripts to create the databases and setup the database accounts.
• You need a folder on the database server for the database files. This folder must exist before
you start the PME installation.
• You need access to SQL Server Management Studio on the database server.
Installation
Run the PME installer on the application server and follow the regular install process, with the
modifications shown below:
1. On the Setup Type installer page, choose Application Server setup type. Continue with
the installer workflow.
2. On the Database Accounts installer page, choose Use SQL Server Authentication and
provide your own password by selecting Change Password. Continue with the installer
workflow.
NOTE: Do not use the installer generate password since it cannot be copied. You will need
access to this password in step 18 below, when editing a script file.
NOTE: If you change the password, the password you are providing must comply with the
password policies of the Windows server and the SQL server.
The software installer cannot validate the password at the time you enter it.
If the password is not valid, the installation will not be successful. In that case, complete the
installation, skipping any unsuccessful steps. See Unsuccessful installation due to invalid
account passwords for information on how to repair the unsuccessful install.
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. On the SQL Server installer page, choose SQL Server Authentication and provide SQL
account information for a low privilege account. This account only needs to be able to
connect to the SQL Server instance. Continue with the installer workflow.
TIP: Make a note of the account username. You will need this username in step 9 and 16
below, when editing a script file.
4. On the Database Files Destination installer page, provide the path to the folder on the
database server, where the database files will be installed. Continue with the installer
workflow.
NOTE: The folder on the database server must exist. The PME installer cannot create a
folder or verify the existence of a folder on the database server. This is because the SQL
account you specified in the previous step has low privileges.
5. After copying files and completing many configuration steps, the installer will stop on the
Create Database step and display an error message. This is because the installer could not
create the databases.
Example:
Leave the installer open in this state. On the PME application server, browse to ...\Power
Monitoring Expert\Database\Diagnostic and copy the following files from there, to
a temporary location on the database server: ION_Data.sql, ION_Network.sql, and
ION_SystemLog.sql.
6. On the database server, open SQL Server Management Studio (SSMS) and enable SQL
CMD by going to Tools > Options, selecting on Query Execution and checking the box By
default, open new queries in SQL CMD mode.
Example:
7. On the database server, open and execute the three scripts files (ION_Data.sql, ION_
Network.sql, and ION_SystemLog.sql) in SSMS. If an Inconsistent Line Endings
dialog box is displayed, select Yes to continue.
NOTE: The account you use to log into the database server must have sysadmin privileges
on the SQL Server.
NOTE: The order in which you run the scripts is not important.
NOTE: The script files create three of the four PME databases - ION_Data, ION_
Network, and ION_SystemLog. The ApplicationModules database will be created
in a later step.
8. On the PME install DVD or ISO file, browse to root\ManualInstall\ and copy the
following script file from there, to a temporary location on the database server:
ManualDBInstall_Script1-Make_DBOwner-DataNtwrkSystm.sql.
NOTE: This will add the account to the db_owner role in the databases.
10. Go back to the PME installer on the application server. It still shows the Configure System
page with the unsuccessful Create Database step. select Skip failed step to skip the failed
Create Database step.
Example:
11. The installer will stop on the Create Database step and display an error message. This is
because the installer could not create the ApplicationsModules database. Leave the
installer open in this state.
13. On the database server, open and execute the ApplicationsModules.sql script files in
SSMS. This will create the ApplicationsModules database.
14. On the PME install DVD or ISO file, browse to root\ManualInstall\ and copy the
following script file from there, to a temporary location on the database server:
ManualDBInstall_Script2-Make_DBOwner-AppMods.sql.
NOTE: This will add the account to the db_owner role in the database.
16. On the PME install DVD or ISO file, browse to root\ManualInstall\ and copy the
following script file from there, to a temporary location on the database server:
ManualDBInstall_Script3-CreateMap_Logins.sql.
NOTE: This will create the PME database accounts that are used by the software to
connect to the databases.
18. Go back to the PME installer on the application server. It still shows the Configure System
page with the unsuccessful Check Applications Database step. select Skip failed step to
skip the failed Check Applications Database step. Continue with the installer workflow.
19. The installer will stop on the Configure SQL Server step and display an error message.
select Yes to continue with the rest of the installation.
NOTE: The installer will display a Could not complete all steps message when it finishes.
Ignore this message. The steps that did not complete are the ones that were done manually as
per instructions above, and then skipped.
Final notes
• Delete the low privilege SQL account created for step 3. It is no longer needed.
NOTE: Note that all three logins need to use the same password.
Then run the PME installer on the application server and select Reset Accounts. In Reset
Accounts, change the password for the Database Accounts to match the one you manually
set in SSMS. You can use the low privilege SQL account created for step 3 for the password
reset in the installer.
NOTE: If you use an SQL account without sysadmin level SQL credentials for the password
reset in the installer, you will see an error at the Update Login Credentials step. Ignore the
message and skip this unsuccessful step. The password reset will still be successful.
• 32-bit version of SQL Server Express is not included with the PME installer
32-bit version of SQL Server Express is not included with the PME installer
32-bit versions of SQL Server Express are still supported, but they are not included with the
installer. If you want to use a 32-bit version, you need to install it on the PME server before
installing the software.
The 64-bit version of SQL Server Express is included with the installer and can be installed as part
of the PME installation workflow.
• VIP Modbus Slave functionality now requires a Data Exchange Module license
• PQ Advisor has changed to PQ Performance and needs some manual post upgrade steps
If your existing system contains VIP frameworks with Modbus Import or Modbus Export modules,
then these modules will be removed automatically during the upgrade. At the same time,
information on configuration settings of these modules and links to other ION modules in the
framework is captured. You can use this information to configure replacement functionality in the
new, upgraded system. For details on the removal of this feature during upgrade and the
information captured, see knowledge base article FA382887.
NOTE: Only the Modbus Import and Modbus Export modules are removed from VIP frameworks
during upgrade. Other modules in the framework remain unchanged.
NOTE: ION modules that have input or setup registers linked to the Modbus Import and Modbus
Export modules will not be functional after the removal of these modules on upgrade. You need
to review the configuration and links of these modules, after the upgrade, and manually put them
back online.
NOTE: Any links from an affected VIP framework to other parts of the system, for example links
to another VIP, remain unchanged during the module deletion process. That means the
functionality provided by those other parts might no longer work as expected. You need to
review any linked functionality, after the upgrade, and make manual updates as required.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Before installing the upgrade, verify that the system is not performing critical control actions
that may affect human or equipment safety.
• Verify correct system operation after the upgrade.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
WARNING
INACCURATE DATA RESULTS
• Before installing the upgrade, verify that the system data results are not used for critical
decision making that may affect human or equipment safety.
• Verify correct system data results after the upgrade.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
NOTE: After the upgrade and before putting the system into service, review any VIP frameworks
that might have had Modbus Import or Modbus Export modules removed during upgrade.
Consider any automated system controls or third-party interactions that might be affected by the
module removal. Make any configuration changes necessary for your system to operate as
expected. Do not put your PME system back into service until you have confirmed its correct
operation.
VIP Modbus Slave functionality now requires a Data Exchange Module license
The Modbus Slave functionality in the VIP requires a valid Data Exchange Module license to be
functional from PME 2020. You must activate this license in PME before you can use the Modbus
Slave functionality.
NOTE: On system upgrade, the Modbus Slave functionality will be disabled, if this license has
not been activated. In that case, PME will periodically log high priority events to the system log
as a reminder that the Modbus Slave functionality is disabled due to insufficient licensing.
When you upgrade a pre-PME 2020 system with an existing ENM configuration, this configuration
will not work after the upgrade. You need to reconfigure the ENM after the upgrade. See Event
Notification Module configuration for more information.
For example, if a device is configured in Management Console or Device Manager with Indian
Standard Time (IST) time zone and the Web client is in Pacific Standard Time( PST) time zone.
In PME 2021 and older versions, for a real-time trend from now to 15 minutes, the graph plots
relative to the browser time zone (PST) even though the device is in IST time zone. The default X-
axis time zone of trend graph is browser time zone.
From PME 2022, for a real-time trend from now to 15 minutes, the graph does not plot because
the plot is based on the device/source time zone (IST). The trend graph X-axis time zone can be
selected as device/source time zone if the devices are in same time zone. The default X-axis time
zone of trend graph is browser time zone.
On a pre-PME 2021 system, if EWS client version 1.1 is used to connect with PME EWS server.
After upgrade to PME 2022 system, change the EWS client version to 1.2 for better performance.
1. Use Configuration Manager 2023 to upgrade the PME 7.2.2 and PME 8.x systems to PME
2023 systems.
NOTE: Install PME 2023 in a different path than PME 8.1, 8.0, or 7.2.2 to avoid potential
conflicts with leftover files from the 8.1, 8.0, or 7.2.2 install.
4. Use Configuration Manager 2023 to write the archived configuration of the old system to the
new PME 2023.
See Configuration Manager for information on this tool. Download the Configuration Manager
2022 from the Schneider Electric Exchange. See Resources for link information. See Upgrade
version support for general upgrade support information.
NOTE: Only for upgrades from versions older than PME 9.0.
Reporter, the Excel based reporting feature, was removed in PME 9.0.
For In-Place upgrades of older PME versions, which includes Reporter, the Reporter functionality
is left in place during the upgrade, but the SQL login account used by Reporter to access data in
the database, is removed. This is done for security reasons.
If you want to continue to use Reporter on an upgraded PME 2024 system, you need to create a
new SQL login account for Reporter and then update the reports with the new account
information.
1. Open Microsoft SQL Server Management Studio (SSMS) on the PME database server
computer.
2. Create a new login with the Login name Report and SQL Server Authentication.
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. Run the following SQL scripts on the ION_Data and ION_Networks databases:
EXEC sp_change_users_login 'Auto_Fix', 'Report'
In the Unhide sheet box, select |PRIVATE|Datasheets and then select OK.
Scroll to the right of the file and update the PASSWORD value to match that of the
Report SQL Server account.
Verify that the server name (column Y) and the database instance name (column Z)
are correct.
WARNING
POTENTIAL COMPROMISE OF SYSTEM AVAILABILITY, INTEGRITY, AND
CONFIDENTIALITY
Use cybersecurity best practices to help prevent unauthorized access to the
software.
Work with facility IT System Administrators to ensure that the system adheres to the
site-specific cybersecurity policies.
NOTE: Only for upgrades from versions older than PME 9.0.
The Tables Web application was removed in PME9.0. Use the table gadget in Dashboards
instead, to setup real-time data displays.
Saved Tables are not migrated to the new table gadgets automatically during the upgrade. You
need to manually recreate the tables in Dashboards, using the table gadget, after the upgrade.
PQ Advisor has changed to PQ Performance and needs some manual post upgrade
steps
NOTE: Only for upgrades from versions older than PME 9.0.
The PQ Advisor software module was renamed to PQ Performance in PME 9.0. As part of this
name change, the VIP framework for PQ Performance was updated. If you are using the PQ
Performance module, then we recommend that you update the framework on your system after
the PME upgrade. To do this, delete the existing PQ Advisor framework in the VIP, paste in the
new framework, and check the Vista diagram links to the VIP framework. See Configure Power
Quality Indicator Diagrams for information on pasting the framework.
If you created a custom tab in the Web Applications of the old system for PQ Advisor, you need to
recreate this tab manually in the new system. The procedure for creating custom tabs changed in
PME 9.0. See (Optional) Create a Power Quality Performance link in the Web Applications for
details.
NOTE: The PQ Performance VIP still uses the old VIP.PQADVISOR name.
NOTE: Only for upgrades from versions older than PME 9.0.
See Install a security certificate for TLS 1.2 in the Install section of this guide for details.
The following table shows the support status for recent PME releases.
• Providing workarounds and fixes for known problems, when possible. No hotfixes for new
issues.
• Providing information on migration to a newer product release with Full Support.
Configuration Manager
This section contains reference information related to the Configuration Manager tool.
TIP: See Resources for information on where to get the Configuration Manager tool.
Use the links below to find the content you are looking for:
About
Version History
Glossary
Configuration Manager user interface
Writing to a Customized PME System
Reconfigure fails after Write to System
Save to archive fails because of insufficient SQL Server service account permissions
Configuration Manager 2024 release notes
About
This program is protected by copyright law and international treaties. Unauthorized reproduction
or distribution of this program, or any portion of it, may result in severe civil and criminal penalties,
and will be prosecuted to the maximum extent possible under the law.
Configuration Manager
Version 2024
Language: English
Release date: 10/2024
Version History
The following information lists the changes that were introduced in each tool release:
Release 10
Release name: Power Monitoring Expert - Configuration Manager 2024
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
(Exception: PME 8.1 archives created with Configuration Manager 2.0.1 can be loaded and
written.)
System support
NOTE: Upgrades and migrations between different architectures are also supported
(Standalone -> Distributed Database, Distributed Database -> Standalone)
New features
Release 9
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
(Exception: PME 8.1 archives created with Configuration Manager 2.0.1 can be loaded and
written.)
System support
NOTE: Upgrades and migrations between different architectures are also supported
(Standalone -> Distributed Database, Distributed Database -> Standalone)
New features
Release 8
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
(Exception: PME 8.1 archives created with Configuration Manager 2.0.1 can be loaded and
written.)
System support
NOTE: Upgrades and migrations between different architectures are also supported
(Standalone -> Distributed Database, Distributed Database -> Standalone)
New features
Release 7
Release name: Power Monitoring Expert - Configuration Manager 2021
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
(Exception: PME 8.1 archives created with Configuration Manager 2.0.1 can be loaded and
written.)
System support
NOTE: Upgrades and migrations between different architectures are also supported
(Standalone -> Distributed Database, Distributed Database -> Standalone)
New features
Release 6
Release name: Power Monitoring Expert - Configuration Manager 2020
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
(Exception: PME 8.1 archives created with Configuration Manager 2.0.1 can be loaded and
written.)
System support
NOTE: Upgrades and migrations between different architectures are also supported
(Standalone -> Distributed Database, Distributed Database -> Standalone)
New features
Release 5
Release name: Power Monitoring Expert - Configuration Manager 9.0
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
(Exception: PME 8.1 archives created with Configuration Manager 2.0.1 can be loaded and
written.)
System support
NOTE: Only upgrades and migrations within the same architecture are supported (Standalone -
> Standalone, Distributed Database -> Distributed Database)
New features
Release 4
Release name: Power Monitoring Expert - Configuration Manager 2.1.0
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
System support
NOTE: Only Standalone system architectures are supported, except for ION Enterprise 6.0.1
Distributed Database systems, which can be upgraded to PME 8.2 Distributed Database.
Release 3
Release name: Power Monitoring Expert - Configuration Manager 2.0.0
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
System support
New features
Release 2
Release name: Power Monitoring Expert - Configuration Manager 1.1.0
NOTE: Archived configurations saved with an earlier version of the Configuration Manager are
not compatible with this release of the tool.
System support
New features
Improvements
General
• Archive file path and name length can be any length; it is no longer restricted to 256
characters.
• Improved error messaging.
• WebReach Start-up diagrams and Vista start-up diagrams are now supported.
• A hierarchy is always written to the target system, even if it contains broken device
references.
User Interface
• Improved messaging and workflows to indicate when services are stopped and restarted.
• The Configuration Manager now displays the Report Subscription's description field:
• Log pane – Added more detail to log messages and improved log message wording.
• Log pane – Changed the default initial sort to show newest log messages first.
Reports
• Reports that were deleted from Custom Report Packs are no longer imported into the target
system.
• Default report sharing is supported.
Release 1
Initial release.
System support
Glossary
The following is an alphabetical list of terms and definitions that are commonly used within the
context of using Configuration Manager.
Term Definition
A computer in a distributed PME system that is running all of the
Application Server PME applications and services. See Distributed System for more
details.
A portion of a configuration. For example: Components vary from
Component
version to version.
Configuration See "PME configuration."
Computer in a distributed PME system that is running the SQL
Database Server database server software and the PME databases. See
“Distributed System” for more details.
DB SQL Server Database System
Device A meter or a point of data collection.
PME installation where parts of the system are installed on
different computers. Different combinations are possible but the
most common is the separation of the PME applications and the
Database server onto different computers.
For example, a simple distributed install would have all the PME
relevant programs and services installed on one computer and
SQL Server with the PME databases installed on a second
Distributed System
computer. In this case, the computer running the applications is
called “Application Server” and the computer running SQL Server
is called “Database Server.”
Term Definition
Information that determines the behavior of a PME system as well
as its look and feel. This information is stored in the software in
various places such as the database, the Windows registry, the file
system, and configuration files. Configuration information is part of
PME configuration the factory install and can be modified or added to during the
commissioning phase and throughout the lifetime of the software.
Configuration information includes settings that are persistent and
determine the state of the software. For example, enable or
disable, boundary conditions, and so on.
A configuration scenario where a field engineer configures a PME
system on a physical computer or Virtual Machine in their office.
After the system has been completely deployed, the configuration
Off-site configuration is exported to a portable archive using the Configuration Manager.
The field engineer then visits the customer site and - using the
same tool - imports the configuration from the archive into the
target PME system that was installed at the client site.
RESL Knowledge base Article - referenced by its RESL number
SSDT SQL Server Data Tools
SSMS SQL Server Management Studio
Single computer running all parts of a PME system. See
Standalone Server
“Standalone System” for more details.
PME installation where all parts of the system are installed on the
same computer, that is all PME applications and services, the SQL
database server, and the PME databases are on a single
computer. This single computer is then referred to as “Standalone
Standalone System Server”.
The topics in this section describe the controls and options available in the Configuration Manager
user interface.
Operation toolbar:
Write to System – Replaces the system configuration with the archived configuration.
Configuration and operation information tabs:
Log – Displays messages that are generated by the Configuration Manager when it
performs an operation.
Information pane:
Review the following information to understand how customized components are effected.
Likely cause: The system key that was provided to the Configuration Manager during Write to
System is not the correct key for the source system archive.
2. Run the PME installer again and choose Export System Key. Save the system key in a
secure location. This key will be needed in step 4 below.
3. Run the PME installer again and choose Import System Key. Provide the correct source
system key. The installer will automatically run a reconfigure after importing the new key.
4. Run the PME installer a third time and choose Import System Key. Provide the original key
for this system from step 2 above. This will ensure that the target system has a unique key
that is different from the source system key.
Likely cause: As part of the save to archive, SQL Server creates backups of the PME databases.
The database backup files are saved to the destination folder under the security context of the
SQL Server service account. If SQL Server does not have write access to the destination folder,
the save to archive is not successful.
Resolution: Try saving the archive to a different location or edit the SQL Server service account
permissions and try saving to the same location again.
Configuration References
This section contains reference information related to the content in the Configuring chapter of
this guide.
Use the following links to find the content you are looking for:
Software Alarms UI
Add Alarm Rule UI
Schedules Configuration UI
Software Alarms UI
Main UI and Alarm Rules tab
Main UI
Selection tabs
1
Select a tab to see information related to Alarm Rules, Schedules, or Source View.
Help
2
Select Help to open the Software Alarms online help.
Number of displayed items
7
Shows the number of items visible on this page, and the total number in this View.
Page Selector
8 Use the page Selector to navigate between pages. Set the number of items that are
displayed on a page.
Schedules UI
Add Schedule
1
Use Add Schedule to create a new Schedule.
Schedules table
2
The Schedules table shows all the Schedules that are configured in the system.
Schedules options
3
Use Schedules options to duplicate, edit, or delete Schedules.
Source View UI
Measurement Selection UI
Real-time Alarms UI
(The above is one example of a Real-time Alarm. The configuration options may vary for other
Real-time Alarms.)
Alarm Name
1 The Alarm Name is the identifier for this alarm in the system. It is used as a reference by
other applications.
Input Evaluation
2 The Input Evaluation setting determines how often the Alarm evaluates the input
measurement value.
Active Condition
3
The Active Condition settings determine when the Alarm goes into an Active state.
Inactive Condition
4
The Inactive Condition settings determine when the Alarm goes into an Inactive state.
Advanced Settings
5 The Advanced Settings determine which priority value is assigned to the Alarm and if the
extreme measurement value that occurs during the Alarm active state is logged.
(The above is one example of a fixed setpoint logged data Alarm. The configuration options may
vary for other fixed setpoint logged data Alarms)
Alarm Name
1 The Alarm Name is the identifier for the Alarm in the system. It is used by as a reference by
other applications.
Input Evaluation
The Input Evaluation setting determines how the Alarm evaluates the input measurement
value. The following options are available:
1 minute
5 minutes
In this configuration, the Alarm evaluates the
10 minutes
Datalog logged measurement value as it was logged at
15 minutes
the specified time intervals.
2 30 minutes
1hr
In this configuration, the Alarm evaluates the
logged measurements as rolled up values. The
interval is either Hourly or Daily. The roll up
Hourly
Aggregated method is defined by the measurement type. For
Daily
example, energy measurements are
accumulated and demand measurements are
averaged.
Active Condition
3
The Active Condition settings determine when the Alarm goes into an Active state.
Inactive Condition
4
The Inactive Condition settings determine when the Alarm goes into an Inactive state.
Advanced Settings
5 The Advanced Settings determine which priority value is assigned to the Alarm and if the
extreme measurement value that occurs during the Alarm active state is logged.
(The above is one example of a smart setpoint logged data Alarm. The configuration options may
vary for other smart setpoint logged data Alarms)
Alarm Name
1 The Alarm Name is the identifier for the Alarm in the system. It is used by as a reference by
other applications.
Active Condition
2
The Active Condition settings determine when the Alarm goes into an Active state.
Inactive Condition
3
The Inactive Condition settings determine when the Alarm goes into an Inactive state.
Advanced Settings
4 The Advanced Settings determine which priority value is assigned to the Alarm and if the
extreme measurement value that occurs during the Alarm active state is logged.
Smart Setpoint
A Smart Setpoint evaluates the input measurement against statistical and historical
behavior of that same input measurement. The following pre-defined settings are available:
You can also define a custom rule for evaluating the input based on the options provided in
the Smart Setpoint configuration window.
Schedule Selection UI
Schedule Selector
1 Select which Schedule you want to use for this Alarm Rule. Using a Schedule is optional.
Select None if you don't want to use a Schedule.
Schedule Options
2
Use these options to edit a Selected Schedule or to Add a new Schedule.
Summary UI
NOTE: These status measurements are not currently available in the VIP/Designer.
Schedules Configuration UI
Schedule Name
1
Provide a name for the schedule.
Schedule Preview
2
The graphic shows the time periods for which the schedule will be active and inactive.
Schedule Configuration
Add rows to define the Start Times, End Times, and days of the week when the schedule is
3
active.
Define if the schedule enables or disables the function that is controlled by it.
Use the links below to find the content you are looking for:
In many jurisdictions, hospitals and medical centers need to test their EPSS on a regular basis
and keep records of such tests. Hospitals and medical centers in the USA, for example, must
meet the standards specified by the Joint Commission on Accreditation of Hospital Organizations
(JCAHO) to operate their facilities. These standards include the testing of generator systems.
These JCAHO standards are derived from both National Fire Protection Association (NFPA) and
National Electrical Code (NEC) requirements.
Use the Backup Power Module to generate reports for government and organizational inspectors
to help determine if an EPSS is in an adequate state to generate electrical power during a utility
outage. These reports can demonstrate compliance not only with the JCAHO standards, but also
with the standards mandated by many other geographies, such as:
• National Electric Code Article 220.87 for the United States of America.
EPSS test
The goal of an EPSS test is to confirm that the EPSS system can transfer the load from normal
supply to emergency supply in the specified amount of time. Normal supply could be utility power,
while emergency supply could be backup generator power.
To start a test, the Automatic Transfer Switch (ATS) is set into Test mode. This triggers a
sequence of events that start the generators and transfers the load to emergency supply. To end
the test, the ATS is set to Normal mode, which transfers the load back to normal supply and stops
the generators.
EPSS test performance is evaluated based on the time it takes to successfully transfer the load
after the start of the ATS test mode. Different standards define different acceptable transfer times
for EPSS systems. See Emergency Power Supply Systems for more information on standard
compliance.
The following diagram shows the test sequence of events. It shows the ATS status (Normal, Test,
Emergency), the generator status (Stop, Start, Running), and the status transitions that control
the logging of generator electrical (load) and engine data for EPSS reporting.
The following shows an example ION framework to create a Transfer Time alarm in PME:
Paste this framework into a compatible ION device and complete its configuration using the
information provided in Configure Generator Test EPSS. Extend the framework as needed, to add
additional, optional inputs such as ATS Power Outage.
NOTE: Use lock paste for all the digital input modules in the framework, and do not select
Maintain external inputs. See Pasting ION modules from the clipboard or a framework for
information on ION framework paste options.
NOTICE
UNINTENDED DEVICE OPERATION
Do not use the lock paste option to overwrite existing destination modules.
Only use the lock paste option if you are an advanced user familiar with ION architecture.
The framework creates a new folder on the ION device with the following modules:
Paste this framework into a compatible ION device and complete its configuration using the
information provided in the framework and in Configure Generator Test EPSS. Extend the
framework as needed, to add additional, optional inputs such as the Emergency Power Source
Available signal, or Engine Oil Pressure measurements.
NOTE: Use lock paste for all the digital input and analog input modules in the framework, and do
not select Maintain external inputs. See Pasting ION modules from the clipboard or a
framework for information on ION framework paste options.
NOTICE
UNINTENDED DEVICE OPERATION
Do not use the lock paste option to overwrite existing destination modules.
Only use the lock paste option if you are an advanced user familiar with ION architecture.
The framework creates a new folder on the ION device with the following modules:
Device configuration
Connect a device digital output to the ATS Test mode digital input. Configure the digital output on
the device for control by a Control Object in PME Vista.
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.
1. In a Vista diagram, create a Vista Control Object and configure it to control the status of the
ATS Test mode digital output on the device.
2. Set the user access level on the Control Object to a level appropriate for your operations, for
example Operator (4). This is to prevent unauthorized users from triggering the Control
Object.
3. Set the Double-Click Action for the Control Object to Password confirmation. This is to
reduce the risk of accidental triggering of the Control Object.
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.
4. In the Vista diagram with the Control Object, create a Status Object and link it to the ATS
status monitored by the device. This is to show the ATS status before and after triggering the
ATS Test mode Control Object in Vista.
The following table shows the monitoring device input requirements, per ATS and generator:
NOTE: ATS measurements are only required for EPSS reporting. For general generator test
reporting, ATS measurements are not required.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically
available
through
digital output
signals from
Normal Required
the ATS.
ATS Status Test Required
Digital Input 3-4 NOTE: All
Indicators Emergency Required
statuses for
Power Outage Optional(*)
a specific
ATS must be
recorded by
the same
monitoring
device.
# of
Data Type Measurements Importance Comments
Channels
This data
needs to be
provided by
a power
monitoring
device
connected to
the ATS
load-side
feeder.
NOTE: Load
3-Phase Power data must be
ATS Load logged with
System - kW tot or kVA tot Optional(*)
Data a 1-minute
Measurements
logging
interval. Use
the ATS Test
and
Emergency
signals to
start the
logging and
the Normal
signal to end
the data
logging.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically
available
through
digital output
signals from
Stopped
Required the
Running
Generator Required generator.
Starting
Status Digital Input 2-4 Optional(*) NOTE: All
Emergency
Indicators Optional(*) statuses for
Power Source
a specific
Available (EPA)
generator
must be
recorded by
the same
monitoring
device.
# of
Data Type Measurements Importance Comments
Channels
This data
needs to be
provided by
a power
monitoring
device
connected to
the
generator
feeder.
NOTE:
Vln a,b,c,avg; Vll Electrical
Generator 3-Phase Power ab, bc,ca,avg data must be
Electrical System - I a,b,c,avg; kW tot; Required logged with
Data Measurements kVA tot; PF sign a 1-minute
tot; Frequency logging
interval. Use
the
generator
Running
signal to
start the
logging and
the Stopped
signal to end
the data
logging.
# of
Data Type Measurements Importance Comments
Channels
This data is
typically
available
through
analog
output
signals from
the
generator.
Engine NOTE:
Required Engine data
Temperature
(**) must be
Generator Exhaust Gas
Required logged with
Engine Analog Input 2 or more Temperature(***)
(**) a 1-minute
Data
Optional(*) logging
Battery Voltage
Optional(*) interval. Use
Oil Pressure
the
generator
Running
signal to
start the
logging and
the Stopped
signal to end
the data
logging.
(*) This data can be included in the report, but it is not required to configure and run the report.
(**) This data is required depending on the generator evaluation method selected. If Engine
Temperature is selected, the Engine Temperature measurement is required, otherwise, it is
optional. If Exhaust Gas Temperature is selected, the Exhaust Gas Temperature measurement is
required, otherwise, it is optional.
(***) Generators with dual exhaust systems require both Exhaust Gas Temperature Left and
Exhaust Gas Temperature Right measurements.
Below is a list of recommended devices:
• ION 9000/7650/7550, PM8000 (for electrical, status, and analog measurements)
• ION 7550RTU, SER 2408, SER 3200 (for status measurements only)
NOTE: The ASCO 4000 and ASCO 7000 ATS can provide logging of ATS status and load
measurements. These ATS types are natively supported in PME. Depending on the ATS
configuration, no external ATS status and load measurements might be required if these ATS
types are used.
Use the links below to find the content you are looking for:
Supported devices
Supported devices
The Breaker Performance reports automatically read the required measurements from the
breaker control units. No measurement selection or configuration is required. Not all control unit
types support all the measurements shown in the report. Unsupported measurement data is
shown as "N/A" in the report.
The Breaker Aging Report and Vista diagrams supports the following device types:
Standard /
Circuit Breaker Range Control Unit Range
Country
• Micrologic 2 A/E/X/Xi
• Micrologic 5 A/E/P/H/X/Xi
• Micrologic 3 A/X/Xi
• Micrologic 5 A/E/P/H/X/Xi
• Micrologic 6 A/E/P/H/X/Xi
• Micrologic 7 A/P/H/X/Xi
NOTE: The IFE/IFM versions of the above device types are supported as well.
Use the links below to find the content you are looking for:
NOTE: You can edit this list of measurements in the PME database.
Demand/Power
Current
The following devices can provide the measurements required for this report:
• BCPM-E
UPS:
- APC Symmetra MW
Energy and Power (*)
Power Losses Report
(see details below) - APC MGE UPS
Galaxy 5000,
- Galaxy VM UPS (*),
- Galaxy VX UPS (*)
- Galaxy VS UPS (*)
Or external metering
Power (see details
UPS Power Report APC Symmetra MW
below)
* If these UPS devices are used, the energy must be calculated and logged in the VIP. Most UPSs
measure both input and output power from which energy can be calculated in the VIP.
If multiple types of power and energy measurements exist in the system, then a look-up method is
used to determine which one to use. The following tables list the supported types in order of look-
up priority.
NOTE: You can edit this list of measurements in the PME database.
Power
NOTE: If you need to create a new device type for the UPS with the Device Type Editor, use the
ION Labels listed in the table for the measurement definitions. This ensures that the correct
measurements will be logged in the database.
Energy
Dashboards references
This section contains reference information related to configuring Dashboards.
Use the links below to find the content you are looking for:
Styling a dashboard
Configuring Gadgets
Styling a dashboard
To add an image to a dashboard, change its background color, or modify the opacity setting for
gadgets on the dashboard:
You can add your own image to the Image Library by Selecting Upload Image... to
open the Upload New Files dialog. Then either drag an image file to the area indicated in
the dialog or Select Choose Files... and navigate to an image on your system. Select
Finish to add the image to the Image Library and then Select OK after you Select the
image for the background.
c. Choose how you want the image to fit from the drop-down list.
b. Select the down arrow to open the palette and Select a predefined color or Select the
color gradient to Select a color.
An opacity setting of 100% indicates that the gadget is not transparent – the background
color or image is not visible through the gadget. A setting of less than 100% results in
the gadget being partially transparent – the background color or image is partially visible
in the gadget.
Configuring Gadgets
The following table shows the different gadget types that are available in Power Monitoring Expert
(PME). Some of the gadgets are included in the base license and others require additional
licensing.
* The Blank Space gadget does not display any data and requires no configuration. The Blank
Space gadget is only visible during the dashboard Edit. By sizing and positioning this blank
gadget, you can change the location of the other gadgets to get the layout you want.
For information on the functionality of the different gadget types, see Gadgets. For information on
licensing, contact your Schneider Electric representative.
Prerequisites
The data for the gadgets must be available. Gadgets that depend on historical data need the
correct logged data in the database. Gadgets that depend on real-time data need the devices that
provide the data to be online and communicating.
The power quality gadgets are part of the Power Quality Performance module. Before you can
use these gadgets in a dashboard, you must first configure the Power Quality Performance
module.
The following table shows the configuration that is required before you can use a power quality
gadget type:
Configuring
The Gadget Setup dialog opens each time you select a gadget to add to a dashboard. The dialog
leads you through a series of gadget configuration pages. The pages and the options 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. The exception is the Blank Space
gadget, which does not require any configuration. Its purpose is to help you position gadgets on
the dashboard by inserting a resizable transparent blank area.
Note that each page of the Gadget Setup dialog is represented by labeled tabs when you edit the
settings for an existing gadget. (See Editing a gadget for more information.)
The following tables indicates the gadget configuration pages that apply to each gadget, where
"Y" indicates that the page applies to that gadget, and "-" indicates that the page is not applicable.
General Display
Measurements Sources Layout Calculations Performance
Settings Settings
Table Y Y Y Y Y Y Y
General
Measurements Sources KPI Formula Threshold Image
Settings
KPI Y Y Y Y Y Y
Pareto
General Data Display Viewing Sankey
Chart
Settings Series Settings Period Chart Setup
Setup
Sankey Y Y Y Y Y -
Pareto Chart Y Y Y Y - Y
Aggregated
Y Y Y Y - Y
Pareto Chart
Heat
General Data Display Viewing Consumption
Map
Settings Series Settings Period Ranking Setup
Setup
Heat Map Y Y Y Y Y -
Consumption Ranking Y Y Y Y - Y
Aggregated Consumption
Y Y Y Y - Y
Ranking
Configuration options
Axes
1. Enter a label for the axes in the Title field under Left Axis or Right Axis. (Right Axis is not
applicable to the Period Over Period gadget.)
Axis titles only appear in the gadget if you have configured at least one measurement series
for the gadget.
2. For the Max Value for each axis, select Auto or Fixed for the data in the gadget. Auto is the
default for the maximum value, which is dependent on available data for the selected
measurement. If you select Fixed, enter the maximum value for the axis.
3. For Min Value for each axis, select Auto or Fixed for the data in the gadget. Fixed is the
default value of zero (0). You can enter a different minimum value. If you select Auto, the
minimum value is dependent on available data for the selected measurement and the
minimum value is automatically adjusted.
4. For Chart Type for each axis, select a type from the dropdown list. The default is Column
for the left axis, and Line with Markers for the right axis.
Calculations
1. Enable Show Statistics Row to display a row at the bottom of the table. This row displays
the aggregated value of each column of data in the table. The aggregated value excludes
the statistics column (if enabled) and user defined calculated field (if enabled):
a. Select the Type of aggregation from the available choices in the dropdown menu to
apply to each column of data in the table.
b. Select the Highlighting Rule from the available choices in the dropdown menu to
define a threshold at which the values in the statistics row are highlighted. The threshold
values are highlighted in red. On selection of Under or Over, enter the value for the
threshold.
2. Enable Show Statistics Column to display a column to the right of the table. This column
displays the aggregated value of each row of data in the table. The aggregated value
excludes the statistics row (if enabled):
a. Select the Type of aggregation from the available choices in the dropdown menu to
apply to each row of data in the table.
b. Select the Highlighting Rule from the available choices in the dropdown menu to
define a threshold at which the values in the statistics column are highlighted. The
threshold values are highlighted in red. On selection of Under or Over, enter the value
for the threshold.
3. Enable Highlight Regular Cells to highlight the values in the table as per the highlight
rules:
a. Select the Highlighting Rule from the available choices in the dropdown menu to
define a threshold at which the values in the table are highlighted. The threshold values
are highlighted in red. On selection of Under or Over, enter the value for the threshold.
4. Enter the desired decimal places in Decimal Places to display in the values.
5. Enable Show User Defined Calculated Field to display a column to right of the table. This
column displays a calculated value as per the defined mathematical expression. The
calculation excludes the statistics row or column (if enabled):
a. Enter a label for the column header of the calculated measured column in the
Calculated Field Name field.
b. Enter the expression using the variables of Variable Reference Table in the Formual
field to calculate the values. Most of the expressions (+, -, * , / , %, ^, min, max, and avg)
can be used.
c. Select the Highlighting Rule from the available choices in the dropdown menu to
define a threshold at which the calculated values in the table are highlighted. The
threshold values are highlighted in red. On selection of Under or Over, enter the value
for the threshold.
d. Refer the Variable Reference Table which displays the variable name and the mapped
source or measurement names. The column name reflects the first column of the table.
Chart Settings
NOTE: Show Chart Crosshairs and Enable Chart Zoom options are available only for Trend
Chart.
1. Enable Show Chart Crosshairs to display cross hair lines when hovering over the data
series on the chart.
2. Enable Enable Chart Zoom to enable zoom options for the chart. The zoom options
available in the chart are:
A slider opens below the X-axis. Use the slider to adjust the viewing period. You can
drag the slider below the X-axis to the right to decrease the viewing period. For example,
if the viewing period is set to This Month and you drag the slider to the right, the range
values decrease, and if you continue to drag the slider to the right, the values decrease
further on the scale.
3. Enable Show Data Points to display the value of the data series to the individual data
series on the chart.
4. Enable Chart Color to set the background color of the chart. Select the color from the
available choices in the dropdown menu.
5. Enable Watermark to display a watermark text on the chart. Type the required text and
select the alignment and font size of the text from the available choices in the dropdown
menus.
Chart Type
Select the Chart Type as Pie or Donut from the dropdown menu to display the chart.
2. For Limit:
a. Select No Limit to display all the items.
b. Select Limit to to display the top or bottom items. Select the quantity of items to display.
4. Select Show Total to display the aggregated total consumption value of all sources above
the chart. Clear the check mark for Show Total to hide the display of the total value.
5. (Optional) Enter a Legend Name. The legend name is displayed below the chart.
Content
1. Use the Source field to enter the URL for the website that you want to display.
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.
NOTE: When you configure the Web Viewer gadget to access a website, you should be
careful that the website does not include hidden malware, viruses, or content that could
compromise your web client computers. It is recommended that the target site specified in
the gadget be secured with the SSL or TLS protocol (accessed via HTTPS).
2. Use the Refresh Interval to indicate how often to refresh the content. The default of None
indicates that the web site is shown in real time.
3. The Width value indicates the display area within the gadget. The default width is 1,000
pixels (px).
b. Select Crop/Zoom the content to display a cropped region of the website. Adjust the
Offset X, Width, Offset Y, and Height for the crop values.
The default position is set to the top left corner of the gadget, as indicated by 0 for both
the Offset X and Offset Y positions. The default width is 1,000 pixels and the default
height is 848 pixels.
It is recommended that the total of the pixel values for Offset X and Width do not exceed
the display width (1000 pixels).
5. select Preview to view how the image will appear in the gadget.
Data Series
By default, the sources are listed in alphabetical order. You can use the Search field to find
sources by name.
NOTE: For large systems with many sources, it takes longer to choose a source from the
source selector if you change the Grouping setting from its default value.
NOTE: For a Sankey Gadget select a hierarchy source. The gadget does not display data if
you select a source from the Devices list.
3. For a selected source, expand a measurement category, for example Energy, and select
the specific measurement you want to include, for example Real Energy Into the Load
(kWh).
The measurements are listed in alphabetical order by measurement category. You can use
the Search Measurements field to find a specific measurement category or measurement.
Select Display only Measurements with historical data to narrow the measurement
choices for the selected source.
4. Select Display Name to enter a name of your choice for gadget data purposes. (This is
recommended.) By default, the name is a combination of the source and the measurement.
For example, for a device main_7650, group BldgA, and measurement Real Energy
Into the Load the display name appears as BldgA.main_7650 Real Energy Into
the Load.
5. Similarly, you can select Display Units and enter a unit of your choice.
6. You can modify the following settings for each source measurement:
Series Style: select the color, line thickness, and how data is represented from the
available choices in the dropdown menus.
Axis: select Right Axis or Left Axis to chart the data series against the scale for the
selected measurement.
Multiplier: change the multiplier value to convert the data from its original unit to the
specified display unit. For example, convert the measurement unit from kWh to MWh by
using a multiplier of 0.001.
Display Settings
1. Enable Custom Font Size to display the text of data values, tooltip, axis, and legends in the
required font size. Choose the required font size by selecting the value.
2. Enable Custom Precision to display the decimal precision of data values, tooltip values,
and axis value in the required decimal precision. Choose the required decimal precision by
selecting the value.
3. Enable Background Color to set the background color of the gadget. Select the color from
the available choices in the dropdown menu.
Equivalency
Default values are automatically entered in the fields on the Equivalency page.
c. Enter the Unit for the equivalency. For example, "miles", "kilometers", "lbs", "kg", and so
on.
d. Select Display After Value or Display Before Value to specify the position of the Unit
label.
General Settings
The default opacity setting is controlled in the Dashboard Styling dialog and applies to
all gadgets included on the dashboard. This is the recommended setting.
b. Clear the check box for Use Dashboard Opacity to enable the settings for the gadget
and select one of the available percentages.
An opacity setting of 100% indicates that the gadget is not transparent – the background
color or image is not visible through the gadget. A setting of less than 100% results in the
gadget being partially transparent – the background color or image is partially visible in the
gadget. The effect of the setting varies depending on the gadget and the background image.
1. For Colors:
a. Select Use fixed value color ranges to manually define the color gradients by entering
values into the boxes. Enter values based on the maximum expected consumption
value per interval.
b. If you clear the Use fixed value color ranges check box, then the gadget assigns
colors for the heat map automatically.
2. For Outliers, select Remove Outliers to exclude data values that exceed the Max
Threshold or fall below the Min Threshold. Define the threshold values by entering limit
values into the boxes.
b. Select Show Total to display a Total value at the top of the Heat Map chart.
4. For Data Gaps, select Clear last log after a data gap to exclude large interval values, that
are the result of data gaps, from the displayed data set.
Image
1. Select an image to display on the gadget from the available images in the Image Library.
2. (Optional) Add an image to the Image Library by selecting Upload Image to open the
Upload New Files dialog. Then either drag an image file to the area indicated in the dialog or
select Choose Files and navigate to an image on your system. select Finish to add the
image to the Image Library and then select it.
KPI Formula
1. Enter the expression using the variables of Variable Reference in the Calculation field to
calculate the values. Most of the expressions (+, -, * , / , %, ^, min, max, and avg) can be
used.
2. Select the desired decimal places in Precision to display in the calculated value.
3. Enter the desired unit in Units to display along with the value. Select Display After Value or
Display Before Value for displaying the unit.
4. Enter the desired name in Description to display on the top of the gadget.
5. Set the Update Interval for the data refresh in the display.
Layout
2. Set the Minimum Column Width for the columns in the table.
Measurements
Select specific measurements from the Measurement List or select a template of pre-defined
measurements.
(Optional) select Show Advanced to filter the measurements list by Type or popularity
(Show).
1. select Select From Template to open the Predefined Measurements Templates dialog.
The dialog lists various templates that include specific measurements. The number of
measurements is identified in parentheses for each template name.
2. Select a template and select OK to add the measurements associated with the template to
the Selected Measurements area.
1. Set the level of the marker line on a scale of 0-100% by entering the Marker Position. For
example, for a marker line at 80%, enter a value of 80.
2. Select Show Total to include a Total value at the top of the Pareto chart.
3. Specify a Legend Name. This name will be shown as an axis label for the left y-axis in the
chart.
Performance
1. Set the Update Interval for the data refresh in the table.
PQ Group
Depending on the scope of the data that you want to display in the gadget, select All Groups (if
there is more than one group in the list), or a specific group in the list. The group names that are
listed in the dialog are defined in the Power Quality Group configuration file, which is configured
during Power Quality Performance commissioning.
1. For Hierarchy Depth Limit, select the depth of the Sankey diagram.
The depth is defined from the selected top node. Each bar in the diagram represents a level
and by reducing this number you can create diagrams focusing on the higher levels. There is
no limit to how many levels can be displayed.
b. Select Sort by name to sort each Sankey level nodes in ascending order by the node
label from top to bottom.
c. Select Sort by value to sort each Sankey level nodes in descending order by the value
from top to bottom.
4. For Options:
a. Select View Only Last Log.
Selecting this option overrides the Viewing Period selection. Instead of displaying data
for the selected viewing period, only the last available data log value for each node in the
hierarchy structure is used. This is useful for viewing the current state of the system, e.g.
Power, Voltage, Current.
c. Select Reverse Sankey Chart to reverse the chart from right to left.
6. For Max Label Width, select the maximum label width of the node labels.
b. Select Wrap long text to display the wrapped text of the node labels.
Sources
NOTE: This gadget configuration page is applicable for Table gadget only.
1. Select one or more sources in the Available Sources area. The sources are added to the
Selected Sources list.
(Optional) Use the Search Sources... field to find sources, select Show Advanced to filter
the source list by Type, or select Add All to select all sources.
(Optional) select Remove All to remove all sources from the Selected Sources area.
Sources
NOTE: This gadget configuration page is applicable for all Power Quality Gadgets except Power
Quality Impact and Power Quality Impact Trend gadget.
NOTE: The sources listed are dependent on the views you create in Hierarchy Manager and the
assigned user group. For Power Factor Impact and Power Factor Impact Trend gadgets, you
must select source. For other gadgets, the source selection is optional.
1. Select one or more sources in the Available Sources area. The sources are added to the
Selected Sources list.
(Optional) Use the Search Sources... field to find sources or select Add All to select all
sources.
(Optional) select Remove All to remove all sources from the Selected Sources area.
Target Lines
1. select Add Target Line to add target line input fields to the page.
Add additional target line input fields by selecting Add Target Line again.
2. Select Fixed Target or Per Day Target for Type to specify how the target line is applied.
a. Fixed Number is a value that applies in all date ranges.
b. Per Day Target is a value that is prorated for the time range that you specify. For
example, a per day target of 100 displays the target line at 100 if viewing By Day, at
3000 if viewing By Month, and at 700 if viewing By Week.
3. Enter a label to display in the chart for the target line and select the axis for the target line in
the respective fields.
4. Use the Color Selector to choose the color of the target line.
Threshold
1. Enable Apply Threshold Colors to highlight the displayed value as per the following
configuration:
a. For Color, select the default data value text color and background color of the gadget
from the available choices in the dropdown menu.
b. For Target, set the first target. If this target is exceeded, then set the required data value
text color and background color of the gadget in Color. Select from the available
choices in the dropdown menu.
c. For Upper Target, set the second target. If this target is exceeded, then set the required
data value text color and background color of the gadget in Color. Select from the
available choices in the dropdown menu.
2. Enable Display Target to display the desired target name in the gadget. Enter the desired
target name in Target Label.
Viewing Period
1. Select the date and time range for the data that is to be displayed in the gadget. To view a
gadget that starts and ends in the past, select the fixed date option. Type a start and end
date in the date boxes or select the arrows beside the dates to display a pop-up calendar
and select a date. Type a time in the time boxes or select the up and down arrows beside the
time to adjust the hours or minutes up or down. You can also view a gadget that starts and
ends in the future. You can use any tool to generate future data. For example, use Manual
Data Editor to manually enter measurement data.
The time range and aggregation settings are specific to the gadget that you select.
NOTE: For all Power Quality gadgets, except the Trend gadgets, the recommended viewing
period is This Month (for monitoring current data) or Last Month (for monitoring historical data).
For the Trend gadgets, the recommended viewing period is Last 12 Months with a By Month
aggregation period.
Use the following links to find the content you are looking for:
Archive
Database archiving copies older data from the operational database into a separate, new
database. The goal of archiving is to keep data safe for future reference. Data is typically archived
based on calendar time intervals, for example by month or by year.
The PME archive task creates a new archive database each time the task is run. Each new
archive database is attached to SQL server and is available to be accessed by PME.
NOTE: The PME archive task does not trim data from the operational database; it only makes a
copy of the archived data, leaving the original data in the operational database. See
Considerations for trimming archived data from ION_Data for important information on this topic.
Backup
Backing up a database creates a copy of the operational database. The goal of a backup is to
have an identical duplicate of the operational database that can be used to restore the system in
case the operational database becomes nonfunctional. Database backups should be created on
a regular basis, for example daily or weekly.
Maintenance
The PME database Maintenance task defragments the database and updates the database
statistics. The goal of these activities is to maintain database performance. Maintenance tasks
should be run on a regular basis, for example daily.
Size Notification
The size notification task is used to monitor the size of the database and to notify users when a
certain size threshold is reached. When the size threshold is reached, the task logs a system log
event message and triggers a Critical alarm in PME every time the task runs.
NOTE: The Size Notification task is only configured for systems using SQL Server Express,
which has a maximum database size limitation of 10 GB.
Trim
Trimming a database deletes data from the database. The goal of trimming is to prevent the
database from growing to a size that could affect system performance. Databases should be
trimmed on a regular basis, for example daily or weekly. For PME only the system log databases
are trimmed.
• The database drive is low on available free space and you cannot switch to a larger drive.
When you trim data from an SQL database, the database file size remains unchanged. After the
trim, the database will first fill the new free space before growing the database file size again. To
reduce the database file size after trimming, Shrink the database, using standard SQL Server
tools.
NOTE: The PME archive task does not trim the database; it only copies data to the archive.
To set a custom password for IONMaintenance, run the PME installer in maintenance mode and
select Reset Accounts to start the account password reset procedure. Follow the installer
instructions to reset the password. See Installer system maintenance tasks for more information.
NOTE: If you set a custom password for the Windows Accounts during the installation of PME,
then this is the password used by IONMaintenance and you can use this password to make
changes to the task schedules in Task Scheduler.
NOTE: IONMaintenance shares the same password with IONUser, another account that is
generated automatically by the installer and which is used for report subscriptions.
NOTE: If you change the password for the Windows accounts, the password you are providing
must comply with the password policies of the Windows server and the SQL server. The
software installer cannot validate the password at the time you enter it. If the password is not
valid, the password reset and reconfiguration will not be successful. In that case, complete the
reconfiguration, skipping any unsuccessful steps. See Unsuccessful installation due to invalid
account passwords for information on how to repair the unsuccessful reset.
• must have the following Windows policy settings: Log on as a batch; Deny log on locally.
• must have the following role memberships for the PME databases (ION_Data, ION_Network,
ION_SystemLog, ApplicationModules):
db_backupoperator
db_ddladmin
Maintenance
public
NOTE: You will need the password for this account during the initial task setup, and later if you
want to edit the tasks in Task Manager in the future.
NOTE: It is best to automate the archive task, but you can also run it manually on demand using
Database Manager.
NOTE: You can use the same Windows user account (created in Step 1) that is used for
other scheduled PME database maintenance tasks to run the archive task. You can also
create a new account that is only used for the archive task, because only this task requires
sysadmin role privileges on the database server (see next step).
2. On the database server, open SQL Server Management Studio and add the sysadmin
server role to the Windows user account created in Step 1. This account is used to run the
archive task; it needs sysadmin permissions to create new archive databases.
3. On the database server, in the folder created in Step 3, create a subfolder called etc and
inside this folder a subfolder called Database, for example C:\PME_Database_
Maintenance\etc\Database.
6. (Optional) In the Task Scheduler Library, create a new folder for the PME database
maintenance tasks, if it does not already exist. For example, Task Scheduler Library >
Power Monitoring Expert.
NOTE: The task name and trigger time shown above are recommendations. You can
choose a different name or trigger if necessary.
8. (Optional) Manually run the archive task to verify its correct operation.
To change the archive location, open the Configuration.ps1 script file, as described in Step 3
in Setting up database maintenance tasks for Distributed PME systems and change the value of
the variable:
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
Select 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.
Search Devices box.
6
Enter a search string to find devices in the devices table.
Refresh
Select Refresh to update the table content and show changes to the device configuration
that might have been done through Management Console.
7
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
- 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
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.
Use the links below to find the content you are looking for:
Main UI
Help
1
Select Help to open the Device Replacement online help.
Selection tabs
2
Select a tab to see information related to Device Replacement or Processed Measurement.
Number of displayed items
6
Shows the number of items visible on this page, and the total number in the system.
Page Selector
7 Use the page Selector to navigate between pages of information. Set the number of items
that are displayed on a page.
Create
Use Create to create processed measurement, which duplicates the original measurement
1
value and aggregate the new measurement value after the measurement value reaches the
threshold or the associated device is replaced.
Processed measurement table
The devices table shows processed measurements devices that are configured in the
2
system. You can use the Filters to search to find processed measurement and
measurements in the processed measurement table.
Use the following links to find the content you are looking for:
Measurement
A B String Register Details pane C Modbus/OPC Map pane
Tree pane
Menu bar
Menu Options
Help Device Type Editor Help: Open the Device Type Editor help file.
Context Menus
Right-click on a manager, module, or register in the ION Tree to open a context menu. The
context menu provides access to the actions you can perform on the Measurement Tree, such as
adding and editing managers, modules, and registers.
Right-click anywhere inside the Modbus/OPC Map table to open a context menu. The context
menu provides access to the actions you can perform on the Map , such as inserting or deleting
rows.
Right-click anywhere inside the Map table header row to open a context menu. The context menu
provides access to actions related to the table format, such as sorting of the table content or
showing or hiding table columns.
• Enable low (minimum), high (maximum) and mean (average) calculations and logging.
NOTE: Only numeric output registers can be calculated and logged. All other types of registers
(for example, enumerated) do not appear on the Configure Logging and Calculation screen.
Screen overview
A Select this check box to make the downstream device columns appear
B Register area C Stale data link D Low area
E High area F Mean area G Help link
H Global register edit area. Use this area to globally edit all rows selected in the upper pane.
All the register information from the device type in the Device Type Editor is pre-populated in this
table when you open the application.
Show downstream device columns: Select this to show all the columns for selecting and
setting the downstream device properties for registers.
Low area: Use this area to enable calculation and set logging of low values.
High area: Use this area to enable calculation and set logging of high values.
Mean area: Use this area to enable calculation and set logging of mean values.
Global register edit area: Use the bottom half of the screen to edit individual registers or multiple
registers, after selecting them in the list.
Help link: Click this link to open the Device Type Editor online help.
Stale data link (All): Click this link to open the Configure Stale Data Settings dialog.
To edit more than one register, select the rows you want to configure similarly and use the
editing tools in the Global area.
Interval: This value determines the logging frequency for the register. Note that this value also
controls the reset interval for the min, max and averaging modules, even if these calculations are
not being logged. The valid range is 1 to 4,000,000 seconds.
Low
Select Calculate to enable calculation of low (minimum) values for this register. Select Log to
enable logging of this value. Note how the label is appended to reflect that this is the low value.
High
Select Calculate to enable calculation of high (maximum) values for this register. Select Log to
enable logging of this value. Note how the label is appended to reflect that this is the high value.
Mean
Select Calculate to enable calculation of mean (average) values for this register. Select Log to
enable logging of this value. Note how the label is appended to reflect that this is the mean value.
Click the All (Stale Data) link to open the Configure Stale Data Settings dialog.
Mark data stale after: Enter the time you want to elapse before data from this register is marked
stale in the data recorder. The valid range is 0 to 7200 seconds.
When data is stale: Select how you want stale data values logged. The setting “log an empty
row” logs an empty row in the data recorder, while “use last known value” logs the last non-stale
value in the data recorder until the end of the current interval.
NOTE: Stale data settings are global (they apply to all registers) for a device type.
Show downstream device columns: Select this check box to make the downstream device
columns appear.
Is Downstream Device: Select this checkbox to indicate the register belongs to a downstream
device.
Downstream Device Name: Enter the name of the downstream device in this field. The register
label is appended with this name. For example, if the device name is Meter01, the register label
becomes VoltsA@Meter01.
NOTE: Using this option without also using the Include Name of Device Instance option causes
multiple devices to appear as a single device in your energy management system. Do not use
this option on its own unless only a single instance of this device is present in your system.
Include Name of Device Instance: Select this check box to append the actual device instance
name to the register label. The placeholder !!DeviceName!! is then added to the label — the name
of the actual device instance gets inserted when it is created.
VoltsA@!!DeviceName!!Meter01
is replaced with
VoltsA@Device01Meter01
This allows for the creation of unique names within Power Monitoring Expert, as well as enabling
each device instance to appear in the product as multiple virtual devices.
For more information on downstream devices and naming conventions, see Downstream Device
Assistant
You are returned to the main Device Type Editor console screen.
Name
The Modbus register name is an identifier for the register. It is used internally, but not displayed in
the measurement selector user interfaces. The ION register label, to which the Modbus register is
mapped, is used for display. If no ION register label is defined, then the ION register name is used
for display.
For multi-circuit devices, such as the BCPM, the Modbus register name is used to identify the
different circuits, with a special naming convention (example: Real Energy@!!DeviceName!!_
1PH_Ch1). These special register names are then used for the creation of managed circuits, if that
feature is configured for the device type in the Management Console.
NOTE: The register name has a maximum character limit of 50, including spaces. This is
important to consider when creating names for multi-circuit devices.
To have an ION register linked to a measured value from a device, map this register to the
appropriate Modbus register. To assign a constant value to an ION register, enter this value into
the Value box for the ION register in the String Register Details pane. You must unmap a mapped
register first before you can edit the value of an ION register. To unmap a register, delete the
ION Handle number for the mapped Modbus register, or delete the entire Modbus register row for
the mapped Modbus register in the Register Map.
Use this field to skip the Not Available check for a register.
Enumeration
Enumeration is used to convert ordinals (position numbers) read from the device into the values
these ordinals represent.
For example, a device may represent the Baud rate with a number from 0 to 3, where 0 = 19200
Baud and 3 = 115200 Baud. Using enumeration, the value 0 is converted to the string "19200
Baud", and the value 3 is converted to "115200 Baud". There are many applications for using
enumerations when reading Modbus register data.
To create an enumeration:
1. In Device Type Editor, open the device type for which you want to define enumerations, and
then browse to the Enumerations tab.
NOTE: This tab is hidden by default. To show the tab, check View > Register Map >
Enumerations.
4. Enter a default value for the enumeration in the Default Enum Value field.
5. Click the Enum Info Option icon in the name field for this enumeration to open the Enum
Info Option table.
6. In Enum Info Option, insert new rows, using the context menu commands and enter the
ordinals into the Ordinal fields and the corresponding values into the Value fields.
For the example above, ordinal 0 has a value of 19200 Baud, ordinal 1 a value of 38400
Baud, ordinal 2 a value of 57600 Baud, and ordinal 3 a value of 115200 Baud.
7. Click the icon in the op left corner of the Enum Info Option grid to return to the
Enumerations table.
8. Browse to the Register Map table and enter the enumeration name created in step 3 into
the Enum Name field for the registers to which it applies.
Format
This data format is used for decoding the values returned from the meter. The selected data
format must match the format delivered by the device. See Modbus Data Formats for the
supported formats.
ION Handle
The ION handle is the reference ID used by Power Monitoring Expert to identify the ION register
that is mapped to the Modbus register. The ION handle is automatically assigned when you map a
Modbus register from the Register Map to the ION register in the ION Tree.
Mask
The mask is used to read individual bit values from a Modbus register value. It is applied to the
register data using an AND logic. For example, if the mask “0x4” is applied, then the register value
displayed is only nonzero if the 3rd least significant bit in the register is a 1. You can apply masks
to both numeric and Boolean data types.
NOTE: For integer values, the bit order of the mask corresponds to the bit order of the actual
data and NOT the order in which the bytes representing the data are returned over Modbus. The
high-order nibble of a 32-bit value is selected as ‘0xf0000000’ regardless of whether the format
is U32_4321 or U32_2143. It should also be noted that the resulting value of a masked integer is
NOT bit shifted. A mask of ‘0xf000’ applied to a 16-bit value of ‘0x1234’ results in ‘0x1000’ (4096
decimal) and NOT 1.
Modbus Address
This is the physical address of the Modbus register. You can find this address number in the
device documentation. Enter the number in either decimal or hexadecimal format. The address
range depends on the register type as follows:
NOTE: When entered in hexadecimal format, the value is only the register offset and does not
include the Register Type identification.
If the Modbus register has a control signal value to indicate when the register is not available, then
you can enter this value in this field. The value must match the control signal value that is received
from the device. This allows the user interfaces that display data for this register in Power
Monitoring Expert to indicate when the value is not available.
Number of Registers
This option is only available if the data type is set to ASCII, ASCII-Reverse or Packed BCD. It
allows you to specify the number of registers to retrieve from the device on a request.
Request Type
This tells the system whether the register is for read (R) or write (W). Other options are read/write
(RW), and command write (CW).
The scale, multiplier and offset can be set to any decimal value within the range of -3.402823466
E + 38 to 3.402823466 E + 38. These values are applied to the measured value returned from the
device in the following way:
Instead of setting these values to a constant, you can also map them to ION registers that hold
these values. This is useful if the value of the ION registers can be read from the device. It is also
useful if you want to use the same scale, multiplier, or offset for multiple registers. In this case you
can map all of the registers to the same ION registers, and set their values to constants. You can
only map to registers already created in the Device Type Editor.
To map the scale, multiplier, or offset to an ION register, enter the ION handle value for this
register, in hex, into the Scale, Multiplier, or Offset fields in the Modbus Register Map.
Setup Reg
Use this field to indicate that a register is a setup register on the device. Setup registers are read
at a lower polling rate than regular data registers, improving the overall performance of the device
driver.
Write Value
This only applies to pulse registers. Use this field to specify the value that is written to the Modbus
register on the device when the ION register is pulsed.
Measurement Tree
The Measurement Tree organizes the device measurements into a structure that is recognized by
Power Monitoring Expert and that determines how you access these measurements in the
software. The Measurement Tree consists of managers, modules, and registers.
Managers
Managers are at the top level of the tree. Managers group together modules of the same type. For
example, a manager called Maximum Readings could contain the modules Max Current, Max
Frequency and Max Voltage. You are free to choose a name for a manager that best meets your
needs. Choose a name that is relevant to the type of modules it contains. You can create up to
127 managers.
Modules
Modules are contained inside managers. Modules group together related registers. For example,
a module called Max Current could contain the registers Max Current A, Max Current B, Max
Current C. You are free to choose a name for a module that best meets your needs. Choose a
name that is relevant to the type of registers it contains. You can create up to 4095 modules inside
a given manager.
Registers
Registers are contained inside modules. (ION) Registers are linked to the Modbus registers and
hold the measured values. You can map registers to a Modbus address, then use Power
Monitoring Expert to read and write data to this Modbus device. You can create up to 255
registers per module.
Factory registers
You cannot add or remove Factory registers, but you can edit them. All Factory registers are
initially set to a default constant value. You can change these constant values, or map the
registers to a valid Modbus address.
OPC Tags
A complete OPC tag contains the elements shown in the following example:
Use the following links to find the content you are looking for:
* 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.
The independent variable is the driver that influences the measurement you want to model. In the
above example, the outside temperature is the independent variable. You can specify one or
more independent variables.
** The energy measurements are aggregated into one total energy measurement by the report.
*** If the PDUs have embedded energy metering, with an accuracy of 1% or better, and can
provide energy, power, voltage, and current data via an industry standard communications
protocol, then no external metering is required to monitor the PDU mains.
PUE Category 2
The VIP framework aggregates total kW values from all Main Incomer Meters and then calculates
and logs 3 values that can be selected in the report and used in the Vista KPI screens: kWh del,
kWh del int, and kW SWD. The VIP framework also aggregates total kW values from all PDU
Meters and then calculates and logs 3 values that can be selected in the report and used in the
Vista KPI screens: kWh del, kWh del int, and kW SWD.
If multiple types of power and energy measurements exist in the system, then a look-up method is
used to determine which one to use. The following tables lists the supported types in order of look-
up priority.
PUE – The ratio between the data center and IT equipment energy measurement values. This
value is calculated for each of the required time periods by the following formula:
IT Equipment – The average of the IT equipment power measurement values for each of the time
periods.
Data Center – The average of the data center power measurement values for each of the time
periods.
PUE Trend – The weekly PUE values are calculated by the following formula where N represents
a week of the year:
Energy Trend – The weekly energy values for IT equipment and support are calculated by the
following formulas where N represents a week of the year:
Use the links below to find the content you are looking for:
Power
Energy
The Energy by IT Customer Report supports the measurements listed in the tables below. Only
one measurement of each type (Energy , Current) is required. If multiple types of the same
measurement exist in the system, then a look-up method is used to determine which one to use.
The tables list the supported types in order of look-up priority.
NOTE: You can edit this list of measurements in the PME database.
Energy
Current
The following devices can provide the measurements required for this report:
• BCPM-E, PM5350 (multi-circuit mode)
• Basic, Intermediate, or Advanced Device for main service entrance (PM5xxx, PM8xxx,
ION7650, ION9000)
Main UI
Selection tabs
1 Select a tab to see information related to notification Rules, Recipients, Templates,
Schedules, or Settings.
Help
2
Select Help to open the Notifications online help.
Number of displayed items
6
Shows the number of items visible on this page, and the total number in this View.
Page Selector
7 Use the page Selector to navigate between pages of information. Set the number of items
that are displayed on a page.
Rules tab
Add Rule
3
Use Add Rule to create a new notification rule.
Search Rules box.
4
Enter a search string to find rules in the notification rules table.
Notification rules table
5
The notification rules table shows all the notification rules that are configured in the system.
Recipients UI
Add Recipients
1
Use Add Recipients to create a new recipient for notifications.
Recipients table
2
The recipients table shows all the recipients that are configured in the system.
Templates UI
Add Templates
1
Use Add Templates to create a new template for notifications.
Templates table
2
The templates table shows all the templates that are configured in the system.
Schedules UI
Add Schedule
1
Use Add Schedule to create a new schedule.
Schedules table
2
The schedules table shows all the schedules that are configured in the system.
Settings UI
NOTE: A red dot beside a topic shows that this topic has not been completely configured.
Add Rule UI
Alarm View
Recipients
Available Recipients
1
This shows the recipients that are available in the system.
Selected Recipients
2
This shows the recipients that have been Selected for this notification rule.
Add Recipients
3 Select this button to add a new recipient to the system. This is a shortcut to the Add
Recipient function on the Recipients tab.
Schedule
Select Schedule
1 Use this to Select the schedule you want to apply to this notification rule. Using a schedule
with a notification rule is optional.
Edit Schedule
2 Select this button to edit the Selected schedule. This is a shortcut to the same function on
the Schedules tab.
Select Timezone
3
Select the timezone that is used to apply the schedule.
Add Schedule
4 Select this button to add a new schedule to the system. This is a shortcut to the Add
Schedule function on the Schedules tab.
Rule Name
1
The rule name is the identifier for this notification rule in the system.
Rule Enabled
2
Use this to enable or disable the rule. When a rule is disabled, no notifications are sent for it.
Message Template
3
Select the template you want to use for the notification message.
Add Template
4 Select this button to add a new template to the system. This is a shortcut to the Add
Template function on the Templates tab.
Delivery Options
Set the delivery options you want to use for this notification. You can also Select which
types of alarm activity will trigger a notification.
The available options include:
5 - Deliver notifications by email
- Deliver notifications by SMS
- Deliver notifications by SNMP
- Send notifications on all activity (Note: This setting only applies to alarm views and
incident views, not to event views.)
Delivery Test
6 Select the Test button for the delivery method you want to test. A delivery test will send a
test message to the address configured for this delivery method on the Settings tab.
Add Recipient UI
Recipient details
The recipient name, email address, phone number (used for SMS messaging), and
SNMP server name. Email, phone number, and SNMP server name are optional; however
1 they are needed if email, SMS, or SNMP notifications should be sent to this recipient.
NOTE: Enter the phone number in E.164 number formatting: [+][country code][area code]
[local phone number]. Example: +14151231234.
Address test
Select the Test button for the address (email, phone number, or SNMP server name) you
2
want to test. An address test will send a test message to the email address or phone
number configured in the recipient details.
Add Template UI
Template details
1 The template name, note, and link. This note and link will be added to the notification
message, after the alarm view details.
Example settings:
NOTE: After the maximum delay, a notification message is sent that includes all alarms that
were active in the notification time window up to the maximum delay cut off. In the example
above, 6 alarms would be included.
Use the links below to find the content you are looking for:
Main UI
Help
1
Select Help to open the EWS Client online help.
Configure EWS Client
Use Configure EWS Client to make the EWS client data available for monitoring and
2
analysis in PME. You can add one EWS client at a time using the EWS Client user
interface.
EWS Client filter
3 Use the EWS Client filter to customize which EWS Clients are displayed in the EWS clients
table. You can filter by Communication Status and Enabled State.
Search EWS Client box
4
Enter a search string to find EWS clients in the EWS clients table.
Refresh
5 Select Refresh to update the table content and show changes to the EWS client
configuration.
Options menu
The Options menu contains the following options:
6 - Show/Hide Columns
- Clear Filter
- Refresh
EWS Client table
7 The EWS client table shows EWS clients that are configured in the system. Which devices
are displayed in the table is controlled by the devices filter, see 3 above.
For example: If EWS server measurement name is "Active Power", this name is 100% match
with the PME name "Active Power", then this EWS server measurement is automatically
mapped to "Active Power" of PME measurement.
• No Name Match: No part of the EWS server measurement name 100% matches with the
PME measurement name.
For example: If EWS server measurement name is "Power", this complete name is not 100%
match with PME measurement name nor contains 100% match with PME measurement
name, then this EWS server measurement is not automatically mapped. This measurement
should be manually mapped.
<PMEDefinitionFile>
<PMEMeasurementName>Real Power</PMEMeasurementName>
<EWSMeasurementName>Real Power</EWSMeasurementName>
<Scale>1</Scale>
You can see the measurement mapping updated accordingly in the Device and Measurement
Mapping dialog of EWS client user interface.
General references
This section contains general reference information.
Use the following links to find the content you are looking for:
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.
1. On the PME application server, find the Add_PQPerf_To_Web.sql script file in ..\Power
Monitoring Expert\diagnostic\PowerQuality\
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.
Prerequisite: The custom application must be in the same Application Pool as the regular PME
applications, and must use the same authentication configuration.
NOTE: If you want your application to take part in keeping PME non-idle, but you do not
want your application to log itself out after the idle period, you can add the following JSON
as a parameter to the idle() method: {enableLogoutRedirection: false;}
NOTE: Before editing the settings in the registry, confirm that your PME system has been taken
out of service and that all system services have been stopped.
To configure the software to trust or not trust self-signed certificates on the database server:
• Legacy security support is an interim solution for users that use standard security mode.
Because of these changes, configuring the devices and viewing the diagram with firmware
version 3.0.0 or higher requires changes in the PME.
1. Right-click the device that has Advanced Security enabled and select Security to open the
Meter Security Settings dialog.
3. Click Match Password and type the password in the Password field then re-type it in the
Confirm Password field.
4. Select the check box if you want to allow the software to send secure time synchronization
signals to the device. Clear the check box if you do not want to send secure time
synchronization signals to the device.
5. Click OK.
To configure the security module in Designer for an existing device after firmware
upgrade:
NOTE: The Change Standard Meter Security option is disabled and hence standard security
can not be enabled.
2. Right-click the Security Options module icon to open the module setup.
3. Highlight the SOP1 Legacy Security Support register and click Modify.
4. Select Disabled in the options drop down and click OK in the Modify Enumerator Register
dialog.
To perform control object function of diagram in Vista for an existing device after firm-
ware upgrade:
1. Enter the username and password. See Controlling system functions for more information.
To perform control object function of diagram in Diagrams for an existing device after
firmware upgrade:
1. Enter the username and password. See Performing manual control actions for more
information.
NOTICE
IRREVERSIBLE OPERATING SYSTEM DAMAGE OR DATA CORRUPTION
Before making any changes, back up your Windows Registry in a network folder or other
remote location.
Failure to follow these instructions can result in irreparable damage to the operating
system of the computer and all existing data.
NOTE: Registry edits must be performed only by qualified and experienced personnel.
1. Select Start > Run, and then type regedit to open the Registry Editor.
NOTE: If the component is run on a 64-bit operating system, navigate to: HKEY_LOCAL_
MACHINE\SOFTWARE\Wow6432Node\Schneider Electric\Power Monitoring
Expert \x.x
6. If your system installation includes Client machines running, you need to update the registry
for each one.
Use the following links to find the content you are looking for:
Use the following link to find the content you are looking for:
NOTE: This section explains about Activate License UI. The Refresh License and Return
License UI are identical to Activate License UI.
Method
Select the method:
• Use Offline method if the PC has no access to the internet but you have access to
another PC connected to the internet.
Instructions
2
Display the instructions as per the selected method.
Activation ID
3
Enter the activation ID.
Location to download the request file
Click Download the save the request file to the selected location.
Location of the response file
Select the location of the response file, which you downloaded from the Offline Licensing
Web Portal.
Activate
7
Click Activate to activate the license.
Cancel
8
Click Cancel to go back to the main window.
License Information UI
Feature List
1
View the list of features name, version, and expiry date for the activated licenses.
Use the following links to find the content you are looking for:
Context menu.
8 Right-click a data cell in the data grid to open the context menu. The Context menu gives
you access to the commands and functions for editing the data loaded into the data editor.
Color legend for issues highlight
9 The data editor uses different color highlights to mark data issues. This legend tells you
which colors are used for which type of issues.
View Log
10 Click View Log to open the Manual Data Editor historical audit log. See Audit Log UI for
more information.
Undo All Changes
You can undo changes that have not been applied yet. After changes have been applied to
11
the database, they are permanent and can only be modified be manually editing the data
again in the Manual Data Editor.
Apply Changes
After you have completed your data edits, click Apply Changes to write the changes to the
12
database. After changes have been applied to the database, they are permanent and can
only be modified be manually editing the data again in the Manual Data Editor.
Load Data UI
Available Sources.
1
Select the source for which want to load the data.
Available Measurements.
Select the measurement for which you want to load data. You have the option to only see
2
those measurements that have logged data for the selected source in the drop-down
control, or see all measurements that are defined in the software.
Add Data to Selection
Click Add Data to Selection to add the source/measurement you selected, to the list of
3
data to be loaded into the data editor. You can add multiple measurements from the same
source, and measurements from different sources to the list.
Selected Pairs
4 This shows the list of selected source/measurement pairs that are to be loaded into the
data editor.
Edit commands for the Selected Pairs list
5 Use Clear All to remove all selected list items. Use Remove Selected to remove items
that you selected from the list.
Create new Measurement
Use this to create a new measurement in the software. This function is needed if you want
to add data that was manually collected for a measurement that does not exist in the
software. For example, if you wanted to add a daily count of cars parked in a parking lot,
you could define a measurement called Number of Cars, which doesn't exist in the
6
software by default. Then you can select this measurement and a source in Manual Data
Editor and add data records with the daily counts.
NOTE: Check the list of available measurements to see if one exists for your application
before creating a new measurement.
Preset
Save and load settings for the Load Data dialog box. This is a way to simplify the data
7 selection for data sets that you frequently access. Set all the settings in Load Data for the
data sets you want and then save the settings to an external file using Save Preset. Load
a pre-defined set of settings into Load Data using Load Preset.
Time Range
8
Select the time range for which you want to load the data from the sources/measurements.
Timezone
Set the timezone for the display of the configurable timestamp in the data editor. The data
9
editor shows two timestamps for each data record, one timestamp in UTC and one in a
configurable timezone.
Timestamp Format
10
Set the format for the timestamp display in the data editor.
Number Format
Set the number of decimals that are displayed for the logged data in the data editor.
11 NOTE: This setting only affects the display of the data in the data editor and the accuracy
to which you can enter new data values. It does not affect data that is loaded into the
editor and then applied to the database without editing the values.
Is Interval Data
Set the expected logging interval for the data. This setting ensures that there is a data row
in the editor for every expected log entry. If there is no data record for an expected entry in
the database, then the Manual Data Editor inserts a timestamped row with a <no data>
12
data values in the editor. This makes it easier to identify missing records and correct them.
NOTE: The data editor shows all logged records in the selected time range, regardless of
the Interval Data settings. No records are hidden or filtered out.
Load Data
13
Click Load Data to open the selected sources/measurements data in the data editor.
Audit Log UI
Data.
1 Select the source/measurement for which want to see the audit data. The available options
include all sources/measurements that have been loaded into the data editor.
Audit log.
View the change history for edited data records including timestamp, username, action,
2
original value, new value. You can use the information in the audit log to reset data values to
their original value if they were changed accidentally or incorrectly.
Time Range.
Select the range of data that you want to fill the gaps in or you can fill all gaps in the entire
1
loaded data range. When selecting a data range in the editor, only select the data values,
not the timestamps.
Data.
2 This is a list of all the sources/measurements that are loaded into the editor. Select the
source/measurement pairs for which you want to fill gaps.
Interpolation Mode
Choose which algorithm is used to fill the gaps. You have the following choices:
Linear
Gaps are filled with the average of the last recorded value before the
interpolation
gaps and the first recorded value after the gaps. All consecutive gaps
between
3 between the known values are filled with the same value.
known values.
Last known Gaps are filled with the last recorded value before the gaps. All
Value consecutive gaps after the known value are filled with the same value.
Constant Value Gaps are filled with the value that you specify in the value box.
OPC references
This section contains reference information related to OPC.
Use the following links to find the content you are looking for:
OPC DA tunneling applications are designed to overcome these limitations when using OPC DA
over a network. The goal of OPC DA tunneling is to eliminate DCOM by replacing it with a network
protocol like TCP. Instead of connecting the OPC DA client to a networked OPC DA server, the
client program connects to a local OPC DA tunneling application, which acts as a local OPC
server. The tunneling application accepts requests from the OPC DA client and converts them to
TCP messages, which are then sent across the network to a companion tunneling application on
the OPC DA server computer. There the request is converted back to OPC DA and is sent to the
OPC DA server application for processing. Any response from the server is sent back across the
tunnel to the OPC DA client application in the same manner.
Diagram: OPC DA data is sent over the network by OPC DA tunneler using common network
protocols.
OPC DA tunneling products are available from several vendors, including Kepware and Matrikon.
When selecting OPC DA tunneling applications, look for products that
• keep the synchronous OPC DA transactions local to the client and server, with an
asynchronous tunnel connection
• provide link monitoring
Use the following links to find the content you are looking for:
• Non-critical loads
Service entrance
Service entrance includes utility feeds and local power sources, such as generators, solar power,
or wind power. Service entrance monitoring should be done with high-end, high accuracy devices
with advanced power quality capabilities. The devices should have revenue accuracy (0.2 Class
accuracy or better) for the calculation of the power factor surcharges.
The following power quality measurements are required for service entrance monitoring:
• Interruption
• Voltage Sag/Swell
• Transient Voltage
• Over/Under Voltage
• Harmonics
• Frequency Variation
• Flicker
NOTE: We recommend the ION9000 and ION7650 device types for service entrance
monitoring.
The following power quality measurements are required for feeder and critical load monitoring:
• Unbalance
• Harmonics
The following power quality measurements provide additional value for feeder and critical load
monitoring:
• Interruption
• Voltage Sag/Swell
• Over/Under Voltage
• Frequency Variation
NOTE: We recommend the PM5500 and PM5300 for the minimum required measurements, and
the PM8000 for full value feeder and critical load monitoring.
Non-critical Loads
This category includes non-critical feeders, power distribution panels, and sub-process unit
panels. Current unbalance and harmonics monitoring are of main interest at these locations. Non-
critical loads may be the location for process impact monitoring, which may require digital or
analog input capabilities on the monitoring device.
The following power quality measurements are required for feeder and critical load monitoring:
• Unbalance
• Harmonics
NOTE: We recommend the PM5300, PM5100, and PM325x device types for non-critical load
monitoring.
Devices List
See the supported devices list for more information on device types that support the power quality
measurements required for the Power Quality Performance module. To find the specific types that
meet your needs, review the device data sheets and specification for the following capabilities:
• Accuracy and sampling rate
• Data recording
• On-board alarming
• Inputs / Outputs
• Communication
NOTE: If the devices that are used for power quality performance monitoring do not support all
the required power quality measurements, then the information that is based on these
measurements is not displayed in the gadgets, diagrams, and reports. However, other power
quality information, that is based on available measurements might still be displayed.
PQ Performance Diagrams Not Logged By Default: All default meter template except
Current Harmonics
PQ Analysis Report PM8000 with IEEE 519 template
ION 6200, 7300, 8600C, 8650C,
8800C, PM200, PM700, PM8001,
PM1200, PM3250, PM3255,
PM5100, PM5300, PM5350,
PM5500, EM3460, EM6400,
EM7000, Micrologic 5.2/6.2/5.3/6.3
E, Micrologic 5.0/6.0/7.0 H (including
IFE/IFM)
Logged By Default:
PQ Performance Diagrams
PQ Rating Gadget ION 7330, 7350, 7400, 7550, 7650,
Frequency Variation All default meter template
PQ Rating Trend Gadget 8600A, 8600B, 8650A, 8650B,
PQ Analysis Report 8800A, 8800B, 9000, PM8000,
PM5650, PM5760, PM5761
Logged By Default:
PQ Performance Diagrams
PQ Rating Gadget PQ Framework and EN50160
Flicker ION 7400, 7650, 8600A, 8650A,
PQ Rating Trend Gadget evaluation enabled
8800A, 8800B, 9000, PM5650,
PQ Analysis Report
PM5760, PM5761
For example:
Power Factor Impact Gadget • Active energy
Power Factor n/a
Power Factor Impact Trend Gadget
• Reactive energy
• Active power
• Reactive power
Capacitor Banks:
• VarPlus Logic VL6 and VL12
The utility charges according to the active energy and adds a surcharge or adjustment for power
factor.
The utility charges according to the active energy and adds a surcharge or adjustment for power
factor.
The utility bills all consumed energy, including the reactive energy.
NOTE: For each disturbance category, choose only the needed measurements from the
supported list to log. Do NOT Log all of them. Logging all measurements can cause unwanted
database growth, and performance issues.
NOTE: 1 Use only for ION 6200, 7300, 8600C, 8650C and 8800C. These measurements are
NOT logged by default.
NOTE:
• PM8000 is categorized as an ION device.
Reports references
This section contains reference information related to configuring Reports.
Use the following links to find the content you are looking for:
First Drop Analysis – Minimum Drop Voltage (V), Maximum Drop Voltage (V) and
Difference (%): The voltage drop minimum, maximum and percentage difference values are
shown in the Drop Analysis table section. To calculate these values, a valid waveform voltage
drop must be found first by sampling the waveform data.
A valid voltage drop is defined as the first waveform section of size n, where the relative minimum
and maximum voltage values have a percentage difference d. In addition, the next sample n+1
must be greater in value than the minimum voltage, to ensure that the lowest value has been
found in the voltage drop.
The sampling section size n and the percentage difference d are determined by the user-defined
report parameters Waveform Drop Sample Size and Waveform Drop Percentage, respectively.
After the voltage drop has been found, the Minimum Voltage and Maximum Voltage are simply
the min and max values in that drop samples, and the Difference is the percentage of the
maximum voltage over the minimum voltage. For example:
Minimum Drop Voltage = Min(ws1 <= WaveformValues < = wsN)
Maximum Drop Voltage= Max(ws1 <= WaveformValues <= wsN)
ws1 is the first point in the sample and wsN is the last point in the sample
Difference (%) = [(Maximum Drop Voltage – Minimum Drop Voltage) / Maximum Drop Voltage]
Recovery Analysis – Target Recovery Voltage (V), Actual Recovery Voltage (V) and
Recovery Time (ms):
Target Recovery Voltage (V): This value is calculated for the reference waveform only. This is
calculated as follows:
Target Recovery Voltage (V) = [Recovery Voltage * Recovery Value Multiplier]
Where Recovery Voltage = Average(w1 <= WaveformValues < wN)
w1 is the very first point in the waveform and wN is the lowest point in the waveform voltage
drop and Recovery Value Multiplier is a user-defined value in the report pre-requisite page
Actual Recovery Voltage (V): The first point in the reference and comparison waveforms that
occurs after the voltage drop, that is equal or greater than the Target Recovery Voltage value.
Recovery Time (ms): This is the time elapsed from the Minimum Voltage Drop time and the
Actual Recovery Voltage time, expressed in milliseconds.
Additional calculations
Voltage Threshold: This is the red horizontal area that is highlighted in the waveform drop chart.
It represents a nominal voltage value, therefore there are no calculations for the Voltage
Threshold.
For example, if the user sets the Voltage Threshold to 50V, then a red line will be drawn at 50v
(based on the Y-axis) and the area below the red line appears shaded in red.
System Integration
This section contains reference information related to System Integration.
Use the following links to find the content 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 to create custom device drivers. See Device Type Editor for
more details.
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.
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
Authentication Set to 'True'
with the EWS server.
Token Reuse
This can improve
Feature
communication
performance.
Reading Interval
When set to True,
allows the extract task
Interval Length to determine the
Set to 'True'
Discovery reading 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 converting the values from an Use default 'Last Known Value'
Method irregular interval into a regular setting
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.
Setting Parameters /
Setting Name Description
Recommended Values
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
Default value is 3600 seconds (1
SQL Command Timeout a 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
ION_Data database for your
Database Settings Connection string to the ION_
system. Information can be found
(ION_Data) Data database
through SQL Management
Studio.
Connection string to the ION_
Provide connection information to
Network_Database where
ION_Network database for your
Database Settings source information should be
system. Information can be found
(ION_Network) loaded. Only applicable if the
through SQL Management
Enable Network Database
Studio.
Source Creation setting is True.
Group Name Settings
Setting Parameters /
Setting Name Description
Recommended Values
When set to 'True', the task adds
Add the 'Group Name' a group name prefix to all
Prefix to Sources if sources that do not already have Set to 'False'.
Needed one. 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’
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
Allow Null Values set to 'True', null values in the Set to 'False'.
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
Enable Recorder and
channels while inserting data. Set to ‘True’.
Channel Creation
Some reports require that the
parameter is set to ‘True’ to run.
Setting Parameters /
Setting Name Description
Recommended Values
Set the
ISCurrentConfiguration Leave this default setting to
Flag to False for New ‘True’.
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.
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.
You can set up logging to help manage ETL jobs. You can also switch between ETL jobs, change
the order of ETL tasks, and remove ETL tasks from an ETL job.
2. In the Job Management list select an ETL job and click Edit.
3. Highlight the task that you want to remove from the left pane.
4. Click Delete
Loading sources can return thousands of rows. To help you manage a large result set, the
ETL Administration Tool includes several features to help you search, filter, and update loaded
sources.
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:
1. Press Ctrl + A.
Batch Edits
A batch edit lets you update all highlighted rows at once.
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.
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.
3. Open your document and place the cursor where you want to paste.
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.
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.
You can select and copy one or more Trend logs from Building Operation and paste that data into
a document, such as a text editor or a spreadsheet.
3. Open your document and place the cursor where you want to paste.
You can find and open a Trend log with the source tag path.
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.
1. In the ETL Configuration Job Configuration Tool screen, select a job to run from the Job
Management drop-down list.
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.
You can configure a job to run as a service. Using this method, the job automatically runs at set
times, based on the settings you provide in the Job tab. Make sure to change the Sleep Time
Between Execution value (in seconds) if you require the service to be run on a schedule different
from the default value of 3600 seconds.
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.
You can also switch between jobs, change task order and remove tasks from a job.
1. Click OK at the bottom right to save and exit the current job.
3. Click Edit.
1. Select a job from the Job Management drop-down list and click Edit.
3. Highlight the task you want to move from the left pane.
1. Select a job from the Job Management drop-down list and click Edit.
3. Highlight the task you want to remove from the left pane.
4. Click the Delete icon. The task is removed from the pane.
This table describes the suggested mappings for supported EBO values:
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
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. 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.
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>
1992 © 2024 Schneider Electric. All Rights Reserved.
EcoStruxure™ Power Monitoring Expert 2024 System Guide Reference
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.
Manual integration steps without using the web application Integration Utility settings
This section describes how to manually integrate Building Operation and PME without using the
web application Integration Utility settings. Sometimes manual steps are more convenient for
certain tasks, for example: making minor changes to the system.
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.
You need to create two different PME users for the integration with Building Operation:
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.
Create links to the PME Diagrams, Reports, and Dashboards applications in Building Operation
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.
6. Click Generate URL. The URL will appear in the Authentication URL box.
8. In Building Operation Workstation, create a new hyperlink for the URL generated in step 6
above.
In order to integrate values from PME with Building Operation, you must:
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.
• The following file contains the list of all PME 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:
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.
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.
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.
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.
TIP: For information on setting up user authentication with Windows Active Directory in PME,
see Adding a Windows user and Adding a Windows group.
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.
Trends references
This section contains reference information related to configuring Trends.
Use the following links to find the content you are looking for:
Configuring a trend
Configuring a trend
Configuring General settings
To configure general settings:
1. In the Trend Setup dialog, on the General tab, enter a title for the trend.
2. To add a new data series, select Add under Data Series. This opens the Add Data Series
dialog.
3. To edit an existing series, select it, and then Select Edit. This opens the Edit Data Series
dialog.
4. In Add (or Edit) Data Series, select a source in the Sources area to Select it.
You can Select sources organized by Devices or Hierarchy Views. You can use the Search
Sources field to find entries by source, group name, or a combination of group and source
names.
(Optional) Select Show Advanced to have the option of showing only Devices, only
Hierarchy Views, or both.
5. For the selected source, expand a measurement type, for example Voltage, and select the
specific measurement you want to include in your trend, for example Voltage A-B.
The measurements are listed in alphabetical order by measurement category. You can use
the Search Measurements field to find a specific measurement category or measurement.
(Optional) Select Show Advanced to open options for filtering the measurements.
Select Display only Measurements with historical data to narrow the measurement
choices for the Selected source.
6. (Optional) Select Display Name if you want to enter a series name of your choice for trend
data purposes. By default, a series name is a combination of source and measurement
information formatted as group.source measurement, for example BldgA.meterA
Voltage A-B.
7. (Optional) Select Display Units and enter a unit description of your choice.
8. You can modify the following settings for each source measurement:
Style: Select the color and line thickness from the available choices in the dropdown
menus.
Decimals: Select the number of decimal places for the data displayed in the legend.
Plot on: Select Right or Left Axis for the location of the measurement values for the
Selected measurement.
Overlay: Select the values that you want to overlay on the trend. By default, no items
are Selected. The Selections are Min, Max, and Mean.
Data Source: Select where to access the data for the trend. The options are to gather
series data from the source in real-time, gather series data from the database as it is
being logged, or gather real-time series data from the source and historical data from
the database to fill the trend, if possible.
9. Select OK to save your changes and close the Add (or Edit) Data Series dialog and to return
to the Trend Setup dialog.
10. Select Add to specify additional sources and measurements for the trend.
11. Select Private Trend to keep this trend private or clear the check box to make it public.
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 for details.
1. In the Trend Setup dialog, on the Axes tab, enter a label for the axes in the Title field under
Right Axis (Primary) or Left Axis (Secondary).
Axis titles only appear if you have configured at least one measurement series and it
appears on the trend.
2. For Right Axis (Primary), Max Value and Min Value are set to Auto by default.
a. (Optional) Select Fixed and enter the maximum or minimum values in the respective
input fields.
Each time the latest data point of a measurement series occurs in an upper or
lower threshold, the color defined for the threshold also colors the background
of the measurement series in the legend.
b. (Optional) Select Target Line, then Select a color from the color Selector and enter a
value for the target line in the input field.
You can Select the Target Line independently from the Upper Threshold or Lower
Threshold settings.
3. For Left Axis (Secondary), Max Value and Min Value are set to Auto by default.
For Fixed maximum or minimum, enter the values in the respective input fields.
4. For X-Axis time zone Selection, Browser Time Zone or Source Time Zone is available for
Selection depending on the time zone of the Selected source.
If single source is configured, you can Select Browser Time Zone or Source Time Zone
for X-Axis.
If multiple sources are configured and sources are in same time zone, you can Select
Browser Time Zone or Source Time Zone for X-Axis.
If multiple sources are configured and sources are not in same time zone, X-Axis is
defaulted to Browser Time Zone.
1. In the Trend Setup dialog, on the Chart tab, Select the text size from the list.
The text size property is applied to trend axis labels, the size of the legend, the legend text
size, and trend data point tooltips.
The default setting is Medium, and the choices are Small, Medium, or Large.
2. Select the position of the legend included in the trend display area from the list.
The default setting is Right, which places the legend on the right side of the trend. The
available choices are Off, Left, or Right.
3. Select the content that you want to include in the legend from the available settings.
The default Selections are Name and Value. The additional Selections are Difference and
Difference (%).
Value is latest data value and the unit of measurement. For example, for voltage
measurements, the default value is numeric_value V such as 415.2 V.
Difference is the change in the measurement from one update to the next. For example, if
the voltage is 415.8 and it changes to 416.1 at the next trend update, the difference
appears as +0.3 in the legend.
Difference (%) is the percentage change in the measurement from one update to the next.
For example, if the voltage changes from 415.8 to 416.1 at the next trend update, the
difference expressed as a percentage appears as +0.072% in the legend.
1. In the Trend Setup dialog, on the Data tab, specify the Data Update Intervals in the From
device and From database drop-down lists.
The default setting is 5 seconds for data updates for trends using the data directly from a
device, and 5 minutes for data updates for trends with data from a database.
2. Specify the Data Points for the x-axis of the trend in the Max per series input field.
The value must be between 100 and 500,000. Increasing the value adds more data points
per series but this can result in a degradation of trend performance.
Examples:
A data interval of 1 second equates to 3600 data points per hour (60 points per minute X
60 minutes per hour). At a setting of 40000 points, approximately 11.1 hours of data is
retained for viewing (40, 000 points / 3600 points per hour = approximately 11.1 hours).
A data interval of 5 seconds equates to 720 data points per hour (12 points per minute X
60 minutes per hour). At a setting of 40000 points, approximately 55.5 hours of data is
retained for viewing (40, 000 points / 720 points per hour = approximately 55.5 hours).
A data interval of 10 seconds equates to 360 data points per hour (6 points per minute X
60 minutes per hour). At a setting of 40000 points, approximately 111.1 hours of data is
retained for viewing (40, 000 points / 360 points per hour = approximately 111.1 hours).
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 Realtime and OPC Diagnostics Access the tool No No No Yes Yes
Yes Reports Access the application Yes Yes Yes Yes Yes
Yes Time of Use Editor Access the tool No No Yes Yes Yes
Yes Trends Access the application Yes Yes Yes Yes Yes
Yes UPS Power Configuration Utility Access the tool No No No Yes Yes
NOTE: To view or change these settings in your system, open Management Console and go to
Tools > System > ION Virtual Processor Setup. For the VIP for which the Modbus Slave is
configured, expand Modbus Network > Slave Ports.
Setting Range
Unit ID 1 - 247 (default: 100)
Receive Timeout (ms) 100 - 10000 (default: 1800)
Transmit Delay (ms) 10 - 60000 (default: 50)
Baud Rate 300 - 115200 (default: 9600)
Parity NONE, ODD, EVEN, MARK, SPACE (default: NONE)
Stop Bits 1, 1.5, 2 (default: 1)
NOTE: The language settings in System Language and Personal Preferences determine the
language the web applications are displayed in.
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.
Operation references
This section contains reference information related to the content in the Configuring chapter of
this guide.
Use the following links to find the content you are looking for:
Topic Links
Alarms UI
Timeline analysis UI
Waveforms UI
Alarms
Alarm to incident mapping
Load Impact calculations
Alarms terminology
Dashboards Dashboards user interface (UI)
Power Quality
Power Quality Performance events and disturbances
Performance
Model creation example
Report input parameters
Interpreting the Energy Regression Analysis Report results
Reports
Reports UI
Reports Icons
Reports Terminology
The Trends user interface
Trends
Trend options
Alarms references
This section contains reference information related to using Alarms.
Use the links below to find the content you are looking for:
Alarms UI
Timeline analysis UI
Waveforms UI
Alarm to incident mapping
Load Impact calculations
Alarms terminology
Alarms UI
1 Main UI
View Library
The view library contains all the alarm views that are configured in the system. Alarm views
can be listed individually, or they can be organized within folders.
1
TIP: To hide the library, click the Hide Library icon ( or ) in the top right corner of the
library. To show the library, click the Show Library icon ( or ) at the top of the library
ribbon, or click anywhere in the minimized library ribbon.
Alarms Display
2
The alarms display pane shows the alarm view Selected in the view library.
2 Alarms display UI
Update timer
1
The update timer shows the time until the next display refresh.
Update mode
Use the update mode to switch between Date Filter mode and Auto-Update mode.
NOTE: This element is only available for history views, not for status views.
Search filter
3 Enter text into the search filter to search and filter the items displayed in the alarms display
pane.
Options menu
4 The Options menu contains options relevant to the content displayed in the alarms display
pane.
Number of displayed items
5
Shows the number of items visible on this page, and the total number in this view.
Page Selector
6 Use the page Selector to navigate between pages. Set the number of items that are
displayed on a page.
3 Alarm status UI
Details button
2 Select Details to see more information related to an alarm. (See below for more
information.)
Alarm status table rows
3 Each row in the table shows an alarm definition that exists in the system. The filter settings
in the view library control which alarm definitions are included in a view.
TIP: Select Details for an alarm definition or double-Select an alarm definition row in the table to
open the alarm details.
Display Selector
1 Select Details to see information about the alarm definition.
Select History to see past instances of this alarm.
Alarm Definition Details information
2
See detailed information about this alarm definition.
Actions
Select Acknowledge to open the Acknowledge Alarms window.
3
Select Open Device Diagram to open the device diagram for the source this alarm is
associated with.
4 Alarm history UI
TIP: Select Details for an alarm instance or double-Select an alarm instance row in the table to
open the alarm details.
Display Selector
Select Details to see information about this alarm instance.
Select Events to see the events that are associated with this alarm instance.
1
Select Tolerance Chart to see an ITIC/CBEMA or SEMI F47-0706 plot for the alarm
instance. Note: This only applies to voltage disturbance alarms.
Select Waveforms to see all the waveform that are associated with this alarm instance.
Alarm instance details information
2
See detailed information about this alarm instance.
Actions
Select Timeline Analysis to open the Timeline window.
Select Acknowledge to open the Acknowledge Alarms window.
Select Open Representative Waveform to see the waveform of the worst disturbance that is
associated with this alarm instance.
3
Select Open Incident to see information on the incident that is associated with this alarm
instance.
Select Open Alarm Definition to see information on the alarm definition for this alarm.
Select Open Device Diagram to see the device diagram for the source that is associated
with this alarm.
5 Incident history UI
Select Open Timeline Analysis to open the timeline analysis window for the incident.
TIP: To analyze multiple Incidents together, Select the Incidents in the table and then
2 choose Open Timeline Analysis on Selection from the Options menu in the top right
corner of the alarms display pane.
Details button
3 Select Details to see more information related to the incident. (See below for more
information.)
TIP: Select Details for an incident or double-select an incident row in the table to open the
incident details.
Display Selector
Select Details to see information about this incident.
Select Alarms to see the alarm instances that are associated with this incident.
1 Select Events to see the events that are associated with this incident.
Select Tolerance Chart to see an ITIC/CBEMA or SEMI F47-0706 plot for the incident.
Note: This only applies to voltage disturbances.
Select Waveforms to see all the waveform that are associated with this incident.
Incident Details information
2
See detailed information about this incident.
Actions
Select Timeline Analysis to see the timeline analysis of the incident.
3 Select Acknowledge to open the acknowledge alarms window.
Select Open Representative Waveform to see the waveform of the worst disturbance that is
associated with this incident.
6 Event history UI
TIP: Double-select an event row in the table to open the alarm instance details for the alarm that
is associated with this event.
7 View settings
Back button
3
Use the Back button to exit the view settings and go back to the library.
View Name
4
Set the name of the view in the library.
Location
5
Determine where the view is stored in the library.
View Access Permissions Selector
Select Public to make this view public. Select Private to make this view private.
6 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 for details.
Priority filter
Select which priority events to include or exclude. This filter allows more precise priority
filtering than the other priority filter.
13
NOTE: This Selector is only available for event history views, not for alarm status or
incident and alarm history views.
Waveforms UI
Incident and alarm instance waveforms UI
Page Selector.
1
Navigate between pages.
Waveforms timeline.
The timeline shows at what point in time the waveforms that are associated with this
2
incident or alarm instance were captured. Each waveform capture is represented by a dot.
The representative waveforms for this incident or alarm instance are shown with black dots.
Inspect button
3
Select the button to open the waveform inspection window for this waveform.
Representative waveform
The black marking identifies the representative waveform for this incident or alarm instance.
4
The representative waveform is the waveform for the worst disturbance in the incident or
alarm instance.
Waveform inspection UI
Region Mode UI
Display Mode
Select one of the following display modes for the waveform chart: Waveform, Waveform
and RMS, RMS.
1
NOTE: The display mode Selector is not available for high speed transient waveform
captures.
Analysis Mode
Select one of the following analysis modes for the waveform chart: Region, Cursor. The
Region mode is the default analysis mode of captured waveform with the automatically
detected sampling rate. The Cursor mode is the analysis mode of captured waveform with
2
manual Selection of sampling rate using cursors. See Cursor Mode UI.
NOTE: The analysis mode Selector is not available for high speed transient waveform
captures.
Channels
3 Select which channels (V1, V2, V3, I1, I2, I3) to include or exclude from the waveform
chart.
View type Selector
Use the view type selector to switch between a Compact View and an Extended View. The
Compact View groups the analysis charts together to fit the window size. The Extended
4 View shows the charts below each other with a larger display area for each chart.
NOTE: The view type selector is not available for high speed transient waveform
captures.
Advanced Options
TIP: The Advanced Options are hidden by default. Select the Advanced Options label to
show or hide these settings.
Auto scale Auto scale adjusts the y-axis automatically as you zoom or pan the
Y-Axis waveform plot.
Shared tooltips display measurement details for all voltage and current
phases as you move the pointer over the waveform plot. Non shared
tooltips only display details for the voltage or current the pointer is hovering
over.
Example: Hover the pointer over the Vab voltage waveform plot.
Shared Tooltips (shows all details)
Shared
Tooltips
Harmonics NOTE: The harmonics setting is not available for high speed transient
waveform captures.
Select the sampling rate at which the waveform was captured. The
sampling rate is detected automatically. Use this control to make
adjustments if the sampling rate setting is incorrect. The sampling rate is
Source
set correctly when the analysis region covers one cycle of waveform
Sampling
capture.
Rate
NOTE: The sampling rate setting is not available for high speed transient
waveform captures.
Zoom
Use the left and right sliders to zoom in and out of the waveform chart. You can also Select
7 and drag the pointer on the plot to zoom. To pan while zoomed in, Select and drag the area
between the sliders. Select (to the right of the sliders) to zoom out to the original size.
Analysis area chart
This chart shows the waveform signature of the section of the waveform that has been
Selected by the analysis area Selector (see 6). The phasor and harmonics calculations are
8 based on the waveform data from the analysis area. The y-axis is automatically scaled.
NOTE: The analysis area chart is not available for high speed transient waveform
captures.
Phasor chart
This chart shows the phasor analysis of the section of the waveform that has been
Selected by the analysis area Selector (see 6). Phasor details are shown in a polar
9
diagram and a data table.
NOTE: The phasor chart is not available for high speed transient waveform captures.
NOTE: The voltage harmonics chart is not available for high speed transient waveform
captures.
NOTE: The current harmonics chart is not available for high speed transient waveform
captures.
Compare Waveforms
Use this option to open this waveform in a new, Compare Waveforms tab in the browser.
12
You can then Select other waveforms to open in the same window. If a Compare
Waveforms tab is already open, then the present waveform is added to that window.
Export Waveform
13 Use this option to download the waveform data of the present waveform in .csv file format.
The file is downloaded to your local Windows Downloads folder.
Cursor Mode UI
Display Mode
Select one of the following display modes for the waveform chart: Waveform, Waveform
and RMS, RMS.
1
NOTE: The display mode Selector is not available for high speed transient waveform
captures.
Analysis Mode
Select one of the following analysis modes for the waveform chart: Region, Cursor. The
Region mode is the default analysis mode of captured waveform with the automatically
detected sampling rate. See Region Mode UI. The Cursor mode is the analysis mode of
2
captured waveform with manual Selection of sampling rate using cursors.
NOTE: The analysis mode Selector is not available for high speed transient waveform
captures.
Channels
3 Select which channels (V1, V2, V3, I1, I2, I3) to include or exclude from the waveform
chart.
Advanced Options
Auto scale Y- Auto scale adjusts the y-axis automatically as you zoom or pan the
Axis waveform plot.
4 Select to view Phasors in the analysis pane.
View NOTE: The View option is not available for high speed transient
waveform captures.
Zoom
Use the left and right sliders to zoom in and out of the waveform chart. You can also Select
6 and drag the pointer on the plot to zoom. To pan while zoomed in, Select and drag the area
between the sliders. Select (to the right of the sliders) to zoom out to the original size.
Cursor Measurement
This table displays 4 columns. The first column displays the time and measurement details
for the voltage and current phases of the cursor 1. The second column displays the time
and measurement details for the voltage and current phases of the cursor 2. The third
column displays the difference of time and measurement details for the voltage and
7 current phases between cursor 2 and cursor 1. The fourth column displays the phase
angle of 3rd column measurements with respect to the first voltage phase angle of 3rd
column. The 3rd column first voltage phase angle is set to 0°.
NOTE: The cursor measurement is not available for high speed transient waveform
captures.
Phasor chart
This chart shows the phasor analysis of the section of the waveform that has been
8 Selected by the cursors. Phasor details are shown in a polar diagram and a data table.
NOTE: The phasor chart is not available for high speed transient waveform captures.
Compare Waveforms
Use this option to open this waveform in a new, Compare Waveforms tab in the browser.
9
You can then Select other waveforms to open in the same window. If a Compare
Waveforms tab is already open, then the present waveform is added to that window.
Export Waveform
10 Use this option to download the waveform data of the present waveform in .csv file format.
The file is downloaded to your local Windows Downloads folder.
Timeline analysis UI
Analysis UI
NOTE: Alarms and data measurements during an incident occur in very short time intervals. To
show the correct sequence of events in the timeline analysis, the timestamps must be accurate.
Consider using monitoring devices with Precision Time Protocol (PTP) or GPS time
synchronization for accurate time stamping.
Options menu
1
Contains options relevant to the content displayed in the Analysis UI.
Notes area
2
(Optional) Enter notes related to the Analysis.
Grouping control
3
Choose to group the items in the Analysis by time or by source.
Zoom and Heatmap
Use the sliders or the time controls to zoom in or out of the analysis time window. Use the
4
button on the right of the slider to zoom out to the original size. The colored areas act as a
heatmap, showing you where the analysis items are located on the time window timeline.
Analysis items
These are the alarms, waveforms, and bursts that are associated with this timeline. The
color bars to the left of the items indicate the item priority. Arrows, pointing up or down, to
5 the left of some of the items indicate Disturbance Direction Detection measurements. Hover
the pointer over the arrows to get specific disturbance direction information.
TIP: Select the item name to open a detail view for the item.
Timeline
Each analysis item is represented by a dot on the timeline or a burst data display. The color
6 of the dot indicates the priority of the item. Alarms with a start and end event are shown with
two dots, connected by a line. Waveforms are shown with a white dot. Zoom in to see the
waveforms timeline. Select a waveform dot to open the waveform viewer.
Analysis item Options
7
Hide an item from view or choose to open a detail view for an item.
View Name
1
Shows the name of the timeline view.
2 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 for details.
Quick Expand
3 Select this option to extend the time window of the view and adds all devices, and all
categories.
Priority filter
4 Select the priority buttons to include or exclude alarms with that priority. The priorities are,
from left to right: No, Low, Medium, High.
Sources Selector
5
Include all sources or Select specific sources.
Show control
Show or hide burst data, waveform data, the notes area, spanning alarms, hidden items.
6 NOTE: Spanning alarms are alarms that started before the time window. Hidden items are
analysis items that are marked as hidden through the item Options menu. Hidden items
appear dimmed when shown.
Category Selectors
Include or exclude certain categories of alarms from the analysis and choose specific types
within each category. The following categories are available:
Power Quality
7 Asset Monitoring
Energy Management
General
Diagnostics
See Alarms for a list of available types in each category.
NOTE: Load loss is the most common load impact caused by voltage disturbances.
• A positive Load Impact value, X > 0%, means a load gain. The real power (kW) of the
monitored circuit has increased by X%.
• A negative Load Impact value, X < -100%, means a potential load reversal. The energy flow
in the monitored circuit might have been reversed. The percent value less than -100% is the
portion of pre-event real power (kW) flowing in the opposite direction. For example, a Load
Impact value of -125% means that the power flow has been reversed and 25% of the pre-
event real power are now flowing in the opposite direction.
A voltage disturbance event can result in any or all of the above load changes. For example,
starting a large load, such as a motor, can produce a voltage sag that causes another load to
disconnect. In this case, the motor load circuit would show a load gain and the other circuit a load
loss.
Alarms terminology
The following is a list of commonly used terms related to Alarms in PME.
Alarm
The term Alarm is commonly used to describe both, an alarm definition and an alarm instance.
Which one it represents in an application must be derived from the context in which it is used. It is
better to use the terms alarm definition and alarm instance to avoid ambiguity.
Alarm definition
An alarm definition is the specification of a defined condition for a particular measurement from a
particular source. When the condition is met, the alarm goes active. When the condition is no
longer met, the alarm goes inactive. Example: An Overcurrent alarm that goes active when the
measured current for a load goes above a defined limit. The alarm definition includes the alarm
name, the source and measurement, the alarm limits, and any other conditions that are relevant
for the alarm.
Alarm instance
An alarm instance is a record of an occurrence where a monitored load exceeds the limits set in
the alarm definition. An alarm instance starts when the alarm state goes active and ends when it
goes inactive. An alarm Instance has a start and end date.
Alarm state
The alarm state shows if the monitored load presently meets the conditions defined in the alarm
definition or not. If it meets the conditions, the alarm state is Active. If it does not meet the
conditions, the alarm state is Inactive.
Alarm acknowledgment
An alarm acknowledgment is a way to indicate in the software that you have seen the alarm and
that it is being managed. When you acknowledge an alarm, the date and time of the
acknowledgment is recorded together with an optional note that you can enter in the acknowledge
window.
An alarm can be acknowledged after it has gone active. An alarm stays unacknowledged until you
acknowledge it. After you have acknowledged an alarm, it stays acknowledged until the next time
it goes active. At that point it is reset to unacknowledged and is waiting for you to acknowledge it
again.
NOTE: You can acknowledge alarms in status views and history views. If you acknowledge
alarms through an incident history view, all alarms that are part of this Incident will be
acknowledged. Whenever you acknowledge an alarm, from any of these locations, you are
acknowledging the alarm definition, not an instance of it. That means acknowledging an alarm
marks it as acknowledged for all instances and resets the unacknowledged occurrence counter.
Incident
An incident combines alarms, waveforms, and burst data from many sources in the system. The
elements are combined based on the proximity in time when the data was recorded and based on
an analysis of the type of data. The goal is to create a single representation of a real-world power
event that shows the impact of this event on the power system as a whole.
• Type: Sag
• Duration: 200.0 ms
Representative waveform
The representative waveform is the waveform that is related to the representative disturbance for
an alarm or an incident. If multiple waveforms are associated with the representative disturbance,
then the representative waveform is selected based on the following priorities:
Burst data
Burst data is pre- and post-event data that is logged during an alarm instance. The recording of
the data is triggered by an alarm going active. Devices that support burst data keep a continuous
buffer of data logs in memory, until a burst data capture is triggered. At that point, the data is
recorded and uploaded to the software, together with the trigger time. By showing both pre- and
post-event data, burst data is a very effective analysis tool. Burst data can be high speed data,
such as half-cycle RMS measurements of voltages, currents, and other quantities, or it can be 1
second measurements for slowly changing parameters.
Event
Events are records of activity or conditions in the monitoring system. Events are generated by
devices and the software and are logged and displayed as they happen in the system without any
processing or aggregation. The system uses event records to determine alarm types and states.
Status view
A status view in the Alarms application shows alarm definitions in the system, their present state,
how often they occurred, their priority, and other relevant information.
History view
A history view in the Alarms application shows instances of incidents, alarms, or events that have
occurred in the system.
Dashboards references
This section contains reference information related to using Dashboards.
Use the following links to find the content you are looking for:
Dashboard Library
Contains all the Dashboards that are configured in the system. Dashboards can be listed
individually, or they can be organized within folders.
1
TIP: To hide the library, click the Hide Library icon ( or ) in the top right corner of the
library. To show the library, click the Show Library icon ( or ) at the top of the library
ribbon, or click anywhere in the minimized library ribbon.
Gadget Settings UI
Dashboard Settings
Search filter.
2
Enter text to search and filter the Dashboards displayed in the Library.
Back button.
3
Exit the Dashboard Settings and go back to the Library.
Dashboard Name.
4
Set the name of the Dashboard in the Library.
Add Gadget.
5 Add new gadgets to the Dashboard. See Adding a gadget to a dashboard for more
information.
Styling.
Set the appearance of the Dashboard by adding a background image, setting the
6
background color, and setting the gadget opacity. See Styling a dashboard for more
information.
View Access Permissions Selector.
Select Public to make this Dashboard public. Select Private to make this Dashboard
private.
7
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 for details.
Location.
8
Determine where the Dashboard is stored in the Library.
Gadget UI
Gadget Title
1
Shows the gadget title.
Viewing Period
Select the date and time range for the data that is to be displayed in the gadget. To view a
gadget that starts and ends in the past, Select the fixed date option. Type a start and end
date in the date boxes or Select the arrows beside the dates to display a pop-up calendar
2
and Select a date. Type a time in the time boxes or Select the up and down arrows beside
the time to adjust the hours or minutes up or down. You can also view a gadget that starts
and ends in the future. You can use any tool to generate future data. For example, use
Manual Data Editor to manually enter measurement data.
Maximize Icon
3
Select to maximize the gadget to display in full screen of the dashboards display pane.
Options menu
Contains options relevant to the Gadget. The following options are available:
Edit
4 Duplicate
Copy to
Export to CSV
Delete
Date and Time Range
5 Displays the date and time range of the data displayed in the gadget. This display is
depended on the Selection of viewing period.
Gadget Data
6
Displays the data of the gadget. Different gadget types can have different data displayed.
Gadget Data Legend
7 Displays the data legend of the gadget. Different gadget types can have different data
legend displayed.
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
• Gadgets
• Session Timeout
Use the links below to find the content you are looking for:
Events
Power Quality (PQ) events are short-term disturbances that are characterized by magnitude,
duration, and direction.
Disturbances
PQ
Summary Magnitude Source Duration Consequence
Disturbances
0.5% - 2.5% of
Non-
Voltage nominal Utility or Overheating or
symmetrical Steady state
Unbalance voltage facility malfunction
voltages
(typical)
1.0% - 30% of
Non- Malfunction
Current nominal Utility or
symmetrical Steady state and breaker
Unbalance current facility
current trip
(typical)
PQ
Summary Magnitude Source Duration Consequence
Disturbances
Malfunction
Voltage Waveform 0 to 20% Nonlinear
Steady state and
Harmonics distortion (typical) loads
overheating
Malfunction
Current Waveform 0 to 20% Nonlinear
Steady state and breaker
Harmonics distortion (typical) loads
trip
Deviation of Up to 5% Standby
Malfunction or
Frequency the frequency deviation of generators or
Intermittent motor
Variation from the nominal poor power
degradation
nominal (typical) infrastructure
Voltage Load exhibits Flickering
waveform 0.1% to 7% significant lights,
Flicker Intermittent
envelope (typical) current equipment
variations variations malfunction
Reports references
This section contains reference information related to using Reports.
Use the links below to find the content you are looking for:
After you generate a report, you can display or change the input parameters you specified for it by
selecting show inputs in the top-right corner of the report display area. To return to the generated
report without changing any of the input parameters, select hide inputs. If you change any of the
input parameters, select Generate Report to regenerate the report.
The following information describes the inputs for the report templates. The available inputs vary
by report template listed in the Reports Library.
Aggregation Data
This input determines the period of time over which data is accumulated for presentation in the
report, such as day, week, and so on. From the dropdown list, select the aggregation interval that
you want to use. If a custom report includes a predefined aggregation interval, contact the owner
to adjust the interval for your use.
Aggregation Interval
This input determines the period of time over which data is accumulated for presentation in the
report, such as day, week, and so on. From the dropdown list, select the aggregation interval that
you want to use. If a custom report includes a predefined aggregation interval, contact the owner
to adjust the interval for your use.
Aggregation Period
This input determines the period of time over which data is accumulated for presentation in the
report, such as day, week, and so on. From the dropdown list, select the aggregation interval that
you want to use. If a custom report includes a predefined aggregation interval, contact the owner
to adjust the interval for your use.
Aggregation Type
The aggregation data that will be displayed: Average, Maximum, or Minimum.
Area
The area whose panels you want to include in the report.
ATS Summary
1. Click ATS Summary.
2. Click Include ATS Summary to include the Automatic Transfer Switch Summary section in
the report. The remaining options in the screen are enabled. Alternatively, clear this check
box to exclude the Automatic Transfer Switch Summary section from the report.
3. Click Include Pass/Fail Indicator to include both the Required Transfer Time and Test
Result fields.. The Test Results shows the pass/fail grade. Alternatively, clear this check box
to exclude the results from the report.
4. Lead ATS - Select the ATS device that you want to use as the lead ATS in reporting the
transfer time. The lead ATS is the ATS upon which the pass/fail grade is based.
You can choose the Auto Select Lead ATS option if you want the system to
automatically select the lead ATS. The ATS device that is first to enter test mode becomes
the lead ATS. If multiple ATS devices enter test mode at the same time, or if none of the
devices enter test mode, the system selects the ATS based on alphabetical order.
Auto-scale Y-Axis
Select whether or not to scale the chart normally. Selecting No, sets the starting point of the Y-
axis at zero. The default is Yes.
Base Interval
This setting works together with Include Empty Intervals. When Include Empty Intervals is
turned on, the system uses the Base Interval to determine the timestamps for the empty records
that are inserted.
Baseline Date
Use the Baseline Date to compare the current state of the breaker settings to a baseline point in
time. If a change is detected between the state of the settings today and the state of the settings
on the baseline date the change will be noted in the report.
Change Summary
Click Yes to include the Change Summary section of the report. Click No to not include it. The
default is No.
Chart Type
Select one of the available chart types from the dropdown list to graphically display the data that
you specified for the report.
Check Source
Use this input to select the reference source for the bill comparison, for example the utility owned
metering source. To select the source, choose a hierarchy view or virtual meter.
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.
Comments
Use this field to add comments that will appear at the bottom of the generated report.
Company Name
Type a name for the company in the text box.
Custom URL
(Optional) Specify the URL for any page or image that you would like to include in the report. This
could be a page from an external or internal website, or a local image.
Customers
Click Select Customers. Select the customers that you want to include in the report from the list.
Click Select All to select all the customers from the list. Click None to deselect all the customers.
Click OK.
Data Selection
Click Minimum EPSS Data to populate the report with the minimum data needed for EPSS
compliance. Minimum EPSS Data includes the ATS Summary and the Generator Summary
pages without additional data tables.
Click Manual Data Selection to enable a custom selection of sections to be included in the
report.
Demand Rating
Enter a value for the rated capacity of the equipment, based on the selected measurement. For
example, if you selected an Active Power measurement (kW), enter the rated kW capacity. The
default value is 1000.
Dependent Variable
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.
Deviation Type
Enter a percentage or specific value to specify the type of deviation to show in the report.
Display Billing ID
Click Yes to show an alphanumeric billing ID for a tenant which can be used by third party billing
engine.
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.
Duration (sec)
Select the duration of rms variation that you want to use in the report (such as 15 seconds, 30
seconds, no limit, etc.)
The duration is the time window used by the generated report to count the voltage swag and / or
swell. The default value is 60 seconds.
Email Address
Enter a comma-separated list of email addresses to which notification emails will be sent.
Email Subject
Enter the subject line for the notification emails.
End Hour
Select the end hour to display when filtering the data by the time of day.
The currency symbol used to display the cost values is set in Web Applications SETTINGS >
Personalization > System Language.
Use this label to aggregate disparate units into a common measurement unit.
For example, for Gas (GJ) and Electricity (kWh) values you could define the Energy Label as
'BTU'.
Energy Measurements
1. Click Select Load Measurement to open the Load Measurement Selector dialog.
Use the Devices option to select the devices you want to include in the report.
From the Grouping list, select the way in which you want to display the sources (for
example by device type or by group name). Click + and - to expand and collapse items
in the navigation tree. Click the check box beside a device (or group of devices) to select
it. Click Select All or Select None in the top-right corner to select or clear all the check
boxes.
Use the Views option to select a hierarchy view (a tree of relationships) or virtual
meters.
The hierarchy views and virtual meters are configured in the Hierarchy Manager
component. (See the Hierarchy Manager Help for further information about hierarchies,
virtual meters, and views.) Click + and - to expand and collapse items in the tree. Click
the check box beside any hierarchy item in the tree or any virtual meter to select it.
3. Under Measurements:
a. Click Select Measurement to open the Measurement Selector.
b. Choose the measurement you want to use for the energy comparison and click OK.
The multiplier lets you add multiple measurements. For example, a multiplier can be
used to get gas and electricity energy currencies onto the same unit footings, so they
can be added together.
For example: To normalize energy usage per square foot of a building, enter Energy per
Square Foot in the Label value, and the square footage of the building in the Value field.
5. Click OK.
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.
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.
Environment Class
Select an option for the three classes of electromagnetic environment. The options are Class 01,
Class 02, and Class 03.
NOTE: Class 01 defines compatibility level lower than public (laboratory instrumentation, some
protection equipment, etc.). Class 02 defines compatibility level equal to public (any equipment
designed for supply from public networks). Class 03 defines compatibility level higher than
public (equipment in the presence of welding machines, rapidly varying loads, large converters,
etc.).
EPSS Group
Select the transfer switches and other equipment group for the report. The list shows the groups
that you defined in the configuration utility. When you select a group from the list, the field to the
right shows the devices included in the group.
Evaluation Limits
Click Configure to configure the EN50160 parameters used in the report. Default values are
provided based on the EN50160 standard.
Click the links in the dialog box to access configuration options for various measurements
included in the report:
• Basic Configuration: Type the maximum percentage of intervals in an observation period
where the component does not meet the EN50160 N1 and N2 requirements before the
component is considered non-compliant.
• Supply Voltage Dips: Type the maximum percentage of intervals in an observation period
that the RMS value can drop below 90% of the nominal voltage for each duration and depth
presented in the dialog box before the component is considered non-compliant.
• Short and Long Interruptions: Type the maximum percentage of intervals in an observation
period that the RMS value can be less than 1% of the nominal voltage for the given duration
before the component is considered non-compliant.
• Temporary Overvoltages: Type the maximum percentage of intervals in an observation
period that the RMS value can exceed the nominal voltage by each magnitude for each
duration presented in the dialog box before the component is considered non-compliant.
NOTE: The EN50160 standard defines the observation period for the above components as one
week.
Event Location
Select how you want to identify the location of the events that are included in the generated report.
The available selections are Internal and External, Internal only, or External only.
Event Priority
Select the priority of alarms and events that you want to include in the report. The options include
high, medium, and low priority alarms and events.
Events Summary
1. Click Events Summary.
2. Click Include Events Summary to include the Events Summary section in the report. The
remaining options in the screen are enabled. Alternatively, clear this check box to exclude
the Events Summary section from the report.
3. Click Include Generator Events to include generator events in the report. Alternatively,
clear this check box to exclude generator events from the report.
4. Click Include ATS Events to include ATS events in the report. Alternatively, clear this
check box to exclude ATS events from the report.
Exclude Sources
(Optional) Define the sources to exclude from the report:
a. In the Sources Included area, select sources to exclude and then click > to move those
sources to the Sources Excluded area.
b. To move all of the sources into the Sources Excluded area, click >>.
The devices in the group appear in the Sources section of the generated report. Excluded devices
appear as grayed-out entries.
NOTE: For Measurement Aggregation Export Report, you can use the Export Format
parameter to select the export format. For Measurement Statistics Export Report, you can export
the report output files in CSV format only. No specific parameter is available for selection of
export format.
Enter a path or file share on the PME server where the report output files will be saved to. If you do
not provide a file name as part of the path, the system will use the default file name
DefaultExport.csv for the export file. You do not need to include an extension with the file
name.
NOTE: The WebReporterAppPool application pool in IIS must have write permission on the
Export File Path location. This application pool is running under the NetworkServices Identity
when PME is installed with SQL Authentication. When it is installed with Windows Integrated
Authentication, then the Windows account that is used to access the databases is used to run
the application pool.
Examples:
Path, without file name: C:\Temp\. (NOTE: Do not forget to include the \ at the end of the path.)
NOTE: This note is applicable for Measurement Aggregation Export Report. When the CSV
(RepGen Compatible) Export Format is selected, the report output is organized by source and
saved to a file with the source name. If multiple sources are selected, one output file for each
source is created.
Export Format
Select the format for the CSV export file. The available options are:
• CSV
Standard CSV output format. All the data is saved into a single output file. Example:
This format is compatible with RepGen, a Microsoft Excel based reporting system that was
part of earlier versions of PME. One output file is created for each selected source. Example:
• Tidy
This format is similar to the RepGen compatible format. It includes the source names and all
the data is saved into a single output file. Example:
Facility Location
(Optional) Type the data center facility location.
Facility Name
Type the data center facility name.
Generator Summary
1. Click Generator Summary.
2. Click Include Generator Summary to include the Generator Summary section in the
report. The remaining options in the screen are enabled. Alternatively, clear this check box
to exclude the Generator Summary section from the report.
3. Click Include Pass/Fail Indicator for Time to EPS Available to include the pass/fail grade
for emergency power source availability. Alternatively, clear this check box to exclude the
pass/fail grade.
4. Click Include Pass/Fail Indicator for Generator Evaluation to include both the pass/fail
grade and the evaluation method used to evaluate each generator. The pass/fail grade is
based on both the run duration and the minimum specified percentage of the prime
nameplate rating. Alternatively, clear this check box to exclude the pass/fail grade and the
evaluation method from the report.
5. Select the Load Details options to specify the electrical data in the report:
Include Chart: Select this check box to include a generator chart showing kW Load,
kVA Load, and the threshold for the minimum acceptable power load based on the
specified load percentage for the run duration.
Include Statistics Table: Select this check box to include a table showing minimum,
average, and maximum electrical readings for the longest continuous load at (or above)
the specified load percentage. The electrical readings measured are: kW, kVA, Ia, Ib, Ic,
In, Vab, Van, Vbc, Vbn, Vca, Vcn.
Include Data Table: Select this check box to include a table showing the generator
electrical details. The data is organized by time intervals and displays the readings for
kW, kVA, load (the percentage of maximum load identified on the generator nameplate),
Power Factor (PF), I avg, VLL avg, VLN avg, and Frequency.
6. Select the Engine Temperature Details options to specify the engine temperature data in
the report:
Include Chart: Select this check box to include a chart showing the engine temperature
for the run duration, and a horizontal line identifying the minimum temperature required
for the run duration.
Include Statistics Table: Select this check box to include a table showing Minimum,
Average, and Maximum engine temperature readings for the longest continuous engine
temperature equal to or above the minimum acceptable engine temperature.
Include Data Table: Select this check box to include a table showing the Longest
Continuous ET (Engine Temperature) time period, the Minimum ET, Required Run
Duration (Min), and Actual Run Duration.
NOTE: The configuration tool does not convert the engine temperature values from
one temperature type to another.
7. Select the Exhaust Gas Temperature Details options to specify the exhaust gas
temperature data in the report:
Include Chart: Select this check box to include a chart showing the exhaust gas
temperature for the run duration, and a horizontal line identifying the minimum
temperature required for the run duration.
Include Statistics Table: Select this check box to include a table showing Minimum,
Average, and Maximum exhaust gas temperature readings for the longest continuous
engine temperature equal to or above the minimum acceptable exhaust temperature.
Include Data Table: Select this check box to include a table showing the Longest
Continuous EGT (Exhaust Gas Temperature) time period, the Minimum EGT, Required
Run Duration (Min), and Actual Run Duration.
8. Under Engine Data, click Include Data Table to include engine details in the report. Details
for each generator include:
Generator name
Group
Keep the default option All Groups or select a specific power quality group from the list.
The groups are defined in the Power Quality Group configuration file, which is implemented
during Power Quality Performance commissioning.
Grouped By
Select from the dropdown list to determine how the circuit breaker aging and electrical wear
analysis results are sorted.
Highlight End
Select the end hour to stop the highlighting of the line in the chart.
Highlight Start
Select the start hour to begin the highlighting of the line in the chart.
Incident Interval
Select the incident interval that you want to use in the report (such as, 20 seconds, 10 minutes, 1
week).
The incident interval is the time window used by the generated report to group multiple
disturbances together into a single incident. The default value is 20 seconds.
Include Chart
Select whether or not to include the chart in the generated report. The default is Yes.
Include Duplicates
Select whether or not to show duplicate data in the generated report. The default is No.
Duplicate data collection is disabled in Power Monitoring Expert by default. In order to be able to
include duplicate data in a report, duplicate data collection must first be enabled for the system.
Clear the checkboxes for any specific items that you do not want to include in the generated
report. If you clear or select Events or Disturbances, the checkboxes for all of the items included
in that category are cleared or selected.
Include Gauges
Select whether or not to include the gauges in the generated report. The default is Yes.
Include Glossary
Click Yes to include a glossary of key terminology at the end of the report. Click No to exclude it.
Include Tables
Select whether or not to include the tables in the generated report. The default is Yes.
Independent Variable
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.
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.
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.
IT Equipment Source
Click Select Source to choose the single source that represents all the IT equipment operated in
the data center facility.
KPI Formula
Enter the mathematical formula that is used to calculate the KPI from the input parameters. Use
the labels that are associated with the input parameters in the Input Source Measurements
section as variables in the formula. You can use the following operators +, -, /, *, Pow(), Sqrt().
• A+B+C
• C / (A + B)
• Pow(A+B+C,2)
• Sqrt(A+B)
KPI Measurement
Select the measurement that is used to represent the KPI output value. The calculated KPI values
will be logged under this measurement and the KPI Source. Use the KPI Measurement
Override if you cannot find a suitable output measurement.
Manually enter the name of a measurement to be used to represent the KPI output value. This
overrides any measurement selected under KPI Measurement. If the measurement you enter
does not already exist in Power Monitoring Expert, it is created.
KPI Source
Enter the name of the source for which the calculated KPI values are logged in Power Monitoring
Expert. The source is created automatically, if it does not exist already.
Load Measurement
Select the source you want.
Logged Measurement
1. Click Select Source to open the Source Selector dialog.
4. Select the instantaneous measurement (power, power factor, current, THD, etc.) and then
click OK.
Maintenance Status
Click Yes to include the Maintenance Status section of the report. Click No to not include it. The
default is Yes.
Manual
Click Manual to select the runs according to a date range and run reason, and then do the
following:
1. Select the Reporting Period date range for the runs to include in the report.
2. Select the Run Reason for the runs to include in the report.
If you select Most recent run and define excluded sources, the exclusions are ignored
when you generate the report.
The devices in the group will appear in the Sources section of the report. Devices that you
excluded from the report will be gray-shaded.
Measurement Label
Input the label to be used to describe the measurements selected in Load Measurement.
Click Select Measurement to open the Measurement Selector dialog. Click + and - to expand
and collapse items in the navigation tree. For reports where you can select multiple
measurements, click the check box beside a measurement (or group of measurements) to select
it. For reports where you can only select a single measurement, click the measurement name to
select it.
Smart Mode provides a general measurement name for you to select. The measurement is
based on a subset derived from all of the available measurements in the particular measurement
category. The underlying operation selects an applicable measurement for each device to
produce equivalent results for reporting purposes.
The following image illustrates how measurements in Smart Mode are determined and applied
from the priority list of measurements. The priority list contains measurements that usually
provide equivalent results for the measurement selected in Smart Mode.
For example, for each device included in a hierarchy view or in a virtual meter, the report starts
with the Real Energy measurement in the priority list. If data for that measurement exists, then it is
used in the report. If data does not exist for the Real Energy measurement, then the report goes to
the Real Energy Total measurement in the list. If data exists for that measurement, then it is used.
The report continues to progress through the priority list to select a measurement that pertains to
each device associated with a hierarchy view or a virtual meter.
You can select Detailed to change to the detailed selection mode. This mode allows you to select
from a full list of measurements.
The Measurement Selector provides a full list of measurements when you select the Devices
radio button in the Source Selector.
Click + and - to expand and collapse items in the navigation tree. For reports where you can select
multiple measurements, click the check box beside a measurement (or group of measurements)
to select it. For reports where you can only select a single measurement, click the measurement
name to select it.
Measurement Interval
Select the observation period (that is, the measurement interval) of 2 Hour, 10 Minute, or 3
Second to use for the IEC61000-4-30 report.
Multiplier
Enter a value to use as a multiplier in normalizing the raw data in the report. The default is 1.
n % Crossing
Type a value for the duration percentage. This value indicates where to place a cross on the
plotted line identifying where that percentage value occurs.
Notify On
Select a notification option for when to send out notification emails. The available options are:
• Do Not Notify
Only send a notification if the threshold for the Check vs Actual Total is exceeded.
• Check Source vs Private Source
Only send a notification if the threshold for the Check vs Private Source is exceeded.
Send a notification email if the calculated upper and lower line value exceeds the aggregated
interval value.
• Upper Only
Send a notification email if the calculated upper line value exceeds the aggregated interval
value.
• Lower Only
Send a notification email if the calculated lower line value exceeds the aggregated interval
value.
Notes
Any notes appear at the bottom of the report page.
Sub-reports
The options available for selection are Generate dynamically and Embed into single report.
• Select Generate dynamically to generate an incident summary report only. You can click the
links in the report to view incident details and also associated waveforms.
This option provides a convenient way to generate a summary of incidents to give you an
indication for investigating a particular incident or waveform. This option is recommended for
interactive viewing and analysis within the reporting period.
• Select Embed into single report to include the incident summary, the incident details, and
the waveforms associated with those incidents in a single generated report. This single report
format facilitates exporting the information to one of the available download formats, and it
also facilitates setting and delivering a report subscription. This option is recommended for
attaching the report to an email.
This option provides a convenient way to extract and share power quality-related information.
Although power quality events vary from system to system, it takes longer to generate the
report using this option because the system queries more data, including data-intensive
waveforms. To prevent possible report timeouts, it is suggested that you keep the number of
waveforms to a minimum by:
Selecting a single source.
Order By
Select to order the list of bills in the report output by tenant name or by rate file name.
Overwrite File
Selecting Yes overwrites an existing file if it exists and selecting No appends the new data to an
existing file.
Page Size
Select from the dropdown list. Select Fit to Page to automatically scale each output page to fit
onto a single report page. Select Custom to scale the output based on the height and width
values provided in the Custom Page Height and Custom Page Width boxes.
The target power factor is configured in the Power Factor Impact Rate.xml file when the Power
Quality Performance module is commissioned. This rate file is included in the Energy Billing
Module, which is subject to licensing. Contact your Schneider Electric representative for further
information.
Precision
Enter the decimal value precision to use in report output and saved values.
Primary Sort
Select the primary sort column from the drop-down list. Your choice sets the primary sort column
for the report; customer, rack or circuit. Depending on how your hierarchy is configured, the sort
might contain customer and circuit only.
Priority
Select the priority of alarms and events that you want to include in the report. The options include
high, medium, and low priority alarms and events.
Private Source
Use this input to select a source for the bill comparison, for example the internal metering source.
To select the source, choose a hierarchy view or virtual meter.
Protection Modes
Click Yes to include the Protection Modes section of the report. Click No to not include it. The
default is Yes.
PUE Category
Select a number for the report category. The value appears as a label below the report title. The
label will be “Category n”, where “n” represents the number selected.
Category 1 is measured at the Uninterrupted Power Supply (UPS). Category 2 is measured at the
Power Distribution Units (PDU). Category 0 and 3 are not included in the PUE Report.
Rate
Select the rate structure to apply to this report. The rate determines how the cost for each source
is calculated.
Rates
Use this input to set up parameters for energy cost reporting. Click Configure Rates to open the
Energy Rates dialog.
• Click Energy and Demand to configure basic rate parameters for the report.
In the Select Measurements section, click the check box beside a measurement to
include it in the report.
In the Select Billing Calculation section, select Flat Rate or select TOU Schedule. If
you select TOU Schedule, select a time of use (TOU) schedule from the dropdown list
(see the Time of Use Editor topic in the online help for Management Console Tools for
information on configuring a time of use schedule).
In the Set Rates section, enter the rates for the selected measurements.
In the Set Demand Calculation section, select the calculation method used to determine
demand: Independent (peak demand is calculated independently for each source) or
Coincident (the demand measurements of the sources are correlated with the peak
demand of the main meter). If you select Coincident for the calculation method, click
Main Meter to select the source to which you want to correlate the demand
measurements.
• Click WAGES to include WAGES (Water, Air, Gas, Electricity, Steam) measurements in the
report. Click the +/- buttons to add or remove measurements. Enter a name for the
measurement then click Select Source and Select Measurement to select a source and
measurement. Enter a rate for the measurement in the Rate field.
• Click Additional Fees to add additional rate information to the report. Enter a name in the
Rate Name field and rate information in the Amount field.
Regression Type
Choose from the dropdown list Single-Line or Broken-Line.
Report Data
Select one or more system configurations to use in the report:
1. Click Select Generator Systems. The Selector screen appears with the UPS systems you
set up in the Generator Power Configuration Utility.
3. Click OK.
1. Click Select Generator Systems. The Selector screen appears with the UPS systems you
set up in the Generator Power Configuration Utility.
3. Click OK.
1. Click Select UPS Systems. The Selector screen appears with the UPS systems you set up
in the UPS Power Configuration Utility.
3. Click OK.
Report Group
Select the group for which the report is intended.
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. You can also run a
report that starts and ends in the future. You must manually add the future data. You can use any
tool to generate future data. For example, use Manual Data Editor to manually enter
measurement data.
• Aggregation Interval: This input appears when you select Month for the Aggregation
Period. Select how you want data grouped for the report: by date (Day of Month) or the day of
the week.
• Selected Dates: This box displays the dates of the data that will appear in the report based
on the options selected.
For example, to compare the selected measurements for the same day of the month over the last
12 months, set Aggregation Period to Day, set Comparison Type to Today vs. Same
Weekday From Previous Month, and enter 12 in the Number of Comparisons field.
Select the reporting period from the dropdown list. The timeframe options in the timeframe
dropdown are relative to the date the report is run. Use a relative date option for reports that you
want to generate on a regularly scheduled basis. 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 whether you want to view timestamps in either Server Local Time or UTC (Universal
Coordinated Time).
If you select a time other than the default custom time, in a Custom Day, the reporting period will
show the start time to end time along with the date.
NOTE: Reports which support Start Hour and End Hour for Rollup consider the values of Start
Hour and End Hour over Custom Day settings.
NOTE: Custom Day settings are not applicable for Model reports.
Report Type
Select either Summary or Detail.
• Summary – Shows only the aggregated values for all racks/circuits for a given tenant.
• Detail – Shows the aggregated value as well as child values of the racks and circuits.
Rollup
Select the aggregation time interval for the reporting data.
NOTE: This note is applicable for KPI report. For the selection of Hourly, Daily, Weekly, or
Yearly value for Rollup parameter, the measurement values are always aggregated for the
selected measurements based on the interval values. For non-cumulative measurements, it is
recommended to select Interval value. For example, if Mean Current measurement is selected
and the Rollup is set to Interval, the Mean Current measurements for the selected interval is
displayed. If Rollup is set to Hourly, the Mean Current measurement values are displayed as
aggregated values and not average values.
NOTE: Interval Rollup is available only for the following reports: KPI reports, Measurement
aggregation export report, Measurement aggregation report and Multiple trend report.
The data is shown with sources and measurements as columns and timestamps as rows.
Example:
The data is shown with timestamps and measurements as columns and sources as rows.
Example:
The data is shown with sources and measurements as columns and timestamps as rows.
This view is similar to the horizontal table with more compact measurement column headers.
Example:
The data is shown with the source name, measurement name, timestamp, value, and so on,
in a single row per data record.
Example:
The report overwrites any values, for this KPI, that already exist in the database from previous
report runs.
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.
Scale Measurement
Select the measurement as the base against which to scale the main dataset. This input is
optional.
Scale Multiplier
Enter a value to use as a multiplier in normalizing the raw data of the scale source and
measurements in the report. The default is 1.
Scale Source
Select the source as the base against which to scale the main dataset. This input is optional.
Select
Select Top (highest result) or Bottom (lowest result) to indicate the order of the gauges in the
generated report. The default is Top.
1. Select the Reporting Period date range for the runs to include in the report.
2. Select the Run Reason for the runs to include in the report.
The devices in the group will appear in the Sources section of the report. Devices that you
excluded from the report will be gray-shaded.
Select Group
Select the group for which the report is intended.
Select Number
Enter the number of sources that you want to include in the ranking. The default is 99.
Select Waveforms
1. Click Select Source, choose a source from the list, and then click OK.
2. Click Select Reference Waveform, select the check box next to one or more comparison
waveforms, and then click OK.
By default, the report looks for the five most recent waveforms that have been captured
for the source to be compared against the reference waveform. Use this mode for
reports that are to be delivered using a report subscription.
This mode allows you to select specific comparison waveforms. It is not recommended
to use this mode with a report subscription.
Shifts
Use the +/- buttons to add additional shifts. For each shift, enter a name and set the start and end
time for the shift.
To configure a shift that spans midnight, use two shifts with the same name. For example, to set
up a day shift and a night shift, add three shifts: Day from 8:00 AM to 8:00 PM, Night from 8:00
PM to 12:00 AM, and Night from 12:00 AM to 8:00 AM.
NOTE: To show all Power Quality events, the Show Event Details must be set to Yes.
Details include the calculated formulas and individual relationship between each driver and the
sub model data.
Show Errors
Click Yes to include error messages in the report, or No to exclude them.
Show Header
Click Yes to include the standard report header in the report. Click No to not include the standard
report header in the report.
The standard report header includes the logo and report title.
The standard report header includes the logo, report title, and report generation information.
Show Totals
Select to include or exclude totals columns or rows in the data tables.
Slideshows
This box shows all available slideshows in your system. Select the slideshows you want to include
in the report.
Sort By
Select the sort options of the tabular data from the dropdown list. The available options are
Source Name, Period, Maximum Value, Minimum Value, and Total. The selection applies to
the entire table. For example, if Maximum Value is selected, then all maximum values across all
measurements and Time of Use periods are considered.
Sort Order
Select Ascending or Descending to show the tabular data based on the Sort By selection.
Source Label
Select an option for the format of the label describing the source. The options are Source Name,
Source Description, and Combined Name/Description.
NOTE: The source description is the description that was entered in Management Console or
Device Manager for a source, when the source was added or edited.
Sources
Use this input to select the devices you want to include in the report.
Click Select Sources to open the Source Selector dialog. From the Grouping list, select the way
in which you want to display the sources (for example by device type, by group name, and so on).
Click + and - to expand and collapse items in the navigation tree. Click the check box beside a
device (or group of devices) to select it. Click Select All or Select None in the top-right corner to
select or clear all the check boxes.
Use the Devices option to select the devices you want to include in the report.
From the Grouping list, select the way in which you want to display the sources (for example by
device type or by group name). Click + and - to expand and collapse items in the navigation tree.
Click the check box beside a device (or group of devices) to select it. Click Select All or Select
None in the top-right corner to select or clear all the check boxes.
NOTE: The sources listed are dependent on the views you create in Hierarchy Manager and the
assigned user group. The hierarchy view is configured in the Hierarchy Manager component.
(See the Hierarchy Manager Help for further information about hierarchies, virtual meters, and
views.)
Click + and - to expand and collapse items in the tree. Click the check box beside any hierarchy
item in the tree to select it.
Click OK after making your selections.
Source Filter
Select either Sources with exceptions only or All sources.
• Sources with exceptions – Shows only the devices which has voltage sags and / or swells.
• All sources – Shows all selected devices. If the devices does not have voltage sags and / or
swells, the count is displayed as zero.
Select the standard deviation calculation 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.
Start Hour
Select the start hour to display when filtering the data by the time of day.
State Labels
Use state labels to add labels to equipment state codes. For example: value = 1, state =
maintenance.
NOTE: State labels are related to the state measurements in the Power Monitoring Expert
database.
2. In the State field, enter the value's corresponding state. For example, if the state with a
value of 3 = medium, enter 'medium'.
3. (Optional) Click + and then repeat steps 1 and 2 to add a state label for each state that you
want to include in the report.
NOTE: If you do not add state labels for every source state, and you set Include Data
Notification to Yes, the generated report will include error warnings indicating that equipment
states are unaccounted for in the State Label mapping.
State Measurement
Use state measurement to select a piece of equipment with state values.
Depending on how your state measurements are configured, the equipment state
measurement could be grouped under "Miscellaneous" or "Custom".
State Measurements
Use state measurement to select equipment with state values.
Depending on how your state measurements are configured, the equipment state
measurement could be grouped under "Miscellaneous" or "Custom".
Statistics Period
Use this input to select the interval for the data you want to view the statistics in the report.
Select the statistics period from the dropdown list. The available options are Entire Period, Day,
Week, Month and Year.
Stylesheet (optional)
Apply further transformation of the XML file by selecting a stylesheet file to create an HTML page
to display of the billing data with enhanced formatting.
Target Line
Enter a value for the target line in relation to the measurement you selected. The default value is
not to include a target line.
Technician Name
Type a name for the technician in the text box.
Tenant
Click Select Source to open the Source Selector dialog. Select a view name or Virtual Meter in
the View dropdown list. Select a tenant name, a device under a tenant name, or a virtual meter.
Click OK to add your selection to the report.
Selecting by view allows you to choose a source associated with a hierarchy configuration, such
as a floor in a physical layout or a circuit in an electrical view. Virtual meters available for selection
are defined separately in Hierarchy Manager. For additional information regarding hierarchies
and virtual meters, see Hierarchy Manager Help.
Selecting by view allows you to choose sources associated with hierarchy configurations, such as
a floor in a physical layout or a circuit in an electrical view. Virtual meters available for selection
are defined separately in Hierarchy Manager. For additional information regarding hierarchies
and virtual meters, see Hierarchy Manager Help.
Tenant Filter
Anything entered in the Tenant Filter parameter (comma separated) that matches any Billing
meta data line items (Tenant column) is included. An '*' can be entered to include everything.
To add additional groups of tenants that share other rates, click the "Plus" icon besides the source
selector.
To add rates for the groups of tenants, select a rate from the drop-down list for each tenant group.
Title
Type a title for the report in the text box.
Threshold
Enter the percentage for the maximum test run load capacity. This is the percentage of the
equipment electrical rating (in amps) entered in the Transfer Switches tab or the Equipment
tab.
Threshold Hours
Enter the maximum number of hours the generators should run in non-emergency use. Enter a
value that is in compliance with local authority requirements. For example, in the United States,
the Environmental Protection Agency (EPA) requires that generators can run no more than 100
hours in non-emergency use.
Timestamp Coincidence
Select either with Customer Peak or with Data Center Peak.
Trip Settings
Click Yes to include the Trip Settings section of the report. Click No to not include it. The default is
Yes.
UPS Group
Add the UPS groups that you want to include in the report.
1. Click Refresh Run History to populate the Runs list with the latest run records.
2. In the Runs list, select Most recent run or the specific run record. The date and reason
for the run appear below the dropdown list.
If you select Most recent run and define excluded sources, the exclusions are ignored
when you generate the report.
Voltage Threshold
Enter voltage threshold value. This input represents a nominal voltage that is used by the report to
display a voltage threshold area below the reference waveform voltage drop.
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.
NOTE: Custom Day settings are not applicable for Model reports.
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.
It is recommended that users have a basic understanding of energy modeling and understand
how to create an Energy Regression Analysis Report. This section discusses in detail the purpose
of each parameter in the report and how to read and interpret meaningful results of an Energy
Regression Analysis Report. After generating the report, conclusions can be drawn from the
generated tables and charts to monitor energy consumption and make cost saving decisions.
Energy Regression Analysis Report results provide a characterization of a building's
performance. You can perform different types of energy analysis with this information, including
the following:
• Energy Benchmarking
• Energy Budgeting
• Energy Savings
Glossary of terms
Term Definition
Cooling Degree Days Measurement designed to reflect the demand for energy needed
(CDD) to cool a building.
Comparing energy profiles against expected profiles and
Cost Savings Analysis
identifying outlying data that may signify areas of improvement.
One degree of departure, on a single day, of the daily mean
Degree Day
temperature from a given standard temperature.
Comparing the energy performance of similar buildings or
Energy Benchmarking
comparing the energy performance of a single building over time.
Determining future energy use and associated costs for different
Energy Budgeting
times of the year.
Computerized simulation of a building that focuses on energy
Energy Modeling consumption, utility bills and life cycle costs of various energy
related items such as air conditioning, lights, and hot water.
Measuring savings by comparing performance profiles before and
Energy Savings
after energy efficiency modifications.
Disaggregating building energy into different categories, such as
Energy Use Breakdowns weather-dependent energy use or weather-independent energy
use.
Term Definition
Heating Degree Days Measurement designed to reflect the demand for energy needed
(HDD) to heat a building.
Performance (Regression)
The statistical line of best fit.
Line
Statistical process for estimating the relationships among
variables. Includes many techniques for modeling and analyzing
Regression Analysis
several variables, when the focus is on the relationship between a
dependent variable and one or more independent variables.
The Report Parameters Summary table appears at the beginning of the report. Based on what
you select for the Show Report Parameters Summary option on the prerequisite page, you can
make this table appear or be hidden in the report.
This table provides important details, such as data sources, calculation methods, and other
parameters about how the report inputs are configured that can help the user understand report
results.
The Regression Analysis Chart shows the relationship between the driver and model data.
In this chart, the blue dots represent real data points. In this case, the data is aggregated weekly
over the course of one year, therefore, there are 52 data points with each data point representing
one week of the year. The yellow line is the regression line, or performance line, of the building.
The performance (regression) line is the best fit line--a line that indicates the expected energy
consumption. The slope of the performance line is a measure of how much extra fuel, energy, or
other resource is consumed for an increase in the independent variable (such as degree days,
production units, and so forth).
Deviations between building performance lines over time means that something has changed in
the way the facility consumes energy. This may be a result of energy efficiency modifications, or it
could indicate an issue with building systems, equipment, or processes. The performance line
provides a benchmark by which changes in energy consumption can be monitored, and
appropriate actions can be taken if variations are detected.
The point of intersection between the two performance lines is called the breakpoint. For energy
consumption analyzed with respect to average temperature, the breakpoint indicates the
temperature at which heating or cooling of a facility begins. Therefore, having a breakpoint further
to the right is better because this indicates that heating or cooling systems are running for less
time, which results in less energy usage.
The Regression Analysis Main Characteristics Table provides information about the Regression
Analysis Chart.
The Side column shows the left and right sides. The Slope column shows the slope values of the
two best-fitting lines intersect. This intersection point is called the breakpoint. The Y-Intercept
column shows a point where the graph of a function or relation intersects with the y-axis of the
coordinate system. Therefore, these points satisfy x = 0.
The R2 column shows a value that indicates how well the data fits the model. The RMSE column
shows the square root of the mean/average of the square of the error. The X Value and Y Value
columns show the coordinates of the Change point.
Monitoring the slopes and breakpoint values provides useful information about a facility’s energy
consumption. Flatter slope lines are better as they indicate a smaller increase in energy
consumption for every additional unit of the independent X-axis variable.
For more information on interpreting the report results, see Interpreting the report.
The Measured Values Against Expected Values Chart shows the relationship between the model
data and time.
In this chart, the blue line indicates the real energy usage over time and the performance line
indicates the expected energy usage over time based on the regression analysis.
The time axis, or X-axis, has different units depending on the selected aggregation period. For
weekly aggregation, the numbers on the X-axis represent the weeks of the year and for daily
aggregation, they represent the days of the year. The year or years contained within the reporting
period are displayed on the chart directly below the X-axis values.
Exceptions Table
The Exceptions Table below shows information for any data point that falls outside of the
exception range defined by the Deviation Type and Max Authorized Deviation parameters.
If there are no exception points, this table does not appear in the report.
Full Table
The Full Table below shows information for all data points.
This row stores information about the breakpoint from the Regression Analysis Chart.
This report generates with almost any set of data and regardless of other parameter selections.
However, the generated report is only of assistance in monitoring energy consumption if the
parameters are configured correctly and with specific intent.
The following section provides specific examples of how to use the Energy Modeling Report to
monitor certain aspects of a facility’s energy consumption.
Regression analysis of energy or resource consumption with respect to Degree Days can provide
valuable information about a facility’s energy efficiency with respect to outside changes in
temperature. Such information can be used to determine when energy efficiency upgrades are
necessary, and to monitor the effectiveness of such solutions after implementation.
For example, a facility manager could compare the Heating Degree Day energy profile of their
building to another facility in a similar climate. If the other building proves to be much more energy
efficient, an analysis could be performed on the differences in building design that could cause
these results. Perhaps the only significant difference is that the more efficient building recently
upgraded their insulation. The less efficient building could then use this information, along with the
Regression Analysis charts to pitch the case that an insulation upgrade should take place to
reduce natural gas usage at the facility.
If the upgrade is successful, a change appears in the Regression Analysis chart the following
year. The chart above shows a possible Regression analysis for the year before the energy
efficiency modifications. The red line in the chart shows how the performance lines and
breakpoint could change when the upgrades are successful. The slopes of the lines in the second
figure are flatter, indicating less energy usage for every additional degree day. The breakpoint
also occurs later, indicating that heating does not have to begin at as low of a temperature as
before, thereby saving additional resources.
Regression analysis can also be used to detect equipment deterioration or failure. Below are two
Regression Analysis charts showing natural gas consumption with respect to production units.
The red line in the chart has a steeper slope and an earlier X-axis intersection point. This indicates
that more natural gas is being used for every unit of production. If data for these charts is collected
over different periods of time, but with no changes to manufacturing processes or equipment, the
steeper regression line in the second chart could indicate deterioration of equipment.
Plotting energy consumption data against any independent variable, not just time, allows you to
analyze in greater detail the energy efficiency of your buildings or facilities, and to make
necessary upgrades or cost analysis decisions.
Conclusion
Energy modeling is a relatively new practice for monitoring and analyzing energy consumption in
buildings and facilities. It involves using computerized simulations to analyze energy
consumption, and it allows customers to understand their expected energy consumption and use
this information to make system design decisions and perform cost benefit analysis.
The Energy Modeling Report, or XY Regression Report, allows users to create energy profiles for
their buildings or facilities. These benchmark energy models provide valuable information about
energy and resource consumption that can help Facility Managers save resources by identifying
and addressing consumption issues.
Recommendations
Many of the report parameters on the prerequisite page are interdependent and configuring this
page requires close attention. It is recommended to rely on documentation to correctly configure
the report. Note that there is no filtering of parameters on the prerequisite page.
Reports UI
Report Library
The Report Library contains all the Reports that are configured in the system. Reports can
be listed individually, or they can be organized within folders.
1
TIP: To hide the library, click the Hide Library icon ( or ) in the top right corner of the
library. To show the library, click the Show Library icon ( or ) at the top of the library
ribbon, or click anywhere in the minimized library ribbon.
Reports Icons
Reports uses different icons to differentiate between reports and report templates in the Report
Library. The following is a list of icons used.
Reports Terminology
The following is a list of commonly used terms related to Reports in PME.
Report
A report is a report template that has been saved with some or all of its input parameters set.
Every time you run a report, it queries the database to retrieve the required data. A report does not
store the output data after it was generated. To save a permanent copy of the output, download
the report in one of the supported formats and save it externally.
Report Template
A report template defines the output layout, the types of inputs and the information in the
database that is accessed for that report. The difference between a report and a report template is
that a report has one or more of its input parameters saved and a template does not.
Downloaded Report
A downloaded report is a copy of the output of a report. You can download a report in different
formats. Download a report to permanently save a copy of its output.
Trends references
This section contains reference information related to using Trends.
Use the links below to find the content you are looking for:
If you log out of the application, your selections are retained and are loaded in the Trends display
pane the next time you log in.
Trend Library
The Trend Library contains all the trends that are configured in the system. Trends can be listed
individually, or they can be organized within folders. You use the Trend Library to select the trends
you want to view.
TIP: To hide the library, click the Hide Library icon ( or ) in the top right corner of the library.
To show the library, click the Show Library icon ( or ) at the top of the library ribbon, or
click anywhere in the minimized library ribbon.
Trend options
The following options are available in the upper right area of the trend in the display pane.
Trend legend
The legend opens on the right of the trend by default. You can select Left or Off on the Chart tab
in the Add Trend or Trend Setup dialogs to change the location of the legend or to remove it from
the trend display.
• If you have enabled multiple axes in your trend, when you place your mouse pointer over a
measurement series in the legend, it indicates which axis the series is drawn on.
• You can temporarily disable a measurement series by selecting the color swatch for the
series.
• The background color of a measurement series entry changes to match the threshold colors
when the series passes into the upper or lower threshold. You set the threshold colors on the
Axes tab of the Add Trend or the Trend Setup dialog.
Inspection mode
The following icons appear when you enable the inspection mode and you place your pointer on
the trend.
When the trend is in inspection mode, the trend remains static until you toggle inspection mode off
to return the trend to its update mode. Note that the data in the legend continues to update in real
time with the latest values even though the trend remains static for analysis purposes. When you
toggle inspection mode off, the trend refreshes and includes all of the data that was captured
while you were in inspection mode.
You can drag the slider below the X-axis to the right to decrease the time range for the trend. For
example, if the time range is set to 15 minutes and you drag the slider to the right, the range
values decrease, and if you continue to drag the slider to the right, the values decrease further to
show minutes and seconds on the scale.
Decommissioning Reference
This section contains detailed instructions for decommissioning your system. For an overview,
see Decommission.
NOTICE
UNINTENDED DATA LOSS OR LOSS OF SOFTWARE FUNCTION
• Only decommission PME systems that are no longer needed.
• Archive important PME data and files before decommissioning. You cannot recover,
reinstall, or otherwise retrieve any part of PME after decommissioning.
Failure to follow these instructions can result in irreversible damage to software and
databases.
You must decommission PME on all PME Servers, Database Servers, and PME Clients.
Decommissioning does not completely restore your computers to the state they were in before
PME was installed. Decommissioning does not remove third-party software used by PME (for
instance, the .NET framework), even if this software was installed using the PME installer.
NOTE: Decommissioning will not remove PME data that has been exported from PME or PME
information in third-party software. This includes, but is not limited to:
• Data exported to other systems using EcoStruxure Web Services (EWS), OPC DA server,
ETL, ODBC, PQDIF or VIP.
• Registration information shared with Schneider Electric.
• Files or data copied, backed-up, exported, or otherwise saved to a file location other than
the PME folder.
Destroy
WARNING
HAZARD OF PHYSICAL INJURY
• Do not destroy hard drives without the proper safety training.
• Never burn a hard drive, put a hard drive in a microwave, or pour acid on a hard drive.
Failure to follow these instructions can result in death or serious injury.
NOTE: If you do not have the proper safety training, consult your IT department to select an
asset disposal company.
1. Identify all computers where PME is installed. In a Distributed Database architecture, this
includes all PME Servers, Database Servers, and PME Clients.
2. Remove all hard drives from the computers identified in the previous step.
Overwrite
NOTICE
UNINTENDED DATA LOSS OR LOSS OF SOFTWARE FUNCTION
• Only overwrite files and folders from PME.
• Back up important files from other software before overwriting PME.
Failure to follow these instructions can result in irreversible damage to software and
databases.
To overwrite PME:
1. Open the Windows Control Panel and select Programs and Features.
2. Uninstall PME.
3. Select and install a data destruction tool. There are many commercial and open-source data
destruction tools available. Consult your IT department if you are unsure about which tool to
choose.
b. In the Object Explorer pane on the left, expand Databases, right-select the database
archive you want to detach and select Tasks > Detach… to open the Detach Database
dialog.
5. Locate your PME folder under Program Files. The PME folder contains the following
subfolders:
\Applications
\config
\Database
\diagnostic
\Diagnostics Tool
\Licenses
\Setup
\SetupLogs
\system
\Uninst_PowerMonitoringExpert
\web
6. Follow instructions provided with your data destruction tool to overwrite the entire PME
folder located in the previous step.
7. Locate any custom PME files in folders outside of the PME folder. This may include, but is
not limited to, following file types:
Vista and Designer files: .cfg, .dgm, .wsn, .wsg
8. Follow instructions provided with your data destruction tool to overwrite the files located in
the previous step.
9. Repeat the steps above on all PME Servers, Database Servers, and PME Clients.
Applications References
This section contains reference information related to the content in the Applications chapter of
this guide.
Use the following links to find the content you are looking for:
NOTE: Use sensor names that are unique in the PME system. This applies to both, variable
names and fixed names. For variable names, they must be unique after the variable has been
replaced with the Access Point name by the device driver.
NOTE: Diagrams does not recognize the variable and does not replace it with the Access Point
device name. Diagrams displays the !!DeviceName!! string as part of the sensor name.
Example:
Example:
Glossary
Process Impact Alarm
Process impact alarms are used by the Power Quality Performance module. These alarms
indicate that a monitored process has been disrupted. If the disruption coincides with a power
quality event, then the Power Quality Performance module assumes that it was caused by the
event. The module then applies a flat-rate cost estimate to the duration of the process impact
alarm to calculate an impact cost.
An OPC tag served up by an OPC server and read by the software through it's OPC client
capabilities.
Software Features
A feature is a system functions that can be used without requiring custom engineering. Most
features require some configuration, such as selecting the input parameters for a report, or the
specification of sources, measurements and time ranges for dashboard gadgets. Examples of
features include the Dashboards, Diagrams, Trends, Alarms, and Reports applications.
Software Modules
Software modules combine different software features and capabilities to create a specific set of
deliverables. Software modules are designed around a particular application. Examples of
software modules include the Power Quality Performance Module, the Energy Analysis Reports
Module, and the Breaker Performance Module.
System databases
Power Monitoring Expert uses four databases to store device communication parameters, system
configuration settings, and logged historical data:
Database Description
Contains all of the configuration data for the Web Applications
ApplicationModules
component.
Contains the logged historical data, events, and waveforms from
ION_Data
devices.
ION_Network Contains device communication information and general settings.
Contains system events that occur during the operation of the
ION_SystemLog
software.
System migration
A system migration is when you move a Power Monitoring Expert system from one computer to
another, or uninstall and re-install it on the same computer.
Alarm
A condition that is being monitored for a particular source in the system. Example: Monitoring for
an over voltage on feeder X.
Occurrence
The alarm condition for the monitored source is met and the alarm goes active. Example: The
voltage on feeder X exceeds the threshold
Alarm Instance
The time period during which an alarm is active, starting when it goes active, ending when it goes
inactive.
Alarm Status
The state the alarm is in. Alarm Status is either active or inactive.
+33 (0) 1 41 29 70 00
www.se.com
7EN02-0500-00 10/2024