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

PME 2023 Web Applications Guide

Uploaded by

John
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
607 views

PME 2023 Web Applications Guide

Uploaded by

John
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 807

EcoStruxure™

Power Monitoring Expert 2023


Web Applications Guide
7EN02-0487-00
07/2023
Legal Information
The Schneider Electric brand and any trademarks of Schneider Electric SE and its subsidiaries
referred to in this guide are the property of Schneider Electric SE or its subsidiaries. All other
brands may be trademarks of their respective owners.

This guide and its content are protected under applicable copyright laws and furnished for
informational use only. No part of this guide may be reproduced or transmitted in any form or by
any means (electronic, mechanical, photocopying, recording, or otherwise), for any purpose,
without the prior written permission of Schneider Electric.

Schneider Electric does not grant any right or license for commercial use of the guide or its
content, except for a non-exclusive and personal license to consult it on an "as is" basis.
Schneider Electric products and equipment should be installed, operated, serviced, and
maintained only by qualified personnel.

As standards, specifications, and designs change from time to time, information contained in this
guide may be subject to change without notice.

To the extent permitted by applicable law, no responsibility or liability is assumed by Schneider


Electric and its subsidiaries for any errors or omissions in the informational content of this material
or consequences arising out of or resulting from the use of the information contained herein.
Safety Information
Important Information
Read these instructions carefully and look at the equipment to become familiar with the
device before trying to install, operate, service or maintain it. The following special
messages may appear throughout this bulletin or on the equipment to warn of potential
hazards or to call attention to information that clarifies or simplifies a procedure.

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


indicates that an electrical hazard exists which will result in personal
injury if the instructions are not followed.
This is the safety alert symbol. It is used to alert you to potential personal
injury hazards. Obey all safety messages that follow this symbol to avoid
possible injury or death.

DANGER
DANGER indicates a hazardous situation which, if not avoided, will result in death or serious
injury.

WARNING
WARNING indicates a hazardous situation which, if not avoided, could result in death or
serious injury.

CAUTION
CAUTION indicates a hazardous situation which, if not avoided, could result in minor or
moderate injury.

NOTICE
NOTICE is used to address practices not related to physical injury.

Please Note
Electrical equipment should be installed, operated, serviced and maintained only by qualified
personnel. No responsibility is assumed by Schneider Electric for any consequences arising out
of the use of this material.

A qualified person is one who has skills and knowledge related to the construction, installation,
and operation of electrical equipment and has received safety training to recognize and avoid the
hazards involved.
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

4 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Safety Information

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

© 2023 Schneider Electric. All Rights Reserved. 5


Safety Information Web Applications Guide

Sankey gadget 131


Pareto Chart gadget 132
Aggregated Pareto Chart gadget 133
Heat Map gadget 134
Consumption Ranking gadget 135
Aggregated Consumption Ranking gadget 136
KPI gadget 137
Dashboards configuration 138
Adding a new dashboard 139
Editing a dashboard 141
Sharing a dashboard 142
Moving a dashboard 143
Deleting a dashboard 144
Set default options for a dashboard 145
Configuring a slideshow 146
Adding a gadget to a dashboard 149
Editing a gadget 150
Moving or resizing a gadget on a dashboard 151
Dashboards references 152
Dashboards user interface (UI) 153
Using Table gadget in Slideshow 157
Styling a dashboard 158
Configuring Gadgets 159
Power Quality Performance events and disturbances 174
Diagrams 177
The Diagrams user interface 179
User authentication 180
Viewing historical (trend) data 181
RMS waveform plotting 181
Viewing meter events 183
Viewing user diagram of devices with security 184
Performing manual control actions 185
Stale data and error indicators 187
Power Quality Performance diagrams 188
Power Quality Performance Indicator diagrams 190
Power Quality Performance Equipment diagrams 195
Insulation Monitoring diagrams 199
Insulation Monitoring diagrams for ANSI 200
Insulation Monitoring diagrams for IEC 213
UPS Auto Test diagrams 225
Overview 225
Diagrams 225
1. Groups summary page 225
2. Group details page 225

6 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Safety Information

3. Device details page 226


EPSS diagrams 228
Overview 228
Diagrams 228
1. Groups summary page 228
2. Group details page 228
3. Device details page 229
Summary pages 229
Breaker Aging diagrams 232
Group Summary Diagram 232
Group Details Diagrams 232
Switchboard Details Diagrams 233
Diagrams and graphics configuration 235
Configuring Devices diagrams 237
Configuring a network diagram 238
Creating custom diagrams 239
Set default options for a diagram 240
Set Diagrams control options 241
Diagram Library 243
Diagrams registry settings 245
Configuring a custom network diagram for direct browser access 247
Configuring Power Quality Performance diagrams 249
Configuring Power Quality Performance diagrams for multiple sites 250
Changes in security settings of device 251
Reports 252
Report templates 253
Subscriptions 255
Time display 255
Terminology 255
Generating a report 256
Downloading a report 257
Report descriptions 258
Backup Power Reports 259
Billing Reports 276
Breaker Performance Reports 287
Energy Analysis Reports 294
Energy Management Reports 325
General Reports 363
Insulation Monitoring Reports 381
IT Billing Reports 386
Power Capacity Reports 389
Power Quality Reports 410
Usage Trending Reports 456
Reports configuration 468

© 2023 Schneider Electric. All Rights Reserved. 7


Safety Information Web Applications Guide

Setting Reports prerequisites 470


Meeting individual report requirements 472
Adding a new report 473
Copying a report 475
Editing a report 476
Moving a report 477
Deleting a report 478
Sharing a report 479
Subscribing to a report 481
Changing a report subscription 485
Deleting a report subscription 486
Uploading a Report Template 487
Configuring the Energy Modeling report 488
Reports references 491
Report input parameters 492
Model creation example 534
Interpreting the Energy Regression Analysis Report results 544
Reports UI 552
Reports Icons 553
Reports Terminology 554
UPS Battery Health Report calculations 555
Trends 556
Time display 557
Trends configuration 558
Adding a new trend 559
Editing a trend 561
Sharing a trend 562
Moving a trend 563
Deleting a trend 564
Trends references 565
The Trends user interface 566
Configuring a trend 567
Trend options 571
Web Applications settings 574
Alarm Views 576
EWS Server 578
Personal Preferences 579
Report Theme 580
System Language 581
System Theme 582
Diagnostics and Usage 584
Registration 585
Authorized Hosts 586
Integration Utility 586

8 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Safety Information

Login Options 588


Session Timeout 591
Web Applications settings references 592
System and personal localization settings 593
Customizing the Web Applications links 594
Device Manager 600
Device Manager or Management Console? 601
Definitions 601
Adding a device 603
Editing a device 606
Deleting a device 608
Connecting or disconnecting an Ethernet device 610
Enabling or disabling a device 612
Viewing a device diagram 614
Adding a site 615
Editing a site 617
Deleting a site 619
Connecting or disconnecting a site 621
Enabling or disabling a site 623
Exporting network configuration for use in a different system 625
Importing network configuration from a different system 627
Viewing system device license status 628
Device Manager references 630
Device Manager user interface 631
Device Replacement 634
Creating a processed measurement 636
Editing a processed measurement 637
Enabling or disabling a processed measurement 638
Configuring device replacement 639
Device Replacement references 640
Device Replacement user interface 641
EWS Client 643
Configuring EWS Client 645
Re-configuring EWS Client 648
Deleting an EWS Client 650
Disabling or Enabling an EWS Client 651
Remapping a Device, Measurement, and / or Alarm Mapping 652
Deleting a Device, Measurement, and / or Alarm Mapping 655
Enabling or Disabling a Device, Measurement, and / or Alarm Mapping 657
EWS Client references 660
EWS Client user interface 661
Hierarchy Manager 665
Hierarchy templates 666

© 2023 Schneider Electric. All Rights Reserved. 9


Safety Information Web Applications Guide

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

10 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Safety Information

Real-time Alarms 730


Logged Data Alarms 731
Fixed Setpoint Alarms 731
Smart Setpoint Alarms 732
Software Alarms considerations 733
Adding a new Alarm Rule 734
Enabling or disabling an Alarm Rule 736
Editing an Alarm Rule 737
Duplicating an Alarm Rule 738
Deleting an Alarm Rule 739
Using the Setpoint Calculator 740
Adding a Schedule 741
Schedules 742
Software Alarms references 743
Software Alarms UI 744
Add Alarm Rule UI 746
Schedules Configuration UI 753
User Manager 754
Users 756
Rules 756
Limitations 757
Adding a standard user 759
Adding a Windows user 761
Adding a Windows group 763
Changing a username 765
Changing a user password 767
Changing a user access level 769
Changing user details 771
Deleting a user 773
User Groups 775
Rules 775
Limitations 776
Adding a user group 778
Adding a user to a user group 780
Adding sources to a user group 782
Changing a user group name 784
Removing a user from a user group 786
Removing sources from a user group 788
Changing application access for a user group 790
Moving a user between user groups 792
Deleting a user group 794
Viewing Web Applications user license information 796
Customizing Access Level Privileges 798
User Manager references 800

© 2023 Schneider Electric. All Rights Reserved. 11


Safety Information Web Applications Guide

User Manager user interface 801


Default User Access Level Privileges 804

12 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Safety Precautions

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.

© 2023 Schneider Electric. All Rights Reserved. 13


Overview Web Applications Guide

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

• What's New Guide (English) – Document number 7EN12-0472

Support

Schneider Electric Support

14 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications

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

RECOMMENDATION: To reduce the risk of cybersecurity attacks, access Web Applications


only from client computers and not from the PME server.

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.

Specifying Which Application to Open First


When you connect to Web Applications through a client computer, the application whose link is on
the left of the series of application links opens in the browser. To specify a different application to
open first, add one of the following application query parameters into the Web address.

/#Dashboards /#Alarms
/#Diagrams /#Reports
/#Trends

For example, http://srv1.MyCompany.com/Web/#Trends opens the Trends application in


the browser.

© 2023 Schneider Electric. All Rights Reserved. 15


Web Applications Web Applications Guide

Opening Web Applications Without Banner


You can open any of the Web applications by itself without showing the Web Applications banner
and navigation bar. To open a Web application in this way, enter the PME server URL with
/<application name> in a browser address bar. For example,
http://srv1.MyCompany.com/Trends opens the Trends application in the browser without
the Web Applications UI elements.

Web Applications User Interface


The top right of the banner contains:
• Your user name: The user name you used to log in.

• 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 Annunciator looks like this:

In this example, the Annunciator shows:


• 1 low priority, active and unacknowledged Alarm (blue)

• 8 medium priority, active and unacknowledged Alarms (yellow)

• 10 high priority, active and unacknowledged Alarms (red)

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.

16 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications

Display Pane
The display pane loads the data visualization selected in the configuration pane.

Time Display in Web Applications


Most of the information displayed in the Web Applications is time based, such as timestamped
real-time data and historical data. In a PME system there are 3 reference points for time zones:
the monitoring devices/sources, the PME server, the Web client (browser).

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:

Web Application Time Zone Used for Display


Device/source time zone as configured in Management Console
Dashboards
or Device Manager.
Device/source time zone as configured in Management Console
Diagrams
or Device Manager.
Device/source time zone or Web client (browser) time zone.
Device/source time zone as configured in Management Console
Trends
or Device Manager. Web client (browser) time zone as configured
in Trends application.
Device/source time zone as configured in Management Console
Alarms
or Device Manager. *
Time zone can be manually selected. Default is Web client
Reports
(browser) 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.

© 2023 Schneider Electric. All Rights Reserved. 17


Web Applications Web Applications Guide

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.

18 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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:

© 2023 Schneider Electric. All Rights Reserved. 19


Alarms Web Applications Guide

View Name Description


This view shows alarms that are in the active state. It includes low,
medium and high priority alarms from all sources and all
Active Alarms
categories. This view does not include General Event and
Unassociated Dropout type alarms.
This view shows all low, medium and high priority alarms in the
All Alarms
system regardless of state, category, and source.
This view shows unacknowledged alarms. It includes low, medium
Unacknowledged Alarms and high priority alarms from all sources and all categories that are
in the active or inactive state.

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:

View Name Description


This view shows Incidents that are categorized as Asset
Asset Monitoring Incidents Monitoring and are in the active or unacknowledged state. It
includes low, medium and high priority Incidents from all sources.
This view shows Incidents that are categorized as General Clutter
Clutter and are in the active or unacknowledged state. It includes low,
medium and high priority Incidents from all sources.
This view shows incidents that are categorized as Power Quality
(Over Voltage, Swell, Under Voltage, Interruption, Sag, Transient,
Load Loss Incidents or Unclassified Disturbance) and that recorded a sustained load
loss after a voltage sag. It includes low, medium and high priority
Incidents that are active or unacknowledged, from all sources.
This view shows Incidents that are categorized as Power Quality
Power Quality Incidents and are in the active or unacknowledged state. It includes low,
medium and high priority Incidents from all sources.
This view shows alarm instances that are in the active or
unacknowledged state. It includes low, medium and high priority
Recent Alarms
alarms from all sources and all categories. This view does not
include Unassociated Dropout and Clock/Time type alarms.
Recent Events This view shows events of all priorities from all sources.
This view shows Incidents that are in the active or
unacknowledged state. It includes low, medium and high priority
Recent Incidents
Incidents from all sources and all categories. This view does not
include General Alarms for type Clutter.
This view shows Diagnostics type alarm instances that are in the
active or unacknowledged state. It includes low, medium and high
System Health
priority alarms from all sources. This view does not include
Diagnostics Alarms of type Clock/Time and Device Settings.

20 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Incidents, Alarms, and Events


Incidents
Incidents provide a high-level view. They 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. You can look at an incident
and see how the different pieces of information are linked together, instead of having to analyze
each data point individually. Use incidents as a starting point for your alarm analysis.
For more information, see:
• Incidents

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

© 2023 Schneider Electric. All Rights Reserved. 21


Alarms Web Applications Guide

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.

For details on the different tools, see:


Disturbance Direction
• Disturbance Direction

• Viewing Disturbance Direction

Load Impact
• Load Impact

• Viewing Load Impact

Timeline analysis
• Timeline analysis

• Viewing a timeline analysis

• Timeline analysis UI

Voltage Tolerance
• Voltage Tolerance

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

For information on how to configure Alarms, see Alarms configuration.

22 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

2. View the incident information displayed in the alarms display pane.


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

Related topics:
• Viewing incidents

• Viewing alarms

• Viewing events

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

© 2023 Schneider Electric. All Rights Reserved. 23


Alarms Web Applications Guide

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

24 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

2. View the alarm information displayed in the alarms display pane.


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

Related topics:
• Viewing incidents

• Viewing alarms

• Viewing events

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

© 2023 Schneider Electric. All Rights Reserved. 25


Alarms Web Applications Guide

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

26 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

2. View the event Information displayed in the alarms display pane.


(Optional) In the view Library, right-click the view name or click Options for this view 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 and Sources to customize the view
if necessary. Save the modified view settings or click Cancel to discard the changes.

TIP: Double-clicking an event in the events display table opens the associated alarm.

Related topics:
• Viewing incidents

• Viewing alarms

• Viewing events

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

© 2023 Schneider Electric. All Rights Reserved. 27


Alarms Web Applications Guide

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

28 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Viewing Disturbance Direction


View Disturbance Direction to analyze the likely origin of voltage disturbance events in your power
system.

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.

To view Disturbance Direction:

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

click Open Details to open the details window.

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

© 2023 Schneider Electric. All Rights Reserved. 29


Alarms Web Applications Guide

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

30 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Viewing Load Impact


View Load Impact to identify changes in steady state electrical loads in your power system
triggered by a voltage disturbance.

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.

To view Load Impact:

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

Details to open the details window.

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.

TIP: See Load Impact calculations for more details.

Related topics:
• Viewing incidents

• Viewing alarms

• Viewing events

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

© 2023 Schneider Electric. All Rights Reserved. 31


Alarms Web Applications Guide

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

32 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Viewing a timeline analysis


View a timeline analysis to investigate the sequence of events that occurred during a single
incident, multiple incidents, or alarms.
To view a timeline analysis for an incident:

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

to open the timeline window.


(Optional) Edit the view settings for the timeline analysis and save the view for future
reference.

To view a timeline analysis for multiple incidents:

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.

To view a timeline analysis for an alarm:

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.

3. In the alarm details window, click Timeline Analysis.

Related topics:
• Viewing incidents

• Viewing alarms

• Viewing events

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

© 2023 Schneider Electric. All Rights Reserved. 33


Alarms Web Applications Guide

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

34 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Viewing Voltage Tolerance


View Voltage Tolerance to investigate the potential impact of a voltage disturbance on equipment.

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.

To view Voltage Tolerance:

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

Open Details to open the details window.

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

© 2023 Schneider Electric. All Rights Reserved. 35


Alarms Web Applications Guide

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

36 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

3. In Details, click Waveforms.

TIP: Click Open Representative Waveform to see the representative waveform for this
Incident or alarm instance.

4. View the waveforms associated with the 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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

© 2023 Schneider Electric. All Rights Reserved. 37


Alarms Web Applications Guide

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

38 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

Acknowledging through an alarm status view


To acknowledge a single alarm:

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.

4. In Acknowledge Alarms, click Acknowledge.


(Optional) In the Comment box, enter notes related to the alarm definition.

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.

To acknowledge multiple alarms:

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

© 2023 Schneider Electric. All Rights Reserved. 39


Alarms Web Applications Guide

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.

4. In Acknowledge Alarms, click Acknowledge.


(Optional) In the Comment box, enter notes related to the alarm definitions.

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.

To acknowledge all alarms in a view:

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.

3. In Acknowledge Alarms, click Acknowledge.


(Optional) In the Comment box, enter notes related to the alarm definitions.

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.

Acknowledging through an alarm history view


To acknowledge an alarm:

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.

5. In Acknowledge Alarms, click Acknowledge.


(Optional) In the Comment box, enter notes related to the alarm.

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.

40 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Acknowledging through an incident history view


To acknowledge all alarms in an incident:

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.

5. In Acknowledge Alarms, click Acknowledge.


(Optional) In the Comment box, enter notes related to the alarms.

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

© 2023 Schneider Electric. All Rights Reserved. 41


Alarms Web Applications Guide

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

42 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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:

Category Type Grouping Time Interval


Flicker 5 minutes
Frequency Variation 5 minutes
Harmonics 5 minutes
Interruption 5 minutes *
Over Voltage 5 minutes *
Power Quality Sag 20 seconds *
Swell 20 seconds *
Transient 20 seconds *
Unbalance 5 minutes
Unclassified Disturbance 20 seconds *
Under Voltage 5 minutes *
Arc Flash 60 seconds
Backup Power 80 minutes
Asset Monitoring Current Monitor 5 minutes
Protection 5 minutes
Thermal Monitor 30 minutes
Air 5 minutes
Demand 5 minutes
Electricity 5 minutes
Energy Management Gas 5 minutes
Power Factor 5 minutes
Steam 5 minutes
Water 5 minutes

© 2023 Schneider Electric. All Rights Reserved. 43


Alarms Web Applications Guide

Category Type Grouping Time Interval


Clutter 1 day
General
General Setpoints 5 minutes
Communication Status 10 minutes
Diagnostics Device Status 5 minutes
System Status 0 seconds (one incident per alarm)

* 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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

44 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

0 = inactive alarm state; 1 = active alarm state; T = time

T1 = Alarm goes active

T2 = Alarm goes inactive

The following diagram shows an instantaneous alarm. For this alarm, the start time T1 and end
time T2 are identical.

0 = inactive alarm state, 1 = active alarm state; T = time

T1/2 = Alarm goes active and immediately inactive again

© 2023 Schneider Electric. All Rights Reserved. 45


Alarms Web Applications Guide

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

46 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

© 2023 Schneider Electric. All Rights Reserved. 47


Alarms Web Applications Guide

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

48 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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:

Source Timestamp Event Condition Measurement Value Type


8/10/2017
Over Voltage Phase
My.Device 1:44:53.000 ON 145.740 Pick up
Voltage A
PM
8/10/2017
Over Voltage Phase
My.Device 1:44:53.000 Extreme 145.740 Instantaneous
Voltage A
PM
8/10/2017
Over Voltage Phase
My.Device 1:45:39.000 OFF 125.230 Drop out
Voltage A
PM

PME uses event records to determine alarm types and states.


Related topics:
• Viewing incidents

• Viewing alarms

• Viewing events

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

© 2023 Schneider Electric. All Rights Reserved. 49


Alarms Web Applications Guide

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

50 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

© 2023 Schneider Electric. All Rights Reserved. 51


Alarms Web Applications Guide

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

52 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

See Load Impact calculations for more details.

Prerequisites
Load Impact calculations are only available for data captured by the following monitoring device
types:
• ION 9000 (all firmware versions)

• ION 8800 (all firmware versions)

• ION 8650 (all firmware versions)

• ION 7650 (all firmware versions)

• ION 7550 (all firmware versions)

• ION 7400 (all firmware versions)

• PM8000 (all firmware versions)

• ACCESS 9510 (all firmware versions)

• ACCESS 9610 (all firmware versions)

• 9410 (all firmware versions)

• 9810 (all firmware versions)

The monitoring devices must be configured to record the following data:


• Sag/swell and transient event data

• 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

© 2023 Schneider Electric. All Rights Reserved. 53


Alarms Web Applications Guide

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

54 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline Analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

© 2023 Schneider Electric. All Rights Reserved. 55


Alarms Web Applications Guide

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

56 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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

© 2023 Schneider Electric. All Rights Reserved. 57


Alarms Web Applications Guide

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 Disturbance Direction

58 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

© 2023 Schneider Electric. All Rights Reserved. 59


Alarms Web Applications Guide

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 Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform analytics

• Alarms terminology

60 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

© 2023 Schneider Electric. All Rights Reserved. 61


Alarms Web Applications Guide

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.

Waveform analytics will:


• Provide event characteristics.

• Provide indications as to the cause of the event.

• Provide whether an event is upstream or downstream.

Viewing Waveform Analytics

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.

Waveform Analysis Information will be visible on the Details tab.

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

62 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

When the waveform analysis is not performed, following information is provided:

Possible issues preventing successful automatic waveform analysis

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.

© 2023 Schneider Electric. All Rights Reserved. 63


Alarms Web Applications Guide

Issue and description Solution


Check configuration and the connections of your meter to
Waveform Analytics is not
ensure it is capturing nominal voltage at the beginning of an
returning readings
event.
Missing Voltage Phases
Verify that the monitoring source is programmed to capture
One or more of the three voltage voltages on all three channels or that all three phases have
phases was not recorded or is been downloaded from the monitoring source.
missing.
Low RMS Voltage

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

64 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

• Viewing Disturbance Direction

• Viewing Load Impact

• Viewing a timeline analysis

• Viewing Voltage Tolerance

• Viewing waveforms

• Acknowledging alarms

For reference information see:


• Alarm Operation

• Incidents

• Alarms

• Events

• Disturbance Direction

• Load Impact

• Timeline analysis

• Voltage Tolerance

• Waveforms

• Waveform Analytics

• Alarms terminology

• Alarms UI

• Timeline analysis UI

• Waveforms UI

For information on how to configure Alarms, see Alarms configuration.

© 2023 Schneider Electric. All Rights Reserved. 65


Alarms Web Applications Guide

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.

For information on how to configure the Alarms application, see:


• Adding a new Alarms view

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

66 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

© 2023 Schneider Electric. All Rights Reserved. 67


Alarms Web Applications Guide

Adding a new Alarms view


Add new Alarms views to access certain types of alarms, incidents, or events. For example,
create views to only see unacknowledged alarms, high priority alarms, or power quality incidents.
You can also create views that only include certain sources, and so eliminate information you are
not interested in.
To add a completely new Alarms view:

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.

5. Save the view.

To add a copy of an existing Alarms view:

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.

68 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

NOTE: Not all of these filters are available for all view types.

4. Save the view.

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

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

© 2023 Schneider Electric. All Rights Reserved. 69


Alarms Web Applications Guide

Copying an Alarms view


Copy Alarms views to quickly create new views that are the same as, or similar to existing views.
For example, create a copy of a view to experiment with the view settings without affecting the
original view. You can also use a copy of a view as a starting point for a new view that shares
many of the settings of the original view.
To copy an Alarms view:

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.

4. Save the View.

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

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

70 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Editing an Alarms view


Edit Alarms views to update the view name, the filter settings, or the location of the view in the
view library.

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.

To edit an Alarms view:

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.

3. Save the view.

Related topics:
• Adding a new Alarms view

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

© 2023 Schneider Electric. All Rights Reserved. 71


Alarms Web Applications Guide

Sharing an Alarms view


Share Alarms views 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 an Alarm view:

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.

4. Click OK to share this view.

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

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

72 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Moving an Alarms view


Move Alarms views to a different location in the view library to make them easier to find or easier
to manage.
To move an Alarms view:

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.

4. Click OK to move the view.

NOTE: You cannot move system views or the System Views folder.

Related topics:
• Adding a new Alarms view

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

© 2023 Schneider Electric. All Rights Reserved. 73


Alarms Web Applications Guide

Deleting an Alarms view


Delete Alarms views that are no longer needed.
To delete an Alarms view:

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

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

74 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Setting a default Alarms view


The default Alarms view is the view that opens when you first open the Alarms application. You
can set a default for your own workspace or the entire system.

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.

To set a default Alarms view:

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.

3. In Configure Default Item, enable Set as my default or Set as system default.

4. Click OK to save the default settings.

Related topics:
• Adding a new Alarms view

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivating alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

© 2023 Schneider Electric. All Rights Reserved. 75


Alarms Web Applications Guide

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.

To use the Deactivate Alarms utility:

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.

5. Click Set Selected Alarms to Inactive.

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.

76 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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

• Copying an Alarms view

• Editing an Alarms view

• Sharing an Alarms view

• Moving an Alarms view

• Deleting an Alarms view

• Setting a default Alarms view

• Changing the alarm viewer settings

• Deactivate alarms

For reference information see:


• Alarms UI

For information on how to use Alarms, see Alarms.

© 2023 Schneider Electric. All Rights Reserved. 77


Alarms Web Applications Guide

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

78 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

© 2023 Schneider Electric. All Rights Reserved. 79


Alarms Web Applications Guide

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.

Date Filter mode: View alarms within a certain date


2 range.

Auto-Update mode: View the latest alarms.

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.

80 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

3 Alarm status UI

Alarm status table columns


Click on any of the column headers to sort by that column. Use the Show/Hide Columns
option in the alarms display pane Options menu to customize which columns are visible.
The following columns are available:

ID Unique numeric alarm identifier.


Priority Alarm priority number from 0 - 255.
Graphic display of active or inactive status. Also shows the amount
State
of time since the alarm went last active.
Active Active or Inactive status.
1 Name Alarm name.
Type Alarm type, for example Over Voltage.
Source Origin of the alarm.
Unacknowledged Number of unacknowledged alarm activations.
Acknowledgement A link to acknowledge the alarm.
Last Occurrence Datetime of latest alarm activation, in browser local time.
Last Occurrence
Datetime of latest alarm activation, in UTC time.
UTC
First Occurrence Datetime of first alarm activation, in browser local time.
Occurrences Total number of alarm activations.

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.

© 2023 Schneider Electric. All Rights Reserved. 81


Alarms Web Applications Guide

3-1 Alarm definition details

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.

82 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

4 Alarm history UI

Alarm history table rows


1 Each row in the table shows an alarm instance that occurred. The filter settings in the view
library control which instances are included in a view.
Details button
2 Click Details to see more information related to the alarm instance. (See below for
more information.)

4-1 Alarm instance details

TIP: Click Details for an alarm instance or double-click an alarm instance row in the table to open
the alarm details.

© 2023 Schneider Electric. All Rights Reserved. 83


Alarms Web Applications Guide

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.

84 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

5 Incident history UI

Incident history table rows


1 Each row in the table shows an incident that occurred. The filter settings in the view library
control which incidents are included in a view.
Analysis button

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.

TIP: For multi-selection, use Ctrl+Click to select individual Incidents, use


Shift+click to select a block of Incidents.

Details button
3 Click Details to see more information related to the incident. (See below for more
information.)

5-1 Incident details

TIP: Click Details for an incident or double-click an incident row in the table to open the incident
details.

© 2023 Schneider Electric. All Rights Reserved. 85


Alarms Web Applications Guide

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.

86 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

6 Event history UI

Event history table columns


Use the Show/Hide Columns option in the alarms display pane Options menu to customize
which columns are visible. The following columns are available:

ID Unique numeric event identifier.


Source Origin of the event.
Timestamp Datetime when the event was recorded, in browser local time.
1 Timestamp UTC Datetime when the event was recorded, in UTC time.
Event Event string, for example RSP10 Status.
Condition Threshold value of the event trigger at the time the event was recorded.
Measurement Measurement that triggered the event.
Value Measured value at the time the event was triggered.
Type Event trigger type, Pick up, Drop out, or Instantaneous.
Priority Event priority number from 0 - 255.

Event history table rows


2 Each row in the table shows an event that occurred. The filter settings in the view library
control which events are included in a view.

TIP: Double-click an event row in the table to open the alarm instance details for the alarm that is
associated with this event.

© 2023 Schneider Electric. All Rights Reserved. 87


Alarms Web Applications Guide

7 View settings

Alarm Status Alarm and Incident History Event History

Options menu and Hide Library icon .


The Options menu contains options relevant to the view library. The following options are
1 available:
Add View
Add Folder
Search filter
2
Enter text into the search filter to search and filter the views displayed in the library.

88 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

View Type selector


7 Select Alarm Status to create an alarm status view. Select Alarm History to create an
alarm history view.
Priority filter
8 Click the priority buttons to include or exclude alarms with that priority. The priorities are,
from left to right: No, Low, Medium, High.
State selector
Select which alarm states to include. The following options are available:
Active or Unacknowledged
9 Active and Unacknowledged
Unacknowledged
Active
All
Sources selector
10
Include all sources or select specific sources.
Category selector
Include or exclude certain categories of alarms and choose specific types within each
category. The following categories are available:
Power Quality (includes filter settings for Voltage Tolerance, Load Impact, and
Disturbance Direction)
11
Asset Monitoring
Energy Management
General
Diagnostics
See Alarms for a list of available types in each category.
Level of Detail selector
Select to see incidents, alarms, or events.
12
NOTE: This setting is only available for history views, not for alarm status views.

© 2023 Schneider Electric. All Rights Reserved. 89


Alarms Web Applications Guide

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.

90 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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

© 2023 Schneider Electric. All Rights Reserved. 91


Alarms Web Applications Guide

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.

92 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

© 2023 Schneider Electric. All Rights Reserved. 93


Alarms Web Applications Guide

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

Non Shared Tooltips (only shows Vab details)

Select which charts (Analysis Area, Phasors, Harmonics (V), Harmonics


(I)) to display in the analysis pane.
View
NOTE: The View option is not available for high speed transient
waveform captures.

Set the number of harmonics to display in the harmonics column chart.

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.

Select the source frequency. The frequency is detected automatically. Use


this control to make adjustments if the frequency setting is incorrect.
Source
Frequency NOTE: The frequency setting is not available for high speed transient
waveform captures.

94 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Analysis area selector


Use the slider to select an analysis area in the waveform chart.
6
NOTE: The analysis area selector 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.

Voltage harmonics chart


This chart shows the voltage harmonic analysis of the section of the waveform that has
been selected by the analysis area selector (see 6). Harmonic details are shown in a
10 column chart.

NOTE: The voltage harmonics chart is not available for high speed transient waveform
captures.

Current harmonics chart


This chart shows the current harmonic analysis of the section of the waveform that has
been selected by the analysis area selector (see 6). Harmonic details are shown in a
11 column chart.

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.

© 2023 Schneider Electric. All Rights Reserved. 95


Alarms Web Applications Guide

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.

96 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

Cursor area selector


Use the cursors (1 and 2) to select an analysis area in the waveform chart.
5
NOTE: The cursor area selector 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.

© 2023 Schneider Electric. All Rights Reserved. 97


Alarms Web Applications Guide

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.

98 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

© 2023 Schneider Electric. All Rights Reserved. 99


Alarms Web Applications Guide

Timeline analysis view settings UI

View Name
1
Shows the name of the timeline view.

100 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Location and sharing


Determines where the view is stored in the library and who can access it.

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.

© 2023 Schneider Electric. All Rights Reserved. 101


Alarms Web Applications Guide

Alarm to incident mapping


The following table shows the mapping of alarm types to Incidents:

Incident Category Incident Type Alarm Types


Interruption Interruption
Over Voltage Over Voltage
Under Voltage Under Voltage
Unclassified Disturbance Unclassified Disturbance
Sag Sag (Voltage)
Swell Swell (Voltage)
Transient Transient
Flicker Flicker
Power Quality
Frequency Variation Frequency Variation
Harmonics
Harmonics (Current)
Harmonics
Harmonics (Power)
Harmonics (Voltage)
Unbalance
Unbalance Unbalance (Current)
Unbalance (Voltage)
Communication Status Communication Status
Diagnostics Device Status Device Status
System Status System Status
Air Air
Demand Demand
Electricity Electricity
Energy Management Gas Gas
Power Factor Power Factor
Steam Steam
Water Water
Arc Flash Arc Flash
Backup Power Backup Power
Over Current
Sag (Current)
Asset Monitoring Current Monitor
Swell (Current)
Under Current
Protection Protection
Thermal Monitor Thermal Monitor

102 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

Incident Category Incident Type Alarm Types


General Event
Clock / Time
Clutter
General Device Settings
Unassociated Dropout
General Setpoints General Setpoint

© 2023 Schneider Electric. All Rights Reserved. 103


Alarms Web Applications Guide

Load Impact calculations


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. To assess the impact of a
disturbance on the load, the software compares the real power (kW) measurements of the
monitored circuit before and after the event.

Load Impact is calculated as:


Load Impact (%) = ((Ppost-event - Ppre-event) / Ppre-event) ×100
• A negative Load Impact value between -100% < X < 0% means a load loss. The real power
(kW) of the monitored circuit has been reduced by X%.

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.

104 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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 occurrence count


The alarm occurrence count is the number of alarm instances that have happened for an alarm
definition.

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.

© 2023 Schneider Electric. All Rights Reserved. 105


Alarms Web Applications Guide

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.

Representative power quality details (representative disturbance)


The representative power quality details describe the representative disturbance for an alarm or
incident. The representative disturbance is used to categorize and quantify the alarm or incident.
For an alarm the representative disturbance is the one that triggered the alarm. For an incident,
which can include multiple alarms, the representative disturbance is the one with the highest
severity in the incident. The representative power quality details include the source, type,
direction, maximum abnormality, start time, end time, and duration of the disturbance.
Example representative power quality details:
• Source: Campus.Residence Hall

• Type: Sag

• Disturbance Direction: Upstream - High Confidence

• Maximum Abnorality: V3: 88.5%

• Start Time: 2019-07-26 9:08:49.330 PM

• End Time: 2019-07-26 9:08:49.530 PM

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

1. The waveform covers full disturbance

2. The waveform covers the start of the disturbance

3. The waveform covers the end of the disturbance

4. The waveform is inside the disturbance

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.

106 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Alarms

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.

© 2023 Schneider Electric. All Rights Reserved. 107


Dashboards Web Applications Guide

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

For reference information see:


• Dashboards user interface (UI)

For information on how to configure Dashboards, see Dashboards configuration.

108 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

2. View the Dashboard Gadgets displayed in the Dashboards display pane.

Related topics:
• Viewing Dashboards

• Dashboard Slideshows

• Playing a Slideshow

• Gadgets

For reference information see:


• Dashboards user interface (UI)

For information on how to configure Dashboards, see Dashboards configuration.

© 2023 Schneider Electric. All Rights Reserved. 109


Dashboards Web Applications Guide

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

For reference information see:


• Dashboards user interface (UI)

For information on how to configure Dashboards, see Dashboards configuration.

110 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to configure Dashboards, see Dashboards configuration.

© 2023 Schneider Electric. All Rights Reserved. 111


Dashboards Web Applications Guide

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:

Bar Chart Power Quality


Energy Equivalency Sankey
Table Pareto Chart
Period over Period Aggregated Pareto Chart
Pie Chart Heat Map
Trend Chart Consumption Ranking
Web Viewer Aggregated Consumption Ranking
KPI gadget

Related topics:
• Viewing Dashboards

• Dashboard Slideshows

• Playing a Slideshow

• Gadgets

For reference information see:


• Dashboards user interface (UI)

For information on how to configure Dashboards, see Dashboards configuration.

112 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Bar Chart gadget


This gadget shows a comparison of several data series, over a selected time period. The
information is shown as horizontal bars.
Example:

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.

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 113


Dashboards Web Applications Guide

Energy Equivalency gadget


This gadget shows a single value that is equivalent to the aggregated consumption input data,
over a selected time period. The value can be scaled to represent a consumption equivalent
measurement, such as CO2 emissions or primary energy units. The information is shown as a
numeric value with unit, a custom text, and a custom graphic.
Example:

For information about configuring the gadget, see Configuring Gadgets.

114 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 115


Dashboards Web Applications Guide

Period Over Period gadget


This gadget shows consumption data for the same measurement for two different viewing periods
side-by-side. The information is shown in a column chart.
Example:

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.

For information about configuring the gadget, see Configuring Gadgets.

116 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Pie Chart gadget


This gadget shows a comparison of several data series in a single chart, over a selected time
period. The information is shown in a pie chart, as a percentage distribution of the different data
series.
Example:

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.

© 2023 Schneider Electric. All Rights Reserved. 117


Dashboards Web Applications Guide

Trend Chart gadget


This gadget shows consumption data, over a selected time period. The information is shown in a
combined column and line chart. You can include one or more data series in a single chart. You
can select how to display the data for both the primary and secondary axes.
Example:

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.

For information about configuring the gadget, see Configuring Gadgets.

118 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Web Viewer gadget


This gadget shows a web page inside the gadget frame in the dashboard.

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:

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 119


Dashboards Web Applications Guide

Power Quality gadgets


NOTE: These gadgets are part of the Power Quality Performance Module. This Module requires
a separate license.

See Power Quality Performance events and disturbances, in the Reference section of this
document, for a definition of power quality events.
Use the following links to jump to the descriptions of the different Power Quality gadget types:

Power Factor Impact Power Quality Impact


Power Factor Impact Trend Power Quality Impact Trend
Power Quality Incident Breakdown Power Quality Rating
Power Quality Incident Impact Power Quality Rating Trend
Power Quality Incident Location

120 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Power Factor Impact gadget

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.

© 2023 Schneider Electric. All Rights Reserved. 121


Dashboards Web Applications Guide

Power Factor Impact Trend gadget

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.

122 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Power Quality Incident Breakdown gadget

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.

© 2023 Schneider Electric. All Rights Reserved. 123


Dashboards Web Applications Guide

Power Quality Incident Impact gadget

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.

124 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Power Quality Incident Location gadget

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.

© 2023 Schneider Electric. All Rights Reserved. 125


Dashboards Web Applications Guide

Power Quality Impact gadget

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.

126 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Power Quality Impact Trend gadget

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.

© 2023 Schneider Electric. All Rights Reserved. 127


Dashboards Web Applications Guide

Power Quality Rating gadget

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.

The following formula is used to calculate the power quality rating:

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"

• PQ.Rating >= 85% à "B"

• PQ.Rating >= 75% à "C"

• PQ.Rating >= 65% à "D"

• PQ.Rating >= 55% à "E"

• PQ.Rating >= 0% à "F"

With 0% = worst power quality and 100% = optimal power quality.

NOTE: The ratings are based on established thresholds and limits defined in IEEE 519, IEC
61000-4-30, EN 50160, and IEEE 1159 standards.

128 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Example:

For information about configuring Power Quality gadgets, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 129


Dashboards Web Applications Guide

Power Quality Rating Trend gadget

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.

130 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 131


Dashboards Web Applications Guide

Pareto Chart gadget


NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.

This gadget shows consumption data, by consumer, for multiple consumers, over a selected time
period. The information is shown in a combined column and line chart. The columns are arranged
from highest consumption to lowest consumption. The chart includes a cumulative curve based
on the aggregation period consumption values. The chart also contains a configurable marker line
which is used as a target or threshold indicator.

Use this gadget to perform an 80/20 analysis, identifying those consumers that together make up
the largest portion, or 80% of the overall consumption.

TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,

hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.

Example:

For information about configuring the gadget, see Configuring Gadgets.

132 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Aggregated Pareto Chart gadget


NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.

This gadget shows consumption data for multiple consumers, over a selected time period. The
information is shown in a combined column and line chart, grouped by aggregation period. The
columns are arranged from highest consumption to lowest consumption. The chart includes a
cumulative curve based on the aggregation period consumption values. The chart also contains a
configurable marker line which is used as a target or threshold indicator.

Use this gadget to perform an 80/20 analysis, identifying those aggregation intervals and
consumers that together make up the largest portion, or 80% of the overall consumption.

TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,

hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.

Example:

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 133


Dashboards Web Applications Guide

Heat Map gadget


NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.

This gadget creates a graphical representation of your data where the individual values are
represented as colors in a matrix format. The graphical display makes it easy to identify patterns
in complex data sets.

Use this gadget with consumption data to identify usage patterns and anomalies.

TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,

hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.

Example:

For information about configuring the gadget, see Configuring Gadgets.

134 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Consumption Ranking gadget


NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.

This gadget shows consumption data, by consumer, for multiple consumers, over a selected time
period. The information is shown side-by-side in a column or bar chart and a doughnut chart. The
columns or bars are arranged in order of consumption. The chart includes the aggregated total
consumption.

Use this gadget to compare the consumption of different consumers over a period of time.

TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,

hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.

Example:

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 135


Dashboards Web Applications Guide

Aggregated Consumption Ranking gadget


NOTE: This gadget is part of the Energy Analysis Dashboards Module. This Module requires a
separate license.

This gadget shows consumption data for multiple consumers, by aggregation period, over a
selected time period. The information is shown side-by-side in a column or bar chart and a
doughnut chart. The columns or bars are arranged in order of the aggregated consumption. The
chart includes the aggregated total consumption.

Use this gadget to compare the consumption of consumers during specific time intervals, for
example by hour, by day of week, or by day.

TIP: This gadget supports printing its complete data set and exporting its complete data set in
PNG, JPG, SVG, CSV, and HTML format directly from the Web browser. To export the data,

hover the mouse pointer over the download icon in the gadget and select Print or the
desired format from the pop-up menu.

Example:

For information about configuring the gadget, see Configuring Gadgets.

136 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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:

For information about configuring the gadget, see Configuring Gadgets.

© 2023 Schneider Electric. All Rights Reserved. 137


Dashboards Web Applications Guide

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

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see Dashboards user interface (UI).

For information on how to use Dashboards, see Dashboards.

138 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Adding a new dashboard


Add new dashboards to view high level historical and real-time data, for example in the form of
Key Performance Indicators (KPIs).
To add a completely new dashboard:

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.

7. Save the dashboard.

To add a copy of an existing dashboard to the Library:

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.

4. Save the modified Dashboard Settings.

© 2023 Schneider Electric. All Rights Reserved. 139


Dashboards Web Applications Guide

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

140 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

3. Save the modified dashboard settings.

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

© 2023 Schneider Electric. All Rights Reserved. 141


Dashboards Web Applications Guide

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.

5. Click OK to share this dashboard.

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

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

142 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

4. Click OK to move the dashboard.

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

© 2023 Schneider Electric. All Rights Reserved. 143


Dashboards Web Applications Guide

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

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

144 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Set default options for a dashboard


The default dashboard is the one that is displayed when you first open Dashboards. You can set a
dashboard to be your own personal default, or the default for the system.

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.

To set the default options for a dashboard:

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.

3. Turn on one or both of Set as my default and Set as system default.

4. Click OK to save the modified Dashboard Settings.

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

© 2023 Schneider Electric. All Rights Reserved. 145


Dashboards Web Applications Guide

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.

3. Type a name for the slideshow in the Name field.

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.

7. Click OK to save your slideshow.

8. Click Close to close the Slideshow Manager.

Editing an existing slideshow


To edit an existing 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 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.

146 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

4. Click OK to save your changes and to return to the Slideshow Manager.

5. Click Close to close the Slideshow Manager.

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.

4. Click Close to close 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.

3. Click Close to close the Slideshow Manager.

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

© 2023 Schneider Electric. All Rights Reserved. 147


Dashboards Web Applications Guide

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

148 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Adding a gadget to a dashboard


Add gadgets to a dashboard to display historical and real-time data. Without gadgets, a
dashboard does not display any data.

NOTE: Gadgets that require special licensing only appear in the list after the correct licensing
has been installed.

To add a gadget to the dashboard:

1. Click Add Gadget to open the Gadget Setup dialog.


By default, all gadgets are included in the dialog. To filter the gadgets by category, click one
of the categories on the left, for example Common or Comparison.

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.

See Configuring Gadgets for a description of the settings.

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.

5. Repeat the process to add additional gadgets to your dashboard.

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

© 2023 Schneider Electric. All Rights Reserved. 149


Dashboards Web Applications Guide

Editing a gadget
To edit the settings for a gadget:

1. Click Settings in the gadget and select Edit to open the Gadget Setup.

2. In Gadget Setup, change any of the settings on the tabs.

See Configuring Gadgets for more details.

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

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

150 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Moving or resizing a gadget on a dashboard


You can move or resize a gadget on a dashboard when the dashboard is in edit mode.

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

3. Drag and drop the gadget to another position on the dashboard.

Other gadgets on the dashboard are re-positioned if additional space is required.

4. Click Finish in Dashboard Controls to save your change.

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.

3. Drag the corner to increase or reduce the size of the gadget.

Other gadgets on the dashboard are re-positioned if additional space is required.

4. Click Finish in Dashboard Controls to save your change.

Related topics:
Dashboards:
• Adding a new dashboard

• Editing a dashboard

• Sharing a dashboard

• Moving a dashboard

• Deleting a dashboard

• Set default options for a dashboard

• Configuring a slideshow

Gadgets:
• Adding a gadget to a dashboard

• Editing a gadget

• Moving or resizing a gadget on a dashboard

For reference information see:


• Dashboards user interface (UI)

• Using Table gadget in Slideshow

For information on how to use Dashboards, see Dashboards.

© 2023 Schneider Electric. All Rights Reserved. 151


Dashboards Web Applications Guide

Dashboards references
This section contains reference information related to Dashboards.

Use the links below to find the content you are looking for:

Dashboards user interface (UI)


Using Table gadget in Slideshow
Styling a dashboard
Configuring Gadgets
Power Quality Performance events and disturbances

152 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Dashboards user interface (UI)


Main UI

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.

Dashboards display pane


2
Shows the Dashboard selected in the View Library.

Gadget Settings UI

© 2023 Schneider Electric. All Rights Reserved. 153


Dashboards Web Applications Guide

Gadget settings tabs


1 The tabs group the different setting options for the gadget. Different gadget types can have
different settings tabs and different settings options within those tabs.

Dashboard Settings

Options menu and Hide Library icon .


Contains options relevant to the Dashboard Library. The following options are available:
1 Add Dashboard
Add Folder
Slideshow Manager

154 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

© 2023 Schneider Electric. All Rights Reserved. 155


Dashboards Web Applications Guide

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.

156 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Using Table gadget in Slideshow


When you use the table gadget in slideshow, the slideshow in the new browser does not retrieve
the real-time data from devices in the system. To retrieve the real-time data, perform the
following:

1. Open a new tab in the browser.

2. Login to the PME web application.

3. Refresh the slideshow page in the browser.

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

© 2023 Schneider Electric. All Rights Reserved. 157


Dashboards Web Applications Guide

Styling a dashboard
To add an image to a dashboard, change its background color, or modify the opacity setting for
gadgets on the dashboard:

1. Click Styling to open the Dashboard Styling dialog.

2. To use an image for the background of the dashboard:


a. Under Background Image, click Select... to open the Image Library.

b. Select an image in the Image Library and click OK.

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.

3. To use a background color for the dashboard:


a. Select Background Color to enable the color palette.

b. Click the down arrow to open the palette and select a predefined color or click the color
gradient to select a color.

4. To change the opacity setting for the gadgets on the dashboard:


a. Select one of the opacity percentages in the list under Gadget Style.

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.

5. Click OK to close the dialog and apply the settings.

158 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

Gadget Type Category Data Type Licensing


Bar Chart Comparison Historical Base License
Energy Equivalency Comparison Historical Base License
Table Comparison Real-time Base License
Pie Chart Comparison Historical Base License
Period over Period Trend over Time Historical Base License
Trend Chart Trend over Time Historical Base License
Web Viewer Web Historical Base License
Energy Analysis
Aggregated
Usage Analysis Historical Dashboards Module
Consumption Ranking
License
Energy Analysis
Aggregated Pareto
Usage Analysis Historical Dashboards Module
Chart
License
Energy Analysis
Consumption Ranking Usage Analysis Historical Dashboards Module
License
Energy Analysis
Heat Map Usage Analysis Historical Dashboards Module
License
Energy Analysis
Pareto Chart Usage Analysis Historical Dashboards Module
License
Energy Analysis
KPI Usage Analysis Real-time Dashboards Module
License
Energy Analysis
Sankey Usage Analysis Historical Dashboards Module
License
Blank Space * Layout n/a Base License
Power Quality Incident PQ Performance
Power Quality Details Historical
Breakdown Module License
Power Quality Incident PQ Performance
Power Quality Details Historical
Impact Module License

© 2023 Schneider Electric. All Rights Reserved. 159


Dashboards Web Applications Guide

Gadget Type Category Data Type Licensing


Power Quality Incident PQ Performance
Power Quality Details Historical
Location Module License
Power Quality PQ Performance
Power Factor Impact Historical
Overview Module License
Power Factor Impact Power Quality PQ Performance
Historical
Trend Overview Module License
Power Quality PQ Performance
Power Quality Impact Historical
Overview Module License
Power Quality Impact Power Quality PQ Performance
Historical
Trend Overview Module License
Power Quality PQ Performance
Power Quality Rating Historical
Overview Module License
Power Quality Rating Power Quality PQ Performance
Historical
Trend Overview Module License

* 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:

Gadget Type Requirements


A rate must be defined in the Power Factor
Power Factor Impact Impact Rate file.
Power Factor Impact Trend A hierarchy view or a virtual meter must be
configured.

160 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Gadget Type Requirements

Power Quality Incident Breakdown


Power Quality Incident Impact Which devices to include/exclude for each
Power Quality Incident Location type of power quality event must be
Power Quality Rating configured.
Power Quality Rating Trend

An hourly rate for use in your production


Power Quality Impact
environment must be included in the Power
Power Quality Impact Trend
Quality Group configuration file.

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 Chart Chart Data Display Viewing


Equivalency Image
Settings Settings Type Series Settings Period
Bar Chart Y Y - Y Y - - Y
Energy
Y - - Y Y Y Y Y
Equivalency
Pie Chart Y Y Y Y Y - - Y

General Settings Content


Web Viewer Y Y

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

© 2023 Schneider Electric. All Rights Reserved. 161


Dashboards Web Applications Guide

General Chart Display Data Viewing Target


Axes
Settings Settings Settings Series Period Lines
Period over
Y Y Y Y Y Y Y
Period
Trend Chart Y 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

General Settings Sources PQ Group Viewing Period


Power Factor Impact Y Y - Y
Power Factor Impact Trend Y Y - Y
Power Quality Incident
Y Y - Y
Breakdown
Power Quality Incident Impact Y Y - Y
Power Quality Incident Location Y Y - Y
Power Quality Impact Y - Y Y
Power Quality Impact Trend Y - Y Y
Power Quality Rating Y Y - Y
Power Quality Rating Trend Y Y - Y

162 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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

© 2023 Schneider Electric. All Rights Reserved. 163


Dashboards Web Applications Guide

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.

The following icons appear on the chart:

A Reset Zoom (100%) - resets the chart to its default size.


Pan the chart - after you zoom in to an area of the diagram, click Pan
B the chart, then click and hold the left mouse button on the diagram
and drag it left or right.

164 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

Consumption Ranking Setup


Complete the options on this page as follows:

1. For Bars Orientation:


a. Select Horizontal to display a horizontal bar chart.

b. Select Vertical to display a vertical column 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.

3. For Sort Order:


a. Select Ascending to show the ranked columns in an ascending order from left to right.
The bars are displayed in an ascending order from top to bottom.

b. Select Descending to show the data in descending order.

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.

The URL should start with http or https.

© 2023 Schneider Electric. All Rights Reserved. 165


Dashboards Web Applications Guide

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

4. Display provides 2 display options for the gadget:


a. Select Scroll the content to enable scrolling for content that exceeds the width or
height of the display area in the gadget.

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:

1. Click Add to open the sources and measurements dialog.

2. Click a source name in the Sources area to select it.

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.

166 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

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.

NOTE: Smart Measurements are not available for gadget configuration.

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.

7. Click OK to close the dialog.

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:

1. Click Select Predefined Equivalency to open the Predefined Equivalencies dialog.

2. Select an item from the list of predefined equivalencies.

Default values are automatically entered in the fields on the Equivalency page.

© 2023 Schneider Electric. All Rights Reserved. 167


Dashboards Web Applications Guide

3. You can change the default values as follows:


a. Enter the Multiplier from Wh value to convert from the watt-hour values into the
equivalent measurement.

b. Select the Decimal Places to display for the equivalent value.

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.

e. Enter the Energy Equivalency Description to be displayed in the gadget.

General Settings
Complete the options on this page as follows:

1. Type a title for the gadget.

2. For Opacity, you can:


a. Leave the default option Use Dashboard Opacity selected.

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.

Heat Map Setup


Complete the options on this page as follows:

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.

3. For Heat Map Header:


a. Select Show Data Series Name to display data series name at the top of the Heat Map
chart.

b. Select Show Total to display a Total value at the top of the Heat Map chart.

168 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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:

1. Choose Sources or Measurements for the column headings in the table.

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.

Select specific measurements

1. Select one or more measurements in the Available Measurements area. The


measurements are added to the Selected Measurements list.

(Optional) Click Show Advanced to filter the measurements list by Type or popularity
(Show).

Select predefined measurements

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.

© 2023 Schneider Electric. All Rights Reserved. 169


Dashboards Web Applications Guide

2. Select a template and click OK to add the measurements associated with the template to the
Selected Measurements area.

Pareto Chart Setup


Complete the options on this page as follows:

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.

2. (Optional) Enable Simple Rendering to improve the display of large tables.

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.

Sankey Chart Setup


Complete the options on this page as follows:

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.

2. For Display Mode:


a. Select Automatic to display the gadget to the best available layout.

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.

3. For Unaccounted Values:


a. Select Display unaccounted values as nodes to display the unaccounted values as
nodes.

b. Enter the Node Label.

170 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

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.

b. Select Show Data Warning to display data warning messages.

c. Select Reverse Sankey Chart to reverse the chart from right to left.

5. For Font Size, select the font size of the nodes.

6. For Max Label Width, select the maximum label width of the node labels.

7. For Label Overflow:


a. Select Truncate long text to display the truncated text of the node labels.

b. Select Wrap long text to display the wrapped text of the node labels.

8. For Chart Size:


a. Select Manual to set the width and height. If you clear Manual selection, the chart size
is automatic.

b. Enter the Width and Height for manual chart.

Sources

NOTE: This gadget configuration page is applicable for Table gadget only.

Select the sources that you want to include in the table:

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.

2. Click a source in the Selected Sources area to remove it as selected.

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

Select the sources that you want to include in the table:

1. Select one or more sources in the Available Sources area. The sources are added to the
Selected Sources list.

© 2023 Schneider Electric. All Rights Reserved. 171


Dashboards Web Applications Guide

(Optional) Use the Search Sources... field to find sources or click Add All to select all
sources.

2. Click a source in the Selected Sources area to remove it as selected.

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

5. Click the Remove Target Line icon to delete it.

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

172 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

in the future. You can use any tool to generate future data. For example, use Manual Data
Editor to manually enter measurement data.

2. If aggregation options are available, select one of the available options.

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.

© 2023 Schneider Electric. All Rights Reserved. 173


Dashboards Web Applications Guide

Power Quality Performance events and disturbances


Events
Power Quality (PQ) events are short-term disturbances that are characterized by magnitude,
duration, and direction.

The following table provides definitions for the different PQ events:

PQ Events Summary Magnitude Source Duration Consequence


Loss of the ½ cycle to 1
Less than 10% Utility or
Interruptions supply minute or Downtime
of nominal facility
voltage more
Decrease in 90% to 10% of Utility or large
½ cycle to 1 Malfunction or
Voltage Sag voltage nominal voltage motors
minute downtime
magnitude (typical) starting
Increase in 110% to 180% Equipment
Utility or ½ cycle to 1
Voltage Swell voltage of nominal malfunction or
facility minute
magnitude (typical) damage
Potentially Switching
Short- Electronic
Transient several activities or <50 ns to 50
duration high equipment
Voltage thousands of lightning ms
overvoltage damage
volts and amps strikes
Sustained
110% to 120% Equipment
increase in Utility or More than 1
Over Voltage of nominal malfunction or
voltage facility minute
(typical) motor heating
magnitude
Sustained
80% to 90% of Equipment
Under decrease in Utility or More than 1
nominal malfunction or
Voltage voltage facility minute
(typical) damage
magnitude

Power Quality event classifications


The following image illustrates the classification of events in relation to a CBEMA chart. The
Power Quality Performance gadgets and reports follow this same color classification of Power
Quality Events.

174 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Dashboards

Percent of nominal No impact


A B C Transient D Swell
voltage region
Under
E Over Voltage F Sag G H Interruption
Voltage

Disturbances
Power Quality (PQ) disturbances are long-term disturbances.

The following table provides definitions for the different PQ 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

© 2023 Schneider Electric. All Rights Reserved. 175


Dashboards Web Applications Guide

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

176 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

For information on how use the Diagrams application, see:


• The Diagrams user interface

• User authentication

© 2023 Schneider Electric. All Rights Reserved. 177


Diagrams Web Applications Guide

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

178 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

The Diagrams user interface


The Diagrams user interface consists of a diagram display pane and a Diagram Library pane.

Diagrams display pane


The diagram display pane shows the diagram selected in the Diagram Library. The system
administrator can set a system default diagram that users see when they first log in.

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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 179


Diagrams Web Applications Guide

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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

180 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Viewing historical (trend) data


The Diagrams application provides a Web-based graphing utility for viewing historical data in the
diagrams. This utility allows you to select the date range and the data that you want to view.

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.

The data log table displays today's data by default.

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.

5. Click Show Graph.

6. Manipulate and control the displayed graph by doing the following:


a. To zoom in on the graph, left click and drag the mouse pointer around the portion you
want to zoom in on.

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

RMS waveform plotting


The Diagrams application plots the calculated root mean square (RMS) values for waveforms.
Related topics:
• The Diagrams user interface

• User authentication

© 2023 Schneider Electric. All Rights Reserved. 181


Diagrams Web Applications Guide

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

182 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Viewing meter events


You can view meter events in the diagrams, in a table format, using the Diagrams application.

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.

The meter events table displays today's data by default.

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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 183


Diagrams Web Applications Guide

Viewing user diagram of devices with security


You can view the user diagram of devices with security settings enabled in Diagrams application.

To view user diagram of the devices with standard security enabled:

1. Log in to Web Applications with username and password.

2. Navigate to Diagrams link.

The network diagram appears in the workspace containing icons that represent groups of
devices on your system.

3. Click Network Diagram.

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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

184 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Performing manual control actions

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.

To perform a control action:

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.

3. Provide any information requested by the confirmation dialog.

4. Click OK in the 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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

© 2023 Schneider Electric. All Rights Reserved. 185


Diagrams Web Applications Guide

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

186 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Stale data and error indicators


The Diagrams application uses the Vista stale data settings for its diagrams. Stale data and errors
are displayed in the browser as follows:
• A yellow border surrounding an object indicates stale data.

• An orange border surrounding an object indicates an error in communications, security


access, configuration, or other system error.

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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 187


Diagrams Web Applications Guide

Power Quality Performance diagrams


NOTE: These diagrams are part of the Power Quality Performance Module. This Module
requires a separate license. The module must be configured before the diagrams can be used.

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.

For details on the diagrams, see:


• Power Quality Performance Indicator diagrams

• Power Quality Performance Equipment diagrams

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

188 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 189


Diagrams Web Applications Guide

Power Quality Performance Indicator diagrams


Overview
The Power Quality Indicator diagrams show several power quality indicators. Each indicator
represents a different type of power quality event or disturbance. The indicators are color coded
and provide more detailed information when clicked.

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.

To open the landing page:

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.

Example landing page:

190 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

• Counts for events with Internal, External, and Undetermined origin.

• A log with event details.

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.

To open a details page:

On the landing page, click an event or disturbance to open the details page for that item.

Example details page:

© 2023 Schneider Electric. All Rights Reserved. 191


Diagrams Web Applications Guide

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.

To open an information page:

On a details page, click the information icon . Click X to return to the details page.

Example information page:

192 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

To open the setup page:

On the landing page, click the Setup icon . Click the Back icon to return to the landing
page.

Example setup page:

For details on the diagrams, see:


• Power Quality Performance Indicator diagrams

• Power Quality Performance Equipment diagrams

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

© 2023 Schneider Electric. All Rights Reserved. 193


Diagrams Web Applications Guide

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

194 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Power Quality Performance Equipment diagrams


Overview
The Power Quality Equipment diagrams show status and operational details about the power
quality equipment in your facility. The status indicators are color coded and provide more detailed
information when clicked.

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.

To open the landing page:

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.

Example landing page:

© 2023 Schneider Electric. All Rights Reserved. 195


Diagrams Web Applications Guide

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.

To open a group page:

On the landing page, click one of the equipment types. Click the Back icon to return to the
landing page.

Example group page:

196 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

3. Details page

This page shows detailed operational information for the equipment, including device status, and
maintenance indicators.

To open a details page:

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.

Click the Back icon to return to the landing page.

Example details page:

© 2023 Schneider Electric. All Rights Reserved. 197


Diagrams Web Applications Guide

For details on the diagrams, see:


• Power Quality Performance Indicator diagrams

• Power Quality Performance Equipment diagrams

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

198 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Insulation Monitoring diagrams


NOTE: These diagrams are part of the Insulation Monitoring Module. This Module requires a
separate license. The module must be configured before the diagrams can be used.

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

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 199


Diagrams Web Applications Guide

Insulation Monitoring diagrams for ANSI


The Insulation Monitoring module includes several diagrams that show the electrical status of the
areas and circuits that are being monitored.

This section describes each type of diagram.


See the following topics:
• Using the diagrams

• Data logs

Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

200 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Using the diagrams


The insulation monitoring diagrams display overview or detail information as well as status.

Facility Summary diagram


The Facility Summary diagram shows each group that contains a number of areas.

The Facilities Summary diagram shows all the groups of areas that were configured for the
facility. Each box in the main area represents a group of areas. This diagram provides a status
overview and links to areas in the facility, as shown next:

© 2023 Schneider Electric. All Rights Reserved. 201


Diagrams Web Applications Guide

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.

Example of an alarm indication:

C Areas Total number of monitored areas in this facility.

Recommended Actions for Alarm Condition Indication


1. Click the Group icon to open the Areas diagram. One or more area boxes will show an alarm
condition.

2. Click the specific area icons to open the Area Details diagrams. One or more panel boxes
will show an alarm condition. If the optional circuit fault locator devices are installed, the
panel box also indicates each circuit that has a resistance fault.

NOTE: Some types of electrical faults can occur and not be indicated by the individual
circuit fault locators. Only the area status indicator turns red. See Indicators for capacitive
faults for details.

3. Notify the responsible person that can address the condition for the area and specific
circuits.

Summary of Areas diagram


The Summary of Areas diagram shows an overview of each area in the facility. Each box
represents a single area.

Example:

202 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

LIM-IG6 in test mode:

© 2023 Schneider Electric. All Rights Reserved. 203


Diagrams Web Applications Guide

LIM-IG6 in alarm condition:

Area Details diagram


The Area Details diagram shows the details for each LIM-IG6 and connected devices in an area.
The Area Details diagram can show up to 3 LIM-IG6 monitors. If more than 3 monitors are in the
diagram, click the arrow in the upper right corner to see other monitors.

NOTE: For 208/240V systems, one LIM-IG6 can be shared between 2 areas. In this case, the
monitor appears on both area diagrams.

For example, the following image shows a diagram of the area and LIM-IG6 details:

204 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

© 2023 Schneider Electric. All Rights Reserved. 205


Diagrams Web Applications Guide

Measurements – Displays the real-time measurements for the components connected


to the LIM-IG6.
• Load – Optional. Displays the transformer load if the circuit transformer is
connected to the LIM-IG6. The status indicator turns red if the overload percentage
exceeds the threshold defined for the transformer.
• Volts L1 - L2 – Voltage between L1 and L2, in V.

• Volts L1 - Ground – Voltage between L1 and Ground, in V.

• Volts L2 - Ground – Voltage between L2 and Ground, in V.


B
• Impedance – Impedance Zf in kΩ.

• Resistance – Resistance Rf in kΩ.

• Leakage – Leakage capacitance in nF.

• Temperature – Optional. The status of the transformer temperature, according to


the over-temperature sensor. This appears only if the temperature sensor is
installed with the transformer. The value changes to red "High" if the temperature
exceeds the threshold.

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.

See examples below for indicators in test or alarm condition.

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.

Indicators for Test Mode and Alarm condition


LIM-IG6 in test mode, with circuit fault locators (left) and without circuit fault locators (right):

206 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

LIM-IG6 in alarm condition, with circuit fault locators (left) and without circuit fault locators (right):

Indicators for capacitive faults

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:

© 2023 Schneider Electric. All Rights Reserved. 207


Diagrams Web Applications Guide

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.

See the following topics:


• Using the diagrams

• Data logs

Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

208 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

Historical data log and graph


The following figure shows the historical log table.

The buttons located at the top of the table are:


• Device Diagram – Click this to return to the diagram.

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

© 2023 Schneider Electric. All Rights Reserved. 209


Diagrams Web Applications Guide

210 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Event Log
The following figure shows the event log table:

The buttons located at the top of the table are:


• Device Diagram – Click this to return to the diagram.

• Change Date Range – Click this to view data for different dates. See "Select Date Range"
below for more information.

Select date range:


For either type of log table, you can select the date range for data you want to see. The default
date range is "Today".

1. Click Select Date Range.

2. Select an available range or click Between these dates and select specific dates in the
calendar.

3. Click Show Table to see the data.

If you select a date range of more than one week, a message appears to inform you that the table
will be very long.

The new table appears.

© 2023 Schneider Electric. All Rights Reserved. 211


Diagrams Web Applications Guide

See the following topics:


• Using the diagrams

• Data logs

Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

212 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Insulation Monitoring diagrams for IEC


The Insulation Monitoring module includes several diagrams that show the electrical status of the
areas and circuits that are being monitored.

This section describes each type of diagram.


See the following topics:
• Using the diagrams

• Data logs

Different diagrams are provided for ANSI and IEC regulated applications:
• Insulation Monitoring diagrams for ANSI

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 213


Diagrams Web Applications Guide

Using the diagrams


The insulation monitoring diagrams display overview or detail information as well as status.

Facility Summary diagram


The Facility Summary diagram shows each group that contains a number of areas.

The Facilities Summary diagram shows all the groups of areas that were configured for the
facility. Each box in the main area represents a group of areas. This diagram provides a status
overview and links to areas in the facility, as shown next:

214 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

Example of an alarm indication:

C Areas – Total number of monitored areas in this facility.

Recommended Actions for Alarm Condition Indication


1. Click the Group icon to open the Areas diagram. One or more area boxes will show an alarm
condition. .

2. Click the specific area icons to open the Area Details diagrams. One or more panel boxes
will show an alarm condition. If the optional circuit fault locator devices are installed, the
panel box also indicates each circuit that has a resistance fault.

3. Notify the responsible person that can address the condition for the area and specific
circuits.

Summary of Areas diagram


The Summary of Areas diagram shows an overview of each area in the facility. Each box
represents a single area.

Example:

© 2023 Schneider Electric. All Rights Reserved. 215


Diagrams Web Applications Guide

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.

216 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

Status indicators in an alarm condition:

© 2023 Schneider Electric. All Rights Reserved. 217


Diagrams Web Applications Guide

Area Details diagram


The Area Details diagram shows the details for the insulation monitoring and fault locator devices.

Example:

The diagram shows the following details:

218 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Device Name – The group and name of the device in the area.

Insulation Monitoring Device Status – Green = Normal, Red = Alarm.


A Impedance – The real-time measurement of the impedance to ground, in kiloohms. If
the impedance is lower than the threshold, the indicator turns orange. The impedance
limit is set on the insulation monitoring device.
Transformer Indicators – The load and temperature status for the current transfer
• Load – If the current transformer load exceeds the threshold, this indicator turns red
and displays the real-time load percentage value.
B
• Temperature – If the current transformer temperature rises above the threshold,
this indicator turns red and the status changes to "High."

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.

Example of status indicators in an alarm condition:

© 2023 Schneider Electric. All Rights Reserved. 219


Diagrams Web Applications Guide

See the following topics:


• Using the diagrams

• Data logs

Different diagrams are provided for ANSI and IEC applications:


• Insulation Monitoring diagrams for ANSI

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

220 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

Historical data log


The following image shows the historical log table from the Power Monitoring Expert view:

The buttons located at the top of the table are:


• Device Diagram – Click this to return to the diagram.

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

© 2023 Schneider Electric. All Rights Reserved. 221


Diagrams Web Applications Guide

222 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Event Log
The following figure shows the event log table from the Power Monitoring Expert view:

The buttons located at the top of the table are:


• Device Diagram – Click this to return to the diagram.

• Change Date Range – Click this to view data for different dates. See "Select Date Range"
below for more information.

Select date range:


For either type of log table, you can select the date range for data you want to see. The default
date range is "Today".

1. Click Select Date Range.

2. Select an available range or click Between these dates and select specific dates in the
calendar.

3. Click Show Table to see the data.

If you select a date range of more than one week, a message appears to inform you that the table
will be very long.

The new table appears.

See the following topics:


• Using the diagrams

• Data logs

© 2023 Schneider Electric. All Rights Reserved. 223


Diagrams Web Applications Guide

Different diagrams are provided for ANSI and IEC applications:


• Insulation Monitoring diagrams for ANSI

• Insulation Monitoring diagrams for IEC

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

224 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

UPS Auto Test 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 UPS devices.

Diagrams
UPS Auto Test diagrams are organized into 3 levels:

1. Groups summary page

2. Group details page

3. Device details page

1. Groups summary page


This page shows a summary of the status for each UPS group.

Example groups summary page:

2. Group details page


This page shows details for each UPS device in the group.

TIP: Click the group icon for a group in the groups summary page to open the respective group
details page.

Example group details page:

© 2023 Schneider Electric. All Rights Reserved. 225


Diagrams Web Applications Guide

(The colored outline boxes around the measurements indicate that the diagram in this example is
not linked to an actual UPS device.)

3. Device details page


This page shows details for a specific UPS device.

TIP: Click a battery icon for a UPS in the group details page to open the respective device details
page.

Example 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

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

226 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 227


Diagrams Web Applications Guide

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:

1. Groups summary page

2. Group details pages

3. Device details pages

In addition, there are summary pages for all the generators and all the transfer switches in the
system.

1. Groups summary page


This page shows a summary for each EPSS group.

Example groups summary page:

2. Group details page


This page shows details for each generator and transfer switch device in the group.

TIP: Click the group icon for a group in the groups summary page to open the respective group
details page.

Example group details page:

228 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

(No data is shown in this example because the diagram is not linked to actual devices.)

3. Device details page


This page shows details for a specific generator or transfer switch device.

TIP: Click a device icon for a generator or transfer switch in the group details page to open the
respective device details page.

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

Example generator summary page:

© 2023 Schneider Electric. All Rights Reserved. 229


Diagrams Web Applications Guide

Example transfer switch summary page:

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

230 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

© 2023 Schneider Electric. All Rights Reserved. 231


Diagrams Web Applications Guide

Breaker Aging diagrams


NOTE: These diagrams are part of the Breaker Performance Module. This Module requires a
separate license. The module must be configured before the diagrams can be used.

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.

Group Summary Diagram


The group summary diagram shows the group summary status and the number of breakers in the
group, for each of the groups setup with the Breaker Configuration tool.

Example:

Group Details Diagrams


A group details diagram shows the switchboards that are part of the group and the breakers in
each switchboard.

TIP: Click the group icon for a group in the groups summary page to open the respective group
details page.

Example (shows details page for Group 1):

232 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Switchboard Details Diagrams


A switchboard details diagram shows detailed information for each breaker in the switchboard.

TIP: Click the switchboard icon for a switchboard in the group details page to open the device
details page.

Example (shows details for Panel A):

Related topics:
• The Diagrams user interface

• User authentication

• Viewing historical (trend) data

• Viewing meter events

• Viewing user diagram of devices with security

• Performing manual control actions

© 2023 Schneider Electric. All Rights Reserved. 233


Diagrams Web Applications Guide

• Stale data and error indicators

• Power Quality Performance diagrams

• Insulation Monitoring diagrams

• UPS Auto Test diagrams

• EPSS diagrams

• Breaker Aging diagrams

For information on how to configure Diagrams, see Diagrams and graphics configuration.

234 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Diagrams and graphics configuration


Use the Diagrams application to view real-time data in one-line and graphics diagrams.

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.

For information on how to configure the Diagrams application, see:


• Configuring Devices diagrams

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

© 2023 Schneider Electric. All Rights Reserved. 235


Diagrams Web Applications Guide

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

236 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Configuring Devices diagrams


Devices diagrams are device type specific diagrams for each configured device in the system.
Devices diagrams are created automatically when a new device is added to the system.

NOTE: You cannot delete Devices diagrams.

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

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

© 2023 Schneider Electric. All Rights Reserved. 237


Diagrams Web Applications Guide

Configuring a network diagram


Before you can view the network diagram in the Diagrams application, you must generate a
network diagram (network.dgm) in Vista. The Diagrams application uses the network diagram
generated in Vista for display in the browser. The network diagram is automatically added to the
Diagram Library, all you need to do is generate the network diagram in Vista, save it in the default
location, and then restart the Diagrams application.

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.

2. Click File > Generate network diagram.

3. Click File > Save.

Related topics:
• Configuring Devices diagrams

• Configuring a Network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

238 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Creating custom diagrams


You create a custom diagram for the Diagrams application with Vista. After you created the
diagram, you must add it to the Diagram Library in the Diagrams application to make it available
for viewing.
To create a diagram:

1. Open Vista and create a new diagram. Use the Vista tools to create display objects and
embedded graphics as applicable.

2. Save the diagram to ...\Power Monitoring Expert\config\diagrams\ud or any


subfolder in this location.

Related topics:
• Configuring Devices diagrams

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

© 2023 Schneider Electric. All Rights Reserved. 239


Diagrams Web Applications Guide

Set default options for a diagram


The default diagram is the one that is displayed when you first open Diagrams. You can set a
diagram to be your own personal default, or the default for the system.

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.

To set the default options for a diagram:

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.

3. Turn on one or both of Set as my default and Set as system default.

4. Click OK to save the modified Diagram Settings.

Related topics:
• Configuring Devices diagrams

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

240 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Set Diagrams control options

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.

Control in Diagrams is disabled by default.

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.

To enable or disable control in Diagrams:

1. Open the Settings page from the SETTINGS link in the Web Applications banner.

2. In the Settings Library select Security > Diagrams Control Options.

NOTE: Only supervisor-level users can access the Diagrams Control Options settings.

3. In Diagrams Control Options, enable or disable manual control in Diagrams.

4. Click Save.

To set the confirmation method:

NOTE: Control in Diagrams must be enabled for the confirmation method settings to be
displayed.

© 2023 Schneider Electric. All Rights Reserved. 241


Diagrams Web Applications Guide

1. Open the Settings page from the SETTINGS link in the Web Applications banner.

2. In the Settings Library select Security > Diagrams Control Options.

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.

Confirmation settings priority:

Control Object Setting Diagrams Setting Behavior


No Confirmation Confirmation Confirmation
No Confirmation Password Password
Confirmation Confirmation Confirmation
Confirmation Password Password
Password Confirmation Password
Password Password Password

Related topics:
• Configuring Devices diagrams

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

242 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

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.

To add a diagram to the library:

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.

4. Save the diagram.

To add a copy of an existing diagram to the library:

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.

4. Save the modified diagram settings.

To edit an existing diagram in the library:

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.

3. Save the modified Diagram Settings.

© 2023 Schneider Electric. All Rights Reserved. 243


Diagrams Web Applications Guide

To share an existing diagram in the library:

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.

4. Click OK to share this diagram.

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.

To move an existing diagram to a different location in the library:

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.

4. Click OK to move the diagram.

To delete a diagram from the library:

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

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

244 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Diagrams registry settings

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 registry keys are in HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Schneider


Electric\Power Monitoring Expert\2023\WebReach.
The following table lists the default Diagrams registry entries and settings.

Default Entries Default Settings Description


Timeout period for the autodiagram
components to communicate with the
AutoDiagramTimeout 20000 milliseconds
device and determine the appropriate
template to open.
Time limit for a diagram subscription to
update its timestamp. If the subscription is
ExpireTimeLimit 600 seconds
not updated within this time period, it is
considered expired and is removed.
HTTPRefreshInterval 10 seconds The web page refresh rate.
The name (tag) that the subscription
SubscriptionObject pmlitem:webreachstore: service uses to find Diagrams-related
information.
The part of the Web address that points to
VirtualDirectory ION the Diagrams-generated Vista diagrams
for displaying in the browser.
The real time data update rate on the web
XMLRefreshInterval 3000 milliseconds
page.

© 2023 Schneider Electric. All Rights Reserved. 245


Diagrams Web Applications Guide

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.

Optional Entries Default Settings Description


This value specifies the network diagram to
display as the homepage for Diagrams. The
x-pml:/diagrams/ud/ value can be a relative path, such as the
NetworkDiagram
network.dgm default setting, or it can be an absolute file
path (e.g.:
D:\customdiagrams\ud\networkB.dgm).
This value determines how long Diagrams
waits for the results of a query to return from
the database before timing out. If this registry
entry is not created or no QueryTimeout value
is specified, Diagrams times out after 60
seconds.
QueryTimeout See description.
This optional registry entry is useful if you
know that a query will take more than 60
seconds to return its results and you do not
want Diagrams to time out before then.
Specify a value that gives you enough time to
get your query results.

Related topics:
• Configuring Devices diagrams

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagram registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

246 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Configuring a custom network diagram for direct browser access


If you access the Diagrams pages directly from a browser, without the Web Applications
framework, you will not have access to the Diagram Library. In this case, Diagrams will
automatically display the default network diagram generated with Vista.

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.

1. Start Windows Registry Editor and navigate to:


HKEY_LOCAL_MACHINE\SOFTWARE\Schneider Electric\Power Monitoring
Expert\2023\WebReach
If the Diagrams application is run on a 64-bit operating system, navigate to:
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Schneider Electric\Power
Monitoring Expert\2023\WebReach

2. Right-click to add a new string value and name it “NetworkDiagram”.

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.

5. Restart IIS on your computer to apply the changes.

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.

© 2023 Schneider Electric. All Rights Reserved. 247


Diagrams Web Applications Guide

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.

3. Select the Action tab and select Open User Diagram.

4. Click Browse to locate your custom network diagram. Select the diagram filename, then
click Open.

5. Click OK to save your changes.

Related topics:
• Configuring Devices diagrams

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

248 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Configuring Power Quality Performance diagrams


NOTE: These diagrams are part of the Power Quality Performance Module. This Module
requires a separate license.

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

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

© 2023 Schneider Electric. All Rights Reserved. 249


Diagrams Web Applications Guide

Configuring Power Quality Performance diagrams for multiple sites


NOTE: These diagrams are part of the Power Quality Performance Module. This Module
requires a separate license.

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

• Configuring a network diagram

• Creating custom diagrams

• Set default options for a diagram

• Set Diagrams control options

• Diagram Library

• Diagrams registry settings

• Configuring a custom network diagram for direct browser access

• Configuring Power Quality Performance diagrams

• Configuring Power Quality Performance diagrams for multiple sites

For information on how to use Diagrams, see Diagrams.

250 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Diagrams

Changes in security settings of device


The security settings for the following device types have changed starting the firmware version
3.0.0:
• ION9000 series devices

• PM8000 series devices

• ION7400 series devices

The changes in the device security settings are:


• Standard security mode is removed

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

To perform control object function of diagram in Diagrams for an existing device


after firmware upgrade:
1. Enter the username and password. See Performing manual control actions for more
information.

© 2023 Schneider Electric. All Rights Reserved. 251


Reports Web Applications Guide

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.

252 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

For more information see:


• Reports UI

• Generating a report

• Downloading a report

Report templates
The default PME report templates cover a wide range of applications. The templates are grouped
into categories based on application. Choose the templates that best meet your reporting needs.
The following table shows the default templates and folders.

NOTE: Some report templates are part of add-on software modules for PME. Those reports are
enabled through the module licenses.

Category Template Licensing


- Generator Activity
- Generator Battery Health
- Generator Battery Health
Export Needs Backup Power Module
Backup Power
- Generator Load Summary license.
- Generator Test EPSS
- UPS Auto Test
- UPS Battery Health
- Billing
- Billing Summary
Needs Energy Billing Module
Billing - Billing Verification
license.
- Multiple Billing
- Multiple Billing Export
- Circuit Breaker Aging Needs Breaker Performance
Breaker Performance
- Circuit Breaker Settings Module license.
- Create Model
- Duration Curve
- Energy Regression Analysis
- Energy Usage per State
- KPI
Needs Energy Analysis Reports
Energy Analysis - KPI by TOU
Module license.
- Multiple Equipment Operation
- Power Usage Per State
- PUE Summary
- Single Equipment Operation
- Use Model

© 2023 Schneider Electric. All Rights Reserved. 253


Reports Web Applications Guide

Category Template Licensing


- Calendar Trend Month
- Calendar Trend Week
- Consumption Ranking
- Device Replacement
- Energy Comparison
- Energy Cost
- Energy Period over Period
Included in Base license, except
- Energy Usage
for Measurement Aggregation
- Energy Usage by Shift
Export and Measurement
Energy Management - Energy Usage by Time of Use
Statistics Export. Both of these
(TOU)
reports requires a Data
- Load Profile
Exchange Module license.
- Measurement Aggregation
- Measurement Aggregation
Export
- Measurement Statistics
- Measurement Statistics Export
- Profile
- Scaled Energy Usage
- 100 ms
- Continuous Thermal Monitoring
- Dashboard
- Dashboard - Portrait
General - Data Export - Extended Included in Base license.
- Data Export - Standard
- Event History
- System Configuration
- Tabular
- Insulation Monitoring (ANSI) Needs Insulation Monitoring
Insulation Monitoring
- Insulation Monitoring (IEC) Module license.
Needs Energy Billing Module
IT Billing - Energy by IT Customer
license.
- Branch Circuit Power
- Equipment Capacity
- Generator Capacity
- Generator Power Needs Capacity Management
Power Capacity
- Power Load Demand & Module license.
Capacity
- Power Losses
- UPS Power

254 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Category Template Licensing


- EN50160:2000
- EN50160:2000 Mains Signaling
- EN50160:2010
- EN50160:2010 Mains Signaling Included in Base license, except
- Harmonic Compliance for Power Quality Analysis and
- Harmonic Compliance 2014 Power Quality Impact. Both of
Power Quality
- IEC61000-2-4 these reports require a Power
- IEC61000-4-30 Quality Performance Module
- Power Quality license.
- SARFI
- Power Quality Analysis
- Power Quality Impact
- Hourly Usage
- Multi Device Usage
Usage Trending - Multiple Trend Included in Base license.
- Single Device Usage
- Trend

Use the following links to find the descriptions of the different report templates:

Backup Power Reports Insulation Monitoring Reports


Billing Reports IT Billing Reports
Breaker Performance Reports Power Capacity Reports
Energy Analysis Reports Power Quality Reports
Energy Management Reports Usage Trending Reports
General Reports

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.

For information on how to configure Alarms, see Reports configuration.

© 2023 Schneider Electric. All Rights Reserved. 255


Reports Web Applications Guide

Generating a report
Generate a report to view power monitoring system information.
To generate a report:

1. In Reports, open the Report Library and navigate to the report you want to generate.

2. Click the report name to display the report in the Reports Display pane.

3. Set the input parameters for the report and click Generate Report.

NOTE: Saved input parameters are preset to their saved values. Not saved input
parameters have generic default values.

4. The report output is displayed in the Reports Display pane.

Related topics:
• Generating a report

• Downloading a report

• Report descriptions

• Reports

• Reports UI

• Reports Terminology

For information on how to configure Reports, see Reports configuration.

256 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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:

1. In Reports, generate 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.

3. The report is downloaded in the selected format.

Related topics:
• Generating a report

• Downloading a report

• Report descriptions

• Reports

• Reports UI

• Reports Terminology

For information on how to configure Reports, see Reports configuration.

© 2023 Schneider Electric. All Rights Reserved. 257


Reports Web Applications Guide

Report descriptions
Use the following links to find the descriptions of the different report types:

Backup Power Reports Insulation Monitoring Reports


Billing Reports IT Billing Reports
Breaker Performance Reports Power Capacity Reports
Energy Analysis Reports Power Quality Reports
Energy Management Reports Usage Trending Reports
General Reports

Related topics:
• Generating a report

• Downloading a report

• Report descriptions

• Reports

• Reports UI

• Reports Terminology

For information on how to configure Reports, see Reports configuration.

258 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Backup Power Reports


NOTE: These reports are part of the Backup Power Module. This module requires a separate
license.

PME has the following backup power report templates:

Generator Activity Report Generator Load Summary Report


Generator Battery Health Report UPS Auto Test Report
Generator Battery Health Export Report UPS Battery Health Report
Generator Test EPSS 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.

© 2023 Schneider Electric. All Rights Reserved. 259


Reports Web Applications Guide

Generator Activity Report

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

• Include Activity Details

• Include Data Warnings

Example:

260 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 261


Reports Web Applications Guide

Generator Battery Health 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

• Select EPSS Group

• Exclude Sources

• Select Generator Starts

• Include Data Warnings

• Cumulative Degradation Threshold

262 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 263


Reports Web Applications Guide

Generator Battery Health Export 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

• Select EPSS Group

• Exclude Sources

• Select Generator Starts

• Cumulative Degradation Threshold

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

264 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Generator Test EPSS 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

• Use Run History

• Select Date Range

• ATS Summary

• Events Summary

• Generator Summary

• Comments

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 265


Reports Web Applications Guide

Example:

266 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 267


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

268 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Generator Load Summary 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

• Select EPSS Group

• Exclude Sources

• Use Run History

• Select Date range

• Reporting Period

• Include Electrical Details

• Include Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 269


Reports Web Applications Guide

Example:

270 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 271


Reports Web Applications Guide

UPS Auto Test 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

• Include Event History

• Include Data Warnings

272 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 273


Reports Web Applications Guide

UPS Battery Health 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

• Waveform Drop Percentage

• Waveform Drop Sample Size

• Recovery Value Multiplier

• Voltage Threshold

• Include Data Warnings

274 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 275


Reports Web Applications Guide

Billing Reports
NOTE: These reports are part of the Energy Billing Module. This module requires a separate
license.

PME includes the following billing report templates:


• Billing Report

• Billing Summary Report

• Billing Verification Report

• Multiple Billing Export Report

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

For information about changing the unit cost values in a rate file used for billing reports, see the
Rate Editor tool.

276 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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:

© 2023 Schneider Electric. All Rights Reserved. 277


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

278 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Billing Summary 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

• Tenants & Rates

• Reporting Period

• Tenant Filter

• Line Item Filter

• Save Billing Totals

• Keep True Totals

• Order By

© 2023 Schneider Electric. All Rights Reserved. 279


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

280 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Billing Verification 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

• Actual Bill Cost

• Alarm Threshold - Check Source vs Actual Total (%)

• Alarm Threshold - Check Source vs Private Source (%)

• Show Bill Details

• Notify On

• Email Address

• Email Subject

© 2023 Schneider Electric. All Rights Reserved. 281


Reports Web Applications Guide

Example:
Comparison summary page

Billing details page for internal source

282 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Billing details page for utility source

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 283


Reports Web Applications Guide

Multiple Billing Export 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

• Tenants & Rates

• Reporting Period

• XML Transform File

• XML Export File

• Overwrite XML Export

• Stylesheet (optional)

• Save Billing Totals

• Email XML Export

• Email Recipients (comma separated)

• Order By

284 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Multiple Billing Report

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

• Tenants & Rates

• Reporting Period

• Load Profile Measurements

• Previous Period Energy Measurement

• Energy Period Comparison Range

• Energy Period Rollup

• Align Day of Week for Months on Energy Chart

• Save Billing Totals

• Notes

• Order By

• Show Footer Image

© 2023 Schneider Electric. All Rights Reserved. 285


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

286 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Breaker Performance Reports


NOTE: These reports are part of the Breaker Performance Module. This module requires a
separate license.

PME includes the following breaker performance report templates:


• Circuit Breaker Aging Report

• Circuit Breaker Settings 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.

© 2023 Schneider Electric. All Rights Reserved. 287


Reports Web Applications Guide

Circuit Breaker Aging Report

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

• Include Breakers with Minor Aging and Wear

• Include Data Warnings

288 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 289


Reports Web Applications Guide

Circuit Breaker Settings 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

• Include Unassociated Breakers

• Baseline Date

• Circuit Breaker Inventory

• Trip Settings

• Protection Modes

• Maintenance Status

• Change Summary

• Include Data Warnings

290 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 291


Reports Web Applications Guide

292 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 293


Reports Web Applications Guide

Energy Analysis Reports


NOTE: These reports are part of the Energy Analysis Reports Module. This module requires a
separate license.

PME includes the following energy analysis report templates:


• Create Model Report

• Duration Curve Report

• Energy Regression Analysis Report

• Energy Usage Per State Report

• KPI Report

• KPI by TOU Report

• Multi Equipment Operation Report

• Power Usage Per State Report

• PUE Summary Report

• Single Equipment Operation Report

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

294 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Create Model Report

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

• Interval and Sub Model Configuration

• Use Exception Periods

• Show Detailed Results

• Save Model Configuration

Example:
See Model creation example

To calculate the models, PME uses the Accord Framework Library which can be found at:
http://accord-framework.net/index.html.

© 2023 Schneider Electric. All Rights Reserved. 295


Reports Web Applications Guide

Duration Curve Report

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

• Single Source – see Sources (Devices and Views)

• Measurement – see Measurements (with Smart Mode)

• n % Crossing

• Exclude Values Over

• Exclude Values Under

• Reporting Period

• Target Line

• Source Label

• Auto-scale Y-Axis

• Include Data Table

• Show Occurrences Chart

• Show Data Warnings

296 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 297


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

298 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Energy Regression Analysis 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

• Driver Data Source

• Driver Data Quantity

• Model Data Source

• Model Data Quantity

• Reporting Period

• Regression Type

• X Axis Calculation Method

• Degree Days Pivot Point

• Y Axis Calculation Method

• Aggregation Interval

• Exclude Incomplete Weeks

• Exclude Incomplete Days

• Exclude Days with Rollover

• Deviation Type

• Max Authorized Deviation

• Include Data Warnings

• Include Report Parameters Summary

© 2023 Schneider Electric. All Rights Reserved. 299


Reports Web Applications Guide

Example:

300 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 301


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

302 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Energy Usage Per State 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

• Energy Measurement Label

• State Measurement

• State Labels

• Rollup

• Aggregation Interval

• Auto-scale Y-Axis

• Include Data Table

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 303


Reports Web Applications Guide

Example:

304 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 305


Reports Web Applications Guide

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

• Input Source Measurements

• KPI Source

• KPI Measurement

• KPI Measurement Override

• KPI Formula

• Save Calculated Values

• Reporting Period

• Show Data Warnings

306 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 307


Reports Web Applications Guide

KPI by TOU 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

• Select Sources – see Sources (Devices and Views)

• Select Measurement – see Measurements (with Smart Mode)

• Multiplier

• Lower Limit - see Lower Target Line

• Upper Limit - see Upper Target Line

• Scale Source

• Scale Measurement

• Scale Multiplier

• Precision

• Custom Units Override

• Reporting Period

• Standard Deviation Calculation Period

• Rollup

• Select Time of Use

• Use Standard Deviation Target in Column Chart

• Show Average in Column Chart

• Standard Deviation Multiplier

• Chart Type

• Include Data Table

• Auto-scale Y-Axis

308 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

• Exclude Unscaled Values

• Show Data Warnings

• Notify On Target Value Exception

• Notify on Std Dev Exception

• Notify/Show Charts on Last Aggregated Interval Exception Only

• Show Charts with Exception Only

• Email Address

• Email Subject

• Source Label

Example:

© 2023 Schneider Electric. All Rights Reserved. 309


Reports Web Applications Guide

310 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 311


Reports Web Applications Guide

Multi Equipment Operation 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.

Report inputs (update)


• Title

• State Measurements

• State Labels

• Reporting Period

• Auto-scale Y-Axis

• Include Data Table

• Show Data Warnings

312 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 313


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

314 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Power Usage Per State 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.

Report inputs (update)


• Title

• Logged Measurement

• State Measurement

• State Labels

• Reporting Period

• Rollup

• Aggregation Type

• Show Min/Max Timestamps

• Auto-scale Y-Axis

• Include Data Table

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 315


Reports Web Applications Guide

Example:

316 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 317


Reports Web Applications Guide

PUE Summary 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

• Data Center Source

• Data Center Power Measurement

• Data Center Energy Measurement

• IT Equipment Source

• IT Equipment Power Measurement

• IT Equipment Energy Measurement

• PUE Category

• Report End Date

• Show Data Warnings

Example:

318 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 319


Reports Web Applications Guide

Single Equipment Operation 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.

Report inputs (update)


• Title

• State Measurement

• State Labels

• Reporting Period

• Rollup

• Auto-scale Y-Axis

• Include Data Table

• Show Data Warnings

320 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 321


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

322 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Use Model 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

• Choose a Model and a Reporting Aggregation Interval

• Display Mode

• Reporting Period

• Include Measured Data

• Enter an optional coefficient in % to be applied on the modeled data

• Insert Data

Example:

© 2023 Schneider Electric. All Rights Reserved. 323


Reports Web Applications Guide

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

324 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Energy Management Reports


PME includes the following energy management report templates:
• Calendar Trend Month Report

• Calendar Trend Week Report

• Consumption Ranking Report

• Device Replacement Report

• Energy Comparison Report

• Energy Cost Report

• Energy Period over Period Report

• Energy Usage Report

• Energy Usage by Shift Report

• Energy Usage by TOU Report

• Load Profile Report

• Measurement Aggregation Report

• Measurement Aggregation Export Report

• Measurement Statistics Report

• Measurement Statistics Export Report

• Profile Report

• Scaled Energy Usage 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.

© 2023 Schneider Electric. All Rights Reserved. 325


Reports Web Applications Guide

Calendar Trend Month Report


Summary
The Calendar Trend Month Report shows a daily demand profile for a load for each day of a
month. Use this report to see out-of-hours usage, benchmark performance targets, and to find
peak and off-peak usage patterns.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Single Source – see Sources (Devices and Views)

• Measurement – see Measurements (with Smart Mode)

• Start Hour

• End Hour

• Highlight Start

• Highlight End

• Reporting Period

• Target Line

• Source Label

• Display Zero Days

• Auto-scale Y-Axis

• Show Data Warnings.

Example:

326 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 327


Reports Web Applications Guide

Calendar Trend Week Report


Summary
The Calendar Trend Week Report shows a daily demand profile for a load for each day of the
week. Use this report to see out-of-hours usage, benchmark performance targets, and to find
peak and off-peak usage patterns.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Single Source – see Sources (Devices and Views)

• Measurement – see Measurements (with Smart Mode)

• Start Hour

• End Hour

• Highlight Start

• Highlight End

• Reporting Period

• Target Line

• Source Label

• Auto-scale Y-Axis

• Show Data Warnings.

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

328 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Consumption Ranking Report


Summary
The Consumption Ranking Report shows the relative ranking of energy consumption for one or
more loads. Use this report to gain an understanding of the operations of your facility or
processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Select Sources – see Sources (Devices and Views)

• Select Measurement – see Measurements (with Smart Mode)

• Multiplier

• Scale Source

• Scale Measurement

• Reporting Period

• Gauge Scale Override

• Select

• Select Number

• Custom Units Label

• Source Label

• Include Chart

• Include Gauges

• Include Tables

• Auto-scale Y-Axis

• Show Data Warnings.

© 2023 Schneider Electric. All Rights Reserved. 329


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

330 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Device Replacement Report


Summary
The Device Replacement Report shows the device last replacement date and the next date for
replacement. Use this report to understand and manage your device replacement operation.

Prerequisites
• The device must be configured in the Device Replacement Manager.

Report inputs
• Title

• Highlight Period - see Reporting Period

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 331


Reports Web Applications Guide

Energy Comparison Report


Summary
The Energy Comparison Report converts different types of energy measurements to a common
energy unit and then normalizes it by criteria, such as area. Use this report to benchmark building
or process energy performance.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Energy Measurements

• Energy Measurement Label

• Rollup

• Reporting Period

• Show Start & End Periods Only

• Chart Type

• Auto-scale Y-Axis

• Include Data Table

• Show Data Warnings

Example:

332 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 333


Reports Web Applications Guide

Energy Cost Report


Summary
The Energy Cost Report shows energy and demand cost based on time of use and flat rate
energy and demand charges. Use this report for internal cost allocation or utility bill verification.

Details
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

• Show Data Warnings

• Source Label

334 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 335


Reports Web Applications Guide

Energy Period over Period Report


Summary
The Energy Period over Period Report shows energy consumption for one or more loads for two
different time periods. Use this report to detect changes in consumption over time, for example
this month vs. the same month last year.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources

• Measurement

• Report Period (with additional options)

• Auto-scale Y-Axis

• Include Aggregation Chart

• Include Stacked Aggregation Chart

• Include Interval Line Trend

• Include Interval Column Trend

• Source Label

• Include Data Table

• Show Data Warnings.

Example:

336 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 337


Reports Web Applications Guide

Energy Usage Report


Summary
The Energy Usage Report shows energy consumption for one or more loads, rolled up by day,
week, month, or year. Use this report to compare energy consumption for different loads and gain
an understanding of the operations of your facility or processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Rollup

• Start Hour

• End Hour

• Lower Target Line

• Upper Target Line

• Source Label

• Include Column Chart

• Include Stacked Column Chart

• Include Line Chart

• Include Pie Chart

• Include 100% Area Chart

• Include Area Chart

• Include Gauges

• Auto-scale Y-Axis

• Show Data Warnings.

338 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 339


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

340 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Energy Usage by Shift Report


Summary
The Energy Usage by Shift Report shows energy consumption for one or more loads broken
down by shifts. Use this report to compare energy consumption for different loads and gain an
understanding of the operations of your facility or processes.

Details

NOTE: If you generate a report before the end of a shift that spans midnight, a portion of the
usage data for that shift is included under the equivalent shift for the current day.

Example:

1. You specify three 8-hour shifts:

Shift 1: 7:00 AM to 3:00 PM


Shift 2: 3:00 PM to 11:00 PM
Shift 3: 11:00 PM to 7:00 AM

NOTE: Shift 3 spans midnight (12:00 a.m.).

2. Your Reporting Period is Last 7 Days.

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

• Show Data Warnings

• Source Label

© 2023 Schneider Electric. All Rights Reserved. 341


Reports Web Applications Guide

Example:

342 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 343


Reports Web Applications Guide

Energy Usage by TOU Report


Summary
The Energy Usage by TOU Report shows energy consumption for one or more loads based on a
Time of Use (TOU) schedule. Use this report to compare energy consumption for different loads
and gain an understanding of the operations of your facility or processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Rollup

• Select Time of Use

• Lower Target Line

• Upper Target Line

• Source Target Line

• Measurement Target Line

• Chart Type

• Source Label

• Include Data Tables

• Auto-scale Y-Axis

• Show Data Warnings.

Example:

344 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 345


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

346 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Load Profile Report


Summary
The Load Profile Report shows demand or load levels, including peak demand, over the reporting
period. Use this report to understand the power consumption patterns of your facility or
processes.

Details
The Load Profile report template uses similar measurements as the Energy Cost report template
but does not use a TOU schedule.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources

• Measurements

• Reporting Period

• Include Data Table

• Auto-scale Y-Axis

• Target Line (kW)

• Target Line (kvar)

• Target Line (kVA)

• Source Label

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 347


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

348 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Measurement Aggregation Report


Summary
The Measurement Aggregation Report gives aggregated logged measurement data in tabular
format. The aggregation intervals are configurable, and the report supports aggregation by time of
use. Use this report to understand the consumption patterns of your facility or processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources

• Measurements

• Reporting Period

• Rollup

• Non Cumulative Measurement Calculation

• Apply Time of Use / Select Time of Use Schedule

• Source Label

• Rollup Table Type

• Show Totals

• Show Data Warnings.

• Show Header

Example 1 - Report output with Rollup set to Interval:

© 2023 Schneider Electric. All Rights Reserved. 349


Reports Web Applications Guide

Example 2 - Report output with Rollup set to Hour:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

350 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Measurement Aggregation Export 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

• Non Cumulative Measurement Calculation

• Apply Time of Use / Select Time of Use Schedule

• Include Empty Intervals

• Base Interval

• Export File Path

• Overwrite File

• Export Format

• Show Data Warnings.

Example - CSV output format:

© 2023 Schneider Electric. All Rights Reserved. 351


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

352 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Measurement Statistics Report


Summary
The Measurement Statistics Report gives a statistics of logged measurement data in tabular and
chart format. The statistics intervals are configurable and the report supports statistics by time of
use. Use this report to understand the consumption patterns of your facility or processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources

• Measurements

• Reporting Period

• Statistics Period

• Apply Time of Use / Select Time of Use Schedule

• Show Separate TOU Values For Non-Cumulative Measurements

• Include Chart

• Sort By

• Sort Order

• Source Label

• Show Data Warnings.

Example:

© 2023 Schneider Electric. All Rights Reserved. 353


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

354 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Measurement Statistics Export 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

• Apply Time of Use / Select Time of Use Schedule

• Show Separate TOU Values For Non-Cumulative Measurements

• Sort By

• Sort Order

• Export Data To - see Export File Path

• Source Label

Example:

© 2023 Schneider Electric. All Rights Reserved. 355


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

356 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Show Data Table

• Auto-scale Y-Axis

• Target Line

• Source Label

• Show Max Values With Charts

• Include Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 357


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

358 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Scaled Energy Usage Report


Summary
The Scaled Energy Usage Report shows the relative ranking of energy consumption for one or
more loads, rolled up by day, week, month, or year. Use this report to compare energy
consumption for different loads and gain an understanding of the operations of your facility or
processes.

Details
This report provides the same data as the Energy Usage Report and additionally sources and
measurements can be scaled with another source and measurement. The report also provides
tabular information with raw and normalized values of the measurements. All normalization
calculations are made at interval level. Each interval level is calculated individually to
accommodate for frequently changing scale date.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Select Sources – see Sources (Devices and Views)

• Select Measurement – see Measurements (with Smart Mode)

• Multiplier

• Scale Source

• Scale Measurement

• Reporting Period

• Rollup

• Start Hour

• End Hour

• Custom Units Label

• Lower Target Line

• Upper Target Line

• Source Label

• Include Column Chart

• Include Stacked Column Chart

• Include Line Chart

• Include Pie Chart

• Include 100% Area Chart

• Include Area Chart

• Include Gauges

© 2023 Schneider Electric. All Rights Reserved. 359


Reports Web Applications Guide

• Include Tables

• Auto-scale Y-Axis

• Show Data Warnings.

Example:

360 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 361


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

362 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

General Reports
PME includes the following general report templates:
• 100 ms Report

• Continuous Thermal Monitoring Report

• Dashboard Report

• Dashboard - Portrait Report

• Data Export - Extended

• Data Export - Standard

• Event History Report

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

© 2023 Schneider Electric. All Rights Reserved. 363


Reports Web Applications Guide

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

• Show Data Warnings

• Source Label

364 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 365


Reports Web Applications Guide

Continuous Thermal Monitoring Report


Summary
The Continuous Thermal Monitoring Report shows the status of the thermal monitoring system.
The thermal monitoring system includes Low Voltage Switchboards, Medium Voltage
substations, and Low Voltage Busways, which are equipped with temperature and environmental
sensors. The report shows the alarm status, communication error, and normal data points
information. Use this report to understand and manage the thermal monitoring system status.

Prerequisites
The thermal monitoring system must be connected to PME.

Report inputs
• Title

• Sources

• Reporting Period

• Show Data Warnings

• Include Chart

• Auto-scale Y-Axis

• Include Normal Values

• Source Label

• Pre Alarm Threshold (LV Busway)

• Alarm Threshold (LV Busway)

366 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 367


Reports Web Applications Guide

368 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 369


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

370 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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

• Custom Page Height

• Custom Page Width

• Slideshows

• Custom URL

• Page Wait Time in Seconds

• Show Header & Footer

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 371


Reports Web Applications Guide

Dashboard - Portrait Report


Summary
The Dashboard - Portrait Report shows screen captures of a dashboard slideshow in a portrait
page layout. Use this report to share dashboard and Web content in any of the supported report
formats, such as PDF and so on.

Details
You can include the screen capture of an additional, custom page by specifying the page URL.

TIP: Create separate slideshows for each dashboard page you want to report on.

Prerequisites
• A Dashboard slideshow must be configured.

Report inputs
• Title

• Page Size

• Custom Page Height

• Custom Page Width

• Slideshows

• Custom URL

• Page Wait Time in Seconds

• Show Header & Footer

• Show Data Warnings

372 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Data Export - Extended


Summary
The Data Export - Extended Report gives logged measurement data in CSV file format. Use this
report to import and analyze data in a third-party application, such as Microsoft Excel.

NOTE: This report has more details than the Data Export - Standard Report, but it supports a
smaller data set.

Details
The data is organized in columns labeled Timestamp UTC, Timestamp, Value, Source,
Measurement, and Unit. This makes it easier to create an Excel pivot table for analyzing the data
in the file. The data is listed for each source and measurement by date and in the specified time
segments for the data. This report can export 80 source measurements for 10 months.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Include Duplicates

Example:

© 2023 Schneider Electric. All Rights Reserved. 373


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

374 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Data Export - Standard


Summary
The Data Export - Standard Report gives logged measurement data in CSV file format. Use this
report to import and analyze data in a third-party application, such as Microsoft Excel.

NOTE: This report has fewer details than the Data Export - Extended Report, but it supports a
larger data set.

Details
The data is organized by column, with column A labeled Timestamp. The remaining columns are
labeled with the source name and measurement. The data is listed by date and in the specified
time segments for the data. This report can export 600 source measurements for 11 months.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Include Duplicates

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 375


Reports Web Applications Guide

Event History Report


Summary
The Event History Report gives a tabular list of event log entries for the selected sources. Use this
report to analyze system events, for example for root cause analysis or sequence of events
analysis.

Details
If no event has occurred that matches the inputs entered when generating the report, no data is
returned.

Prerequisites
• None

Report inputs
• Title

• Sources

• Reporting Period

• Show Data Warnings

• Priority

• Source Label

376 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 377


Reports Web Applications Guide

System Configuration Report


Summary
The System Configuration Report shows details about the monitoring devices in your network,
including communications information. Use this report for device and communications network
inventory and planning.

Prerequisites
• None

Report inputs
• Title

• Show Data Warnings.

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

378 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Source Label

• Include Duplicates

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 379


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

380 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Insulation Monitoring Reports


NOTE: These reports are part of the Insulation Monitoring Module. This module requires a
separate license.

PME includes the following insulation monitoring report templates:


• Insulation Monitoring Report (ANSI)

• Insulation Monitoring Report (IEC)

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.

© 2023 Schneider Electric. All Rights Reserved. 381


Reports Web Applications Guide

Insulation Monitoring Report (ANSI)

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

• Include Data Table

• Include Data Warnings

382 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Hospital Operating Room Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 383


Reports Web Applications Guide

Insulation Monitoring Report (IEC)

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

• Include Data Table

• Include Data Warnings

384 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Hospital Operating Room Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 385


Reports Web Applications Guide

IT Billing Reports
NOTE: These reports are part of the Energy Billing Module. This module requires a separate
license.

PME includes the following IT billing report templates:


• Energy by IT Customer 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.

386 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Energy by IT Customer Report

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:

© 2023 Schneider Electric. All Rights Reserved. 387


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

388 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Power Capacity Reports


NOTE: These reports are part of the Capacity Management Module. This module requires a
separate license.

PME includes the following power capacity report templates:


• Branch Circuit Power Report

• Equipment Capacity Report

• Generator Capacity Report

• Generator Power Report

• Power Load Demand & Capacity Report

• Power Losses Report

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

© 2023 Schneider Electric. All Rights Reserved. 389


Reports Web Applications Guide

Branch Circuit Power Report

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

• Include Data Warnings

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

390 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Equipment Capacity 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

• Show Daily Rollups

• Include Data Table

• Include Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 391


Reports Web Applications Guide

Example:

392 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 393


Reports Web Applications Guide

394 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 395


Reports Web Applications Guide

Generator Capacity 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)

• The generator capacity used/available.

• The redundancy levels (N-1, N-2, …).

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

• Include Data Table

• Include Data Warnings

396 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 397


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

398 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Generator Power 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

• Include Data Tables

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 399


Reports Web Applications Guide

Example:

400 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 401


Reports Web Applications Guide

Power Load Demand & Capacity 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

• Single Source – see Sources (Devices and Views)

• Measurement – see Measurements (with Smart Mode)

• Demand Rating kW

• Demand Adjustment (%)

• Show Data Warnings.

Example:

402 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 403


Reports Web Applications Guide

Power Losses 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

• Energy Cost (per kWh)

• Aggregation Data

• Include Data Tables

• Show Data Warnings

404 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 405


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

406 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

UPS Power 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

• Include Data Tables

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 407


Reports Web Applications Guide

Example:

408 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 409


Reports Web Applications Guide

Power Quality Reports


NOTE: The Power Quality Analysis and Power Quality Impact reports are part of the Power
Quality Performance Module. This module requires a separate license.

PME includes the following power quality report templates:


• EN50160:2000 Report

• EN50160:2000 Mains Signaling Report

• EN50160:2010 Report

• EN50160:2010 Mains Signaling Report

• Harmonic Compliance Report - Legacy

• Harmonic Compliance Report

• IEC61000-2-4 Report

• IEC61000-4-30 Report

• Power Quality Report

• SARFI Report

• Power Quality Analysis Report

• Power Quality Impact 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.

410 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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

• Supply voltage unbalance

• Harmonic voltage

• Interharmonic voltage

• Frequency

• Voltage magnitude

• Flicker

• Short- and long-term interruptions

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

• Include EN50160 Configuration Parameters

• Include Data Warnings

• Source Label

© 2023 Schneider Electric. All Rights Reserved. 411


Reports Web Applications Guide

Example:

412 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 413


Reports Web Applications Guide

EN50160:2000 Mains Signaling


Summary
The EN50160:2000 Mains Signaling Report shows an analysis of the compliance of selected
sources based on the mains signaling specifications of the EN50160:2000 power quality
standard. Use this report for an analysis and compliance assessment of your facility against the
EN50160:2000 power quality standard.

NOTE: This report needs data from monitoring devices with EN50160:2000 monitoring
capabilities.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs:
• Title

• Sources

• Signaling Voltage

• Reporting Period

• Show Data Warnings

• Source Label

414 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 415


Reports Web Applications Guide

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

• Supply voltage unbalance

• Harmonic voltage

• Interharmonic voltage

• Frequency

• Voltage magnitude

• Flicker

• Short- and long-term interruptions

Prerequisites
• The measurement data must be available as historical data logs in the database.

Prerequisites
The following firmware versions are required:

Device Firmware version


8650A_FAC_V4.2.0.0.1
ION8650 8650B_FAC_V4.2.0.0.1
8650C_FAC_V4.2.0.0.1
8000_FAC-PQ_V1.1.0.0.0
PM8000
8000_FAC_V1.1.0.0.0

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.

416 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Report inputs
• Title

• Sources

• Evaluation Limits

• Reporting Period

• Include EN50160 Configuration Parameters

• Include Data Warnings

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 417


Reports Web Applications Guide

EN50160:2010 Mains Signaling


Summary
The EN50160:2010 Mains Signaling Report shows an analysis of the compliance of selected
sources based on the mains signaling specifications of the EN50160:2010 power quality
standard. Use this report for an analysis and compliance assessment of your facility against the
EN50160:2010 power quality standard.

NOTE: This report needs data from monitoring devices with EN50160:2010 monitoring
capabilities.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Prerequisites
The following firmware versions are required:

Device Firmware version


8650A_FAC_V4.2.0.0.1
ION8650 8650B_FAC_V4.2.0.0.1
8650C_FAC_V4.2.0.0.1
8000_FAC-PQ_V1.1.0.0.0
PM8000
8000_FAC_V1.1.0.0.0

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

• Show Data Warnings

418 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 419


Reports Web Applications Guide

Harmonic Compliance Report - Legacy


Summary
The Harmonic Compliance Report shows an analysis of the harmonic compliance of selected
sources based on the IEEE 519-1992 standard. Use this report for an analysis and compliance
assessment of your facility against the IEEE 519-1992 harmonics standard.

NOTE: This report needs data from monitoring devices with IEEE 519-1992 monitoring
capabilities.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Reporting Period

• Comments

• Include THD/TDD Charts

• Include Average Harmonic Charts

• Include Harmonic Detail Charts

• Lock Chart Scales at Zero

• Show Data Warnings

Example:

420 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 421


Reports Web Applications Guide

422 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 423


Reports Web Applications Guide

Harmonic Compliance Report


Summary
The Harmonic Compliance Report shows an analysis of the harmonic compliance of selected
sources based on the IEEE 519-2014 standard. Use this report for an analysis and compliance
assessment of your facility against the IEEE 519-2014 harmonics standard.

NOTE: This report needs data from monitoring devices with IEEE 519-2014 monitoring
capabilities.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Reporting Period

• Comments

• Include THD/TDD Charts

• Include Average Harmonic Charts

• Include Harmonic Detail Charts

• Lock Chart Scales at Zero

• Show Data Warnings

Example:

424 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 425


Reports Web Applications Guide

426 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 427


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

428 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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 dips and short interruptions

• Voltage unbalance

• Temporary power-frequency variations

• Harmonics up to order 50

• Interharmonics up to the 50th harmonic

• 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

• Single Source – see Sources (Devices and Views)

• Environment Class

• Reporting Period

• Source Label

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 429


Reports Web Applications Guide

Example:

430 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 431


Reports Web Applications Guide

432 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 433


Reports Web Applications Guide

434 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 435


Reports Web Applications Guide

436 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 437


Reports Web Applications Guide

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.

The IEC61000-4-30 report shows the following types of information:


• Voltage profile

• 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

• Voltage Nominal [V]

• Frequency Nominal [Hz]

• Voltage Baseline [%]

• THD Baseline [%]

• Frequency Baseline [%]

• Unbalance Baseline [%]

• Flicker Baseline - High

• Flicker Baseline - Low

• Reporting Period

• Source Label

• Show Data Warnings

438 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 439


Reports Web Applications Guide

440 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 441


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

442 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Power Quality Report


Summary
The Power Quality Report shows the number and severity of voltage sags, swells, and transients
over a period of time. It includes waveform signatures and susceptibility curve plots, such as
CBEMA (1996), CBEMA (Updated), ITIC, or SEMI F47. Use this report to analyze power quality
(PQ) incidents, to assess possible impacts of PQ events on your facility or processes, and to help
identify causes of PQ events.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources

• Incident Interval

• Reporting Period

• Source Label

• CBEMA (1996), CBEMA (Updated), ITIC, SEMI F47 curves

• Y-Axis Max Value (% Nominal)

• Sub-reports

• Show Data Warnings

Additional information about incident details and waveform details.


Incident details:

When you use the Generate Dynamically sub-reports option, you can view details of an incident
by clicking the link in the TimeStamp column in the table.
Detailed information about a single power quality incident is displayed, including:
• A CBEMA (1996), CBEMA (Updated), ITIC, or SEMI F47 curve containing the power quality
disturbances for the selected incident. (The curve used in the plot is dependent on the overlay
options you select for the report.)
• The timestamps, types, phases, duration, and magnitude of disturbances in the selected
incident, with the worst event in the selected incident highlighted (worst event = largest
magnitude x duration).
• The power quality settings of the device that registered the disturbance (for example,
sag/swell limits, transient threshold, and so on).

To return to the summary report, use the report section back button on the report toolbar.

Waveform details:

When you use the Generate Dynamically sub-reports option, you can view the waveform details
of an incident by clicking the waveform icon in the incident details table in the Incident sub report.

The waveform details include all the waveforms that were recorded for a disturbance. It displays a
waveform chart along with an optional table with waveform values.

© 2023 Schneider Electric. All Rights Reserved. 443


Reports Web Applications Guide

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.

• An individual waveform plot for each of:


V1 and I1

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.

• The sampling frequency of the waveforms.

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:

444 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

© 2023 Schneider Electric. All Rights Reserved. 445


Reports Web Applications Guide

NOTE: This example only shows selected content from the report, it does not show the entire
report.

446 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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

• Sources (Devices and Views)

• Reporting Period

• Source Filter

• Duration (sec)

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 447


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

448 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Power Quality Analysis 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.

• Power Factor — Details, consisting of additional information on power quality disturbances.


The logged data represented in a trend chart is for each Incomer or main meter defined in the
PowerQualityGroups.csv file. The table below the chart shows Active and Reactive energy
data grouped by each power source meter. The red target line in the chart is set to 92 by
default on the report template page.

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.

© 2023 Schneider Electric. All Rights Reserved. 449


Reports Web Applications Guide

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

• Include Events and Disturbances in the Detail Section

• Power Factor Target

• Include Non Impacting Events

• Include Data Tables in the Detail Section

• Include Data Warnings

450 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

© 2023 Schneider Electric. All Rights Reserved. 451


Reports Web Applications Guide

452 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 453


Reports Web Applications Guide

Power Quality Impact 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

• Include Undetermined Events

• Include Data Warnings

454 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 455


Reports Web Applications Guide

Usage Trending Reports


PME includes the following usage trending report templates:
• Hourly Usage Report

• Multi Device Usage Report

• Multiple Trend Report

• Single Device Usage 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.

456 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Hourly Usage Report


Summary
The Hourly Usage Report shows the consumption rate, per hour, of various types of utilities, such
as electricity, water, and so on, for different consumers for a specific day. Use this report to check
and analyze resource consumption in your facility or processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Reporting Period

• Target Line

• Source Label

• Include Data Table

• Include Chart

• Auto-scale Y-Axis

• Show Data Warnings.

© 2023 Schneider Electric. All Rights Reserved. 457


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

458 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Multi Device Usage Report


Summary
The Multi Device Usage Report shows daily consumption for various types of utilities, such as
electricity, water, and so on, for different consumers. Use this report to check and analyze
resource consumption in your facility or processes.

Details

NOTE: The measurements that you select for the devices need to provide equivalent data
results. For example:

• Correct:

Real Energy selected for MeterA


Real Energy into the Load selected for MeterB
• Incorrect:

Real Energy selected for MeterA


Reactive Energy selected for MeterA

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

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Rollup

• Reporting Period

• Show Start & End Periods Only

• Source Label

• Chart Type

• Auto-scale Y-Axis

• Include Data Table

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 459


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

460 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Multiple Trend Report


Summary
The Multiple Trend Report shows aggregated logged measurement data from multiple loads in a
tabular and visual display and as a trend plotted on separate axes. The aggregation intervals are
configurable. Use this report to compare different loads.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources Left and Right– see Sources (Devices and Views)

• Measurements Left and Right– see Measurements (with Smart Mode)

• 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

• Calculation Method Left and Right

• Reporting Period

• Rollup

• Chart Type

• Source Label

• Show Summary Data Table

• Show Detailed Data Table

• Auto-scale Y-Axis

• Auto Scale Second Y Axis

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 461


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

462 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Single Device Usage Report


Summary
The Single Device Usage Report shows daily consumption of a certain type of utility, such as
electricity, water, and so on, for a certain consumer. It includes a trend display showing the daily
consumption side-by-side. Use this report to check and analyze resource consumption in your
facility or processes.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Single Source – see Sources (Devices and Views)

• Measurements (with Smart Mode)

• Rollup

• Reporting Period

• Source Label

• Show Start & End Periods Only

• Align Day of Week for Months

• Auto-scale Y-Axis

• Show Data Warnings

© 2023 Schneider Electric. All Rights Reserved. 463


Reports Web Applications Guide

Example:

NOTE: This example only shows selected content from the report, it does not show the entire
report.

464 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

• Keep or change the default selections for the parameters.

• Save the updated report to overwrite the existing version.

Prerequisites
• The measurement data must be available as historical data logs in the database.

Report inputs
• Title

• Sources (Devices and Views)

• Measurements (with Smart Mode)

• Chart Type

• Reporting Period

• Source Label

• Target Line

• Auto-scale Y-Axis

• Include Data Table

• Include Duplicates

• Show Data Warnings.

© 2023 Schneider Electric. All Rights Reserved. 465


Reports Web Applications Guide

Example:

466 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

NOTE: This example only shows selected content from the report, it does not show the entire
report.

© 2023 Schneider Electric. All Rights Reserved. 467


Reports Web Applications Guide

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

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

468 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

© 2023 Schneider Electric. All Rights Reserved. 469


Reports Web Applications Guide

Setting Reports prerequisites


Before you can use Reports, you need to specify the database to use for reporting, and you need
to configure the delivery options for report subscriptions. These settings are defined in
Management Console.
To set the prerequisites:

1. Open Management Console and select Tools > Reports Configuration to open the dialog.

2. Click the Reports tab to configure general reporting options:


From the dropdown list in the Reports Database section, select the database on which
to run reports. Only those databases and database archives compatible with Reports
are listed.

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

Port: Type the port address used by your SMTP server.

Use SSL: Select this option to encrypt your user credentials.

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.

4. Click OK to save your changes.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

470 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

© 2023 Schneider Electric. All Rights Reserved. 471


Reports Web Applications Guide

Meeting individual report requirements


Different reports have different data requirements. These requirements must be met before you
can generate the report. For details on specific report requirements, see Report descriptions.
Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

472 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Adding a new report


Add new reports to meet your needs for reporting on specific data or for specific report formats.
For example, create reports for power quality, energy consumption, power demand, breaker
monitoring, and many other applications.
To add a new report:

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.

7. Click Save in Report Settings to save the report.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

© 2023 Schneider Electric. All Rights Reserved. 473


Reports Web Applications Guide

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

474 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

4. Save the report.

NOTE: You cannot copy report templates.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

© 2023 Schneider Electric. All Rights Reserved. 475


Reports Web Applications Guide

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.

4. Save the report.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

476 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

4. Click OK to move the report.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

© 2023 Schneider Electric. All Rights Reserved. 477


Reports Web Applications Guide

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.

NOTE: You cannot delete report templates.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

478 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

To share a saved report:

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.

4. Click OK to share this report.

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

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

© 2023 Schneider Electric. All Rights Reserved. 479


Reports Web Applications Guide

For information on how to use Reports, see Reports.

480 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

To subscribe to an individual report:

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.

3. Continue with step 4 in "To subscribe to multiple reports" below.

To subscribe to multiple reports:

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.

NOTE: This creates subscriptions for all the selected reports.

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.

To install Microsoft Access Database Engine 2016 Redistributable:


a. Open the Command Prompt.

b. Run accessdatabaseengine_X64.exe /quiet.

6. Under Delivery Mode, select one of the following delivery options:

Email: Click Recipients to open the Distribution List dialog.


The dialog has two tabs: Users/Groups and Manual Entry. You can use both tabs to
select and type email addresses, respectively. They are not mutually exclusive.

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

© 2023 Schneider Electric. All Rights Reserved. 481


Reports Web Applications Guide

alphabetically by group then by user.


Ensure that email addresses are defined in User Manager for the users.
Select the users or groups that you want as the recipients of the generated report.
Click OK when you complete your selections.

Manual Entry tab


If you click the Manual Entry tab, type the email address of a recipient and click Add to
include the recipient's email address in the Current subscription recipients area.
Repeat this step for each recipient.
To remove an email address from the Current subscription recipients area, click an
address and then click Remove.
Click OK when the list is complete.

Email Subject field


(Optional) Type the text you want to include as the subject line in the email that is sent to
the recipients.

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

482 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

9. Click Save to save the subscription.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

© 2023 Schneider Electric. All Rights Reserved. 483


Reports Web Applications Guide

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

484 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Changing a report subscription


Change report subscriptions to update the subscription properties such as subscription name,
output format, delivery mode, or subscription schedule.
To change a report 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, 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

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

© 2023 Schneider Electric. All Rights Reserved. 485


Reports Web Applications Guide

Deleting a report subscription


Delete report subscriptions that are no longer needed.
To delete a report 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, find the subscription you want to delete. All existing subscriptions
are displayed in the subscriptions table.

3. Click Delete Subscription to delete the subscription. Click OK in the confirmation


dialog.

4. Click Close.

Related topics:
Reports:
• Setting Reports prerequisites

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

486 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Uploading a Report Template


Upload custom Report Templates to generate Reports that are not available by default in the
software.

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

• Meeting individual report requirements

• Adding a new report

• Copying a report

• Editing a report

• Moving a report

• Deleting a report

• Sharing a report

Subscriptions:
• Subscribing to a report

• Changing a report subscription

• Deleting a report subscription

Other
• Changing the Reports theme

• Uploading a Report Template

• Configuring the Energy Modeling report

• Reports UI

For information on how to use Reports, see Reports.

© 2023 Schneider Electric. All Rights Reserved. 487


Reports Web Applications Guide

Configuring the Energy Modeling report


Before you can use the modeling report, you must first create a model for your facility or process
with the Create Model Report. This model is then used in the Use Model Report. You only use the
Create Model report during configuration. After the model has been created, you do not need to
run this report again, unless you want to create a new model.
To create a model and use the Energy Modeling report:

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

2. Based on the results, define sub-models and exception periods, if applicable.

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:

1. In Modeling Configuration, select the Sub-Models tab.

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.

The Condition must be a valid SQL query statement.

488 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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 .

Defining exception periods


Exception periods are special time intervals, such as holidays, with unpredictable consumption
behavior that is different from the rest of the time period. Exception periods can be defined down
to a specific time interval for a specific source and measurement.

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:

1. In Modeling Configuration, select the Exception Periods tab.

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.

The Condition must be a valid SQL query statement.

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.

© 2023 Schneider Electric. All Rights Reserved. 489


Reports Web Applications Guide

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 .

See a Model creation example.

490 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Reports references
This section contains reference information related to Reports.

Use the links below to find the content you are looking for:

Report input parameters


Model creation example
Interpreting the Energy Regression Analysis Report results
UPS Battery Health Report calculations
Reports UI
Reports Icons
Reports Terminology

© 2023 Schneider Electric. All Rights Reserved. 491


Reports Web Applications Guide

Report input parameters


The report input area opens when you select a report in the Report Library. You must specify the
necessary input parameters before you can generate the report. For saved reports, some or all
the input parameters may already be specified.

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.

Actual Bill Cost


(Optional) Enter a billing amount, for example from a utility issued bill, which will be compared to
the calculated bill value from the reference source. Set to 0 to ignore.

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.

Alarm Threshold (LV Busway)


Enter the alarm threshold value for Low Voltage Busway devices. This input represents an alarm
value that is used by the report to show the alarm threshold information.

Alarm Threshold - Check Source vs Actual Total (%)


(Optional) Set the notification threshold, in %, for the billing difference between the Check source
and the Actual Total. Set to 0 to ignore.

492 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Alarm Threshold - Check Source vs Private Source (%)


(Optional) Set the notification threshold, in %, for the billing difference between the Check source
and the Private source. Set to 0 to ignore.

Align Day of Week for Months


When the Aggregation Interval is Month, selecting Yes includes the data in the table by day of
week (Sun, Mon, Tues, and so on). Selecting No includes the data in the table by the day of the
month (1, 2, 3, and so on). The default is Yes.

Align Day of Week for Months on Energy Chart


Select Yes to show the data for the Previous Period Energy Measurement chart by day of
week (Sat, Sun, Mo, ...) when a monthly rollup period is selected. Select No to show the data by
day of month (1, 2, 3, ...).

Apply TOU Schedule


Select if you want to use a time of use (TOU) schedule with this report. If you want to use a TOU
schedule, select a TOU schedule from the list. The list shows the existing TOU schedules that are
configured in the system. If you have not created a TOU schedule, the field shows that no
schedule is available.

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.

5. Click OK to save your changes and return to the report template.

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.

© 2023 Schneider Electric. All Rights Reserved. 493


Reports Web Applications Guide

Auto-scale Second Y-Axis


Select whether or not to scale the chart normally. Selecting No, sets the starting point of the
second (right) 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.

Calculation Method (Left and Right)


Select the aggregation method to be used for rolling up both cumulative and non cumulative
measurements. Examples of non cumulative measurements include Voltage, Current, and
Power. An example of a cumulative measurement is Energy. Cumulative measurements are
aggregated by summation.

CBEMA (1996), CBEMA (Updated), ITIC, SEMI F47 curves


Click Yes for the power quality curve (CBEMA (1996), CBEMA (Updated), ITIC, or SEMI F47) that
you want to show in the incident plots. Click No to hide the curve.

You can select one or more of the curves.

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.

Choose a Model and a Reporting Aggregation Interval


Select the model you want to use for the report from the Model drop-down list.

Select the aggregation interval you want to use for the report from the Reporting Aggregation
Interval drop-down list. The options available in this drop-down list depend on the selected
model.

Circuit Breaker Inventory


Click Yes to include the Inventory section of the report. Click No to not include it. The default is
Yes.

494 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

Cumulative Degradation Threshold


Enter the value that represents the maximum total voltage difference between the reference
waveform and the evaluated waveforms. For example, if the waveform is off by 1.0 on each point
from the reference, the total degradation is 10. If the threshold value is 8, then the degradation
exceeds the threshold.

Custom Page Height


Specify a custom output page height. This value is ignored if Page Size is set to Fit to Page.

Custom Page Width


Specify a custom output page width. This value is ignored if Page Size is set to Fit to Page.

Custom Units Label


Enter any text to be used as the measurement label for instances when normalization is used , for
example, kWh/Person. The default is kWh.

Custom URL
(Optional) Specify the URL for any page or image that you would like to include in the report. This
could be a page from an external or internal website, or a local image.

Customers
Click Select Customers. Select the customers that you want to include in the report from the list.
Click Select All to select all the customers from the list. Click None to deselect all the customers.
Click OK.

Data Center Energy Measurement


Click Select Measurement to choose the measurement for interval energy usage for the entire
data center. This will typically be a 15-minute interval value.

Data Center Power Measurement


Click Select Measurement to choose the measurement for instantaneous power consumption
for the entire data center.

Data Center Source


Click Select Source to choose a single source to represent the entire data center facility.

Degree Days Pivot Point


The Degree Days Pivot Point is the point where either heating or cooling is required to keep the
temperature within the designated degree range.

© 2023 Schneider Electric. All Rights Reserved. 495


Reports Web Applications Guide

Demand Adjustment (%)


Enter a multiplier, in %, to apply to the load measurements. For example, a demand adjustment of
125% applied to a load measurement of 100 kW, results in an adjusted load measurement of 125
kW. The default value is 125.

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.

To specify the dependent variable,

1. Click Select Source and select a device from the Devices list or a Hierarchy node from the
Views list.

2. Click Select Measurement and select the measurement to be modeled.

3. Select an aggregation method for the measurement from the Aggregation Method drop
down list.

The following aggregation methods are available:

AVG: calculates the average measurement value over the interval.


SUM: adds up the measurement values over the interval.
DELTA: subtracts the beginning measurement value from the end measurement value of
the interval.

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.

The following display modes are available:

496 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

Display Zero Days


Select whether or not to show days where data is logged but the values are all zero. Note that
days with no logged values at all are still included in the report. The default is No.

Driver Data Quantity


Click Select Measurement. Navigate to and select a measurement, and then click OK.

Driver Data Source


Click Select Source, and then choose from the dropdown list a Grouping: None, Group Name,
Site, or Device Type. Navigate to and select a source, and then click OK.

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 Recipients (comma separated)


Enter a comma-separated list of email addresses to which to email the transformed XML.

Email Subject
Enter the subject line for the notification emails.

Email XML Export


Select Yes to email the transformed XML output ('XML Export File') to the addresses specified in
Email Recipients.

End Hour
Select the end hour to display when filtering the data by the time of day.

The time range in the list is in 24-hour format in descending order.

Energy Cost per kWh


Enter the appropriate value for the blended cost of energy. This value is used in the calculations
for the cost of losses in the report. Only numeric values with up to two decimal places will be used
in the report.

The currency symbol used to display the cost values is set in Web Applications SETTINGS >
Personalization > System Language.

© 2023 Schneider Electric. All Rights Reserved. 497


Reports Web Applications Guide

Energy Measurement Label


Type a label to describe the measurements selected in Energy Measurements.

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.

2. Under Load, click Select Source to open the Source Selector.

The Source Selector dialog provides options to show Devices or Views.

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.

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.

c. If required, enter a Multiplier value.

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.

4. (Optional) Use Normalization to normalize measurement values.


a. In Label, enter the normalization label value.

b. In Value, enter the value that you want to normalize.

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.

Energy Period Comparison Range


Select the reporting period for the Previous Period Energy Measurement.

498 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Select the reporting period from the dropdown list. The timeframe options in the timeframe
dropdown are relative to the date the report is run. To run a report that starts and ends in the past,
select the fixed date option. Type a start and end date in the date boxes or click the arrows beside
the dates to display a pop-up calendar and select a date. Type a time in the time boxes or click the
up and down arrows beside the time to adjust the hours or minutes up or down.

Select the timezone you want to view timestamps in.

Energy Period Rollup


Select the aggregation time interval for the Previous Period Energy Measurement data.

Enter an optional coefficient in % to be applied on the modeled data


(Optional) Enter coefficients that are applied to the modeled data to adjust the model output
based on known or expected changes.

For example, if you implemented an energy conservation measure on June 1, 2016 for which you
are expecting an energy saving of 15%, enter -15 as a coefficient and June 1, 2016 as the start
date from which to apply it on. All modeled data, starting with that date, will be adjusted by -15%.
You can add multiple coefficients at multiple dates. Coefficients are applied cumulatively, on top
of any previously applied coefficients.

To specify a coefficient,

1. Enter the coefficient value in percent, including the sign, in the text box.

2. Enter the date on which this coefficient takes effect into the date box.

To add additional coefficients, click the + sign next to the coefficient text box. Click - to remove a
coefficient.

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.

© 2023 Schneider Electric. All Rights Reserved. 499


Reports Web Applications Guide

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.

5. Click OK to save your changes and return to the report template.

Exclude Days with Rollover


Exclude days that contain rollover from the report.

Exclude Incomplete Days


Exclude days that are incomplete from the report.

500 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Exclude Incomplete Weeks


Exclude weeks that are incomplete 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 >>.

c. Click OK to save the sources and return to the report template.

The devices in the group appear in the Sources section of the generated report. Excluded devices
appear as grayed-out entries.

Exclude Unscaled Values


Select whether or not to show the zero values, which can not be scaled in the data table of the
generated report. The default is No. If a scaling Source and Measurement pair is selected but for
some of the rolled up intervals (Aggregation + Time of Use), these values cannot be calculated
because of divide by zero error. In this case these values will be set to zero.

Exclude Values Over


Enter a value to indicate the point at which values over this number are not plotted in the chart.
The default value is No Exclusions.

Exclude Values Under


Enter a value to indicate the point at which values over this number are not plotted in the chart.
The default value is No Exclusions.

Export File Path

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, including file name: C:\Temp\test.

© 2023 Schneider Electric. All Rights Reserved. 501


Reports Web Applications Guide

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:

• CSV (RepGen compatible)

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.

Flicker Baseline - High


Type the Flicker Baseline High value if the default is not appropriate for your needs.

Flicker Baseline - Low


Type the Flicker Baseline Low value if the default is not appropriate for your needs.

502 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Frequency Baseline [%]


Type the Frequency Baseline value if the default is not appropriate for your needs.

Frequency Nominal [Hz]


Type the nominal frequency of the system (for example, 60).

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.

© 2023 Schneider Electric. All Rights Reserved. 503


Reports Web Applications Guide

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

Generator start and stop times by date

A label to indicate whether the data was collected automatically or manually.

A table of measurements; such as battery voltage and coolant temperature. Each


measurement includes a timestamp and the corresponding values.

8. Click OK to save your changes and return to the report template.

Gauge Scale Override


Choose a specific value for all of the gauge scales to use in custom situations, such as when
normalizing data. This input is optional.

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.

High Target Line (Left and Right Axis)


Enter a value for the target line representing the target for the high end of your energy use. This
target line is red in the generated report. The default is No Target Line.

High Target Name (Left and Right Axis)


Enter a name to identify the high target line in the chart legend for the left and right axis,
respectively. The defaults are Left Axis High Target and Right Axis High Target, respectively.

Highlight End
Select the end hour to stop the highlighting of the line in the chart.

504 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

The time range in the list is in 24-hour format in descending order.

Highlight Start
Select the start hour to begin the highlighting of the line in the chart.

The time range in the list is in 24-hour format in ascending order.

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 Activity Details


Click Yes to include a generator details section in the report. Click No to exclude this section.

Include Aggregation Chart


Select whether or not to include a bar chart in the generated report showing a summary of the
measurement you chose for the selected sources. The default is Yes.

Include 100% Area Chart


Select whether or not to include an area chart showing the data results stacked to a 100% level.
The default is Yes.

Include Area Chart


Select whether or not to include an area chart in the generated report to view the contribution of
data over a given period of time.

Include Average Harmonic Charts


Select whether or not to include charts showing the average values related to harmonic
compliance. The default is Yes.

Include Breakers with Minor Aging and Wear


Select Yes or No. Selecting Yes allows all of the breakers to appear in the report regardless of the
current electrical aging and electrical wear levels. Selecting No allows only breakers with
moderate or critical electrical aging and electrical wear to appear.

Include Chart
Select whether or not to include the chart in the generated report. The default is Yes.

Include Column Chart


Select whether or not to include a column chart in the generated report to compare the data
represented in the chart. The default is Yes.

Include Data Table


Select whether or not to show the data table in the generated report. The default is No.

© 2023 Schneider Electric. All Rights Reserved. 505


Reports Web Applications Guide

Include Data Tables


Click Yes to include a section for capacity data in the report. Click No to exclude capacity data.

Include Data Tables in the Detail Section


Select whether or not to show data table for power quality events in the generated report. The
default is No.

Include Data Warnings


Click Yes to include data warnings in the report. If there are none, the section is not included.
Click No to exclude this section.

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.

Include Electrical Details


Select the option to specify the start records. When you click Select Reference Starts you can
choose the specific start records by generator and date. For example, you can use this option to
compare yesterday's Gen 1 start voltage signature to the Gen 1 start voltage signature from six
months prior.

Include Empty Intervals


Select to include or exclude data records in the report output that have no data. If Rollup is
Interval, an empty data record will be shown as an empty row or column in the table with the
corresponding interval timestamp. This can be useful for data exporting to avoid missing rows.

Include EN50160 Configuration Parameters


Select whether or not to include the configuration inputs entered in the Configure Evaluation
Limits dialog in the generated report.

Include Event History


Click Yes to include event log data in the report. Click No to exclude it.

Include Events And Disturbances in the Detail Section


Click the field to open the Events and Disturbances dialog. By default, all items under Events and
Disturbances are selected, as well as Power Factor.

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.

506 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Include Harmonic Detail Charts


Select whether or not to include charts showing a second level of harmonic compliance detail for
the generated report. The default is No.

Include Interval Column Trend


Select whether or not to include a bar chart in the generated report showing the measurement you
chose for the sources for each hour in the 24-hour period for the specified days. The default is
Yes.

Include Interval Line Trend


Select whether or not to include a line chart in the generated report showing the measurement
you chose for the sources for each hour in the 24-hour period for the specified days. The default is
No.

Include Line Chart


Select whether or not to include a line chart in the generated report to display the data trend over a
given time period. The default is Yes.

Include Measured Data


Choose to include the actual data with the modeled data or not by selecting Yes or No for Include
Measured Data.

Include Non Impacting Events


Select Yes if you want to include events in the Power Quality Events — Details section of the
generated report that are classified as having no impact on the power quality of your site. By
default, power quality events with no impact are excluded from the generated report.

Include Normal Values


Select whether or not to show the normal values in the generated report. The default is Yes.

Include Pie Chart


Select whether or not to include a pie chart in the generated report to show a numerical proportion
of the results. The default is Yes.

Include Report Parameters Summary


Select whether or not to include report parameters in the generated report. The default is Yes.

Include Stacked Aggregation Chart


Select whether or not to include a stacked chart in the generated report showing the
measurement you chose for the selected sources. The default is No.

Include Stacked Column Chart


Select whether or not to include a stacked column chart in the generated report to display the
proportions for the data represented in the chart. The default is Yes.

Include Tables
Select whether or not to include the tables in the generated report. The default is Yes.

© 2023 Schneider Electric. All Rights Reserved. 507


Reports Web Applications Guide

Include THD/TDD Charts


Select whether or not to include charts showing the total harmonic distortion (THD) of the voltage
waveform, and the total demand distortion (TDD) of the current waveform, in the generated
report. The default is Yes.

Include Two Specific Periods Only


Select whether or not to include only the first and last period of data in the selected date range.
The default is No.

Include Unassociated Breakers


Include breakers that are not defined as being part of Switchboards and Groups in the report. The
default is Yes.

Include Undetermined Incidents


This option represents the number of events that cannot be classified as External or Internal.
Select Yes or No to include or exclude the data for these events from the generated report.

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.

To specify the independent variables,

1. Click Select Source and select a source from the list. Hierarchies are not supported for
independent variables.

2. Click Select Measurement and select the measurement.

3. Select an aggregation method for the measurement from the Aggregation Method drop
down list.

The following aggregation methods are available:

AVG: Calculates the average measurement value over the interval.


SUM: Sums the measurements values over the interval.
DELTA: Subtracts the beginning measurement value from the end measurement value of
the interval.
MIN: Selects the minimum measurement value over the interval.
MAX: Selects the minimum measurement value over the interval.
CDD: Calculates the Cooling Degree Days.
HDD: Calculates the Heating Degree Days.

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.

508 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Input Source Measurements


Select one or more measurements and their sources, to be used in the calculation of the KPI.
Each measurement is associated with a label, for example A,B,C, ... which you use to define the
KPI formula.

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:

Measured: This is a copy of the dependent variable measured data.


Modeled Data: This is the data calculated by the model for the dependent variable.
Residual: This is the delta between the Measured data and the Modeled data
Residual%: This is the Residual data in percent.

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.

Interval and Sub Model Configuration


Select the reporting interval from the Interval drop-down list.

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 Energy Measurement


Click Select Measurement to choose the measurement for interval energy usage for all the IT
equipment used. This will typically be a 15-minute interval value.

IT Equipment Power Measurement


Click Select Measurement to choose the measurement for instantaneous power consumption
for all the IT equipment used.

© 2023 Schneider Electric. All Rights Reserved. 509


Reports Web Applications Guide

IT Equipment Source
Click Select Source to choose the single source that represents all the IT equipment operated in
the data center facility.

Keep True Totals


Select Yes if you want the totals in the report to be unaffected by the filtering. If you want the totals
in the report to be based on line item and tenant filter, select No.

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().

Here are some examples of valid formula syntax:


• (A + B) / C

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

KPI Measurement Override


Only use this input if you cannot find a suitable measurement under KPI 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.

Line Item Filter


Anything entered in the Line Item Filter parameter (comma separated) includes rows from the
Item column. For example, to include the On Peak Usage line item, enter On Peak Usage in the
Line Item Filter. To include both On and Off Peak usage, enter Peak Usage.

Load Measurement
Select the source you want.

510 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Load Profile Measurements


Select one or more measurements to be displayed in a trend chart at the end of each bill. The
measurements are associated with the selected tenants. The date range for the chart is the same
as the selected reporting period.

Lock Chart Scales at Zero


Select whether or not to force the y-axis to start at zero rather than scaling the chart normally. The
default is Yes.

Logged Measurement
1. Click Select Source to open the Source Selector dialog.

2. Select the source and then click OK.

3. Click Select Measurement to open the Measurement Selector dialog.

4. Select the instantaneous measurement (power, power factor, current, THD, etc.) and then
click OK.

Low Target Line (Left and Right Axis)


Enter a value for the target line representing the target for the low end of your energy use. This
target line is yellow in the generated report. The default is No Target Line.

Low Target Name (Left and Right Axis)


Enter a name to identify the low target line in the chart legend for the left and right axis,
respectively. The defaults are Left Axis Low Target and Right Axis Low Target, respectively.

Lower Target Line


Enter a value for the target line representing the target for the low end of the energy use. The
lower target is a yellow line in the report. Columns in charts that are on lower target line, or
between the lower target line and the upper target line, are outlined in yellow. The default value is
0.

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.

© 2023 Schneider Electric. All Rights Reserved. 511


Reports Web Applications Guide

Max Authorized Deviation


Enter a value by which deviation is allowed for the report.

Measurement Label
Input the label to be used to describe the measurements selected in Load Measurement.

Measurements (Reports other than Load Profile)


Use this input to select the measurements you want to include in the report.

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.

After selecting the measurements, click OK.

Measurements (with Smart Mode)


Smart Mode is enabled in the Measurement Selector when you select the Views radio button in
the Source Selector, which then lets you select a hierarchy view or a virtual meter for your
source parameter.
When you open the Measurement Selector, Smart Mode lists general measurement names by
default. A Detailed Mode option is also available for the measurements.

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.

512 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

You can select Detailed to change to the detailed selection mode. This mode allows you to select
from a full list of measurements.

Smart Mode Detailed Mode

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.

After selecting the measurements, click OK.

© 2023 Schneider Electric. All Rights Reserved. 513


Reports Web Applications Guide

Measurements (Load Profile Report)


This input determines whether the report is calculated using demand or power measurements.
Select either Demand or Power from the dropdown list.

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.

Measurement Target Line


Select a measurement to use with the source identified in Source Target Line to establish ON
and OFF peak target lines in the generated report.

Model Data Quantity


Click Select Measurement. Navigate to and select a measurement, and then click OK.

Model Data Source


Click Select Source, and then choose from the dropdown list a Grouping: None, Group Name,
Site, or Device Type. Navigate to and select a source, and then click OK.

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

No notification email will be sent.


• Both

Send a notification email if either alarm threshold is exceeded.


• Check Source vs Actual Total

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.

Notify on Std Dev Exception


Select a notification option for when to send out notification emails. The available options are:
• Do Not Notify

No notification email will be sent.

514 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

• Both Upper and Lower

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.

Notify On Target Value Exception


Select whether or not to send out notification emails whenever the calculated value of aggregated
interval exceeds the specified static target value. The default is No.

Notify/Show Charts on Last Aggregated Interval Exception Only


Select whether or not to send out notification emails and show in charts whenever the last
aggregated interval exceeds the specified target lines. The default is No. The last interval is the
absolute last aggregated interval in the selected reporting period, regardless whether data exists
for that period.

Notes
Any notes appear at the bottom of the report page.

Non Cumulative Measurement Calculation


Select the aggregation method to be used for rolling up non cumulative measurements. Examples
of non cumulative measurements include Voltage, Current, Power. An example of a cumulative
measurement is Energy. Cumulative measurements are aggregated by summation.

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.

© 2023 Schneider Electric. All Rights Reserved. 515


Reports Web Applications Guide

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.

Specifying a reporting period of a single day or less.

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.

Overwrite XML Export


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.

Page Wait Time in Seconds


Specify the maximum time the report waits for the slideshow or custom URL to load. If you
selected multiple slideshows, then this maximum wait time is applied to each of the slideshows. If
a slideshow or URL loads faster than the maximum wait time, the report completes before this
time has elapsed.

Power Factor Target


The target power factor for the site. The default target is 92, which you can change to match you
site power factor target.

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.

Pre Alarm Threshold (LV Busway)


Enter the pre alarm threshold value for Low Voltage Busway devices. This input represents a pre
alarm value that is used by the report to show the pre alarm threshold information.

Precision
Enter the decimal value precision to use in report output and saved values.

516 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Previous Period Energy Measurement


Select one or more usage measurements. These measurements will be displayed in a column
chart, as past consumption for the selected tenants, at the end of each bill. The reporting period
for these measurements is set through the Energy Period Comparison Range input.

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.

© 2023 Schneider Electric. All Rights Reserved. 517


Reports Web Applications Guide

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.

Recovery Value Multiplier


Enter the multiplier value from 0.01 to 1.00. This value is used by the algorithm to determine the
waveform recovery voltage value and time (relative to the waveform voltage drop) for both
reference and comparison waveforms.

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.

2. Select one or more generator systems.

3. Click OK.

Report Data Generators


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.

2. Select one or more generator systems.

3. Click OK.

Report Data UPS


Select one or more system configurations to use in the report:

1. Click Select UPS Systems. The Selector screen appears with the UPS systems you set up
in the UPS Power Configuration Utility.

2. Select one or more UPS systems.

3. Click OK.

518 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Report End Date


Select either Today or Fixed Date for the data you want to generate in the report. If using Fixed
Date, enter the desired date.

Select either Server Local Time or UTC (Coordinated Universal Time).

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.

Select the timezone you want to view timestamps in.

Reporting Period (with additional options)


The Reporting Period input contains the following fields and dropdown lists:
• Timezone: Select whether you want to view timestamps in either Server Local Time or UTC
(Universal Coordinated Time).
• Aggregation Period: Select the block of time for which you want to compare data (i.e., day,
week).
• Comparison Type: Select what period of data you want to compare the selected
Aggregation Period to (i.e., today vs. the same day from the previous month or current month
vs. the same month from the previous year). The options vary depending on the Aggregation
Period selected.
• Number of Comparisons: Enter the number of periods you want to compare.

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

© 2023 Schneider Electric. All Rights Reserved. 519


Reports Web Applications Guide

Reporting Period (for Power Quality report)


Use this input to select the timeframe for the data you want to view in the report. The report
retrieves all events over the duration of the reporting period. The events are summarized into
incidents and displayed on the report according to the Incident Interval setting.

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.

Examples of Custom Day

Example 1: Default Custom Day

520 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Example 2: Custom Start of Day set as 6 AM

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.

© 2023 Schneider Electric. All Rights Reserved. 521


Reports Web Applications Guide

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.

Rollup Table Type


Select the format for the report data table. The available options are:
• Horizontal Rollup Table

The data is shown with sources and measurements as columns and timestamps as rows.
Example:

• Vertical Rollup Table

The data is shown with timestamps and measurements as columns and sources as rows.
Example:

• Demand and Consumption Rollup Table

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:

522 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

• Flat Rollup Table

The data is shown with the source name, measurement name, timestamp, value, and so on,
in a single row per data record.
Example:

Save Billing Totals


Save Billing Totals calculates the billing total per Tenant (Source) and writes the value back into
the database so that it can be used in other applications, such as Dashboards, Diagrams or
Reports.

Save Calculated Values


Click No to preview the report outputs without saving them to the database. Click Yes to save the
report outputs in the database.

The report overwrites any values, for this KPI, that already exist in the database from previous
report runs.

Save Model Configuration


Choose to save the created model to the database or not by selecting Yes or No for Safe Model
Configuration.

For saving the model, enter the model name in the Model Name input box that is displayed when
Yes is selected for Safe Model Configuration.

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.

Select Date Range


Select this if you want to select the runs according to a date range and run reason, and then do
the following:

© 2023 Schneider Electric. All Rights Reserved. 523


Reports Web Applications Guide

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 EPSS Group


Select the group for which the report is intended.

Select Generator Starts


Select the option to specify the start records. When you click Select Reference Starts you can
choose the specific start records by generator and date. For example, you can use this option to
compare yesterday's Gen 1 start voltage signature to the Gen 1 start voltage signature from six
months prior.

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 Time of Use


Select a TOU schedule to use for the report. Existing time of use schedules are shown in the list. If
you have not created a time of use schedule, the field shows that no time of use schedule is
available.

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.

3. Define the comparison waveforms using one of the following:


Click Enter the number of comparison waveforms and enter a value in the field.

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.

Click Select the comparison waveforms, then click Select Comparison


Waveforms, select the check box next to the waveforms you choose, and then click
OK.

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.

524 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

Show all Power Quality Events in Details


Select whether or not to show the Power Quality event details in the generated report. The default
is No.

NOTE: To show all Power Quality events, the Show Event Details must be set to Yes.

Show Average in Column Chart


Select whether or not to show an additional line in each chart representing the average of that
series in the generated report. The default is No.

Show Bill Details


Click Yes to include the comparison summary page and the individual bills for the source and the
reference source in the report output. Click No to only include the comparison summary page in
the report output.

Show Charts with Exception Only


Select Yes to show charts which contain any aggregated intervals that exceeds the specified
cause target value. If Notify/Show Charts on Last Aggregated Interval Exception Only is set
to Yes, only charts which exceeds the target value in the Last interval is shown.

Show Daily Rollups


Click Yes to include the Time of Use interval selections for non-cumulative measurements. If you
click No, the report excludes the Time of Use interval selections. For cumulative measurements,
the Time of Use interval selection is always considered.

Show Data Warnings


Click Yes to include data warnings in the report. If there are none, the section is not included.
Click No to exclude this section.

Show Detailed Data Table


Select whether or not to show the detailed data table in the generated report. The default is No.

Show Detailed Results


Choose to include details in the report or not by selecting Yes or No for Show Detailed Results.

Details include the calculated formulas and individual relationship between each driver and the
sub model data.

Show Errors
Click Yes to include error messages in the report, or No to exclude them.

Show Event Details


Select whether or not to show the event details in the generated report. The default is No.

© 2023 Schneider Electric. All Rights Reserved. 525


Reports Web Applications Guide

Show Footer Image


Select Yes to show an image instead of the Notes at the bottom of each bill. Select No to show
the Notes instead of an image.

NOTE: The report displays the image file BillingFooter.jpg in


...\Web\ReportDepot\ION Reports\ION Report Packs\Billing Reports\ if it
exists. There is no image provided by default. Create your own image and save it under the
above name in the specified location.

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.

Show Header & Footer


Click Yes to include the standard report header and footer in the report. Click No to not include the
standard report header and footer in the report.

The standard report header includes the logo, report title, and report generation information.

Show Max Values With Charts


Select the options to show the maximum values for each chart. The available options are
• Show All Max Values (Default)

• Show First Max Value

• Do Not Show Max Values

Show Occurrences Chart


Click Yes to include an Occurrences chart in the report. Click No to exclude this chart.

Show Report Parameters Summary


Select whether or not to show report parameters in the generated report. The default is Yes.

Show Separate TOU Values For Non-Cumulative Measurements


Click Yes to include the Time of Use interval selections for non-cumulative measurements. If you
click No, the report excludes the Time of Use interval selections. For cumulative measurements,
the Time of Use interval selection is always considered.

Show Start & End Periods Only


Select to show or not in the report the start and end periods. The default is No.

Show Summary Data Table


Select whether or not to show the summary data table in the generated report. The default is No.

Show Totals
Select to include or exclude totals columns or rows in the data tables.

526 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Show Min/Max Timestamps


Click Yes to include the report period timestamps. Click No to exclude them.

Signaling Voltage 1, 2 and 3 Eval Limit [%]


Type the maximum percentage of intervals in an observation period in which the mean value of
the signaling voltage can exceed the curve defined in the EN50160 standard before that mains
signaling voltage is considered non-compliant.

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.

After selecting the devices, click OK.

Sources (Devices and Views)


The Source Selector dialog provides options to show Devices or Views:

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.

After selecting the devices, click OK.

© 2023 Schneider Electric. All Rights Reserved. 527


Reports Web Applications Guide

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.

Sources (for Power Quality report)


(Optional)Use this input to select the devices you want to include in the report.

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.

Source Target Line


Select a source to use with the measurement selected in Measurement Target Line to establish
ON and OFF peak target lines in the generated report.

Standard Deviation Calculation Period


Use this input to select the timeframe, for which standard deviation is calculated. The selected
timeframe should be within the reporting period timeframe.

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.

Select the timezone you want to view timestamps in.

Standard Deviation Multiplier


Enter a value to adjust the width of the standard deviation banding. The default is 1.

Start Hour
Select the start hour to display when filtering the data by the time of day.

The time range in the list is in 24-hour format in ascending order.

528 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

For each state that you want to include in the report:

1. In the Value field, enter a state value.

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.

4. (Optional) Click - to delete a state label.

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.

1. Click Select Source to open the Source Selector dialog.

2. Select the source and then click OK.

3. Click Select Measurement to open the Measurement Selector dialog.

4. Select the equipment state measurement and then click OK.

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.

1. Click Select Source to open the Source Selector dialog.

2. Select the source and then click OK.

3. Click Select Measurement to open the Measurement Selector dialog.

4. Select the equipment state measurement and then click OK.

Depending on how your state measurements are configured, the equipment state
measurement could be grouped under "Miscellaneous" or "Custom".

5. (Optional) Click + and add another source measurement pair.

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.

© 2023 Schneider Electric. All Rights Reserved. 529


Reports Web Applications Guide

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.

Technical knowledge of XML, XSLT, and HTML is recommended.

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.

Target Line (kW)


Enter a value for the location of the target line in the kW chart in the generated report. The default
is 0.

Target Line (kvar)


Enter a value for the location of the target line in the kvar chart in the generated report. The default
is 0.

Target Line (kVA)


Enter a value for the location of the target line in the kVA chart in the generated report. The default
is 0.

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.

Tenant (multiple selection)


Click Select Source to open the Source Selector dialog. Select a view name or Virtual Meter in
the View dropdown list. Select one or more tenant names, one or more devices under a tenant
name, or one or more virtual meters. Click OK to add your selections to the report.

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.

530 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Tenants and Rates


To select a group of tenants that share the same rate, click Select Sources to open the source
selector dialog. Select a view name or Virtual Meter in the View drop-down list. Select one or
more tenant names, one or more devices under a tenant name, or one or more virtual meters.
Click OK to add your selections to the report.

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.

THD Baseline [%]


Type the THD Baseline value if the default percentage is not appropriate for your needs.

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.

Unbalance Baseline [%]


Type the Unbalance Baseline value if the default percentage is not appropriate for your needs.

Upper Target Line


Enter a value for the target line representing the target for the high end of your energy use. The
upper target is a red line in the report. Columns in charts that on or above the upper target line are
outlined in red. The default value is 0.

UPS Group
Add the UPS groups that you want to include in the report.

Use Exception Periods


Choose to use exception periods or not by selecting Yes or No for Use Exception Periods.

© 2023 Schneider Electric. All Rights Reserved. 531


Reports Web Applications Guide

Use Run History


Click Use Run History to select the most recent run, or select other specific runs that are stored
in history, and then do the following:

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.

Use Standard Deviation Target in Column Chart


Type the Voltage Baseline value if the default percentage is not appropriate for your needs.

Voltage Baseline [%]


Type the Voltage Baseline value if the default percentage is not appropriate for your needs.

Voltage Nominal [V]


Type the nominal voltage of the system (for example, 120).

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.

Waveform Drop Percentage


Enter a percentage value from 1.00 to 100.00. This input value represents the percentage that is
used by the algorithm to detect the first voltage drop in the reference and comparison waveforms.

Waveform Drop Sample Size


Enter a value for this sample size. This input represents the number of waveform samples (or
points) - from 2 to a total number of waveform samples (for example, 1024, 2048, and so forth) -
used by the algorithm in the detection of the waveform voltage drop for the reference and
comparison waveforms.

X Axis Calculation Method


Choose from the dropdown list one of the following methods: Cooling Degree Days, Heating
Degree Days, Average, Sum, or Delta.

XML Export File


Type the name of the XML output file (including the file share or physical path) that is created after
the XML transform has been applied. For example: C:\bill_
report\MonthlyBillingDataMain.xml.

XML Transform File


Select the XML transform (xslt) file (via file share or physical path) to transform the default XML
output into a specific format.

Technical knowledge of XML and XSLT is recommended.

532 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Y Axis Calculation Method


Choose from the dropdown list one of the following methods: Average, Sum, or Delta.

Y-Axis Max Value (% Nominal)


Choose one of the available percentage values to visually increase the level of detail above the
nominal value. The percentage value that you select sets the maximum vertical axis in the
incidents plot. The default value is 500%.

© 2023 Schneider Electric. All Rights Reserved. 533


Reports Web Applications Guide

Model creation example


The following example shows the process of creating a model for use with the Use Model Report.
It shows the steps for creating a basic model and then improving it iteratively.

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.

Model creation run 1


The dependent variable is the electrical Real Energy (kWh) measurement for the HVAC system of
the building. The independent variables are the outside temperature and humidity.

We use the following inputs for the Create Model report:

Title Create Model Report


Source = HVAC - Fans and Compressors
Dependent Variable Measurement = Real Energy (kWh)
Aggregation Method = SUM
Source = Victoria.Weather
Measurement = Weather Temperature (°C)
Aggregation Method = AVG
Independent Variable(s)
Source = Victoria.Weather
Measurement = Weather Relative Humidity (%)
Aggregation Method = AVG
Reporting Period 1/1/2017 - 12/31/2017, Server Local Time
Interval and Sub Model Interval = Week
Configuration Sub Model = No Sub Model
Use Exception Periods No
Show Detailed Results No
Save Model Configuration No

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:

534 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

For the next run, we use a Daily aggregation method.

Model creation run 2


We change the Interval to Day.

We use the following inputs for the Create Model report:

Title Create Model Report


Source = HVAC - Fans and Compressors
Dependent Variable Measurement = Real Energy (kWh)
Aggregation Method = SUM

© 2023 Schneider Electric. All Rights Reserved. 535


Reports Web Applications Guide

Title Create Model Report


Source = Victoria.Weather
Measurement = Weather Temperature (°C)
Aggregation Method = AVG
Independent Variable(s)
Source = Victoria.Weather
Measurement = Weather Relative Humidity (%)
Aggregation Method = AVG
Reporting Period 1/1/2017 - 12/31/2017, Server Local Time
Interval and Sub Model Interval = Day
Configuration Sub Model = No Sub Model
Use Exception Periods No
Show Detailed Results No
Save Model Configuration No

Results:

536 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

Model creation run 3


We use a Weekday vs Weekend sub-model.

We use the following inputs for the Create Model report:

Title Create Model Report


Source = HVAC - Fans and Compressors
Dependent Variable Measurement = Real Energy (kWh)
Aggregation Method = SUM
Source = Victoria.Weather
Measurement = Weather Temperature (°C)
Aggregation Method = AVG
Independent Variable(s)
Source = Victoria.Weather
Measurement = Weather Relative Humidity (%)
Aggregation Method = AVG
Reporting Period 1/1/2017 - 12/31/2017, Server Local Time
Interval and Sub Model Interval = Day
Configuration Sub Model = Weekday vs Weekend
Use Exception Periods No
Show Detailed Results No
Save Model Configuration No

Results:

© 2023 Schneider Electric. All Rights Reserved. 537


Reports Web Applications Guide

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.

Model creation run 4


We use exception periods to account for the holidays.

We use the following inputs for the Create Model report:

Title Create Model Report


Source = HVAC - Fans and Compressors
Dependent Variable Measurement = Real Energy (kWh)
Aggregation Method = SUM

538 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Title Create Model Report


Source = Victoria.Weather
Measurement = Weather Temperature (°C)
Aggregation Method = AVG
Independent Variable(s)
Source = Victoria.Weather
Measurement = Weather Relative Humidity (%)
Aggregation Method = AVG
Reporting Period 1/1/2017 - 12/31/2017, Server Local Time
Interval and Sub Model Interval = Day
Configuration Sub Model = Weekday vs Weekend
Use Exception Periods Yes
Show Detailed Results No
Save Model Configuration No

NOTE: Custom Day settings are not applicable for Model reports.

Results:

© 2023 Schneider Electric. All Rights Reserved. 539


Reports Web Applications Guide

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.

Model creation run 5


We change the Aggregation Method for outside temperature to Cooling Degree Days (CDD) with
a base temperature of 11 °C.

We use the following inputs for the Create Model report:

Title Create Model Report


Source = HVAC - Fans and Compressors
Dependent Variable Measurement = Real Energy (kWh)
Aggregation Method = SUM
Source = Victoria.Weather
Measurement = Weather Temperature (°C)
Aggregation Method = CDD
Independent Variable(s)
Source = Victoria.Weather
Measurement = Weather Relative Humidity (%)
Aggregation Method = AVG
Reporting Period 1/1/2017 - 12/31/2017, Server Local Time
Interval and Sub Model Interval = Day
Configuration Sub Model = Weekday vs Weekend
Use Exception Periods Yes
Show Detailed Results No
Save Model Configuration No

Results:

540 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

We now have a pretty accurate model of our energy consumption based on outside temperature
and humidity.

TIP: Choose to include model creation details in the report.

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.

© 2023 Schneider Electric. All Rights Reserved. 541


Reports Web Applications Guide

Statistical information:

Weekday sub-model data driven by outside temperature vs measured data:

Weekday sub-model data driven by outside temperature with influence of humidity removed vs
measured data:

542 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Weekend sub-model data driven by outside temperature vs measured data:

Weekend sub-model data driven by relative humidity 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.

© 2023 Schneider Electric. All Rights Reserved. 543


Reports Web Applications Guide

Interpreting the Energy Regression Analysis Report results


The Energy Regression Analysis Tool is a highly configurable tool that allows you to monitor and
manage a building or facility’s energy and resource consumption. This practice, called energy
modeling, involves analyzing building energy systems, monitoring energy consumption, and
detecting anomalies or changes in system behavior that may require that you perform energy
efficiency upgrades or fixes. The Energy Regression Analysis Report allows you to model energy
data one independent variable at a time with a wide range of desired independent variables, such
as weather or occupancy rate.

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.

544 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

© 2023 Schneider Electric. All Rights Reserved. 545


Reports Web Applications Guide

Reading the report


This section discusses how to read the different types of information in the report.

Report Parameters Summary table


The Report Parameters Summary table appears at the beginning of the report. Based on what
you select for the Show Report Parameters Summary option on the prerequisite page, you can
make this table appear or be hidden in the report.

This table provides important details, such as data sources, calculation methods, and other
parameters about how the report inputs are configured that can help the user understand report
results.

Regression Analysis Chart


The Regression Analysis Chart shows the relationship between the driver and model data.

In this chart, the blue dots represent real data points. In this case, the data is aggregated weekly
over the course of one year, therefore, there are 52 data points with each data point representing
one week of the year. The yellow line is the regression line, or performance line, of the building.
The performance (regression) line is the best fit line--a line that indicates the expected energy
consumption. The slope of the performance line is a measure of how much extra fuel, energy, or
other resource is consumed for an increase in the independent variable (such as degree days,
production units, and so forth).

546 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

Regression Analysis Main Characteristics Table


The Regression Analysis Main Characteristics Table provides information about the Regression
Analysis Chart.

The Side column shows the left and right sides. The Slope column shows the slope values of the
two best-fitting lines intersect. This intersection point is called the breakpoint. The Y-Intercept
column shows a point where the graph of a function or relation intersects with the y-axis of the
coordinate system. Therefore, these points satisfy x = 0.

The R2 column shows a value that indicates how well the data fits the model. The RMSE column
shows the square root of the mean/average of the square of the error. The X Value and Y Value
columns show the coordinates of the Change point.

Monitoring the slopes and breakpoint values provides useful information about a facility’s energy
consumption. Flatter slope lines are better as they indicate a smaller increase in energy
consumption for every additional unit of the independent X-axis variable.

For more information on interpreting the report results, see Interpreting the report.

Measured Values Against Expected Values Chart


The Measured Values Against Expected Values Chart shows the relationship between the model
data and time.

© 2023 Schneider Electric. All Rights Reserved. 547


Reports Web Applications Guide

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.

548 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

Within the Full Table, there is a row with missing values.

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.

© 2023 Schneider Electric. All Rights Reserved. 549


Reports Web Applications Guide

Interpreting the report


After generating the report, the data can be analyzed in different ways to draw different
conclusions about energy and resource consumption. Below are two examples involving different
independent variables.

Example 1: Justifying Energy Efficiency Upgrades


Regression analysis of energy or resource consumption with respect to Degree Days can provide
valuable information about a facility’s energy efficiency with respect to outside changes in
temperature. Such information can be used to determine when energy efficiency upgrades are
necessary, and to monitor the effectiveness of such solutions after implementation.

For example, a facility manager could compare the Heating Degree Day energy profile of their
building to another facility in a similar climate. If the other building proves to be much more energy
efficient, an analysis could be performed on the differences in building design that could cause
these results. Perhaps the only significant difference is that the more efficient building recently
upgraded their insulation. The less efficient building could then use this information, along with the
Regression Analysis charts to pitch the case that an insulation upgrade should take place to
reduce natural gas usage at the facility.

If the upgrade is successful, a change appears in the Regression Analysis chart the following
year. The chart above shows a possible Regression analysis for the year before the energy
efficiency modifications. The red line in the chart shows how the performance lines and
breakpoint could change when the upgrades are successful. The slopes of the lines in the second
figure are flatter, indicating less energy usage for every additional degree day. The breakpoint
also occurs later, indicating that heating does not have to begin at as low of a temperature as
before, thereby saving additional resources.

Example 2: Identifying Equipment Failure


Regression analysis can also be used to detect equipment deterioration or failure. Below are two
Regression Analysis charts showing natural gas consumption with respect to production units.

The red line in the chart has a steeper slope and an earlier X-axis intersection point. This indicates
that more natural gas is being used for every unit of production. If data for these charts is collected
over different periods of time, but with no changes to manufacturing processes or equipment, the
steeper regression line in the second chart could indicate deterioration of equipment.

550 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

© 2023 Schneider Electric. All Rights Reserved. 551


Reports Web Applications Guide

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 Inputs panel


The top part of the Reports Display pane shows the inputs for the selected report. Different
2
reports have different input types. Some inputs are preset with default values, others are
unassigned and must be set before the report can be generated.
Hide Report Inputs / Show Report Inputs link
3
Click this link to hide or show the report input panel.
Generate Report button
4
Click this button to generate the report after you have set all the required input parameters.
Report Display panel
5 View the report output after generating the report. Use Download report as, at the top of
the panel, to download the report in PDF, Excel, or Tiff image format.

552 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

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.

Private Report with some inputs saved

Private Report with all inputs saved

Public Report with some inputs saved

Public Report with all inputs saved

© 2023 Schneider Electric. All Rights Reserved. 553


Reports Web Applications Guide

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.

Report Input Parameters (or Inputs)


Report input parameters are the variables that must be entered before a report can be generated.
For example, the input parameters can determine for which devices a report is run, or which
measurements are included. Different report templates have different input parameters.

554 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Reports

UPS Battery Health Report calculations


The following terms and explanations of various calculations are used in the UPS Battery Health
Report:

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.

© 2023 Schneider Electric. All Rights Reserved. 555


Trends Web Applications Guide

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.

556 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

A Title B Upper threshold C Lower threshold


D Target line E Left axis F Scale ( from View setting)
G Right axis H Axis title I Trend options
J Legend K Close/open toggle

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.

For information on how to configure Trends, see Trends configuration.

© 2023 Schneider Electric. All Rights Reserved. 557


Trends Web Applications Guide

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

For reference information see:


• The Trends user interface

For information on how to use Trends, see Trends.

558 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

Adding a new trend


Add new trends to monitor historical and real-time data in graphical format.
To add a completely new trend to the library:

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.

4. Save the trend.

To add a copy of an existing trend to the library:

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.

4. Save the modified trend settings.

Related topics:
• Adding a new trend

• Editing a trend

• Sharing a trend

• Moving a trend

• Deleting a trend

© 2023 Schneider Electric. All Rights Reserved. 559


Trends Web Applications Guide

For reference information see:


• The Trends user interface

For information on how to use Trends, see Trends.

560 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

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:

1. Open the Trend Setup dialog by:

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.

3. Save the modified settings.

Related topics:
• Adding a new trend

• Editing a trend

• Sharing a trend

• Moving a trend

• Deleting a trend

For reference information see:


• The Trends user interface

For information on how to use Trends, see Trends.

© 2023 Schneider Electric. All Rights Reserved. 561


Trends Web Applications Guide

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.

4. Click OK to share this trend.

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

For reference information see:


• The Trends user interface

For information on how to use Trends, see Trends.

562 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

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.

4. Click OK to move the trend.

Related topics:
• Adding a new trend

• Editing a trend

• Sharing a trend

• Moving a trend

• Deleting a trend

For reference information see:


• The Trends user interface

For information on how to use Trends, see Trends.

© 2023 Schneider Electric. All Rights Reserved. 563


Trends Web Applications Guide

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

For reference information see:


• The Trends user interface

For information on how to use Trends, see Trends.

564 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

Trends references
This section contains reference information related to Trends.

Use the links below to find the content you are looking for:

The Trends user interface


Configuring a trend
Trend options

© 2023 Schneider Electric. All Rights Reserved. 565


Trends Web Applications Guide

The Trends user interface


The Trends user interface consists of a trends display pane and a Trend Library pane.

Trends display pane


The Trends display pane shows the trends selected in the Trend Library. When you create a
trend, it automatically opens in the display pane and the trend name is selected in the Trend
Library. You can select multiple trends to be shown simultaneously in the display pane. Scroll the
display pane to view all of the trends that you selected in the Trend Library. For information on
the options and controls available in the trend view, see Trend options.

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.

For information on how to configure Trends, see Trends configuration.

566 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

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.

© 2023 Schneider Electric. All Rights Reserved. 567


Trends Web Applications Guide

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.

Configuring Axes settings


To configure axes settings:

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.

i. When you select Upper Threshold:


Select a color from the color selector for area shading on the trend between the
maximum value and the upper threshold value.

Enter a value for the upper threshold in the input field.

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.

ii. When you select Lower Threshold:


Select a color from the color selector for area shading on the trend between the
minimum value and the lower threshold value.

Enter a value for the lower threshold in the input field.

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

568 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

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.

Configuring Chart settings


To configure chart settings:

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 (%).

Name is either the default measurement name in the form of group.device


measurement, or the custom name that you specified on the Add or Edit Data Series
dialogs.

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.

Configuring Data display settings


To configure data display settings:

1. In the Trend Setup dialog, on the Data tab, specify the Data Update Intervals in the From
device and From database dropdown lists.

© 2023 Schneider Electric. All Rights Reserved. 569


Trends Web Applications Guide

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 default setting is 40000.

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

570 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

Trend options
The following options are available in the upper right area of the trend in the display pane.

These options are summarized in the following table.

This icon appears only if there is an


information, error, or warning message
associated with the device. If the icon pulses,
the viewer contains a new error or warning
message that has not yet been viewed. When
Open the Diagnostic
you open the viewer, you can click Clear Log
Log Viewer
to remove the existing entries. This action
removes the icon from the trend display area
until new information is logged in the viewer.
Click Close to close the viewer and return to
the trend display.
The setting for the time range on the X-axis.
• Select a time range from the dropdown
list. The view window reflects the time in
minutes or hours from the last data point
read from the source. For example, if you
are viewing a 15 minute window and the
last data point occurred 20 minutes ago,
View list
then the trend time range spans the
previous 35 to 20 minutes.
• Select a time zone option either browser
time zone or source time zone. The X-
axis reflects the time zone as per the
selection. This option is disabled if the
sources are not in the same time zone.
Acts as toggle to enable and disable the
inspection mode for the trend. When you
enable inspection mode, inspect icons appear
on the trend when you place your pointer
anywhere on the diagram. A slider also opens
Inspect below the X-axis. Use the slider to adjust the
time range for the trend. Data values are not
updated in the trend, but they continue to be
updated in the legend. When you disable
inspection mode, all data that was captured is
shown.

© 2023 Schneider Electric. All Rights Reserved. 571


Trends Web Applications Guide

Opens the Trend Setup dialog. You can


Edit
modify any of the settings for the trend.
Saves the trend data that is displayed in the
Download trend data diagram in a CSV file on your system. When
as CSV events occur, you can download the data to a
CSV file for further analysis.
Displays the trend in a full browser page.
Maximize Click the Restore icon to return to the
default size in the trend display area.
Closes the trend. This also clears the
Close
checkbox for the trend in the Trend Library.

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.

The legend provides the following capabilities:


• You can close and open the legend by clicking the arrow on the left side of the legend.

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

572 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Trends

A Reset Zoom (100%) - resets the trend to its default size.


Pan the chart - after you zoom in to an area of the diagram, click Pan the
B chart, then click and hold the left mouse button on the diagram and drag it
left or right.
Zoom in to selection area - zooms in when you drag the mouse over an area
C of the chart. The zoom action occurs when you release the left mouse
button.

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.

© 2023 Schneider Electric. All Rights Reserved. 573


Web Applications settings Web Applications Guide

Web Applications settings

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.

574 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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

© 2023 Schneider Electric. All Rights Reserved. 575


Web Applications settings Web Applications Guide

Alarm Views
Use the alarm view settings to:
• Change the number of items that are displayed in the alarms display.

• Change the priority classifications for alarms and incidents.

• Customize the behavior of the alarm annunciator with these settings.

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

2. Click Save to apply the changed settings.

To change the Alarm Viewer update interval:

1. Under Display Settings, select the Update Interval.

2. Click Save to apply the changed settings.

To turn the Alarm Annunciator on or off:

1. Under Annunciator, turn Enable on or off.

When the Annunciator is turned off, it is not visible in the Web Applications banner.

2. Click Save to apply the changed settings.

To change what type of state counts are shown in the Alarm Annunciator:

1. Under Annunciator, select the state type for Show counts for.

2. Click Save to apply the changed settings.

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.

2. Click Save to apply the changed settings.

To change for which Alarm priorities an Alarm notification sound is played:

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. Click Save to apply the changed settings.

To change the sound that is played for Alarm notification:

1. Under Annunciator, click Select Sound File.

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.

b. Click Finish to add it to the Media Library.

576 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

3. Click OK to complete your sound selection.

4. Click Save to apply the changed settings.

To change the Alarm Annunciator update interval:

1. Under Annunciator, select the Update Interval.

2. Click Save to apply the changed settings.

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.

2. Click Save to apply the changed settings.

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.

2. Click Save to apply the changed settings.

© 2023 Schneider Electric. All Rights Reserved. 577


Web Applications settings Web Applications Guide

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.

2. Add a user name.

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.

578 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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.

To change any of the personal preferences:

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.

© 2023 Schneider Electric. All Rights Reserved. 579


Web Applications settings Web Applications Guide

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.

3. Click Save to apply the changed settings.

To change the Reports Logo:

1. In SETTINGS, open the Settings Library and click Report Theme.

2. Under Report Logo, click Select to open the Select Report Logo Image dialog.

3. Select an image currently available in the repository, or


a. Click Upload Image to choose an image file available on your system or drag an image
file into the application area.

b. Click Finish to add it to the image repository.

4. Click OK to complete your selection.

5. Click Save to apply the changed settings.

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.

580 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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.

To change any of the system localization settings:

1. Select the options you want from the drop-down lists.

2. Click Save to apply the changed settings.

© 2023 Schneider Electric. All Rights Reserved. 581


Web Applications settings Web Applications Guide

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.

• Specify if you want to use compact mode navigation.

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.

• Reset the theme to system defaults.

To select the theme to be default or user defined:

1. Under General Theme, click Default Theme or click User Defined.

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. Click Save to apply the changed settings.

To specify the display of the vendor logo:

1. Under General Theme, click User Defined.

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. Click Save to apply the changed settings.

To change the top left logo and text:

1. Under General Theme, click User Defined.

2. Under Image, click Select.

582 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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.

Click Finish to add it to the Image Library.

4. Click OK to complete your image selection.

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.

6. Click Save to apply the changed settings.

To change the theme color:

1. Under General Theme, click User Defined.

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.

3. Click Save to apply the changed settings.

To choose the location of the library panel:

1. Under Navigation, select Left or Right.

2. Click Save to apply the changed settings.

To specify the use of compact mode navigation:

1. Under Navigation, turn on Always use compact mode for Navigation.

2. Click Save to apply the changed settings.

To change the color settings for Waveform and Burst Data:

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.

2. Click Save to apply the changed settings.

To reset the theme to the system defaults:

1. Click Default Theme.

2. Click Save to apply the changed settings.

© 2023 Schneider Electric. All Rights Reserved. 583


Web Applications settings Web Applications Guide

Diagnostics and Usage


Diagnostics and Usage
Diagnostics and Usage anonymously sends data to a secure server. Schneider Electric uses this
data to help improve our software by understanding how you use it.

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.

This operation is enabled by default.

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.

The following diagnostic and usage data is collected when it is enabled:

Diagnostic Data Usage Data


• Power Monitoring Expert version
• Total number of devices
• Operating system version and type (32- or
• Device type count
64-bit)
• Number of users
• Number of CPU cores

• System memory (RAM)

• .NET Framework version

• SQL Server version

• Distributed or local database

• City or region

• Number of monitors in use

• Client screen resolution

• Screen DPI

To disable the sending of data:

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.

584 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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.

© 2023 Schneider Electric. All Rights Reserved. 585


Web Applications settings Web Applications Guide

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 enable or disable the pre-authentication for standard users:

1. Under Pre-Authentication for Standard Users, turn Enable pre-authentication on or off.

2. Click Save to apply the changed settings.

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.

586 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

Select Windows User.

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.

3. Under Link Format, select the desired link format:

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.

4. Click Generate Web Application 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.

© 2023 Schneider Electric. All Rights Reserved. 587


Web Applications settings Web Applications Guide

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:

1. Click Start > Settings > System > Display.

2. Set the slider for Change the size of text, apps and other items to 100%.

3. Click Apply.

Option 2:

588 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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.

4. Select Change settings for all users.

5. Select Disable display scaling on high DPI settings.

© 2023 Schneider Electric. All Rights Reserved. 589


Web Applications settings Web Applications Guide

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.

590 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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

• Touch screen activity

© 2023 Schneider Electric. All Rights Reserved. 591


Web Applications settings Web Applications Guide

Web Applications settings references


This section contains reference information related to Web Applications settings.
Use the links below to find the content you are looking for:

System and personal localization settings


Customizing the Web Applications links

592 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

System and personal localization settings


NOTE: The language settings in System Language and Personal Preferences determine the
language the web applications are displayed in.

By default, the localization settings in Personal Preferences are the same as the ones in System
Language. Changes to the settings in System Language are automatically copied to the Personal
Preferences settings as long as the Personal Preferences settings have never been customized.
After you customized the Personal Preferences localization settings once, they will no longer
change when the System Language settings are changed.

NOTE: Your personal localization settings overrule the system localization settings for your user
account.

Example 1: Language settings in Personal Preferences follow System Language if they have
never been customized.

Condition Language Settings Comments


This is assuming the software
System Language: English
Default was installed as an English
Personal Preferences: English
system.
The Personal Preferences
Change System Language System Language: French
language settings follow the
to French Personal Preferences: French
System Language settings.

Example 2: Personal Preferences remain at customized setting after having been customized at
some point.

Condition Language Settings Comments


This is assuming the software
System Language: English
Default was installed as an English
Personal Preferences: English
system.
Change Personal System Language: English The Personal Preferences have
Preferences to French Personal Preferences: French been customized.
The settings are back to their
Change Personal
System Language: English defaults, but the Personal
Preferences back to
Personal Preferences: English Preferences had been
English
customized.
The Personal Preferences
Change System Language System Language: French language settings no longer
to French Personal Preferences: English follow the System Language
settings.

© 2023 Schneider Electric. All Rights Reserved. 593


Web Applications settings Web Applications Guide

Customizing the Web Applications links


By default, Web Applications shows the following application links: Dashboards, Diagrams,
Trends, Alarms, Reports, Settings. You can add custom links, hide/unhide links, re-order links,
and delete links.

Default links:

Example customized 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.

To add a custom link:

1. On the PME application server, find the Add_PQPerf_To_Web.sql script file in


...\Power Monitoring Expert\diagnostic\PowerQuality\

2. On the database server, open SQL Server Management Studio (SSMS).

3. Open the Add_PQPerf_To_Web.sql script in SSMS.

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.

5. Execute the script on the ApplicationModules database.

TIP: You can execute this query repeatedly to change any of the settings for the custom
link.

6. Close SSMS.

7. Reload Web Applications if it is open in a browser.

594 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

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:

© 2023 Schneider Electric. All Rights Reserved. 595


Web Applications settings Web Applications Guide

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

596 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

To hide or unhide a link:

1. On the database server, open SQL Server Management Studio (SSMS).

2. Copy the following SQL script into a query window in SSMS:


SELECT *
FROM [ApplicationModules].[Configuration].[ConfigurationSettings]
WHERE ItemType ='ApplicationFramework' AND Item = 'Applications'

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

6. Copy the following SQL script into a query window in SSMS:


UPDATE [ApplicationModules].[Configuration].
[ConfigurationSettings]
SET Value = '<Copy entire data from notepad with the modified
enabled property here>'
WHERE [key]= '<Type the custom application link (internal) name
here, in our example this is MyCustomLink>'

7. Update the query settings as described in the script above.

8. Execute the script on the ApplicationModules database.

9. (Optional) Repeat steps 4-8 to hide or unhide additional links.

10. Close SSMS.

11. Reload the Web Applications if they are open in a browser.

To re-order links:

1. On the database server, open SQL Server Management Studio (SSMS).

2. Copy the following SQL script into a query window in SSMS:


SELECT *
FROM [ApplicationModules].[Configuration].[ConfigurationSettings]
WHERE ItemType ='ApplicationFramework' AND Item = 'Applications'

3. Execute the query on the ApplicationModules database. This returns the settings for the
Web Applications links.

© 2023 Schneider Electric. All Rights Reserved. 597


Web Applications settings Web Applications Guide

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.

6. Copy the following SQL script into a query window in SSMS:


UPDATE [ApplicationModules].[Configuration].
[ConfigurationSettings]
SET Value = '<Copy entire data from notepad with the modified
order property here>'
WHERE [key]= '<Type the custom application link (internal) name
here, in our example this is MyCustomLink>'

7. Update the query settings as described in the script above.

8. Execute the script on the ApplicationModules database.

9. (Optional) Repeat steps 4-8 to re-order additional links.

10. Close SSMS.

11. Reload the Web Applications if they are open in a browser.

To delete a link:

1. On the database server, open SQL Server Management Studio (SSMS).

2. Copy the following SQL script into a query window in SSMS:


DELETE FROM [ApplicationModules].[Configuration].
[ConfigurationValue]
WHERE ConfigurationKeyId = (Select id from [ApplicationModules].
[Configuration].[ConfigurationKey] where Name='<Type the custom
application link (internal) name here, in our example this is
MyCustomLink>')
DELETE FROM [ApplicationModules].[Configuration].
[ConfigurationKey]
WHERE Name='<Type the custom application link (internal) name
here, in our example this is MyCustomLink>'

3. Update the query settings as described in the script above.

598 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Web Applications settings

4. Execute the query on the ApplicationModules database. This deletes the Web Applications
link.

5. (Optional) Repeat steps 3-4 to delete additional links.

6. Close SSMS.

7. Reload the Web Applications if they are open in a browser.

© 2023 Schneider Electric. All Rights Reserved. 599


Device Manager Web Applications Guide

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.

Failure to follow these instructions can result in an unstable or unusable network.

Use Device Manager to:


• Configure devices and sites.

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

600 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Device Manager or Management Console?


Device Manager shares the site and device configuration with Management Console. That means
you can use either application to configure sites and devices. Depending on your workflow you
might prefer to work in one or the other application. Device Manager is limited to configuring sites
and devices. Management Console offers additional configuration functions, such as modem
configuration or setting up connection schedules. Management Console also provides access to
maintenance and programming tools.

NOTE: You cannot add direct serial sites or modem sites with Device Manager. Use
Management Console to add these sites.

Use Device Manager for:


• exporting device and site configuration in CSV format

• importing device and site configuration in CSV format

• configuring devices and sites in the web interface

Use Management Console for:


• adding direct serial or modem sites

• configuring modems and connection schedules

• configuring managed circuits and logical devices

• configuring devices with advanced security

• accessing any of the maintenance and programming tools

• configuring devices and sites in a Windows application on an Engineering client

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.

To configure devices and sites, see:


Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

© 2023 Schneider Electric. All Rights Reserved. 601


Device Manager Web Applications Guide

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

602 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Adding a device
Add a device to make this device and its data available for monitoring and analysis in PME. You
can add one device at a time using the Device Manager user interface. You can also import many
devices at once using configuration import.
To add a device using the Device Manager user interface:

1. In Device Manager, select the Devices tab, and then click Add Ethernet Device or click the
down arrow next to it to add a serial or OPC device. This opens the New Device dialog.

TIP: The right-click context menu for a device in the table has a Duplicate Device option to
create a copy of an existing device.

2. In New Device, enter the required information such as group name, device name, device
type, 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.

NOTE: PME performs certificate validation only on the following scenarios:


1. First time device configuration.
2. Disconnect and connect the device from Management Console/Device Manager.

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.

© 2023 Schneider Electric. All Rights Reserved. 603


Device Manager Web Applications Guide

4. (Optional) Enter Description information.

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.

To add one or more devices using configuration import:

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.

4. Save the file in CSV format.

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.

9. Click Finish in the import wizard.

Related topics:
Devices
• Adding a device

• Editing a device

604 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 605


Device Manager Web Applications Guide

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:

1. In Device Manager, select the Devices tab.

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.

TIP: Double-click a row to open the Device Configuration dialog.

3. In Device Configuration, update the configuration settings as needed.

4. Click OK.

To edit multiple devices using the Device Manager user interface:

1. In Device Manager, select the Devices tab.

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.

3. In Device Configuration, update the configuration settings as needed.

NOTE: Only those settings that are common to all selected devices can be configured at
the same time.

4. Click OK.

To edit devices using configuration import:

1. In Device Manager, select the Devices tab.

2. Export the existing configuration in one of the following ways:


a. To export the configuration for a single device:
In the devices table, select the row of the device for which you want to export the
configuration, then right-click in the row and select Export Device Configuration
for Editing in the context menu. This exports the configuration and saves it in
CSV file format to your local Downloads folder.

b. To export the configuration for multiple devices:


In the devices table, select the rows of the devices for which you want to export the
configuration, then right-click in the selected row area and select Export
Configuration for <number> Devices for Editing in the context menu. This
exports the configuration and saves it in CSV file format to your local Downloads
folder.

606 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

TIP: Use Ctrl+Click to select individual devices, use Shift+click to select a


block of devices.

c. To export the configuration for all devices:


Click Options in the top right corner of the Devices pane, and then click Export
Devices Configuration for Editing in the options menu. This exports the
configuration and saves it in CSV file format to your local Downloads folder.

3. Open the exported configuration file in a text editor and edit the configuration information for
the devices as needed.

NOTE: Do not edit the content of the UniqueSystemId column.

4. Save the file in CSV format.

5. In Device Manager, click Import. This opens the import wizard.

6. Follow the steps in the import wizard to complete the configuration import.

7. Click Finish in the import wizard.

Related topics:
Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 607


Device Manager Web Applications Guide

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:

1. In Device Manager, select the Devices tab.

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.

3. In the confirmation dialog box, click OK.

To delete multiple devices:

1. In Device Manager, select the Devices tab.

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.

3. In the confirmation dialog box, click OK.

Related topics:
Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

608 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 609


Device Manager Web Applications Guide

Connecting or disconnecting an Ethernet device


Disconnect an Ethernet device to temporarily remove it from the communication network, for
example for system testing. Connect an Ethernet device, that was previously disconnected, to
restore its communication network connection.
To connect a single Ethernet device:

1. In Device Manager, select the Devices tab.

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.

To connect multiple Ethernet devices:

1. In Device Manager, select the Devices tab.

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.

To disconnect a single Ethernet device:

1. In Device Manager, select the Devices tab.

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.

To disconnect multiple Ethernet devices:

1. In Device Manager, select the Devices tab.

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.

610 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 611


Device Manager Web Applications Guide

Enabling or disabling a device


Disable a device to remove it from the communication network. For example, disable a device that
is out of service. Enable a device that was previously disabled to reconnect it to the
communication network.
To enable a single device:

1. In Device Manager, select the Devices tab.

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.

To enable multiple devices:

1. In Device Manager, select the Devices tab.

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.

To disable a single device:

1. In Device Manager, select the Devices tab.

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.

To disable multiple devices:

1. In Device Manager, select the Devices tab.

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.

612 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 613


Device Manager Web Applications Guide

Viewing a device diagram


Device diagrams are device type specific diagrams in the Diagrams application that show
historical and real-time data for a device. You can open a device diagram for a device directly
from Device Manager.

NOTE: To see data in a diagram, the device must be connected to and communicating with
PME.

To view a device diagram:

1. In Device Manager, select the Devices tab.

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

614 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Adding a site
A site is a gateway to establish a connection between the software and a group of devices. Add
sites to connect devices with serial communication or to connect OPC devices.

NOTE: You do not add sites for Ethernet devices. You add Ethernet devices directly to the
system. See Adding a device for details. The software automatically sets up an internal site for
each Ethernet device. These internal sites are not visible in Device Manager.

NOTE: You cannot add direct serial sites or modem sites with Device Manager. Use
Management Console to add these sites.

You can add sites through the Device Manager user interface, one site at a time. You can also
add one or more sites at the same time through importing site configuration information.
To add a site through the Device Manager user interface:

1. In Device Manager, select the Sites tab, and then click Add Ethernet Gateway or click the
down arrow next to it to add an OPC site. This opens the New Site dialog.

TIP: The right-click context menu for a site in the table has a Duplicate Site option to
create a copy of an existing site.

2. In New Site, enter the required information such as name, IP address, and so on.

TIP: Click Show Advanced to access advanced configuration settings. These settings
have factory defaults and only need to be changed for specific application needs.

3. (Optional) Enter Description information.

4. Click OK.

To add one or more sites through configuration import:

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.

4. Save the file in CSV format.

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.

9. Click Finish in the import wizard.

© 2023 Schneider Electric. All Rights Reserved. 615


Device Manager Web Applications Guide

Related topics:
Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

616 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Editing a site
Edit a site to update its name or to change its configuration settings. You can edit sites through the
Device Manager user interface or through exporting, editing, and then re-importing the site
configuration.
To edit a single site through the Device Manager user interface:

1. In Device Manager, select the Sites tab.

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.

3. In Site Configuration, update the configuration settings as needed.

4. Click OK.

To edit multiple sites through the Device Manager user interface:

1. In Device Manager, select the Sites tab.

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.

3. In Site Configuration, update the configuration settings as needed.

NOTE: Only those settings that are common to all selected sites can be configured at the
same time.

4. Click OK.

To edit sites through configuration import:

1. In Device Manager, select the Sites tab.

2. Export the existing configuration in one of the following ways:


a. To export the configuration for a single site:
In the sites table, select the row of the site for which you want to export the
configuration, then right-click in the row and select Export Site Configuration for
Editing in the context menu. This exports the configuration and saves it in CSV file
format to your local Downloads folder.

b. To export the configuration for multiple sites:


In the sites table, select the rows of the sites for which you want to export the
configuration, then right-click in the selected row area and select Export
Configuration for <number> Sites for Editing in the context menu. This exports
the configuration and saves it in CSV file format to your local Downloads folder.

© 2023 Schneider Electric. All Rights Reserved. 617


Device Manager Web Applications Guide

TIP: Use Ctrl+Click to select individual sites, use Shift+click to select a


block of sites.

c. To export the configuration for all sites:


Click Options in the top right corner of the Sites pane, and then click Export
Sites Configuration for Editing in the options menu. This exports the
configuration and saves it in CSV file format to your local Downloads folder.

3. Open the exported configuration file in a text editor and edit the configuration information for
the sites as needed.

NOTE: Do not edit the content of the UniqueSystemId column.

4. Save the file in CSV format.

5. In Device Manager, click Import. This opens the import wizard.

6. Follow the steps in the import wizard to complete the configuration import.

7. Click Finish in the import wizard.

Related topics:
Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

618 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Deleting a site
Delete a site if this site is no longer needed, for example if all the devices connected to the site
have been removed from service.
To delete a site:

1. In Device Manager, select the Sites tab.

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.

3. In the confirmation dialog box, click OK.

To delete multiple sites:

1. In Device Manager, select the Sites tab.

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.

3. In the confirmation dialog box, click OK.

Related topics:
Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

© 2023 Schneider Electric. All Rights Reserved. 619


Device Manager Web Applications Guide

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

620 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Connecting or disconnecting a site


Disconnect a site to temporarily remove the devices on this site from the communication network,
for example for system testing. Connect a site, that was previously disconnected, to reestablish its
communication network connection.
To connect a single site:

1. In Device Manager, select the Sites tab.

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.

To connect multiple sites:

1. In Device Manager, select the Sites tab.

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.

To disconnect a single site:

1. In Device Manager, select the Sites tab.

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.

To disconnect multiple sites:

1. In Device Manager, select the Sites tab.

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.

© 2023 Schneider Electric. All Rights Reserved. 621


Device Manager Web Applications Guide

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

622 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Enabling or disabling a site


Disable a site to remove this site from the communication network, for example if the devices on
this site are out of service for a longer period of time. Enable a site, that was previously disabled,
to reestablish its communication network connection.
To enable a single site:

1. In Device Manager, select the Sites tab.

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.

To enable multiple sites:

1. In Device Manager, select the Sites tab.

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.

To disable a single site:

1. In Device Manager, select the Sites tab.

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.

To disable multiple sites:

1. In Device Manager, select the Sites tab.

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.

© 2023 Schneider Electric. All Rights Reserved. 623


Device Manager Web Applications Guide

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

624 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Exporting network configuration for use in a different system


Export the device and site configuration of a system for importing into another system. For
example, configure the sites and devices in a test system and then export this configuration for
use in a production system.

NOTE: You cannot import the configuration back into the same system from which it was
exported.

To export the network configuration for use in a different system:

1. In Device Manager, select the Devices or the Sites tab.

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.

3. Transfer the exported configuration file to the target system.

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

© 2023 Schneider Electric. All Rights Reserved. 625


Device Manager Web Applications Guide

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

626 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Importing network configuration from a different system


Import the device and site configuration that was exported from another system. For example, to
create a copy of an existing system or to transfer the configuration from a test system into a
production system. You can also import the configuration from configuration tools, such as ION
Setup.

NOTE: You cannot import the configuration back into the same system from which it was
exported.

To import the network configuration from a different system:

1. In Device Manager, click Import. This opens the import wizard.

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.

3. Complete the configuration import in the import wizard.

4. Click Finish in the import wizard.

Related topics:
Devices
• Adding a device

• Editing a device

• Deleting a device

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 627


Device Manager Web Applications Guide

Viewing system device license status


View device license status to verify that the required device licenses are activated in your system.
For example, confirm that enough free licenses are available before adding a number of new
devices to the 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.

To view system device license status:

1. In Device Manager, select the Devices tab.

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

• Connecting or disconnecting an Ethernet device

• Enabling or disabling a device

• Viewing a device diagram

Sites
• Adding a site

• Editing a site

• Deleting a site

• Connecting or disconnecting a site

• Enabling or disabling a site

Network
• Exporting network configuration for use in a different system

• Importing network configuration from a different system

For reference information see:


• Device Manager

• Device Manager user interface

628 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

• Viewing system device license status

© 2023 Schneider Electric. All Rights Reserved. 629


Device Manager Web Applications Guide

Device Manager references


This section contains reference information related to Device Manager.

Use the links below to find the content you are looking for:

Device Manager user interface

630 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

Device Manager user interface


Main user interface (UI) and Devices tab

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

Add Ethernet Device


Use Add Ethernet Device to add a new Ethernet device to the system. To add a Serial
Device, connected through an Ethernet gateway, or an OPC device, click the down arrow
3 and select the appropriate option from the drop-down menu.

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.

© 2023 Schneider Electric. All Rights Reserved. 631


Device Manager Web Applications Guide

Search Devices box.


6
Enter a search string to find devices in the devices table.
Refresh
Click Refresh to update the table content and show changes to the device configuration that
might have been done through Management Console.
7
NOTE: The Communication Status indicator in the table is updated automatically every 10
seconds. To update the configuration information use Refresh.

Options menu
The Options menu contains the following options:
- Show/Hide Columns
- Clear Filter
8
- View Device Licenses
- Export Devices Configuration for Editing
- Export Network Configuration for Use in a Different System
- Refresh
Devices table
9 The devices table shows devices that are configured in the system. Which devices are
displayed in the table is controlled by the devices filter, see 5 above.

Sites tab

Add Ethernet Gateway


1 Use Add Ethernet Gateway to add a new Ethernet Gateway site to the system. To add an
OPC site, click the down arrow and select the appropriate option from the drop-down menu.
Import
Use the import wizard to import device or site configuration into the system. You can import
2 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.
Sites filter
3 Use the sites filter to customize which sites are displayed in the sites table. You can filter by
Communication Status, Type, and Enabled State.
Search Sites box.
4
Enter a search string to find sites in the sites table.

632 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Manager

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.

© 2023 Schneider Electric. All Rights Reserved. 633


Device Replacement Web Applications Guide

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.

Failure to follow these instructions can result in an unstable or unusable network.

634 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Replacement

Use Device Replacement to:


• Create processed measurement. The processed measurement is a multiple data series of
device and the measurement. This processed measurement duplicates the original
measurement value until the measurement value reaches the threshold or the device is
replaced. Once threshold is reached or the device is replaced, this processed measurement
aggregates the sum of the threshold value or value until device replace and the newly logged
value. The processed measurement contains the aggregated value of the measurement.
• Configure device replacement. Based on processed measurement device selection, the
device replacement list is generated. You can select the last replacement date and the
replacement period.

Use the processed measurement in place of regular measurement to view historical trends, key
performance indicators, reports, and other information about the power system you are
monitoring without any spikes due to device replacement or threshold limits of measurement
values.

To configure device replacement, see:


• Creating a processed measurement

• Editing a processed measurement

• Enabling or disabling a processed measurement

• Configuring device replacement

For reference information see Device Replacement user interface

© 2023 Schneider Electric. All Rights Reserved. 635


Device Replacement Web Applications Guide

Creating a processed measurement


Create processed measurement to duplicate the original measurement value and aggregate the
new measurement value after the measurement value reaches the threshold or the associated
device is replaced.
To create a processed measurement using the Device Replacement user interface:

1. In Device Replacement, select the Processed Measurement tab, and then click Create.

2. Select the Processed Measurement Name.

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.

4. Click a measurement name in the Available Measurements area to select it.

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.

6. Click to select the device and measurement data series.

7. (Optional) Perform step 4 to 6 for other measurements and devices.

8. Click Add to list the selected measurement and device.

9. Click Save.

Related topics:
• Creating a processed measurement

• Editing a processed measurement

• Enabling or disabling a processed measurement

• Configuring device replacement

For reference information see Device Replacement user interface

636 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Replacement

Editing a processed measurement


Edit a processed measurement to update the measurement and device selection.
To edit a processed measurement using the Device Replacement user interface:

1. In Device Replacement, select the Processed Measurement tab.

2. Select the row of the processed measurement you want to edit and then click Edit in this
row.

3. Update the measurement and device selection as needed.

4. Click Save.

Related topics:
• Creating a processed measurement

• Editing a processed measurement

• Enabling or disabling a processed measurement

• Configuring device replacement

For reference information see Device Replacement user interface

© 2023 Schneider Electric. All Rights Reserved. 637


Device Replacement Web Applications Guide

Enabling or disabling a processed measurement


Disable a processed measurement to remove it from the measurement list. Enable a processed
measurement that was previously disabled to remove from the measurement list.
To disable a processed measurement using the Device Replacement user interface:

1. In Device Replacement, select the Processed Measurement tab.

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.

To enable a processed measurement using the Device Replacement user interface:

1. In Device Replacement, select the Processed Measurement tab.

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

• Editing a processed measurement

• Enabling or disabling a processed measurement

• Configuring device replacement

For reference information see Device Replacement user interface

638 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Replacement

Configuring device replacement


Configure device replacement to select the last replacement date and the replacement period for
the list of devices based on the processed measurements.
To configure device replacement using the Device Replacement user interface:

1. In Device Replacement, select the Device Replacement tab.

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

• Editing a processed measurement

• Enabling or disabling a processed measurement

• Configuring device replacement

For reference information see Device Replacement user interface

© 2023 Schneider Electric. All Rights Reserved. 639


Device Replacement Web Applications Guide

Device Replacement references


This section contains reference information related to Device Manager.

Use the links below to find the content you are looking for:

Device Replacement user interface

640 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Device Replacement

Device Replacement user interface


Main user interface (UI)

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.

Device Replacement tab

Search Devices box.


3
Enter a search string to find devices in the devices replacement table.
Date Range Filter.
4 Use the date range filter to customize which devices are displayed in the devices
replacement table.
Devices replacement table
5
The devices table shows the devices that are configured for replacement.

Processed measurement tab

© 2023 Schneider Electric. All Rights Reserved. 641


Device Replacement Web Applications Guide

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.

642 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

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.

To configure and map EWS Client, see:


• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

© 2023 Schneider Electric. All Rights Reserved. 643


EWS Client Web Applications Guide

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:

644 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

Configuring EWS Client


Configure an EWS client to make the EWS client data available for monitoring and analysis in
PME. You can add one EWS client at a time using the EWS Client user interface.

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.

To add an EWS Client using the EWS Client user interface:

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.

NOTE: EWS client supports EWS server version 1.2 only.

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.

© 2023 Schneider Electric. All Rights Reserved. 645


EWS Client Web Applications Guide

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.

8. To map the device,


a. In the mapping table, select the row of the device for which you want to map, and then
click Map in this row. This opens the Map Device dialog.

b. In Map Device, map to existing device or create new device.


To map to existing device, select the required information such as group name and
time zone from the drop down list.

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.

9. To map the measurement,


a. In the mapping table, select the row of the measurement for which you want to map, and
then click Map in this row. This opens the Map Measurement dialog.

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

b. In Map Measurement, map to existing measurement or create new measurement.


To map to existing measurement, under Existing Measurements, click the
measurement name to select it.

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.

646 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

10. (Optional) To map an alarm,

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.

c. Click the alarm name to select it.

d. Click OK.

11. Click Finish.

Related topics:
• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:
• 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.

© 2023 Schneider Electric. All Rights Reserved. 647


EWS Client Web Applications Guide

Re-configuring EWS Client


Re-configure an EWS client to update the EWS client configuration or the mapping information.
You can edit one EWS client at a time using the EWS Client user interface.

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.

To edit an EWS Client using the EWS Client user interface:

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.

2. In Re-configure EWS Client, select the Configuration tab.

3. In Configuration, update the configuration settings as needed.

4. In Re-configure EWS Client, select the Device and Measurement Mapping tab.

5. In Device and Measurement Mapping, update the mapping settings as needed.

6. Click OK.

Related topics:
• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:

648 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide 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.

© 2023 Schneider Electric. All Rights Reserved. 649


EWS Client Web Applications Guide

Deleting an EWS Client


Delete an EWS client if it is no longer needed, for example if the EWS server connected to
EWS client has been removed from service. You can delete one EWS client at a time using the
EWS Client user interface.

NOTE: When an EWS client is deleted, the configuration and mapping is also deleted.

To delete an EWS Client using the EWS Client user interface:

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.

2. In the confirmation dialog box, click Delete.

Related topics:
• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:
• 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.

650 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

Disabling or Enabling an EWS Client


Disable an EWS client to remove it from the communication network. For example, disable an
EWS client that is out of service. Enable an EWS client that was previously disabled to reconnect
it to the communication network. You can enable or disable one EWS client at a time using the
EWS Client user interface.
To disable an EWS Client using the EWS Client user interface:

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.

2. In Re-configure EWS Client, select the Configuration tab.

3. In Configuration, turn off the Enabled option.

4. Click OK.

To enable an EWS Client using the EWS Client user interface:

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.

2. In Re-configure EWS Client, select the Configuration tab.

3. In Configuration, turn on the Enabled option.

4. Click OK.

Related topics:
• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:
• 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.

© 2023 Schneider Electric. All Rights Reserved. 651


EWS Client Web Applications Guide

Remapping a Device, Measurement, and / or Alarm Mapping


Remap a device, measurement, and / or alarm mapping to update the device, measurement, and
/ or alarm mapping information. You can remap one device, measurement, or alarm at a time
using the EWS Client user interface.
To remap a device using the EWS Client user interface:

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.

3. In Device and Measurement Mapping, to remap the device,


a. In the mapping table, select the row of the device for which you want to remap, and then
click Edit in this row. This opens the Remap Device dialog.

b. In Remap Device, remap to existing device or create new device.


To remap to existing device, update the required information such as group name
and time zone from the drop down list.

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.

To remap a measurement using the EWS Client user interface:

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.

3. In Device and Measurement Mapping, to remap the measurement,


a. In the mapping table, select the row of the measurement for which you want to remap,
and then click Edit in this row. This opens the Map Measurement dialog.

652 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

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

b. In Map Measurement, remap to existing measurement or create new measurement.


To remap to existing measurement, under Existing Measurements, click the
measurement name to select it.

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.

To remap an alarm using the EWS Client user interface:

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.

3. In Device and Measurement Mapping, to remap an alarm,


a. In the mapping table, select the row of an alarm for which you want to remap, and then
click Edit 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.

c. Click the alarm name to select it.

d. Click OK.

4. Click OK.

Related topics:
• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

© 2023 Schneider Electric. All Rights Reserved. 653


EWS Client Web Applications Guide

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:
• 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.

654 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

Deleting a Device, Measurement, and / or Alarm Mapping


Delete a device, measurement, and / or alarm mapping to delete the device, measurement, and /
or alarm mapping information. You can delete one or all device, measurement, or alarm mapping
at a time using the EWS Client user interface.

TIP: Select Delete All Mapping to delete all the device, measurement, and alarm mapping.

To delete a device mapping using the EWS Client user interface:

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.

4. In the confirmation dialog box, click Delete.

NOTE: On device deletion, the associated measurement(s) are deleted.

To delete a measurement mapping using the EWS Client user interface:

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.

4. In the confirmation dialog box, click Delete.

To delete an alarm mapping using the EWS Client user interface:

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.

4. In the confirmation dialog box, click Delete.

Related topics:
• Configuring EWS Client

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

© 2023 Schneider Electric. All Rights Reserved. 655


EWS Client Web Applications Guide

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:
• 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.

656 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

Enabling or Disabling a Device, Measurement, and / or Alarm


Mapping
Disable a device, measurement, and / or alarm mapping to remove the device, measurement, and
/ or alarm mapping information from the communication network. Enable a device, measurement,
and / or alarm mapping that was previously disabled to reconnect it to the communication
network. You can disable / enable one or all device, measurement, or alarm at a time using the
EWS Client user interface.

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.

To enable a device mapping using the EWS Client user interface:

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.

To enable a measurement mapping using the EWS Client user interface:

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.

To enable an alarm mapping using the EWS Client user interface:

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.

© 2023 Schneider Electric. All Rights Reserved. 657


EWS Client Web Applications Guide

To disable a device mapping using the EWS Client user interface:

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.

To disable a measurement mapping using the EWS Client user interface:

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.

To disable an alarm mapping using the EWS Client user interface:

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

• Re-configuring EWS Client

• Deleting an EWS Client

• Disabling or Enabling an EWS Client

For specific information on mapping, see


• Remapping a Device, Measurement, and / or Alarm Mapping

• Deleting a Device, Measurement, and / or Alarm Mapping

• Enabling or Disabling a Device, Measurement, and / or Alarm Mapping

658 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

For reference information see:


• EWS Client user interface

• measurement name is automatically mapped to PME measurement name based on the


following scenarios:
• 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.

© 2023 Schneider Electric. All Rights Reserved. 659


EWS Client Web Applications Guide

EWS Client references


This section contains reference information related to EWS Client.

Use the links below to find the content you are looking for:

EWS Client user interface


measurement name is automatically mapped to PME measurement name based on the
following scenarios:
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.

660 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

EWS Client user interface


Main user interface (UI)

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.

© 2023 Schneider Electric. All Rights Reserved. 661


EWS Client Web Applications Guide

Number of displayed items


8
Shows the number of items visible on this page, and the total number in the system.
Page selector
9 Use the page selector to navigate between pages of information. Set the number of items
that are displayed on a page.

662 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide EWS Client

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.

© 2023 Schneider Electric. All Rights Reserved. 663


EWS Client Web Applications Guide

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.

To customize the mapping:

1. Navigate to ...\Power Monitoring Expert\config\WebServices.

2. Edit the EWSClient_MappingDefinitionFile.xml file using any XML editor. The


recommended tool is Notepad++.

3. For the required PME measurement name under


<PMEMeasurementName> </PMEMeasurementName>,
enter the corresponding the measurement name under
<EWSMeasurementName> </EWSMeasurementName>.
For example, if the measurement is Real Power, then update the PME Real Power definition
section as follows:

<PMEDefinitionFile>
<PMEMeasurementName>Real Power</PMEMeasurementName>
<EWSMeasurementName>Real Power</EWSMeasurementName>
<Scale>1</Scale>

4. (Optional) Perform step 3 for other measurements.

5. Save and close the file.

You can see the measurement mapping updated accordingly in the Device and Measurement
Mapping dialog of EWS client user interface.

664 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

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

Common elements of hierarchy templates


• Creating a hierarchy

• Creating an apportioned meter

• Creating a virtual meter

• Dynamic hierarchy

• Meter apportionment

• Virtual meter

• Using hierarchies in other applications

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.

© 2023 Schneider Electric. All Rights Reserved. 665


Hierarchy Manager Web Applications Guide

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.

666 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

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

• Other real-world objects

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.

© 2023 Schneider Electric. All Rights Reserved. 667


Hierarchy Manager Web Applications Guide

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.

668 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

Common elements of hierarchy templates


The components that make up Hierarchy Manager can appear differently depending on the
hierarchy template installed in the system. Although these different hierarchy templates can have
different tab and property names, and the relationships between the Nodes differ, the method
used to modify the hierarchy is similar for most templates. This section provides information
regarding the basic steps to modifying a hierarchy, regardless of the template used.

Hierarchy Manager has a series of tabs across the top of the page. These tabs are the
representation of the Nodes. Clicking on any of these tabs displays the instances of the Node
types in a grid format.

The process involved with creating an instance of a Node type is the same for most hierarchy
templates. To create a new instance, select the applicable tab and click Add. The Properties
window opens, containing fields that represent the properties for that particular Node instance.
Any required fields are identified with a Required message. Click in the attribute fields and enter
the necessary information. Reference fields are selected from a grid and can also have a time
dimension associated with them (see Dynamic hierarchy for additional information). Click Add to
open the Select dialog and select the applicable item from the grid. If there are no items to choose
from, you might need to create a new instance for that Node type.

To edit an instance of a Node type, click the applicable tab, double-click an instance in the grid, or
select it and click Edit. Make the changes to the applicable fields in the Properties dialog and
click OK.

To delete an existing instance of a Node type, select the applicable tab, select an instance on that
tab and click Delete. After you confirm the delete action, the instance disappears from the grid,
and any reference information regarding the deleted instance is removed from all affected Node
instances.

Tree View
Displaying the views of a template is also similar for most template types. You can see the view of
a hierarchy by clicking the Show Views link. The view shows the different levels of the hierarchy,
and the date range for each entry of the hierarchy.

Date Range: Use the To and From fields to select the date range to display the hierarchy.

Available Views: Use this section to switch between different views if there is more than one view
available. The available views are determined by the hierarchy template. Click Update when you
change the date range, the scale, or view.

Scale: Select Days or Months to provide the appropriate scale to the hierarchy view.

Beside each hierarchy level is a bar that indicates when in the date range the Node was part of the
hierarchy. If the bar has a rounded edge, the Node reference has an end date within the date
range. If the bar has a square edge, the Node reference continues beyond the date range.

You can click the pencil (edit) icon to the left of the bars to open and edit the properties for the
related item.

If you do not see a node in the hierarchy view, make sure the date range includes the date that
Node was part of the hierarchy. You can view the date range for a hierarchy entry by hovering the
pointer on it.

© 2023 Schneider Electric. All Rights Reserved. 669


Hierarchy Manager Web Applications Guide

670 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

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.

Open Hierarchy Manager


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. Open Hierarchy Manager in one of the following ways:


From Web Applications Settings > System > Hierarchies

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.

Site, Buildings, and Areas tabs represent each Node type.

© 2023 Schneider Electric. All Rights Reserved. 671


Hierarchy Manager Web Applications Guide

Add a building to the hierarchy


1. Click the Buildings tab.

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.

672 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

4. Confirm that the date has changed in the Start Date column under Sites, then click OK.

Associate areas and devices to Building Three


1. Click the Areas tab.

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.

© 2023 Schneider Electric. All Rights Reserved. 673


Hierarchy Manager Web Applications Guide

3. Click Add above the Building grid to open the Add Building References dialog.

4. Select Building Three in the grid.

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.

View the hierarchy in a tree configuration


To see the hierarchy in a tree organization, switch to the Tree View by clicking Show Views, in
the top right corner of the Hierarchy Manager window. You can use this window to select the type
of view you want to see (if multiple views are available), and the date range for the view. Click
Update to refresh the view after you make your selections.
Click:
• The plus sign in the view to expand that entry.

• The minus sign beside an entry to collapse that part of the hierarchy.

674 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

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

• Click Show Types to return to the initial Hierarchy Manager page.

Adding and removing devices


This part of the example involves replacing a device in Building Two after a renovation. Set the
end date for the device you are replacing to the date they are removed. Then assign a new device
to the area with the start date set to the day the device is installed.

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.

1. Open Hierarchy Manager and click the Areas tab.

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.

© 2023 Schneider Electric. All Rights Reserved. 675


Hierarchy Manager Web Applications Guide

7. Select the new device, Campus.Library_NEW.

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.

676 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

Creating an apportioned meter


You can create an apportioned meter when you add a device to a hierarchy node by changing the
value in the Percentage field in the Add Device References dialog. The default value is 100
percent. The percentage can be a negative, positive, or integer value. The percentage field is
restricted to 15 characters. Time intervals for apportioned meters function in the same way as
devices. See Meter apportionment for more information.
To create an apportioned meter:

1. In Hierarchy Manager, open the AREAS tab.

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.

4. Change the value in the Percentage field.

5. If required, click the From or To fields to change the start and end dates for the apportioned
meter.

6. Click OK.

© 2023 Schneider Electric. All Rights Reserved. 677


Hierarchy Manager Web Applications Guide

Creating a virtual meter


The Virtual Meter tab includes Add, Edit, and Delete controls above a data grid showing any
previously created virtual meters.

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.

Adding a virtual meter to a hierarchy node


After you create a virtual meter, it appears in device lists with the other devices. You can attach a
virtual meter to a hierarchy node in the same way as the other devices.

See Virtual meter for more information.

678 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

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

Replacing or reconfiguring a device can also be captured in a hierarchy. If a device requires


replacement or reconfiguring, it can be unassigned from an instance on a specific date, and the
new or reconfigured device assigned to the same instance. The entry for the unassigned device is
grayed-out and italicized in the hierarchy if the End Date is the current date or earlier.

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.

© 2023 Schneider Electric. All Rights Reserved. 679


Hierarchy Manager Web Applications Guide

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.

See Creating an apportioned meter for more information.

680 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

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.

See Creating a virtual meter for more information.

Data aggregation in Hierarchies


A Hierarchy aggregates the measurements from the device nodes all the way up through the
different hierarchy levels. For example, a hierarchy with the levels Building > Floor > Areas, where
the monitoring devices are associated with the Areas, will show the aggregation of all the area
measurements for a floor at the Floor level and the aggregation of all floor measurements at the
Building level.
Example: Measurements aggregating up the hierarchy

Hierarchy Level 1 Hierarchy Level 2 Hierarchy Level 3 Hierarchy Level 4

Building [22kWh] (aggregated)

Floor 1 [10kWh] (aggregated)

Area 1 [7kWh] (aggregated)

Device - 5kWh (measured)

Device - 2kWh (measured)

Area 2 [3kWh] (aggregated)


Device - 3kWh (measured)
Floor 2 [12kWh] (aggregated)

Area 3 [12kWh] (aggregated)

Device - 12kWh (measured)

© 2023 Schneider Electric. All Rights Reserved. 681


Hierarchy Manager Web Applications Guide

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.

Hierarchy Level 1 Hierarchy Level 2 Hierarchy Level 3 Hierarchy Level 4

Building [14kWh] (aggregated)

Floor 1 [2kWh] (aggregated)

Device - 2kWh (measured)


Area 1 [7kWh] (aggregated)

Device - 5kWh (measured)

Device - 2kWh (measured)

Area 2 [3kWh] (aggregated)


Device - 3kWh (measured)
Floor 2 [12kWh] (aggregated)

Area 3 [12kWh] (aggregated)

Device - 12kWh (measured)

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.

682 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Hierarchy Manager

Using hierarchies in other applications


You can use hierarchies in the following Power Monitoring Expert (PME) applications:
• Dashboards

• Reports

• Trends

In the Dashboards application, you can use hierarchies in the gadget data series selector to select
data from a source based on its location in the hierarchy. Selecting a hierarchy View allows you to
group device data at different aggregation points in the hierarchy. For example, it is possible to
create a dashboard that depicts the energy usage of a single floor in a building as a single data
series even though there are multiple meters monitoring different circuits.

You can also use hierarchies in several of the reports available in the Reports application. You
can use the source selector for these reports to select items from the hierarchy to include in the
report. As in the Dashboards application, a hierarchy View groups device data at different
aggregation points, which are then displayed in a report. In addition to the default reports,
hierarchies can also be used in custom reports that have been created for use in different
solutions.

You can use hierarchies in the Trends application to select data from a source based on its
location in the hierarchy.

© 2023 Schneider Electric. All Rights Reserved. 683


Log Viewer Web Applications Guide

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 Viewer User Interface

Date Range Selector.


1
Select the time range for which you want to display the system log entries.
Max Records.
2
Set the maximum number of entries to be displayed in the system log table.
Minimum Priority.
Filter lower priority log entries from the system log table view.
3
The available options, in increasing priority order, are: Diagnostics, Information, Warning,
Error, Critical.

684 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Log Viewer

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.

© 2023 Schneider Electric. All Rights Reserved. 685


Log Viewer Web Applications Guide

System log table


The System log table shows system events for the selected time range and filter settings.
See 1-8 above.
14
TIP: Double-click a row in the table or select a row and hit Enter to view details for this
log entry.

Number of displayed items


15 Shows the number of items visible on this page, and the total number for the selected time
range and filter settings. See 1-8 above.
Page selector.
16 Use the page selector to navigate between pages. Set the number of items that are
displayed on a page.

686 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Event Notification Module

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.

© 2023 Schneider Electric. All Rights Reserved. 687


Event Notification Module Web Applications Guide

Event Notification Module configuration


NOTE: This functionality is part of the Event Notification Module. This module requires a
separate license.

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.

To configure notifications, see:


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

688 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Editing notification settings


Edit notification settings to configure the parameters that control the behavior of the application
and define the delivery options.
To edit notification settings:

1. In Notification Manager, select the Settings tab.

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.

ii. SMTP Settings


SMTP Server Host: Set the SMTP server URL or IP address.

SMTP Server Port: Set the server port number.

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.

© 2023 Schneider Electric. All Rights Reserved. 689


Event Notification Module Web Applications Guide

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.

Server Name or IP Address: Set the SNMP server URL or IP address.

User Name: Set the SNMP server user name.

Authentication Password: Set the SNMP server authentication password.

Privacy Password: Set the SNMP server privacy password.

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.

690 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Maximum Delay (seconds): The time after which the system sends a notification
regardless of any incremental delays.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 691


Event Notification Module Web Applications Guide

Adding a notification rule


Add a notification rule to receive messages when alarms or incidents happen in your power
system.
To add a new notification rule:

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.

3. Select one or more recipients to receive a notification. 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.

5. Specify a notification Rule Name.

6. Enable or disable the rule.

7. Select a message template.

8. Set the Delivery Options:


a. Enable or disable email notification.

b. Enable or disable SMS notification.

c. Enable or disable SNMP notification.

d. Set which activities in the alarm view trigger a notification.

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:

Event Notification Module configuration


Settings
• Editing notification settings

692 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 693


Event Notification Module Web Applications Guide

Enabling or disabling a notification rule


Enable a notification rule to start receiving messages when alarms or incidents happen in your
power system. Disable a notification rule to stop receiving messages for alarms defined in the
rule.
To enable or disable a notification rule:

1. In Notification Manager, select the Rules tab.

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:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

694 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 695


Event Notification Module Web Applications Guide

Editing a notification rule


Edit an existing notification rule to add or remove recipients, or to modify the notification rule
parameters such as alarm view, schedule, or delivery options.
To edit a notification rule:

1. In Notification Manager, select the Rules tab.

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.

4. Update the settings.

5. Click Save.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

696 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 697


Event Notification Module Web Applications Guide

Deleting a notification rule


Delete a notification rule that is no longer needed.
To delete a notification rule:

1. In Notification Manager, select the Rules tab.

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.

3. Click Yes to confirm.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

For reference information see:


• Notification Manager user interface

• Add Rule UI

698 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 699


Event Notification Module Web Applications Guide

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.

2. Enter the following information:


Recipient Name: The name that is displayed in the recipients table and the Available
Recipients list.

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:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

• Deleting a notification rule

700 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

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

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 701


Event Notification Module Web Applications Guide

Editing a recipient
Edit an existing recipient to update the recipient information such as name, email, or phone
number.
To edit a recipient:

1. In Notification Manager, select the Recipients tab.

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.

3. In Edit Recipient, update the information you want to change.

4. Click OK.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

702 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 703


Event Notification Module Web Applications Guide

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:

1. In Notification Manager, select the Recipients tab.

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.

3. Click Yes to confirm.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

704 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 705


Event Notification Module Web Applications Guide

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.

2. Enter the following information:


Template Name: The name that is displayed in the templates table and the Message
Template drop-down box.

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:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

• Deleting a notification rule

Recipients
• Adding a recipient

• Editing a recipient

• Deleting a recipient

706 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Templates
• Adding a template

• Editing a template

• Deleting a template

Schedules
• Adding a Schedule

• Editing a schedule

• Deleting a schedule

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 707


Event Notification Module Web Applications Guide

Editing a template
Edit an existing template to update the information that is included in the alarm notification
messages.
To edit a template:

1. In Notification Manager, select the Templates tab.

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.

3. In Edit Template, update the information you want to change.

4. Click OK.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

708 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 709


Event Notification Module Web Applications Guide

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.

NOTE: You cannot delete the default template.

To delete a template:

1. In Notification Manager, select the Templates tab.

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.

3. Click Yes to confirm.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

710 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 711


Event Notification Module Web Applications Guide

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.

2. Enter a schedule name.

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:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

• Deleting a notification rule

Recipients
• Adding a recipient

• Editing a recipient

• Deleting a recipient

Templates
• Adding a template

• Editing a template

712 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

• Deleting a template

Schedules
• Adding a Schedule

• Editing a schedule

• Deleting a schedule

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 713


Event Notification Module Web Applications Guide

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:

1. In Notification Manager, select the Schedules tab.

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.

3. In Edit Schedule, update the information you want to change.

4. Click OK.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

714 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 715


Event Notification Module Web Applications Guide

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:

1. In Notification Manager, select the Schedules tab.

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.

3. Click Yes to confirm.

Related Topics:

Event Notification Module configuration


Settings
• Editing notification settings

Rules
• Adding a notification rule

• Enabling or disabling a notification rule

• Editing a notification rule

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

716 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

• Deleting a schedule

For reference information see:


• Notification Manager user interface

• Add Rule UI

• Add Recipient UI

• Add Template UI

• Schedules Configuration UI

• Notification delay example

© 2023 Schneider Electric. All Rights Reserved. 717


Event Notification Module Web Applications Guide

Event Notification configuration references


This section contains reference information related to Event Notification configuration.
Use the links below to find the content you are looking for:

Notification Manager user interface


Add Rule UI
Add Recipient UI
Add Template UI
Notification delay example

718 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Notification Manager user interface


Main user interface (UI) and Rules tab

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.

© 2023 Schneider Electric. All Rights Reserved. 719


Event Notification Module Web Applications Guide

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

720 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Settings topic selector


The topic selector groups settings by function. Click a topic to see the relevant settings in
1 the configuration pane.

NOTE: A red dot beside a topic shows that this topic has not been completely configured.

Settings configuration pane


2 The configuration pane shows the Notifications settings related to the selected topic.
(General settings are shown in the above example.)

© 2023 Schneider Electric. All Rights Reserved. 721


Event Notification Module Web Applications Guide

Add Rule UI
Alarm View

Available Alarm Views


1 This shows the alarm views that are available in the system. It shows system views and any
custom views that have been created.
Notify on Alarm View
2 This shows the alarm view that has been selected for this notification rule. Only one alarm
view can be selected.

722 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

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.

© 2023 Schneider Electric. All Rights Reserved. 723


Event Notification Module Web Applications Guide

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.

724 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

Notification Rule Settings

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.

© 2023 Schneider Electric. All Rights Reserved. 725


Event Notification Module Web Applications Guide

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.

726 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Event Notification Module

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.

© 2023 Schneider Electric. All Rights Reserved. 727


Event Notification Module Web Applications Guide

Notification delay example


The following example shows how the delay settings for notifications affect the message delivery.

Example settings:

Initial Delay (seconds) = 10


Incremental Delay (seconds) = 7
Maximum Delay (seconds) = 30

A - New alarm activity occurs every 5 seconds


B - Initial and incremental time delays
C - Notification message is sent after maximum delay of 30 seconds

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.

728 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Rate Editor

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.

Rate Editor User Interface


The Line Item Label and Unit Cost areas on the right list a description of line items and the
associated cost values defined in each rate file. Click a rate file to view its line items and cost
values.
To modify the unit cost value for billing report purposes:

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.

3. To return to the previous value, click Undo.

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

© 2023 Schneider Electric. All Rights Reserved. 729


Software Alarms configuration Web Applications Guide

Software Alarms configuration

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.

The following real-time Alarm Templates are available:

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.

730 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

See Real-time Alarms UI for information on Real-time Alarms configuration.

Logged Data Alarms


These Alarms are based on data that has been logged to the database. Logging of the required
data must be configured, and data logs must be in the database for these Alarms to function
correctly. Use logged data Alarms for alarming on consumption type parameters, such as energy
or WAGES.

PME provides two types of logged data Alarms: Fixed Setpoint Alarms and Smart Setpoint
Alarms.

Fixed Setpoint Alarms


Fixed Setpoint Alarms use pre-defined, fixed threshold values for the Active and Inactive
conditions. For example, you can configure an Over Demand Alarm that goes Active when the
Demand exceeds 800 kW and goes Inactive when the Demand falls below 600 kW. The following
Fixed Setpoint Alarm templates are available:

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.

© 2023 Schneider Electric. All Rights Reserved. 731


Software Alarms configuration Web Applications Guide

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.

Smart Setpoint Alarms


Smart Setpoint Alarms use threshold values for Active and Inactive conditions that are based on
data of the monitored input measurement itself. For example, you can configure an Over Demand
Alarm that goes Active when the Demand is the "Highest Value in last 30 days", or when the value
is "Abnormally High for the day of the week". The following Smart historical Alarm Templates are
available:

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.

732 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

Software Alarms considerations


Take the following into account when using Software Alarms:
• Configuring many Alarm Rules with short update intervals can affect overall system
performance.
• Alarm state is not evaluated if a device is disabled. For example, a communication loss is not
triggered ON or OFF for a disabled device. Activities like maintenance on a meter can be
done without the need to change the Alarm Rule.
• Communication Loss Alarms are only applied to physical devices. Any logical devices or
downstream devices are removed from the Alarm Rule.
• The Alarm Rule name must be unique in the system. That means you cannot have two Alarm
Rules defined with the same name.
• The Alarm Name must be unique for a source. That means you cannot enable two Alarms
with the same Alarm Name for the same source.

To configure software Alarms, see:


• Adding a new Alarm Rule

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

© 2023 Schneider Electric. All Rights Reserved. 733


Software Alarms configuration Web Applications Guide

Adding a new Alarm Rule


Add a new Alarm Rule to monitor and alarm on specific conditions in your power system.
To add a new Alarm Rule:

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.

3. Select the measurements to alarm on. 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

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

734 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

© 2023 Schneider Electric. All Rights Reserved. 735


Software Alarms configuration Web Applications Guide

Enabling or disabling an Alarm Rule


Enable an alarm rule to start monitoring the alarm conditions defined in the rule for the linked
sources. Disable an alarm rule to stop monitoring the alarm conditions defined in the rule for the
linked sources.
To enable or disable an Alarm Rule:

1. In Software Alarms, select the Alarm Rules tab.

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

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

736 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

Editing an Alarm Rule


Edit an existing Alarm Rule to add or remove sources and measurements, or to modify the Alarm
Rule parameters such as Active and Inactive conditions.
To edit an Alarm Rule:

1. In Software Alarms, select the Alarm Rules tab.

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.

4. Update the settings.

5. Click Save.

Related topics:
• Adding a new Alarm Rule

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

© 2023 Schneider Electric. All Rights Reserved. 737


Software Alarms configuration Web Applications Guide

Duplicating an Alarm Rule


Duplicate an existing Alarm Rule to save time when creating a new Rule that is similar to an
existing Rule.
To duplicate an Alarm Rule:

1. In Software Alarms, select the Alarm Rules tab.

2. In the Alarm Rules table, find the row of the Rule which you want to duplicate, and then click

Duplicate in this row to open the Edit Alarm Rule window.

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

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

738 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

Deleting an Alarm Rule


Delete Alarm Rules that are no longer needed.
To delete an Alarm Rule:

1. In Software Alarms, select the Alarm Rules tab.

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

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

© 2023 Schneider Electric. All Rights Reserved. 739


Software Alarms configuration Web Applications Guide

Using the Setpoint Calculator


Use the Setpoint Calculator to calculate values for the Active and Inactive Alarm conditions.

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

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

740 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

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:

1. Click Add Schedule.


You can access this control in the:
Schedules tab of the main Software Alarms user interface

Add Alarm Rule - Schedule window (when adding a new Alarm Rule)

Edit Alarm Rule > Schedule tab (when editing an existing Alarm Rule)

2. Enter a Schedule Name.

3. Define the active and inactive days and times of the Schedule.

4. Click Save.

Related topics:
• Adding a new Alarm Rule

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

© 2023 Schneider Electric. All Rights Reserved. 741


Software Alarms configuration Web Applications Guide

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

• Enabling or disabling an Alarm Rule

• Editing an Alarm Rule

• Duplicating an Alarm Rule

• Deleting an Alarm Rule

• Using the Setpoint Calculator

• Adding a Schedule

• Software Alarms configuration

For reference information see:


• Schedules

• Software Alarms UI

• Add Alarm Rule UI

• Schedules Configuration UI

742 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

Software Alarms references


This section contains reference information related to Software Alarms.
Use the links below to find the content you are looking for:

Software Alarms UI
Add Alarm Rule UI
Schedules Configuration UI

© 2023 Schneider Electric. All Rights Reserved. 743


Software Alarms configuration Web Applications Guide

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.

Alarm Rules tab

Add Alarm Rule


3
Use Add Alarm Rule to create a new Alarm Rule.
Alarm Rules table
4
The Alarm Rules table shows all the Alarm Rules that are configured in the system.
Enable Alarm Rule
Each Alarm Rule can be enabled or disabled separately. The Enable Alarm Rule slider
5
shows the enable state of the Alarm Rules. Click the slider for an Alarm Rule to enable or
disable this Rule.
Alarm Rules options
6
Use Alarm Rules options to duplicate, edit, or delete Alarm Rules.

744 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

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

Source View Alarm Rules table


1 The table shows an alternate view of the Alarm Rules. Use this view to see which Alarms
are configured for which sources.
Show Alarm Rule
2 When you click Show Alarm Rule for a row in the Source View table, the Alarm Rules tab
opens with the specific Alarm Rule highlighted.

© 2023 Schneider Electric. All Rights Reserved. 745


Software Alarms configuration Web Applications Guide

Add Alarm Rule UI


Alarm Templates

Alarm Template Search


1
Type a search string into the search box to find the alarm template you are looking for.
Alarm Template groups
2
The available alarm templates are grouped by application.
Alarm Template list
3
A list of alarm templates that are available in the selected group.

746 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

Measurement Selection UI
Measurement Selection with recommended measurements

Measurement Selection without recommended measurements

© 2023 Schneider Electric. All Rights Reserved. 747


Software Alarms configuration Web Applications Guide

Alarm Rule Details UI


Real-time Alarms UI

(The above is one example of a Real-time Alarm. The configuration options may vary for other
Real-time Alarms.)

Alarm Name
1 The Alarm Name is the identifier for this alarm in the system. It is used as a reference by
other applications.
Input Evaluation
2 The Input Evaluation setting determines how often the Alarm evaluates the input
measurement value.
Active Condition
3
The Active Condition settings determine when the Alarm goes into an Active state.
Inactive Condition
4
The Inactive Condition settings determine when the Alarm goes into an Inactive state.
Advanced Settings
5 The Advanced Settings determine which priority value is assigned to the Alarm and if the
extreme measurement value that occurs during the Alarm active state is logged.

748 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

Logged Data Alarms UI (Fixed Setpoint)

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

© 2023 Schneider Electric. All Rights Reserved. 749


Software Alarms configuration Web Applications Guide

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.

Logged Data Alarms UI (Smart Setpoint)

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

750 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

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:

Highest Value in last 30 days Abnormally High Value


Lowest Value in last 30 Days Abnormally Low Value
Highest Value in last Year Abnormally High Value for similar time of day
Daily Value above 50% of Average Abnormally High Value for the day of week

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

© 2023 Schneider Electric. All Rights Reserved. 751


Software Alarms configuration Web Applications Guide

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

Enable Alarm Rule


1 The Enable Alarm Rule slider shows the enable state of the Alarm Rule. Click the slider to
enable or disable this Rule.
Alarm Status Measurement Mappings
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.
2 Enable real-time Alarm Status measurements if you want to access Alarm state information
in Diagrams, Trends, or other real-time applications in PME.

NOTE: These status measurements are not currently available in the VIP/Designer.

752 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide Software Alarms configuration

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.

© 2023 Schneider Electric. All Rights Reserved. 753


User Manager Web Applications Guide

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.

Use User Manager to:


• Configure users and user groups.

• Customize user access level privileges.

• View web application user licensing information.

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.

To configure users and user groups, see:


Users
• Users

• Adding a standard user

754 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 755


User Manager Web Applications Guide

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:

User Type Characteristics


This is a PME native user account. The username, password, and
details are defined in the PME User Manager.
Standard user
Note: The email addresses defined for a user can be used for
report subscriptions.
This is an account from an external Windows system. The
Windows user username, password, and details are defined through the
Windows Active Directory or local Windows operating system.
This is a group of accounts from an external Windows system. The
Windows group username, password, and details are defined through the
Windows Active Directory or local Windows operating system.

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.

756 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

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.

The following limitations exist for all PME users:


• A user cannot change its own access level.

• A user cannot delete its own account.

Related topics:
Users
• Users

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

© 2023 Schneider Electric. All Rights Reserved. 757


User Manager Web Applications Guide

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

758 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Adding a standard user


Add a standard user to create an account for accessing PME. Set the access level for the user to
control what they are allowed to do.

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.

To add a standard user:

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.

3. (Optional) Enter Details information.

4. Click Add.

Related topics:
Users
• Users

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

© 2023 Schneider Electric. All Rights Reserved. 759


User Manager Web Applications Guide

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

760 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Adding a Windows user


Add a Windows user to give this user access to PME. Set the access level for the Windows user
to control what they are allowed to do.

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.

To add a Windows user:

1. In User Manager, select the Users tab, and then click Add Windows User

2. In Add Windows User - Selection:


a. Select a domain name.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

© 2023 Schneider Electric. All Rights Reserved. 761


User Manager Web Applications Guide

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

762 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Adding a Windows group


Add a Windows group to give all Windows users in this group access to PME. Set the access level
for the Windows group to control what they are allowed to do.

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.

To add a Windows group:

1. In User Manager, select the Users tab, and then click Add Windows Group

2. In Add Windows Group - Selection:


a. Select a domain name.

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.

3. In Add Windows Group - Details, assign an access level.

(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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

© 2023 Schneider Electric. All Rights Reserved. 763


User Manager Web Applications Guide

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

764 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Changing a username
Change a username to give the user a better or more meaningful name.

NOTE: You can only change the name of a standard user in User Manager. You cannot change
the name of a Windows user or group.

To change a username:

1. In User Manager, select the Users tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

© 2023 Schneider Electric. All Rights Reserved. 765


User Manager Web Applications Guide

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

766 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Changing a user password


Change a user password to update the password as part of a security best practice, or because
the existing password is lost.

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:

1. In User Manager, select the Users tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

© 2023 Schneider Electric. All Rights Reserved. 767


User Manager Web Applications Guide

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

768 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Changing a user access level


Change a user access level to give this user higher or lower access permissions in PME.

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.

To change a user access level:

1. In User Manager, select the Users tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

© 2023 Schneider Electric. All Rights Reserved. 769


User Manager Web Applications Guide

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

770 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Changing user details


Change user details to add additional information or update outdated information.

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.

To change user details:

1. In User Manager, select the Users tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

© 2023 Schneider Electric. All Rights Reserved. 771


User Manager Web Applications Guide

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

772 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Deleting a user
Delete a user if this user is no longer needed, for example if someone no longer needs access to
PME.

NOTE: Windows users or groups are only removed from PME. The group or user is not deleted
from Windows.

NOTE: When a user is deleted, this user will be logged out automatically by the system after a
short period of time, if they are logged in.

To delete a user:

1. In User Manager, select the Users tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

© 2023 Schneider Electric. All Rights Reserved. 773


User Manager Web Applications Guide

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

774 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

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.

• A user can be a member of multiple groups.

• When a new user is created, it is automatically added to the Global 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 non-supervisor level user that is a member of a custom group is promoted to supervisor, it


is automatically removed from all custom groups and added to the Global group.
• If the last custom group is deleted, all of its members are moved to the Global group.

The following rules apply to resource access by groups in PME:


• A user that is a member of multiple groups can access the sources of each group.

• If a member of a custom group is deleted or removed from the group, then this user's public
content, such as dashboards or reports, remains available to the group.

© 2023 Schneider Electric. All Rights Reserved. 775


User Manager Web Applications Guide

• 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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

776 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 777


User Manager Web Applications Guide

Adding a user group


Add a user group to control which sources and applications the group members can access in
PME.
To add a user group:

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

778 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 779


User Manager Web Applications Guide

Adding a user to a user group


Add a user to a user group to give this user access to the sources and applications assigned to
this group in PME.
To add a user to a user group:

1. In User Manager, select the User Groups tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

780 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 781


User Manager Web Applications Guide

Adding sources to a user group


Add sources to a user group to give the users in this group access to these sources in PME.
To add sources to a user group:

1. In User Manager, select the User Groups tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

782 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 783


User Manager Web Applications Guide

Changing a user group name


Change a user group name to give this group a better or more meaningful name.
To change a user group name:

1. In User Manager, select the User Groups tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

784 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 785


User Manager Web Applications Guide

Removing a user from a user group


Remove a user from a user group to no longer give this user access to the sources and
applications assigned to this group in PME.
To remove a user from a user group:

1. In User Manager, select the User Groups tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

786 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 787


User Manager Web Applications Guide

Removing sources from a user group


Remove sources from a user group to no longer give the users in this group access to these
sources in PME.
To remove sources from a user group:

1. In User Manager, select the User Groups tab.

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.

3. In Edit User Group, select the Sources tab.

4. In the Selected Sources list, select the source you want to remove, and then click Remove

for this source.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

788 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 789


User Manager Web Applications Guide

Changing application access for a user group


Change application access for a user group to add or remove access to certain applications for
the members of this group in PME.
To change application access for a user group:

1. In User Manager, select the User Groups tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

790 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 791


User Manager Web Applications Guide

Moving a user between user groups


Move a user to a different user group to change which sources and applications this user can
access in PME.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

792 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 793


User Manager Web Applications Guide

Deleting a user group


Delete a user group if this group is no longer needed, for example after all users have been
removed from the group.
To delete a user group:

1. In User Manager, select the User Groups tab.

2. In the user groups table, select the row of the user group you want to delete, and then click
Delete in this row.

3. In Delete User Group, click Delete.

Related topics:
Users
• Users

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

794 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 795


User Manager Web Applications Guide

Viewing Web Applications user license information


View license information to determine the number of available, free licenses left in the system.
You can also see which users have licenses issued to them, and when they were issued.

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.

To view license information:

1. In User Manager, select the Licenses tab.

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

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

796 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 797


User Manager Web Applications Guide

Customizing Access Level Privileges


Each user in PME has an access level. This access level determines the actions the user is
allowed to take in the software. There are 5 different access levels. The highest level is
supervisor, the lowest level is observer. Each access level has a default set of privileges. You can
customize many of these privileges, as shown below.

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.

To customize access level privileges:

1. In User Manager, select the Privileges tab.

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.

3. Click Save Privileges to apply the changed settings.

Related topics:
Users
• Users

• Adding a standard user

• Adding a Windows user

• Adding a Windows group

• Changing a username

• Changing a user password

• Changing a user access level

• Changing user details

• Deleting a user

User groups
• User Groups

• Adding a user group

• Adding a user to a user group

• Adding sources to a user group

• Changing a user group name

• Removing a user from a user group

• Removing sources from a user group

• Changing application access for a user group

798 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

• Moving a user between user groups

• Deleting a user group

For information on the Web Application user licenses, see:


• Viewing Web Applications user license information

To customize user access level privileges, see:


• Customizing Access Level Privileges

For reference information see:


• User Manager

• User Manager user interface

• Default User Access Level Privileges

© 2023 Schneider Electric. All Rights Reserved. 799


User Manager Web Applications Guide

User Manager references


This section contains reference information related to User Manager.
Use the links below to find the content you are looking for:

User Manager user interface


Default User Access Level Privileges

800 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

User Manager user interface


Users user interface (UI)

User Manager Help


1
Click Help to open the online help.
Users, User Groups, and Licenses tabs
2
Click a tab to open the associated screen.
Add Standard User, Add Windows User, and Add Windows Group buttons
3
Click a button to activate its function.
Search Users box
4
Enter a search string to find users in the users table.
Users table
5
Shows the existing users in the system.
Edit and Delete icons
6
Click Edit to make changes to this user. Click Delete to delete this user.
Number of displayed users
7
Shows the number of items visible on this page, and the total number of items in the system.
Page selector
8
Navigate between pages. Set the number of items that are displayed on a page.

User Groups UI

© 2023 Schneider Electric. All Rights Reserved. 801


User Manager Web Applications Guide

Add User Group button


1
Click the button to add a new user group.
User Group table
2
This table shows the existing user groups in the system.

Licenses UI

1 Web Applications User Licenses Summary


2 Licenses table

Privileges UI

Save Privileges and Reset Privileges buttons


1 Click a button to activate its function. Note: Reset Privileges resets all access level
privileges to their system defaults. See Default User Access Level Privileges for details.
2 Privileges table

802 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

© 2023 Schneider Electric. All Rights Reserved. 803


User Manager Web Applications Guide

Default User Access Level Privileges


The access level that is assigned to a user in Power Monitoring Expert determines the
permissions this user has in the system. There are five access levels - Observer, User, Controller,
Operator, and Supervisor. Certain default privileges are assigned to the different access levels.
Some of these privileges are configurable. See Customizing Access Level Privileges for details.

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:

Configurable Application Privilege Observer User Controller Operator Supervisor*

Yes Alarm Views Access the settings No No No No Yes

Yes Alarms Access the application No Yes Yes Yes Yes

Yes Alarms Acknowledge alarms No No Yes Yes Yes

Yes Alarms Create new alarm views No No Yes Yes Yes

Yes Alarms Delete any alarm view No No No No Yes

Yes Alarms Edit any alarm view No No No No Yes

Set system default alarm


Yes Alarms No No No No Yes
view

Yes Alarms View incidents No Yes Yes Yes Yes

Yes Authorized Hosts Access the settings No No No No Yes

Yes Breaker Configuration Tool Access the tool No No No Yes Yes

Yes Cloud Agent Manager Access the tool No No No No Yes

Yes Dashboards Access the application Yes Yes Yes Yes Yes

Yes Dashboards Create new dashboards No Yes Yes Yes Yes

Yes Dashboards Delete any dashboard No No No No Yes

Yes Dashboards Edit any dashboard No No No No Yes

Yes Dashboards Manage slideshows No No Yes Yes Yes

Set system default


Yes Dashboards No No No No Yes
dashboard

Yes Dashboards View slideshow list Yes Yes Yes Yes Yes

Yes Deactivate Alarms Access the tool No No No No Yes

Yes Device Manager Access the tool No No No Yes Yes

Device Type and Driver Package


Yes Access the tool No No No No Yes
Installer

Yes Diagnostic Viewer Access the tool No No Yes Yes Yes

Yes Diagnostics and Services Access the settings No No No No Yes

Yes Diagrams Access the application Yes Yes Yes Yes Yes

804 © 2023 Schneider Electric. All Rights Reserved.


Web Applications Guide User Manager

Configurable Application Privilege Observer User Controller Operator Supervisor*

Yes Diagrams Create new diagrams No No No No Yes

Yes Diagrams Delete any diagram No No No No Yes

Yes Diagrams Edit any diagram No No No No Yes

Yes Diagrams Set system default diagram No No No No Yes

Yes Diagrams (Standalone) Access the application Yes Yes Yes Yes Yes

Yes Event Watcher Access the tool No No No No Yes

Yes EWS Client Access the settings No No No No Yes

Yes EWS Server Access the settings No No No No Yes

Generator Performance
Yes Access the tool No No No Yes Yes
Configuration Tool

Generator Power Configuration


Yes Access the tool No No No Yes Yes
Utility

Yes Hierarchy Manager Access the tool No No Yes Yes Yes

Insulation Monitoring
Yes Access the tool No No No Yes Yes
Configuration Tool

Yes Log Viewer Access the tool No No No Yes Yes

Yes Logical Device Type Editor Access the tool No No No Yes Yes

Yes Login Options Access the settings No No No No Yes

Yes Management Console Access the application No Yes Yes Yes Yes

Yes Management Console Configure system No No No Yes Yes

Connect/disconnect sites
Yes Management Console No No Yes Yes Yes
and devices

Yes Manual Data Editor Access the tool No No No No Yes

Modbus Gateway Service


Yes Access the tool No No No No Yes
Configuration

Yes Modeling Configuration Access the tool No No Yes Yes Yes

Yes Notifications Access the tool No No No Yes Yes

Yes Personal Preferences Access the settings No Yes Yes Yes Yes

Power Losses Configuration


Yes Access the tool No No No Yes Yes
Utility

Yes Rate Editor Access the tool No No Yes Yes Yes

Yes Realtime and OPC Diagnostics Access the tool No No No Yes Yes

Yes Registration Access the settings No No No No Yes

Yes Report Theme Access the settings No No No No Yes

Yes Reports Access the application Yes Yes Yes Yes Yes

Yes Reports Create new reports No Yes Yes Yes Yes

© 2023 Schneider Electric. All Rights Reserved. 805


User Manager Web Applications Guide

Configurable Application Privilege Observer User Controller Operator Supervisor*

Yes Reports Delete any report No No No No Yes

Yes Reports Edit any report No No No No Yes

Yes Reports Manage report subscriptions No Yes Yes Yes Yes

Yes Security Options Access the settings No No No No Yes

Yes Session Timeout Access the settings No No No No Yes

Yes Software Alarms Access the tool No No Yes Yes Yes

Yes System Language Access the settings No No No No Yes

Yes System Theme Access the settings No No No No 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 Trends Create new trends No Yes Yes Yes Yes

Yes Trends Delete any trend No No No No Yes

Yes Trends Edit any trend No No No No Yes

Yes Upload Report Template Access the tool No No No No Yes

Yes UPS Configuration Tool Access the tool No No No Yes Yes

Yes UPS Power Configuration Utility Access the tool No No No Yes Yes

Yes User Manager** Access the tool No No No No Yes

Yes User Manager** Add user groups No No No No Yes

Yes User Manager** Add users No No No No Yes

Yes User Manager** Delete any user No No No No Yes

Yes User Manager** Delete any user group No No No No Yes

Yes User Manager** Edit any user No No No No Yes

Yes User Manager** Edit any user group No No No No Yes

Yes User Manager** View user groups No No No No Yes

Yes User Manager** View users No No No No Yes

* Supervisor access level has all privileges. This is not configurable.


** User Manager privileges are not configurable.

806 © 2023 Schneider Electric. All Rights Reserved.


Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison
France

+33 (0) 1 41 29 70 00

www.se.com

As standards, specifications, and designs change from time to time,


please ask for confirmation of the information given in this publication.

© 2023 Schneider Electric. All Rights Reserved.

7EN02-0487-00 07/2023

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy