PME 2023 Web Applications Guide
PME 2023 Web Applications Guide
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 Web Applications Guide
Contents
Safety Information 3
Safety Precautions 13
Overview 14
About this document 14
Document updates 14
Resources 14
Web Applications 15
Overview 15
Specifying Which Application to Open First 15
Opening Web Applications Without Banner 16
Web Applications User Interface 16
Alarm Annunciator 16
Library Pane 16
Display Pane 17
Time Display in Web Applications 17
Alarms 19
Overview 19
View types 19
Status views 19
History views 20
Incidents, Alarms, and Events 21
Incidents 21
Alarms 21
Events 21
Alarm Acknowledgment 21
Analysis tools 22
Time display 22
Terminology 22
Viewing incidents 23
Viewing alarms 25
Viewing events 27
Viewing Disturbance Direction 29
Viewing Load Impact 31
Viewing a timeline analysis 33
Viewing Voltage Tolerance 35
Viewing waveforms 37
Acknowledging alarms 39
Acknowledging through an alarm status view 39
Acknowledging through an alarm history view 40
Acknowledging through an incident history view 41
Incidents 43
Alarms 45
Events 49
Disturbance Direction 51
Prerequisites 51
Load Impact 53
Prerequisites 53
Timeline analysis 55
Prerequisites 55
Voltage Tolerance 57
Analysis tool 57
Prerequisites 57
Waveforms 60
Prerequisites 60
Waveform analytics 62
Alarms configuration 66
Adding a new Alarms view 68
Copying an Alarms view 70
Editing an Alarms view 71
Sharing an Alarms view 72
Moving an Alarms view 73
Deleting an Alarms view 74
Setting a default Alarms view 75
Deactivating alarms 76
Alarms references 78
Alarms UI 79
Waveforms UI 91
Timeline analysis UI 98
Alarm to incident mapping 102
Load Impact calculations 104
Alarms terminology 105
Dashboards 108
Time display 108
Viewing Dashboards 109
Dashboard Slideshows 110
Playing a Slideshow 111
Gadgets 112
Bar Chart gadget 113
Energy Equivalency gadget 114
Table gadget 115
Period Over Period gadget 116
Pie Chart gadget 117
Trend Chart gadget 118
Web Viewer gadget 119
Power Quality gadgets 120
Nodes 667
Node properties 668
Common elements of hierarchy templates 669
Creating a hierarchy 671
Open Hierarchy Manager 671
Add a building to the hierarchy 672
Associate areas and devices to Building Three 673
View the hierarchy in a tree configuration 674
Adding and removing devices 675
Creating an apportioned meter 677
Creating a virtual meter 678
Adding a virtual meter to a hierarchy node 678
Dynamic hierarchy 679
Meter apportionment 680
Virtual meter 681
Data aggregation in Hierarchies 681
Using hierarchies in other applications 683
Log Viewer 684
Log Viewer User Interface 684
Event Notification Module 687
Event Notification Module configuration 688
Editing notification settings 689
Adding a notification rule 692
Enabling or disabling a notification rule 694
Editing a notification rule 696
Deleting a notification rule 698
Adding a recipient 700
Editing a recipient 702
Deleting a recipient 704
Adding a template 706
Editing a template 708
Deleting a template 710
Adding a Schedule 712
Editing a schedule 714
Deleting a schedule 716
Event Notification configuration references 718
Notification Manager user interface 719
Add Rule UI 722
Add Recipient UI 726
Add Template UI 727
Notification delay example 728
Rate Editor 729
Rate Editor User Interface 729
Software Alarms configuration 730
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 as a reference for users and administrators of the EcoStruxure™ Power
Monitoring Expert (PME) Web Applications.
This document is not a tutorial, it was written with the assumption that you have been trained in
the use and administration of PME.
This document does NOT discuss:
• The non-Web Applications functionality of PME.
• The planning, design, installation, upgrade, integration, or administration of the PME system.
• 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.
Resources
Documentation
The following EcoStruxure™Power Monitoring Expert 2023 documents are available on the
Schneider Electric Download Center:
• System Guide (English) – Document number 7EN02-0485
Support
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 click 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. Click 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, click 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.
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.
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 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, warnings 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
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
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
Click 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: Click Details for an alarm definition or double-click 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
Click Acknowledge to open the Acknowledge Alarms window.
3
Click Open Device Diagram to open the device diagram for the source this alarm is
associated with.
4 Alarm history UI
TIP: Click Details for an alarm instance or double-click 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
Click Timeline Analysis to open the Timeline window.
Click Acknowledge to open the Acknowledge Alarms window.
Click Open Representative Waveform to see the waveform of the worst disturbance that is
associated with this alarm instance.
3
Click Open Incident to see information on the incident that is associated with this alarm
instance.
Click Open Alarm Definition to see information on the alarm definition for this alarm.
Click Open Device Diagram to see the device diagram for the source that is associated with
this alarm.
5 Incident history UI
Click 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 Click Details to see more information related to the incident. (See below for more
information.)
TIP: Click Details for an incident or double-click 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
Click Timeline Analysis to see the timeline analysis of the incident.
3 Click Acknowledge to open the acknowledge alarms window.
Click Open Representative Waveform to see the waveform of the worst disturbance that is
associated with this incident.
6 Event history UI
TIP: Double-click 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
Click 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. Click 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 click
7 and drag the pointer on the plot to zoom. To pan while zoomed in, click and drag the area
between the sliders. Click (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 diagram
9
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 click
6 and drag the pointer on the plot to zoom. To pan while zoomed in, click and drag the area
between the sliders. Click (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: Click 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. Click 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 Click this option to extend the time window of the view and adds all devices, and all
categories.
Priority filter
4 Click 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
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:
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.
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:
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:
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:
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:
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:
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
Dashboards references
This section contains reference information related to Dashboards.
Use the links below 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 click the arrows beside the dates to display a pop-up calendar
2
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 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
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 clicking Upload Image... to open
the Upload New Files dialog. Then either drag an image file to the area indicated in the
dialog or click Choose Files... and navigate to an image on your system. Click Finish to
add the image to the Image Library and then click OK after you select the image for the
background.
c. Choose how you want the image to fit from the drop-down list.
b. Click the down arrow to open the palette and select a predefined color or click 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
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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.
Zoom in to selection area - zooms in when you drag the mouse over
C an area of the chart. The zoom action occurs when you release the
left mouse button.
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
Complete the option on this page as follows:
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
Complete the options on this page as follows:
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. Click Preview to view how the image will appear in the gadget.
Data Series
Complete the options on this page as follows:
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 click 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
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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 clicking Upload Image to open the
Upload New Files dialog. Then either drag an image file to the area indicated in the dialog or
click Choose Files and navigate to an image on your system. Click Finish to add the image
to the Image Library and then select it.
KPI Formula
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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) Click Show Advanced to filter the measurements list by Type or popularity
(Show).
1. Click 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 click 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
Complete the options on this page as follows:
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, click Show Advanced to filter
the source list by Type, or click Add All to select all sources.
(Optional) Click 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 click Add All to select all
sources.
(Optional) Click Remove All to remove all sources from the Selected Sources area.
Target Lines
Complete the options on this page as follows:
1. Click Add Target Line to add target line input fields to the page.
Add additional target line input fields by clicking 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
Complete the options on this page as follows:
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
Complete the options on this page as follows:
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 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 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.
Disturbances
Power Quality (PQ) disturbances are long-term 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)
Malfunction
Voltage Waveform 0 to 20% Nonlinear
Steady state and
Harmonics distortion (typical) loads
overheating
PQ
Summary Magnitude Source Duration Consequence
Disturbances
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
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 help 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 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.
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.
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.
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 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
The following figure shows the event log table:
• 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 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.
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.
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.
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.
• 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.
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
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 help for information on control object configuration.
NOTE: Control in Diagrams is only available when a HTTPS connection is used between the
PME server and the Web Applications client.
1. Open the Settings page from the SETTINGS link in the Web Applications banner.
NOTE: Only supervisor-level users can access the Diagrams Control Options settings.
4. Click Save.
NOTE: Control in Diagrams must be enabled for the confirmation method settings to be
displayed.
1. Open the Settings page from the SETTINGS link in the Web Applications banner.
NOTE: Only supervisor-level users can access the Diagrams Control Options settings.
3. In Diagrams Control Options, select the confirmation method - Dialog Box without
Password or Dialog Box with Password.
NOTE: Control objects in diagrams can be configured, at design time, to always require
password confirmation. This configuration has priority over the confirmation method
settings above. See Controlling system functions in Vista help for information on control
object configuration.
4. Click Save.
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
• 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.
Reports
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software or the devices.
• Do not base your maintenance or service actions solely on messages and information
displayed by the software.
• Do not rely solely on software messages and reports to determine if the system is
functioning correctly or meeting all applicable standards and requirements.
• Consider the implications of unanticipated transmission delays or failures of
communications links.
Failure to follow these instructions can result in death, serious injury, equipment
damage, or permanent loss of data.
WARNING
UNINTENDED EQUIPMENT OPERATION
• Do not use the software to control time-critical functions.
• Do not use the software to control remote equipment without proper access control and
status feedback.
Failure to follow these instructions can result in death, serious injury, or equipment
damage.
Use the Reports application to generate historical data reports. You can view the reports in PME
or download them in different formats for sharing or storing externally. To generate a report, you
can either run it manually, setup an automatic schedule, or define trigger events such as a system
disturbance.
Reports are based on historical data that is stored in the PME database. A report can simply
display the historical data, or it can process data to show patterns and relationships. The Tabular
Report is an example of a simple report that shows data in a table. The Energy Modeling report is
an example of a report that processes different types of input data to produce predictions and
comparisons displayed in chart and diagram formats.
Reports are generated based on report templates. PME provides a wide range of default
templates. You can change the colors and logo used for these templates. To customize the types
of inputs or outputs of the default templates you need to create custom templates. Creating
custom templates requires engineering work outside of PME.
The Reports user interface (UI) has two main areas: Report Library and Reports Display. To see a
report in the Reports Display, you select the report in the Report Library.
TIP: You can open Reports from the REPORTS link in the Web Applications banner.
• Generating a report
• Downloading a report
Report templates
The default PME report templates cover a wide range of applications. The templates are grouped
into categories based on application. Choose the templates that best meet your reporting needs.
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
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
The Generator Activity Report shows:
• The number of non-emergency running hours as an annual total.
• 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 Backup Power Module must be configured.
• 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 Backup Power Module must be configured.
• 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 Backup Power Module must be configured.
• 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 Backup Power Module must be configured.
• 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
• Events Summary
• Generator 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 Backup Power Module must be configured.
• 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 Backup Power Module must be configured.
• 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 Backup Power Module must be configured.
• 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 Energy Billing Module must be configured.
• 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 Energy Billing Module must be configured.
• 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 Energy Billing Module must be configured.
• 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:
Comparison summary page
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 Energy Billing Module must be configured.
• 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 Energy Billing Module must be configured.
• 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.
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 Breaker Performance Module must be configured.
• 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 Breaker Performance Module must be configured.
• 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.
• 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:
See Model creation example
To calculate the models, PME uses the Accord Framework Library which can be found at:
http://accord-framework.net/index.html.
NOTE: This report is part of the Energy Analysis Reports Module. This module requires a
separate license.
Summary
The 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 Energy Analysis Reports Module must be configured.
• 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 Energy Analysis Reports Module must be configured.
• 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 Energy Analysis Reports Module must be configured.
• 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 Energy Analysis Reports Module must be configured.
• 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 Energy Analysis Reports Module must be configured.
• 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 Energy Analysis Reports Module must be configured.
• The measurement data must be available as historical data logs in the database.
• 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 Energy Analysis Reports Module must be configured.
• The measurement data must be available as historical data logs in the database.
• 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 Energy Analysis Reports Module must be configured.
• 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 Energy Analysis Reports Module must be configured.
• The measurement data must be available as historical data logs in the database.
• 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.
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.
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.
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.
Prerequisites
• The device must be configured in the Device Replacement Manager.
Report inputs
• Title
Example:
NOTE: This example only shows selected content from the report, it does not show the entire
report.
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.
Details
With an Energy Cost Report, you can:
• Use a time of use (TOU) schedule that you define using the Time of Use Editor (see the "Time
of Use Editor" topic in the Management Console Tools section of the online Power Monitoring
Expert Help).
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.
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.
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.
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
• The measurement data must be available as historical data logs in the
database.
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.
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.
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.
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.
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.
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.
Prerequisites
The thermal monitoring system must be connected to PME.
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
• A Dashboard slideshow must be configured.
Report inputs
• Title
• Page Size
• Slideshows
• Custom URL
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
• A Dashboard slideshow must be configured.
Report inputs
• Title
• Page Size
• Slideshows
• Custom URL
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.
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.
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.
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.
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
The report includes:
• A Total Hazard Current graph, showing measured currents against the Total Hazard Current
limits.
• An events table, showing information for each event that occurred in the reporting range.
• A data log table, showing Total Hazard Current measurements and other meter data.
Prerequisites
• The Insulation Monitoring Module must be configured.
• 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
The report includes:
• An impedance graph, showing a comparison of impedance measurements to the impedance
threshold.
• A transformer load graph, showing a comparison of transformer load measurements to the
load threshold.
• An events table, showing information for each event that occurred in the reporting range.
• A data log table, showing measurements for impedance, load, and temperature.
Prerequisites
• The Insulation Monitoring Module must be configured.
• 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 Energy Billing Module must be configured.
• 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.
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 Capacity Management Module must be configured.
• 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 Capacity Management Module must be configured.
• 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
The report shows:
• Power consumption grouped by load type (Equipment, Life Safety, Critical)
Prerequisites
• The Capacity Management Module must be configured.
• 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 Capacity Management Module must be configured.
• 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 Capacity Management Module must be configured.
• 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 Capacity Management Module must be configured.
• 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.
• 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.
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.
Prerequisites
The following firmware versions are required:
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.
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.
Prerequisites
The following firmware versions are required:
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.
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.
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
The IEC61000-2-4 report shows an analysis of compatibility levels of low-frequency conducted
disturbances that were taken in compliance with the IEC61000-2-4 standard. Use this report for a
power quality analysis of your facility based on the IEC61000-2-4 measurement standard.
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 the Pasting a node's
entire configuration into another node topic in system guide.
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.
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
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.
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 Power Quality Performance Module must be configured.
• The measurement data must be available as historical data logs in the database.
Related
• Power Quality Impact Report – provides an estimated impact of production downtime.
• 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 Power Quality Performance Module must be configured.
• 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.
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.
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.
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.
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.
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 in Management Console Help 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
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 .
Reports references
This section contains reference information related to 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
clicking 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, click hide inputs. If you change any of the
input parameters, click 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
Status results. The Test Status 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.
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 to include both the pass/fail grade and the test 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 test method from the report.
4. Select the Electric Data 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 Avg., Min, Max 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 Details: 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.
5. Select the Engine Temperature Data 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 Avg, Min, Max 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 Details: 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.
6. Select the Exhaust Gas Temperature Data 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 Avg, Min, Max 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 Details: 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.
7. Under Engine Data, click Include Details 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 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.
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.
Click OK after making your selections.
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 Warnings
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.
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.
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 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.
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.
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.
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.
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.
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.
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
Trends references
This section contains reference information related to 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.
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, click Add under Data Series. This opens the Add Data Series
dialog.
3. To edit an existing series, select it, and then click Edit. This opens the Edit Data Series
dialog.
4. In Add (or Edit) Data Series, click 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) Click 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 click 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) Click 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. Click OK to save your changes and close the Add (or Edit) Data Series dialog and to return
to the Trend Setup dialog.
10. Click 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 dropdown 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).
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 clicking 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.
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
Security Login Options
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
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.
To change the Reports colors:
1. Under Report Colors, select Use Theme Colors or Override Theme Colors.
TIP: The system theme colors are defined by the System Theme settings for the Web
Applications. See System Theme for more information.
2. If you choose Override Theme Colors, then set the colors for the Report Title, Section
Header, Table Header, Summary, Row Shading, and Section Title, using the drop-down
selectors.
2. Under Report Logo, click Select to open the Select Report Logo Image dialog.
NOTE: You can use GIF, JPG, JPEG, or PNG image formats. The recommended file size is 250
x 100 pixels. Images are automatically re-sized to fit the logo area in Reports.
System Language
Use these system localization settings to select the language, region, and currency symbol. The
setting for Region determines date, time, number, and currency formats.
NOTE: Your personal localization settings overrule the system localization settings for your user
account. By default, your personal localization settings are the same as the system localization
settings. See System and personal localization settings for details on the behavior of these
settings.
NOTE: The system localization settings also apply to the diagrams displayed in the Vista
application.
System Theme
Use the system theme settings to:
• 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.
• City or region
• Screen DPI
1. Open Web Applications and click Settings > Registration & Analytics > Diagnostics and
Services.
2. Select Disable in the dropdown list and click Save to apply the change.
Registration
Connected Services
Connected Services lets you share the operational data that is collected by Power Monitoring
Expert with Schneider Electric. The collected energy and power data can then be used by
connected services – such as EcoStruxure™ Power Advisor and EcoStruxure™ Asset Advisor –
to help identify gaps or issues in your power management system. It can also help identify power
quality issues within your electrical distribution system.
The collected data depends on the specific services that the customer receives from Schneider
Electric. For more information on Connected Services, see the Power Advisor User Guide.
To disable the collecting of operational data, select Disable in the drop-down list and click Save to
apply the change.
Software registration
Registration information is used by Schneider Electric to help provide support and to enhance the
service we provide to you. Schneider Electric will never sell or share this information.
By registering you acknowledge that your registration information will be shared with Schneider
Electric and you consent to receiving occasional communications about your product. Product
communication includes new features, service pack releases, and recommended cybersecurity
updates.
You can edit the registration information at any time through the web application settings.
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.
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-Click Login Only
Windows users can log into the system by clicking a hyperlink on the login page.
• Manual Login and One-Click Login
Windows users can log into the system by manually entering credentials, or by clicking a
hyperlink on the login page.
NOTE: Standard users, if allowed to log in, always have to enter their credentials manually.
If the Login dialog box appears very small or if the Password text box is not visible, follow one of
the below options:
Option 1:
2. Set the slider for Change the size of text, apps and other items to 100%.
3. Click Apply.
Option 2:
1. In Windows Explorer, navigate to the appropriate EXE files (Designer, Vista...) in the
installation directory: ..\Power Monitoring Expert\system\bin.
2. Right-click 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.
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
By default, the localization settings in Personal Preferences are the same as the ones in System
Language. Changes to the settings in System Language are automatically copied to the Personal
Preferences settings as long as the Personal Preferences settings have never been customized.
After you customized the Personal Preferences localization settings once, they will no longer
change when the System Language settings are changed.
NOTE: Your personal localization settings overrule the system localization settings for your user
account.
Example 1: Language settings in Personal Preferences follow System Language if they have
never been customized.
Example 2: Personal Preferences remain at customized setting after having been customized at
some point.
Default links:
NOTICE
INOPERABLE DATABASE
Back up the database before executing SQL scripts.
Failure to follow these instructions can result in an inoperable database and loss of
data.
NOTE: You can also copy and paste the example script below into SSMS.
4. Update the script settings, in the marked areas in the script, to meet your needs.
NOTE: The order value determines the order in which the links are arranged in the web
page banner. The order numbers increase from left to right. The numbers for the default
links are: Dashboards (10), Diagrams (20), Trends (30), Alarms (40), Reports (50). The
location of the SETTINGS link is not controlled by the order value. It is always in the right
most position.
TIP: You can execute this query repeatedly to change any of the settings for the custom
link.
6. Close SSMS.
Example script to create a MY CUSTOM LINK link between the REPORTS and SETTINGS links
in the Web Applications banner that opens a custom web page:
USE ApplicationModules
DECLARE @id NVARCHAR(255)
DECLARE @name NVARCHAR(255)
DECLARE @displayName NVARCHAR(255)
DECLARE @description NVARCHAR(255)
DECLARE @order NVARCHAR(100)
DECLARE @target NVARCHAR(400)
----------------------------------------------------------------------
-- Edit the following values to define your custom settings
----------------------------------------------------------------------
-- Custom application link (internal) name.
SET @id = 'MyCustomLink'
-- Custom application link description
SET @description = 'My custom link shows my custom content'
-- Display Name
set @displayName = 'My Custom Link'
-- Custom application link order. Less than 10 will bring new link to
-- first left position.
SET @order = 60
-- Target URL can be provided in single quote here,
-- e.g. 'https://www.mypage.com'
-- If on the same machine, should be the relative path.
-- e.g., '/myApp/index.html'
SET @target = 'https://www.mypage.com'
----------------------------------------------------------------------
-- DO NOT MODIFY CONTENT BELOW
----------------------------------------------------------------------
DECLARE @configurationValue NVARCHAR(MAX)
SET @configurationValue =
'<FrameworkApplication id="' + @id + '"'
+ ' displayName="' + @displayName + '"'
+ ' description="' + @description + '"'
+ ' resourceSet="ApplicationFrameworkResources"'
+ ' target="' + @target + '"'
+ ' privilege=""'
+ ' order="' + @order + '"'
+ ' enabled="true"'
+ ' xmlns="uri:application-modules/power/framework/application#" />'
EXECUTE [ApplicationModules].[Configuration].[WriteConfigurationValue]
'ApplicationFramework'
,'Applications'
,@id
,@description
,@configurationValue
,NULL
,0
3. Execute the query on the ApplicationModules database. This returns the settings for the
Web Applications links.
4. Copy the content of the Value column for the link you want to hide or unhide, into a text
editing tool such as Notepad. For example:
<FrameworkApplication id="MyCustomLink" displayName="My Custom
Link" description="My custom link shows my custom content"
resourceSet="ApplicationFrameworkResources"
target="https://www.mypage.com" privilege="" order="60"
enabled="true" xmlns="uri:application-
modules/power/framework/application#" />
5. Change the enabled property value to "false" in the text editor to hide a link, or to "true" if to
unhide a link
To re-order links:
3. Execute the query on the ApplicationModules database. This returns the settings for the
Web Applications links.
4. Copy the content of the Value column for the link you want to reorder, into a text editing tool
such as Notepad. For example:
<FrameworkApplication id="MyCustomLink" displayName="My Custom
Link" description="My custom link shows my custom content"
resourceSet="ApplicationFrameworkResources"
target="https://www.mypage.com" privilege="" order="60"
enabled="true" xmlns="uri:application-
modules/power/framework/application#" />
5. Change the order property value to a new value in the text editor.
NOTE: The order value determines the order in which the links are arranged in the web
page banner. The order numbers increase from left to right. The numbers for the default
links are: Dashboards (10), Diagrams (20), Trends (30), Alarms (40), Reports (50). The
location of the SETTINGS link is not controlled by the order value. It is always in the right
most position.
To delete a link:
4. Execute the query on the ApplicationModules database. This deletes the Web Applications
link.
6. Close SSMS.
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 help.
Definitions
Sites
A site is a group of devices in the system that share a common communications link. A site can be
a direct site, a modem site, an Ethernet gateway site, or an OPC site.
Devices
A device is a meter or other component that communicates and gathers data and is installed on a
network.
• 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
Use the links below to find the content you are looking for:
Main UI
Selection tabs
1
Select a tab to see information related to Devices or Sites.
Help
2
Click Help to open the Device Manager online help.
Number of displayed items
10
Shows the number of items visible on this page, and the total number in the system.
Page selector
11 Use the page selector to navigate between pages of information. Set the number of items
that are displayed on a page.
Devices tab
NOTE: To add serial devices that are directly connected to the system, for example
through a RS485 converter, or to add Logical Devices, use Management Console.
Import
Use the import wizard to import device or site configuration into the system. You can import
4 configuration from a different system, from configuration tools, or edited configuration from
the same system. See Importing network configuration from a different system and Editing
a device, Editing a site for more details.
Devices filter
5 Use the devices filter to customize which devices are displayed in the devices table. You
can filter by Communication Status, Type, and Enabled State.
Options menu
The Options menu contains the following options:
- Show/Hide Columns
- Clear Filter
8
- View Device Licenses
- Export Devices Configuration for Editing
- Export Network Configuration for Use in a Different System
- Refresh
Devices table
9 The devices table shows devices that are configured in the system. Which devices are
displayed in the table is controlled by the devices filter, see 5 above.
Sites tab
Refresh
Click Refresh to update the table content and show changes to the site configuration that
might have been done through Management Console.
5
NOTE: The Communication Status indicator in the table is updated automatically every 10
seconds. To update the configuration information use Refresh.
Options menu
The Options menu contains the following options:
- Show/Hide Columns
6 - Clear Filter
- Export Sites Configuration for Editing
- Export Network Configuration for Use in a Different System
- Refresh
Sites table
7 The sites table shows sites that are configured in the system. Which sites are displayed in
the table is controlled by the sites filter, see 3 above.
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.
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
Use the links below to find the content you are looking for:
Main UI
Help
1
Click 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.
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 measurement name
is automatically mapped to PME measurement name based on the following scenarios: for
more details on automated measurement mapping. See It is possible to customize the
mapping of measurement name with PME measurement name using the definition file.
The definition file is stored under :...\config\WebServices. 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
• It is possible to customize the mapping of measurement name with PME measurement name
using the definition file. The definition file is stored under :...\config\WebServices.
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
Use the links below to find the content you are looking for:
Main UI
Help
1
Click 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 Click 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.
measurement name is automatically mapped to PME measurement name based on the following
scenarios:
• Full Name Match: The complete measurement name matches 100% with the
PME measurement name.
For example: If measurement name is "Active Power", this name is 100% match with the
PME name "Active Power", then this measurement is automatically mapped to "Active
Power" of PME measurement.
• No Name Match: No part of the measurement name 100% matches with the
PME measurement name.
For example: If 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
measurement is not automatically mapped. This measurement should be manually mapped.
It is possible to customize the mapping of measurement name with PME measurement name
using the definition file. The definition file is stored under :...\config\WebServices.
<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.
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.
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.
From Management Console Tools > Web Tools > Hierarchy Manager.
2. Type a user name and password in the Log In dialog, if required, and click OK to open
Hierarchy Manager.
NOTE: In the following steps, devices have already been added to the system, and the
hierarchy has been populated with site, building, and area information.
The Buildings grid includes Building One and Two, the site they are associated with, and
the areas defined for each building.
2. To add Building Three, click Add above the Buildings grid to open the Properties dialog for
the Buildings node, then enter the building name in the Name field.
3. Click Add above the Site grid, in the properties dialog, to open the Add Site References
dialog and select the Faber College site name in the grid. Then click the From date field or
click the calendar icon beside it at the bottom of the dialog. Select a start date in the
calendar.
4. Confirm that the date has changed in the Start Date column under Sites, then click OK.
A new area needs to be created, Area 3. Associate this area with the new building, assign a
device to the area, and set the start date.
2. Click Add above the Areas grid to open the Properties dialog for the Areas node, then type
Area 3 in the Name field.
3. Click Add above the Building grid to open the Add Building References dialog.
5. Click the From field or click the calendar icon and select a start date.
6. Confirm that the date has changed in the From field under Building, then click OK.
7. Click Add above the Device grid to open the Add Device References dialog.
8. Select a device.
9. Click the From field or click the calendar icon and select a start date.
10. Confirm that the date has changed in the Start Date column under Device, then click OK.
The following image shows the complete set of entries on the Areas tab.
• The minus sign beside an entry to collapse that part of the hierarchy.
• The pencil (edit) icon to open and edit the properties for the related item.
• The bar for each entry to see the Node name and the effective date range for that entry.
The device that you are replacing is associated with Area 2 in Building Two.
When this task is complete:
• The entry for the old device is dimmed and italicized in the hierarchy if the End Date is the
current date or earlier.
• Any reports that include the area only include data collected by the device up to this new end
date.
NOTE: Date ranges extend from start of day to start of day. This means that the end date does
not include data collected for that day.
2. Double-click Area 2 in the grid or select it and click Edit to open the properties dialog.
3. Double-click Campus.Library device in the Device grid, or select it and click Edit to open the
Edit Device References dialog.
4. Click the To field, or click the calendar icon beside it, and select the end date.
5. Confirm that the date has changed in the End Date column under Device, then click OK.
6. Click Add above the Device grid to open the Add Device References dialog.
8. Click the From field or click the calendar icon beside it. Select the start date.
9. Confirm that the date has changed in the Start Date column under Device, then click OK.
When you complete these tasks, any reports that include this area with a date range that extends
beyond the device start date includes data collected by the new device as of their start date. The
reports do not include any data for the removed device as of their end date.
2. Select the area for which you want to create an apportioned meter and click Edit to open the
properties dialog.
3. In the area properties dialog, under Devices, select the device and click Edit. This opens the
Edit Device References dialog.
5. If required, click the From or To fields to change the start and end dates for the apportioned
meter.
6. Click OK.
Add: Selecting Add opens the Properties dialog. Type a name for the virtual meter and click Add
in the Devices area to select devices to attach to it. You can attach a device, a previously created
virtual meter, or an apportioned meter in the same way you attach a device to a hierarchy node.
Time intervals for start and end dates work the same as on meters attached to hierarchy nodes.
Edit: Editing a virtual meter is like editing the relationship between a hierarchy node and a device.
You can add, edit, or delete virtual meters but you need to ensure that your changes respect time
intervals.
For example, if you are replacing a meter, you need to update the End Date for it, and you need to
specify an appropriate Start Date for the new meter. Do not delete the original meter as this
removes the meter historically.
Delete: You can delete a virtual meter, but you need to take care when doing so. When you delete
a virtual meter, the relationships between all hierarchy nodes and the virtual meter are removed.
Dynamic hierarchy
Another feature of Hierarchy Manager is the ability to assign devices or Node instances for
discrete units of time. Instead of devices existing in either an assigned or unassigned state
independent of time, a device can be assigned to one Node instance for a specific length of time,
then assigned to another instance for another length of time.
With this time dimension, Hierarchy Manager can be used by organizations that require an ever-
changing representation of their system. If one tenant moves out and another moves in, that
change can be reflected in the hierarchy. Energy and power usage can be tracked for each tenant
over time, and billing information can be collected, aggregated, and displayed in a report.
NOTE: If your hierarchy does not change over time you do not need to set the date ranges for
the various devices or Node instances. In Power Monitoring Expert, these static hierarchies exist
from the date when the system was first commissioned (system start), to the farthest date the
system recognizes (end of time).
Dynamic hierarchies are established when you create or edit the properties of a Node instance
that is associated with a device. For example, if Customer A is set to lease a rack from a data
center, you can assign the racks and circuits to that customer on a specific date. When tenant A's
lease expires, you can remove the assignment of the racks and circuits on the expiration date and
reallocate them to tenant B.
See Creating a hierarchy for details on how to use the dynamic hierarchies function.
Meter apportionment
Meter apportionment allows you to assign a percentage of a device that has been assigned to an
area. For example, if a common area is monitored by a single meter but shared by two tenants, for
billing purposes you might want to allocate only a portion of the meter to each tenant. If tenant 1
uses 60% of the common area and tenant 2 uses 40%, you can attach 60% of a meter's reading to
the tenant 1 area node and the other 40% to the tenant 2 area node.
Virtual meter
A virtual meter allows you to aggregate measurements from any combination of devices,
apportioned meters, or other virtual meters available in Hierarchy Manager. The newly created
virtual meter can be assigned to a node in Hierarchy Manager just like any other device and
appears in dialogs that have a Views selection. You can even create an apportioned meter from a
virtual meter.
Examples:
• Assume that there are several feeder meters connected to the main power bus and you want
to calculate the total power usage. You can create a virtual meter that includes each of the
feeder meters. Then you can choose one of the reports supporting virtual meters to generate
a report showing the total power usage for the virtual meter.
• Assume that there is a large area monitored by a single meter (M1). Within that area is a
single room that is monitored by a separate meter (M2). Tenant 1 is using the small room and
Tenant 2 is using the remaining area. To calculate Tenant 2's power usage, the readings from
M2 must be subtracted from the readings of M1. This can be accomplished by assigning M1
and an apportioned meter of M2 with an allocation of -100%, removing M2's readings from
Tenant 2's power usage calculation.
The alternative is to create a virtual meter. For example, create a new virtual meter Tenant_
2_Net_Meter, and assign the two devices, M1 and M2 (-100%), to the virtual meter. The
virtual meter is assigned to Tenant 2's node. If at some time in the future a new meter is
added, you can edit the virtual meter to include the new meter.
The starting point for the aggregation in the Hierarchy is a device node. The Hierarchy will not
include measurements from nodes below the device node in the aggregation.
Example: Device nodes are the beginning of the aggregation.
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.
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.
Log Type.
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.
NOTE: This functionality is part of the Event Notification Module. This module requires a
separate license.
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.
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
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
Main UI
Selection tabs
1 Select a tab to see information related to notification Rules, Recipients, Templates,
Schedules, or Settings.
Help
2
Click 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 Click 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 Click 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 Click 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 Click 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 Click 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
Click 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.
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).
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
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
Click 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
Measurement Selection with recommended measurements
(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.
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
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
+33 (0) 1 41 29 70 00
www.se.com
7EN02-0487-00 07/2023