PME 8.2 - Hierarchy Manager
PME 8.2 - Hierarchy Manager
7EN52-0413-00
03/2017
Legal Information
The Schneider Electric brand and any registered trademarks of Schneider Electric Industries SAS
referred to in this guide are the sole property of Schneider Electric SA and its subsidiaries. They
may not be used for any purpose without the owner's permission, given in writing. This guide and its
content are protected, within the meaning of the French intellectual property code (Code de la
propriété intellectuelle français, referred to hereafter as "the Code"), under the laws of copyright
covering texts, drawings and models, as well as by trademark law. You agree not to reproduce,
other than for your own personal, noncommercial use as defined in the Code, all or part of this guide
on any medium whatsoever without Schneider Electric's permission, given in writing. You also
agree not to establish any hypertext links to this guide or its content. Schneider Electric does not
grant any right or license for the personal and noncommercial use of the guide or its content, except
for a non-exclusive license to consult it on an "as is" basis, at your own risk. All other rights are
reserved.
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.
As standards, specifications and designs change from time to time, please ask for confirmation of
the information given in this publication.
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.
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.
Contents
Safety Precautions 7
Hierarchy Manager 9
Hierarchy templates 9
Nodes 10
Node properties 10
Common elements of hierarchy templates 11
Creating a hierarchy 12
Open Hierarchy Manager 13
Add Building Three to the hierarchy 13
Associate areas and devices to Building Three 15
View the hierarchy in a tree configuration 16
Adding and removing devices 17
Creating an apportioned meter 18
Creating a virtual meter 19
Adding a virtual meter to a hierarchy node 20
Dynamic hierarchy 20
Meter apportionment 21
Virtual meter 21
Using hierarchies in other applications 22
7EN52-0413-00 Page 5 of 24
Hierarchy Manager - Help Topics
Page 6 of 24 7EN52-0413-00
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 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 because communication delays can
occur between the time a control is initiated and when that action is applied.
• Do not use the software to control remote equipment without securing it with an authorized
access level, and without including a status object to provide feedback about the status of the
control operation.
Failure to follow these instructions can result in death or serious injury.
WARNING
INACCURATE DATA RESULTS
• Do not incorrectly configure the software, as this can lead to inaccurate reports and/or data
results.
• 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
• Change default passwords to help prevent unauthorized access to device settings and
information.
• Disable unused ports/services and default accounts to help minimize pathways for malicious
attackers.
• Place networked devices behind multiple layers of cyber defenses (such as firewalls, network
segmentation, and network intrusion detection and protection).
• Use cyber security best practices (for example: least privilege, separation of duties) to help
prevent unauthorized exposure, loss, or modification of data and logs, or interruption of
services.
Failure to follow these instructions can result in death, serious injury, and equipment
damage.
7EN52-0413-00 Page 7 of 24
Safety Precautions Hierarchy Manager - Help Topics
Page 8 of 24 7EN52-0413-00
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
StruxureWare™ 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.
The following topics provide specific information regarding the features and use of the Hierarchy
Manager application:
The hierarchies, nodes, relationships, and views are configured via a web interface called Hierarchy
Manager, which you can open from the Settings page in Web Applications. Once configured, views
of the hierarchy structure can be used in different areas of Power Monitoring Expert.
NOTE: Before using Hierarchy Manager, ensure that devices, logical devices, or managed circuits
have been added to Power Monitoring Expert through the Management Console component.
Hierarchy templates
When the Hierarchy Manager application opens, everything displayed in the application is based on
the hierarchy template defined in the system. This template defines the parameters of the model. If
you were to describe the physical layout of a building for example, you could describe the name of
the building, each floor of the building, and the rooms or areas that each floor contains. The
hierarchy template for a building's physical layout does the same thing, using Nodes to represent
the different aspects of the model.
7EN52-0413-00 Page 9 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
Note that a Virtual Meter Node is included in the hierarchy template. You can define virtual meters
without associating them with a hierarchy, or you can include virtual meters in a hierarchy the same
way that you include devices. You can select virtual meters for many of the reports in the Reports
application.
Each Node contains instances of that particular Node type, which in turn are defined by a set of
properties. These properties not only define the different parts of the model, they also define the
relationships that exist between the different Nodes. This is useful when aggregating the device
data used in other parts of Power Monitoring Expert.
Once the model has been created, the devices that are collecting data can be associated with the
different levels of the hierarchy that are defined in the template.
Nodes
A Node can be described as the building block of a hierarchy. Nodes are used to model a customer
system and can represent:
l Electrical equipment
l Logical concepts
l Physical locations
Nodes are displayed in Hierarchy Manager as a set of tabs. Each tab is labeled with the name of the
part of the model it represents. Each Node displays a number of Node instances in a grid format. In
Hierarchy Manager, a Node can be described as the type of object required to model a system,
while Node instances can be thought of as the reference to the real-world objects in that system.
For example, if 'Car' is used as an example of a Node, then 'my Corvette' could describe an
instance of the Car Node.
A hierarchy that represents the physical layout of a company's industrial site might have a Site
Node, a Building Node, and an Areas Node. Each of those Nodes can contain instances of that
Node type. Under the Building Node for example, you could list the different buildings located in a
particular site. The Properties of each of these Nodes are specified by the user.
Each Node instance is represented in the system as a set of properties that define the
characteristics of that instance. These properties can be further broken down into Attributes and
References.
Node properties
Attributes and References can be used to describe the properties of a Node, and their relationships
to other Nodes. These properties provide the context that helps to describe the different parts of the
model. For example, a Node called Floors may 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.
Page 10 of 24 7EN52-0413-00
Hierarchy Manager - Help Topics Hierarchy Manager
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. In situations where 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 " on page 12 for more
information.
Hierarchy Manager has a series of tabs across the top of the page. These tabs are the
representation of the Nodes. Clicking on any of these tabs displays the instances of the Node types
in a grid format.
The process involved with creating an instance of a Node type is the same for most hierarchy
templates. To create a new instance, select the applicable tab and click Add. The Properties
window opens, containing fields that represent the properties for that particular Node instance. Any
required fields are identified with a Required message. Click in the attribute fields and enter the
necessary information. Reference fields are selected from a grid, and can also have a time
7EN52-0413-00 Page 11 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
dimension associated with them (see "Dynamic hierarchy" on page 20 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 may need to create a new instance for that Node type.
To edit an instance of a Node type, click the applicable tab, double-click an instance in the grid, or
select it and click Edit. Make the changes to the applicable fields in the Properties dialog and click
OK.
To delete an existing instance of a Node type, select the applicable tab, select an instance on that
tab and click Delete. After you confirm the delete action, the instance disappears from the grid, and
any reference information regarding the deleted instance is removed from all affected Node
instances.
Tree View
Displaying the views of a template is also similar for most template types. You can see the view of
a hierarchy by clicking the Show Views link. The view shows the different levels of the hierarchy,
and the date range for each entry of the hierarchy.
Date Range: Use the To and From fields to select the date range to display the hierarchy.
Available Views: Use this section to switch between different views if there is more than one view
available. The available views are determined by the hierarchy template. Click Update when you
change the date range, the scale, or view.
Scale: Select Days or Months to provide the appropriate scale to the hierarchy view.
Beside each hierarchy level is a bar that indicates when in the date range the Node was part of the
hierarchy. If the bar has a rounded edge, the Node reference has an end date within the date range.
If the bar has a square edge, the Node reference continues beyond the date range.
You can click the pencil (edit) icon to the left of the bars to open and edit the properties for the
related item.
If you do not see a node in the hierarchy view, make sure the date range includes the date that Node
was part of the hierarchy. You can view the date range for a hierarchy entry by hovering the pointer
on it.
Creating a hierarchy
The following example uses the default hierarchy template (with Site, Buildings, and Areas nodes)
to illustrate the basic functionality of Hierarchy Manager.
In this scenario, you 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 you must add this building information into 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 several meters. In Hierarchy Manager, you must swap the old devices with the new
by changing the end date for the existing devices to the day they were removed. New devices must
be associated with their correct areas and their start dates must correspond to the date they were
installed.
Page 12 of 24 7EN52-0413-00
Hierarchy Manager - Help Topics Hierarchy Manager
2. Type a user name and password in the Login dialog, if required, and click OK to open
Hierarchy Manager.
In the following steps, devices have already been added to the system through Management
Console, and the hierarchy has been populated with site, building, and area information. For
additional information regarding adding devices to the system, refer to the "Management
Console" section of the StruxureWare Power Monitoring Expert User Guide.
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 type Building Three in the Name field.
7EN52-0413-00 Page 13 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
3. Click Add above the Site grid to open the Add Site References dialog and select the Faber
College site name in the grid.
4. Click the From date field or click the calendar icon beside it. Select a start date of March 15 in
the calendar.
Page 14 of 24 7EN52-0413-00
Hierarchy Manager - Help Topics Hierarchy Manager
5. Confirm that the date has changed in the Start Date column under Sites, then click OK.
Four new areas need to be created: Room 3A to Room 3D. You need to associate these areas
with the new building, and assign devices to each area. Set the start date for all of these to
March 15.
2. Click Add above the Areas grid to open the Properties dialog for the Areas node, then type
Room 3A in the Name field.
3. Click Add above the Building grid to open the Add Building References dialog.
5. Click the From field or click the calendar icon beside it. Select the start date of March 15 in the
calendar.
7EN52-0413-00 Page 15 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
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.
9. Click the From field or click the calendar icon beside it. Select the start date of March 15 in the
calendar.
10. Confirm that the date has changed in the Start Date column under Device, then click OK.
11. Follow the same steps to create Room 3B, 3C, and 3D as areas, and assign the respective
devices Faber.Bldg3B, Faber.Bldg3C, and Faber.Bldg3D to them. The following image shows
the complete set of entries on the Areas tab.
Page 16 of 24 7EN52-0413-00
Hierarchy Manager - Help Topics Hierarchy Manager
Click:
l The minus sign beside an entry to collapse that part of the hierarchy.
l The pencil (edit) icon to open and edit the properties for the related item.
l The bar for each entry to see the Node name and the effective date range for that entry.
The devices that you are replacing are associated with Room 2B and 2C in Building Two.
When this task is complete:
l The entry for each device is greyed-out and italicized in the hierarchy if the End Date is the cur-
rent date or earlier.
l Any reports that include these areas only includes data collected by these devices up to this
new end date.
NOTE: Date ranges extend from start of day to start of day. This means that the end date does not
include data collected for that day.
2. Double-click Room 2B in the grid, or select it and click Edit to open the Properties for Room
2B dialog.
7EN52-0413-00 Page 17 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
3. Double-click Faber.Bldg2B 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. Select the end date of March 15 in the
calendar.
5. Confirm that the date has changed in the End Date column under Device, then click OK.
You can now associate the new device with this area. For the purposes of this example the
new device has already been added to the system through Management Console.
6. Click Add above the Device grid to open the Add Device References dialog.
8. Click the From field, or click the calendar icon beside it. Select the start date of March 15 in
the calendar.
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 these areas with a date range that
extends beyond the device start date includes data collected by these new devices as of their start
date. The reports do not include any data for the removed devices as of their end date.
NOTE: You cannot edit the percentage for an apportioned device after you set it. To change the
percentage, you need to change the end date and add the device with a new start date and updated
apportionment percentage, or delete it from the hierarchy and add it again as new entry with the
required percentage.
Page 18 of 24 7EN52-0413-00
Hierarchy Manager - Help Topics Hierarchy Manager
1. Select the device you want to apportion in the Add Device References dialog.
3. If required, click the From or To fields to change the start and end dates for the apportioned
meter.
4. Click OK.
The following image shows that Faber.Bldg2A has an apportioned value of 75 percent as of March
15.
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.
7EN52-0413-00 Page 19 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
Time intervals of the attached devices operate in the same manner as time intervals on meters
attached to hierarchy nodes.
Edit: Editing a virtual meter is similar to editing the relationship between a hierarchy node and a
device. You can add, edit, or delete virtual meters but you need to ensure that your changes respect
time intervals.
For example, if you are replacing a meter, you need to update the End Date for it and you need to
specify an appropriate Start Date for the new meter. Do not delete the original meter as this
removes the meter historically.
Delete: You can delete a virtual meter but you need to take care when doing so. When you delete a
virtual meter, the relationships between all hierarchy nodes and the virtual meter are removed.
Dynamic hierarchy
Another feature of Hierarchy Manager is the ability to assign devices or Node instances for discrete
units of time. Instead of devices existing in either an assigned or unassigned state independent of
time, a device can be assigned to one Node instance for a specific length of time, then assigned to
another instance for another length of time.
Page 20 of 24 7EN52-0413-00
Hierarchy Manager - Help Topics Hierarchy Manager
With this time dimension, Hierarchy Manager can be used by organizations that require an ever-
changing representation of their system. If one tenant moves out and another moves in, that change
can be reflected in the hierarchy. Energy and power usage can be tracked for each tenant over time,
and billing information can be collected, aggregated, and displayed in a report.
NOTE: If your hierarchy does not change over time you do not need to set the date ranges for the
various devices or Node instances. In Power Monitoring Expert, these static hierarchies exist from
the date when the system was first commissioned (system start), to the farthest date the system
recognizes (end of time).
Dynamic hierarchies are established when you create or edit the properties of a Node instance that
is associated with a device. For example, if Customer A is set to lease a rack from a data center,
you can assign the racks and circuits to that customer on a specific date. When tenant A's lease
expires, you can remove the assignment of the racks and circuits on the expiration date and
reallocate them to tenant B.
See "Creating a hierarchy " on page 12 for details on how to use the dynamic hierarchies function.
Meter apportionment
Meter apportionment allows you to assign a percentage of a device that has been assigned to an
area. For example, if a common area is monitored by a single meter but shared by two tenants, for
billing purposes you may want to allocate only a portion of the meter to each tenant. If tenant 1 uses
60% of the common area and tenant 2 uses 40%, you can attach 60% of a meter's reading to the
tenant 1 area node and the other 40% to the tenant 2 area node.
Virtual meter
A virtual meter allows you to aggregate measurements from any combination of devices,
apportioned meters, or other virtual meters available in Hierarchy Manager. The newly created
virtual meter can be assigned to a node in Hierarchy Manager just like any other device, and
appears in dialogs that have a Views selection. You can even create an apportioned meter from a
virtual meter.
Examples:
l 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.
l 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
7EN52-0413-00 Page 21 of 24
Hierarchy Manager Hierarchy Manager - Help Topics
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.
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.
Review the "Dashboards" and "Reports" topics in the Web Applications Help for information
regarding the use of hierarchies and virtual meters.
Page 22 of 24 7EN52-0413-00
Schneider Electric
35 rue Joseph Monier
92500 Rueil Malmaison - France
www.schneider-electric.com
7EN52-0413-00 03/2017