Download as pdf or txt
Download as pdf or txt
You are on page 1of 60

How can I…

Create a KPI Dashboard:


That Shows Daily Electric Consumption vs.
Average Temperature for the Last 30 Days?

System Technical Note


Power Monitoring Expert 8.x

V2.1
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 manual 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.

© 2017 Schneider Electric All Rights Reserved. ii


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

© 2017 Schneider Electric All Rights Reserved. iii


Document Version Tracking

Document
Author Version Date Comments
Version

Not Release. Originally entitled “How can I… Import


KPI Data and Create KPI Dashboards?”. The
--- Joyce Liu 2013-07-08
scope encompassed importing KPI data in general
rather than addressing a specific customer need.

Based on a specific Use Case originally outlined in


Joyce Liu,
1.0 2014-07-14 the unreleased STN “How can I… Import KPI Data
Dana Davidson
and Create KPI Dashboards?”

2.0 Dana Davidson 2015-06-02 Updated for Power Monitoring Expert 8.0

2.1 Dana Davidson 2017-03-12 Updated for PME 8.2

© 2017 Schneider Electric All Rights Reserved. iv


Table of Contents
Legal Information i
Safety information ii

Safety precautions iii


Document Version Tracking iv
About The TVD Program vii

1. Introduction 1
1.1. Purpose 1
1.2. Customer Challenges 1
1.3. Prerequisites 3
1.4. About this Document 4
1.5. Glossary 4

2. Selection 5
2.1. Selected Architecture(s) 5
2.2. Key Functions 6
2.3. Specification for Tender 7

3. Design 8
3.1. Solution Overview 8
3.2. Data Import 9
3.3. Logical Device Types 10
3.4. Logical Devices 11

4. Validation 13
4.1. Validation Method 13
4.2. Time taken by Testers for Configuration and Implementation 13

5. Configuration and Implementation 15


5.1. Steps 1: Subscribe to the XML Feed 16
5.2. Step 2: Configure VIP to read XML Feed 17
5.3. Step 3: Create New Logical Device Type 17
5.4. Step 4: Create New Logical Device 20
5.5. Step 5: Make the Weather Data available in Web Client Dashboards 22

© 2017 Schneider Electric All Rights Reserved. v


5.6. Step 6: Create KPI Dashboard 27

6. Operation and Maintenance 31


6.1. Data Import via XML Import Module 31
6.2. Can I Edit Imported External Data? 31

7. Conclusion 32

8. Appendix 33
8.1. Glossary 33
8.2. Steps referenced from External STN 34
8.3. Operation and Maintenance referenced from External STN 48

9. Supplemental Information and Reference 50

© 2017 Schneider Electric All Rights Reserved. vi


About The TVD Program
This document is a System Technical Note (STN) Report. A STN is one of the documents created
as part of the Tested Validated Documented (TVD) activity. These documents include the
following:

 TVDA: Tested Validated Documented Architectures

A Tested, Validated, Documented Architecture (TVDA) provides technical guidelines and


recommendations for implementing technologies to address your needs and requirements.
This note covers the entire scope of the project life cycle, from the Selection to the Operation
phase, and provides design methodologies and source code examples for all system
components.

 TVDS: Tested Validated Documented Solutions

A Tested Validated Documented Solution (TVDS) is similar to a TVDA, however, a TVDS is


very specific and is usually aimed at a complete solution for a segment. Depending on the
documentation already produced as part of a solution, a TVDS may simply be a report that
summarizes the activities that took place to meet the TVD criteria.

 STN: System Technical Note

A System Technical Note (STN) provides a more theoretical approach by focusing on a


particular system technology. A STN describes when to use a particular technology, and
provides support in the Selection phase of a project. TVDAs and STNs are related and
complementary. Generally, you will find technology fundamentals in an STN and their
corresponding applications in one or several TVDAs or TVDSs.

TVD represents a set of activities that result in a document or documents that are produced to
describe how to achieve a specific goal for an offer or solution. These activities consist of Testing
(or Verifying), Validating, and Documenting. While these activities are part of normal offer
development, the difference with TVD is that they are applied with a specific goal in mind;
Validation, for example, is done specifically to help ensure that the goal of the TVD output is
possible. TVD activities are narrowly focused to help ensure a high standard of quality for the
system or capability that the TVD document describes.

© 2017 Schneider Electric All Rights Reserved. vii


1. Introduction

1.1. Purpose
This technical note describes the necessary steps to create a specific KPI dashboard in Power
Monitoring Expert. KPIs are normally an expression of the combination of metered power
monitoring data, such as energy or power data, along with other data that is not naturally logged
in Power Monitoring Expert (herein referred to as “external data”). This external data can include:

 Energy targets

 Production volume

 Real-time energy price

 Facility data – building area, building occupancy

 Weather data – ambient temperature

This document describes the Solution to 1) import external weather data and compare it with daily
electric consumption data, and 2) how to create a KPI Dashboard to display the comparison. This
document explains how to do the following:

 Import external data into Power Monitoring Expert;

 Create necessary KPI calculations in Power Monitoring Expert;

 Expose the new and external data to Power Monitoring Expert ’s Web Client; and

 Create the relevant KPI dashboards.

1.2. Customer Challenges


Key Performance Indicators (KPIs) are important to managing energy consumption and costs.
KPIs are a way to convert a customer’s volumes of metered data into concise, actionable
information.

KPIs can be used to achieve the following results with a customer’s energy management system:

 Energy efficiency

 Find and quantify opportunities to save energy

 Prove the energy management plan

 Validate energy savings after equipment or building retrofits

© 2017 Schneider Electric All Rights Reserved. 1


 Track and adjust performance

 Monitor energy consumption per unit produced in a manufacturing environment

 Monitor energy consumption per unit area in an office building

 Track energy performance against expected or optimal patterns. For deviations from the
optimal value, check your equipment performance.

 Compare consumption against energy drivers, for example, air temperature, wind speed,
building occupancy, etc.

KPIs are usually derived from comparing actual energy consumption against external data, that
is, data that is not typically logged into Power Monitoring Expert via energy meters. External data
can come from third-party systems, manually generated spreadsheets, automated XML feeds or
this data can be manually entered into Power Monitoring Expert.

Examples of how external data can be combined with metered data and turned into actionable
KPIs are shown in Table 1 below:

External Data KPI

Real-time energy price Calculated energy cost

Business and energy management plans Energy consumption/cost targets

Production volume Consumption or cost per unit

Building area (for example, square footage or m3) Consumption by area

Building occupancy Consumption per person

Weather data – ambient temperature Consumption vs. outside temperature

Table 1: KPI examples using external data

A challenge for the customer is that this data is not native to the Power Monitoring Expert system
and there is no user-level interface for simply importing this data into the system. Therefore, the
application engineer deploying the system should determine how to import this data. Without
established and recommended best practices, the result is often a one-time solution that cannot
be re-used and that is difficult to maintain and upgrade. The purpose of this document is to
provide guidance and suggest current best practices for the following activities:

1. Configuring the system for import;

2. Storing external data; and

3. Creating of KPI dashboards with this external data.

© 2017 Schneider Electric All Rights Reserved. 2


1.3. Prerequisites
This section outlines the requirements necessary to implement this Solution.

1.3.1. System Prerequisites

The following technical prerequisites are required for this Solution:

 Power Monitoring Expert 7.2.2 or higher – completely installed, configured and able to import
data

 Incomer Meter – at least one Power Meter attached to a building’s feeder that is configured
properly in the Power Monitoring Expert system and recording data

 Internet Access – properly configured firewalls to allow access from the server hosting the
Power Monitoring Expert application to the URL of the XML data feed

 The STN: “How can I Import Weather Feed Data into Power Monitoring Expert?”

1.3.2. Competencies

The skills required to implement the Solution discussed in this document include understanding
and having hands-on experience with the following:

 Creating Power Monitoring Expert dashboards

 Creating Power Monitoring Expert Logical Device types and Logical Devices

 Working knowledge and understanding of the external data source, for example, Building
Management System, Microsoft Excel, and XML feed, etc.

 Using the ION XML Import module in the VIP

 Reading XML files and extracting namespace and xPath information

 System programming in Power Monitoring Expert’s Designer tool for cases where KPI values
require calculations in the Virtual ION Processor (VIP)

 Understand the procedure in the STN: “How can I Import Weather Feed Data into Power
Monitoring Expert?”

The amount of time necessary to finish this Solution will be influenced by the level of
understanding for each of these points by the person implementing the Solution.

© 2017 Schneider Electric All Rights Reserved. 3


1.3.3. Additional Prerequisites

This document assumes that the Customer’s Power Monitoring Expert system is already
configured and logging real-time energy data for use in the KPI Dashboard. It is assumed that the
main consumption meters are already connected to Power Monitoring Expert.

1.4. About this Document


This document is intended for Field Engineers, Application Engineers and System Integrators
who have at least a basic knowledge of how to install and commission the Power Monitoring
Expert application. It describes the components, procedures and best practices involved in
specifying and delivering a KPI Dashboard Solution using Power Monitoring Expert.

Scope of Document

Due to the complexity of data aggregation by time in Power Monitoring Expert, this document is
limited to discussing solutions that involve simple or no calculations with real-time data only.
Intermediate knowledge of framework programming is required to configure the VIP to perform
time-based aggregation.

The Solution described in this document is limited to consumption-related KPIs due to the nature
of Dashboards in Power Monitoring Expert.

1.5. Glossary
A glossary is available in the Appendix of this document. Please refer to the glossary if needed.

© 2017 Schneider Electric All Rights Reserved. 4


2. Selection
This chapter presents the different possible solutions that could answer the customer challenges
and identifies the selected Solution described in this document. The choice of architecture and
tools is described, and the reasons why this choice is made.

The purpose of KPI metrics is to provide an overview of the state of a system. KPI dashboards
can be displayed in almost any relevant energy software application. A facility manager may want
to view energy data alongside Building Management data; a global energy manager may want a
high-level energy overview of various sites in the organization; a local energy manager may want
to display energy savings KPIs in the building lobby.

Depending on how the KPI will be used, KPI dashboards can be created in site-specific
applications or global energy management systems. In some cases, the customer may want to
export the power monitoring data to energy management software to view KPIs from a global
view or to building management systems to view KPIs along with Building operations data. In
other cases, the customer may want to import KPI data into Power Monitoring Expert to view KPI
data for the specific site.

The desired solution depends on the purpose of the KPI Dashboards. The Solution documented
in this Technical Note applies when the following are true:

 The customer wants to view energy KPIs along with real-time energy data

 The KPIs are specific to the one site

 The users are only interested in site-specific KPIs

2.1. Selected Architecture(s)


The “Daily Electric Consumption vs. Average Temperature for the Last 30 Days” KPI
Dashboard Solution involves creating a dashboard with data collected and/or calculated outside
of the Power Monitoring Expert system and then displaying that data along with logged energy
consumption data. It is assumed that the customer already has an operational Power Monitoring
Expert system with logged real-time energy data and access to external data (network
connections, XML feeds, etc).

This primary Solution, as illustrated in Figure 1 below involves the following:

1. Importing the external data into Power Monitoring Expert to make the data available for use
in the system;

2. Storing the imported and/or calculated KPI data in a Logical Device and custom
measurement (or standard measurement, if available); and

© 2017 Schneider Electric All Rights Reserved. 5


3. Creating KPI dashboards in Dashboards.

Note: White circles without a number in Figure 1 indicate steps that are not used in this
procedure.

The external data must be imported into the system so that KPI data can be available for use in
the Web Client’s Dashboard component. As a best practice, Logical Devices are used in this
Solution to present the KPI data from the VIP in a more intuitive manner compared to creating
Dashboards with direct links to an obscure VIP.

Figure 1: The “Daily Electric Consumption vs. Average Temperature for the Last 30 Days”
KPI Dashboard Solution

2.2. Key Functions


Creating a dashboard gadget that displays the relationship between electricity consumption and
outside temperature is a basic method to indicate how a building’s energy usage is driven by
temperature fluctuations. The more electricity used in heating and/or cooling a building, the more
apparent this relationship becomes by implementing this Solution. The data results of this
relationship can also drive business decisions to execute energy efficacy programs, such as
updating older HVAC systems or renovating a building with better insulation.

© 2017 Schneider Electric All Rights Reserved. 6


2.3. Specification for Tender
 The software shall be able to show energy consumption trends in relation or correlated to a
driver, for example, temperature.

© 2017 Schneider Electric All Rights Reserved. 7


3. Design
This chapter describes the different parts of the architecture and how they are linked together.

3.1. Solution Overview

Figure 2: KPI Dashboard Solution Design for Real-time External Data and KPI Calculations
The approach illustrated in Figure 2 applies to a scenario where real-time data (for example, air
temperature, real-time energy price, or production volume) is imported and/or required for KPI
calculation in Power Monitoring Expert.

In this architecture, a VIP framework is created to import real-time data and to apply a timestamp
to each value as it is imported. At minimum, the following modules are used:

 The XML Import module is configured to read an XML source (XML feed or file of a specific
format).

 The Data Recorder module logs the external data into a Data Log output register.

 The Periodic Timer module triggers both modules at a user-defined frequency.

© 2017 Schneider Electric All Rights Reserved. 8


If KPI calculations are required, calculations must occur in the above VIP framework. At
minimum, the following modules are used:

 Simple arithmetic calculations can be performed in the Arithmetic module by linking energy
data and external data to the module and defining a simple KPI formula in an output register.

 The results of the calculations can then be written to another Data Log output register in the
existing Data Recorder module.

In order to make this KPI data easy to find in the Web Client Dashboards component, the data
must be stored in the Power Monitoring Expert database by mapping the VIP registers to a
standard or custom measurement in a Logical Device.

A custom Logical Device Type is used to group the standard and/or custom measurements for
the external and calculated data, if available. If importing weather data (ambient temperature,
relative humidity, atmospheric pressure, wind direction, and/or wind speed) or real-time energy
prices in USD or CAD, use standard measurements to store the external data. Otherwise custom
measurement(s) must be created to store the imported and calculated KPI data, and configured
for proper use by Dashboard gadgets.

The KPI data is written to a standard or custom measurement linked to a Logical Device type.
Then the KPI Dashboards can be built in Power Monitoring Expert Dashboards.

3.2. Data Import


There are two main data import tools to use when importing external data. The best one to use
depends on the data import approach and whether KPI calculations are required.

1. The ETL application is used in cases where KPI data contains time-stamped values (past or
future) or KPI data comes from a third-party system. This design will not be used in this
Solution.

2. The XML Import module is used in cases where the KPI data is real-time data, such as
weather data or real-time price data, and/or where KPI calculations are required. It will be
used in this Solution.

Power Monitoring Expert’s XML Import Module (see Figure 3 below) is only available through the
Virtual ION Processor (VIP). Importing data in this way allows use of the VIP’s powerful
functionality for calculations and data manipulation before storing KPI data into the ION_Data
database.

© 2017 Schneider Electric All Rights Reserved. 9


Figure 3: Use VIP XML Import Module for XML feeds or Real-time Data

The minimum information required by the XML Import Module includes:

 The URL of the XML data feed;

 XML namespace associated with the element to query, if available; and

 XPath query(s) to the data point(s) in the XML file.

The Power Monitoring Expert’s XML Import Module is the tool of choice when:

 Real-time data is involved;

 Real-time data is available through an XML feed; and/or

 KPI calculations must be performed before storing the data in ION_Data.

Data can be imported via various means, however, Power Monitoring Expert’s XML Import
module is recommended specifically for managing XML data feeds or importing data values that
do not have an associated timestamp. Using existing and tested tools that come with Power
Monitoring Expert helps to help ensure that the Solution can be supported in the long-term.

3.3. Logical Device Types


The purpose of using a custom Logical Device Types is to group together measurements that
best represent the KPI dataset. When designing a custom Logical Device Type, consider the
following:

 Grouping measurements by type of KPI data; and

 The convenience of locating all KPI Dashboard measurements under one source.

Table 2 below shows some KPI Logical Device Type examples.

© 2017 Schneider Electric All Rights Reserved. 10


Table 2: KPI Logical Device Type Examples

Logical Device Type Measurements Measurement Type

Weather KPI Weather temperature Standard

Weather relative humidity Standard

Weather atmospheric pressure Standard

Weather wind speed Standard

Energy Cost KPI Market Energy Standard

Price Energy Cost Standard

Targets and Budget KPI Expected Energy Consumption Custom

Budgeted Energy Cost Custom

Production KPI Production Volume Custom

Consumption per Widget Custom

Production Cost KPI Production Volume Custom

Consumption per Widget Custom

Market Energy Price Standard

Energy Cost Custom

As indicated in Table 2, a Logical Device Type for a Weather KPI could use a number of
measurements, including:

 Weather temperature

 Weather relative humidity

 Weather atmospheric pressure

 Weather wind speed

In this Solution, we use Weather temperature twice for the Celsius measurement and for the
Fahrenheit measurement.

3.4. Logical Devices


Logical Devices are used to expose the KPI data to Dashboards in an intuitive manner. In this
step, identify the Logical Devices to create and the device type to apply.

Following the Weather KPI example, let’s assume that the customer has three different weather
stations that provide data near the customer’s factory. Having a Weather KPI Logical Device

© 2017 Schneider Electric All Rights Reserved. 11


Type allows us to create additional Logical Devices of the same type. In this case, each device
represents a separate weather station as illustrated in Figure 4 below.

Logical Device Type: Weather KPI

Weather Temperature °F
Weather Temperature °C

Logical Device Type: Weather KPI


Logical Device: Victoria Airport

Weather Temperature °F
Weather Temperature °C

Logical Device Type: Weather KPI


Logical Device: Victoria University

Weather Temperature °F
Weather Temperature °C

Logical Device Type: Weather KPI


Logical Device: Victoria Harbour

Weather Temperature °F
Weather Temperature °C

Figure 4: Example of multiple Logical Devices created from one Logical Device Type used
to store external weather data from three weather stations (Airport, Harbor, and University)
imported via the VIP XML Import Module

© 2017 Schneider Electric All Rights Reserved. 12


4. Validation

4.1. Validation Method


The Validation was performed using two different methods:

Single Weather Station: The steps outlined in Section 5, Configuration and Implementation,
were followed using one specific weather station, Victoria, British Columbia, for all testers.

Multiple Weather Stations: The steps outlined in Section 5, Configuration and Implementation,
were followed. However, each tester selected three different weather stations at random and the
data from these stations were imported into one system using three different logical devices.

4.2. Time taken by Testers for Configuration and Implementation


Single Weather Station

Step First Tester’s Time Second Tester’s Time

Subscribe to the XML Feed 20 minutes 120 minutes

Configure VIP to read XML Feed 30 minutes 30 minutes

Create New Logical Device Type 10 minutes 2 minutes

Create New Logical Device 20 minutes 2 minutes

Make the Weather Data available in 20 minutes 5 minutes


Web Client Dashboards

Create KPI Dashboard 20 minutes 5 minutes

TOTAL 120 minutes 164 minutes

© 2017 Schneider Electric All Rights Reserved. 13


Multiple Weather Stations

Step First Tester’s Time Second Tester’s Time

Subscribe to the XML Feed 20 minutes 5 minutes

Configure VIP to read XML Feed 30 minutes 5 minutes

Create New Logical Device Type 10 minutes 1 minutes

Create Three (3) New Logical Devices 30 minutes 2 minutes

Make the Weather Data available in 30 minutes 3 minutes


Web Client Dashboards

Create Three (3) KPI Dashboards 30 minutes 5 minutes

TOTAL 150 minutes 21 minutes

© 2017 Schneider Electric All Rights Reserved. 14


5. Configuration and Implementation
In this Solution, the Customer wants to see a KPI Dashboard showing daily electric consumption
of a specific building versus average temperature for the last 30 days. Hourly temperature data is
available from a weather subscription service via an XML feed, and total building consumption is
available from the main power meter already connected to the Power Monitoring Expert system.

The implementation steps of this Solution, as illustrated in Figure 5 below, include the following:

1. Importing real-time temperature data via the XML Import Module in the VIP;

3. Logging temperature data to a Data Recorder in the VIP;

4. Linking the VIP temperature registers to a Logical Device; and

5. Plotting actual electricity consumption vs. average temperature in a Bar/Line chart in


Dashboards.

Figure 5: Energy Consumption vs. Weather Temperature KPI Architecture

© 2017 Schneider Electric All Rights Reserved. 15


The general implementation steps for this Solution are as follows:

1. Subscribe to the XML feed.

a. Obtain a subscription to the XML feed.

b. Identify the Weather location and obtain the URL that provides weather data.

2. Create Logical Device to receive weather data. Identify and create measurements, logical
device types and logical devices to “store” the KPI data.

3. Configure VIP to import XML Feed.

a. Analyze the XML response to identify the xPath for each measurement you want to log.

b. In Designer, configure the VIP framework to:

i. Read the XML source (weather feed) via the XML Import module;

ii. Log the raw data to a Data Recorder;

iii. Label the data recorder’s register with a name corresponding to the KPI logged.

c. Test the data import. In Vista, create a Vista diagram to show the imported XML data
and validate data using Vista query tables.

4. Make the Weather Data available in Web Client Dashboards. Map the VIP’s KPI register(s)
to the Logical Device that was created earlier from the Configuration section of this
document.

5. Create KPI Dashboard – Create a new Dashboard gadget to plot actual energy consumption
and weather temperature, and confirm that the expected KPI data successfully appears on
the Dashboard.

The step-by-step instructions on how to import weather feed data via the VIP (Steps 1, 2 and 3 in
this Solution) are available in the document entitled “How can I Import Weather Feed Data into
Power Monitoring Expert?”. This document serves as the foundation to the implementation of this
Solution. It is recommended to have all relevant documents available during implementation.

5.1. Steps 1: Subscribe to the XML Feed


This step involves:

1. Subscribing to a weather XML feed service;

2. Gaining access to the XML data for the relevant weather station; and

3. Identifying the URL for a specific weather station.

© 2017 Schneider Electric All Rights Reserved. 16


For detailed instructions, refer to “Step 1 - Subscribe to a Weather Feed to retrieve data” in the
document entitled “How can I Import Weather Feed Data into Power Monitoring Expert?”, or in
the Appendix of this document.

5.2. Step 2: Configure VIP to read XML Feed


For detailed instructions, refer to the following sections in the document entitled “How can I Import
Weather Feed Data into Power Monitoring Expert?” (Also contained within the Appendix of this
document):

 Step 2 – Analyze the Weather Feed Response to create ‘Paths’

 Step 3 – Configure the VIP

 Step 4 – Log the Temperature Data

Note: Because temperature data is available at hourly intervals, configure the periodic timer to
trigger every hour. However, it may be helpful to temporarily configure the periodic timer to trigger
more frequently (for example, every 5 minutes) until your implementation is complete. This allows
you to confirm that the implementation works— especially after mapping VIP registers to the
Logical Device.

5.3. Step 3: Create New Logical Device Type


1. Open the Power Monitoring Expert Management Console.

2. Select Tools > Logical Device > Logical Device Type Editor

3. Provide the credentials for a Supervisor.

© 2017 Schneider Electric All Rights Reserved. 17


4. In the Logical Device Type Editor, click New to create a new Logical Device Type. A new
blank record is added to the list of Logical Device Types.

5. A message appears at the bottom of this dialog stating that “User data has Errors. Errors
must be corrected before saving changes.” Ignore this message at this time. It simply
indicates that the new Logical Device Type needs to be defined.

© 2017 Schneider Electric All Rights Reserved. 18


6. Navigate to the Summary tab and enter the name of the new Logical Device Type. In this
example, the name is “Weather KPI”.

7. Navigate to the Measurements tab. In the measurements table, select the following
measurement(s) and click the [>>] button to apply the measurement(s) to the new Logical
Device Type:

 Weather Temperature °F

 Weather Temperature °C

© 2017 Schneider Electric All Rights Reserved. 19


8. Click OK to save the new Logical Device type. The Logical Device Type Editor saves the
new Type and closes the Tool.

5.4. Step 4: Create New Logical Device


With the existing Logical Device Types from the previous section, you can create new Logical
Devices as follows.

1. In Management Console, navigate to the Devices view.

© 2017 Schneider Electric All Rights Reserved. 20


2. In the Device list, right-click and select New then Logical Device.

3. The Logical Device Configuration window appears. Select or enter a Device Group and give
the Device a name.

4. Under the Logical Device Type dropdown list, select the corresponding Logical Device
Type.

© 2017 Schneider Electric All Rights Reserved. 21


5. Click OK to save the Logical Device. The links to the measurements will be made after the
data import is implemented.

5.5. Step 5: Make the Weather Data available in Web Client Dashboards
Now that the XML data is being logged to the VIP, the next step is to map the VIP registers to the
Logical Device created earlier. Although temperature data is available in Dashboards via the VIP
“device”, it is more intuitive for the Customer to search for weather data from the Logical Device
named after the weather station.

Map the VIP temperature registers to the Logical Device as follows:

1. On the Power Monitoring Expert Application Server, launch Management Console and
navigate to the Devices list.

2. Select the from the list Logical Device created in Step 4, then right-click and select
Configure Device from the pop-up menu.

3. The Logical Device Configuration window appears. On the right in the Register Mapping list,
expand the Device Name to reveal the measurements of the logical device.

4. In the Input Devices list,

a. Expand the list under the VIP device type to reveal the list of VIP devices.

b. Select the VIP where the weather data is imported.

© 2017 Schneider Electric All Rights Reserved. 22


5. The Input Device Registers list in the middle populates with all possible output registers in
the VIP. Expand the XML Import Module node and find the relevant XML Import Module
output registers (Weather Station Temperature (Celsius) and Weather Station Temperature
(Fahrenheit) in this case) and map them to the corresponding measurements in the Logical
Device (that is, drag and drop registers to the measurement you want to map).

6. Click OK to save mappings. Any data imported by the VIP XML Import module and logged by
the Data Recorder will now be redirected to the Logical Device.

Behind-the-scenes: Although the data is being written to the Data Recorder in the VIP, you need only
map the register(s) from the input module (XML Import Module, in this case) to the
Logical Device measurements. Power Monitoring Expert will automatically associate
new historical data logged by the Data Recorder to the Logical Device and at the same
time make a link to the real-time data. Any data logged prior to the Logical Device
mapping remains under the VIP Source; however no data for that measurement will be
logged to the VIP Source after the Logical Device mapping is in place. This may cause
unexpected results if the VIP Source has been used prior for other purposes, such
as referenced by a dashboard gadget or report.

As illustrated in Figure 6, the Data Recorder serves to log data to the ION_Data
database while the Logical Device mapping serves to redirect the incoming data to the
new Logical Device SourceID.

© 2017 Schneider Electric All Rights Reserved. 23


Figure 6: Data Flow between VIP and Logical Device

Note: Allow 15 minutes for the system to register the mappings throughout.

7. Confirm that the Logical Device has data by creating a quick Vista Query to the Logical
Device.

a. Open Vista and create a new diagram or use an existing test diagram.

b. In the Diagram Objects toolbox, drag and drop the Data Log Viewer object to the
diagram.

c. Right-click the Data Log Viewer object.

d. In the Query Server tab, select the Custom Query Server radio button, and click Edit
Link.

e. Select QUERYSERVER from the Nodes list, and double-click to populate the Managers
list, then the Modules list and the Output Registers list.

f. Select and double-click the QM1 Query Register output register.

g. Click OK.

© 2017 Schneider Electric All Rights Reserved. 24


h. In the Query tab, click Edit Query.

i. Add the newly-created logical device and click Next.

j. From the Available list, select the Data Rec, click Add, then click Next.

k. When prompted to “Select the columns to appear in the Log Viewer”, add the timestamp
and temperature columns, then click Next.

l. Select the timestamp column to sort on, and then click Finish.

© 2017 Schneider Electric All Rights Reserved. 25


m. Click OK in the Data Log Viewer Configuration window to get back to your Vista
diagram.

8. Double-click on the Data Log Viewer icon to open the viewer. More valid data points for each
measurement appear. The first timestamp should be sometime after you mapped the Logical
Device measurements.

9. If data does not appear for the Logical Device or if the Logical Device does not appear in the
list of nodes when you define the Data Log Viewer query, you may need to restart the ION
Network Router Service on the Application Server. Doing so will restart the following
additional ION services:

a. ION Virtual Processor Service;

© 2017 Schneider Electric All Rights Reserved. 26


b. ION Site Service;

c. ION Query Service;

d. ION Log Inserter Service; and

e. ION Real Time Data Service.

10. Check the Data Log Viewer again; Data should appear now. If data does not appear, refer to
the Schneider Electric Knowledgebase or Schneider Electric’s Solutions Expert Online
Community for tips. Seeing data in the Data Log Viewer indicates that data is successfully
logged under the Logical Device.

5.6. Step 6: Create KPI Dashboard


The Customer wants to see a KPI Dashboard showing daily electric consumption of an office
building versus maximum temperature for the last 30 days. Hourly temperature data is now
logged to a Logical Device, and total building consumption data is available from the main power
meter already connected to the Power Monitoring Expert system.

A KPI Dashboard similar to the Figure 7 below appears.

Figure 7: Energy Consumption vs. Ambient Temperature KPI

© 2017 Schneider Electric All Rights Reserved. 27


Create this KPI Dashboard as follows:

1. Open the Power Monitoring Expert Web Client, and login with Supervisor credentials.

2. In the main toolbar, click Dashboards, then click the Setup View link on the upper-right part
of the page.

3. From the Dashboard Library, create a New Dashboard by clicking the “ ” icon and then
click the edit “ ” icon from the list of icons in the Dashboard Library. The Dashboard
Properties window appears.

4. You can change the following options at any time. Enter them in the Properties window per
the suggestions below:

a. General > Name: Weather KPI

b. Layout: 1 Gadget (be sure and click on the picture of the layout of “1 Gadget”; if you
don’t it will retain the 6-gadget layout).

© 2017 Schneider Electric All Rights Reserved. 28


5. Click OK to exit the Dashboard Properties window. Drag and drop a Bar/Line gadget onto
the page from the Gadget Library.

6. Click the Click to Set Up link in the middle of the gadget. The Gadget Properties window
appears.

7. Under the Summary tab, enter a Title and Description. For example, you can use
“Consumption vs. Ambient Temperature” and a description of the location.

8. Leave the Chart Type settings as default – Primary Axis is a Bar Chart and Secondary Axis
is a Line Chart.

9. Under the Data Series – Bar Chart Tab:

a. Click Add. The Bar Chart Source selector appears.

b. In the Sources area, find and select the main power meter.

c. In the Measurements area, find and select the consumption measurement, for instance,
“Real Energy Into the Load”.

d. Update the Display Name if necessary then click OK.

10. Under the Data Series – Line Chart Tab:

a. Click the Add button. The Line Chart source selector appears.

b. In the Sources area, find the Logical Device under the Weather device grouping.

c. In the Measurements area, select Environment for the type filter, then select All
Measurements for the show filter.

d. Two “Weather Temperature” measurements appear. They appear to be identical, but


you can see which one is Fahrenheit and which one is Celsius by selecting the
measurement and noting the Measurement Unit displayed beside the Display Name at
the bottom of the window.

© 2017 Schneider Electric All Rights Reserved. 29


e. Select the measurement you want and enter a series display name (for example,
Temperature in Celsius).

f. Click OK to return to the Chart Properties window.

11. Under the Viewing Period tab, select “Last 30 days – By Day of Week”. Based on the
measurement’s properties as defined in the database, the Dashboard sums the consumption
data to daily values and show the maximum temperature for the day.

12. Click OK to view the resulting Chart. A chart similar to that in Figure 7 above appears.

13. Validate data. Now that data is displayed in the Dashboard, perform a validation to help
ensure the values shown in the Dashboard match what you expect. Using Vista Query, you
can copy the data to Excel, perform the expected aggregation, and compare values on the
KPI Chart.

Note: The KPI Dashboard will not display a full 30 days of activity until the sources referenced by the
dashboard has 30 days of data in the database. If the energy or the weather source has
been recently added, then allow for a 30-day period to transpire to take full advantage of
the KPI Dashboard.

© 2017 Schneider Electric All Rights Reserved. 30


6. Operation and Maintenance
This section discusses how the Solution behaves in normal and maintenance conditions at the
functional level.

6.1. Data Import via XML Import Module


The Real-time KPI Solution runs under components that are native to the Power Monitoring
Expert system, therefore, the Operation and Maintenance does not require anything beyond
normal system procedures. However, there are a few common considerations for long-term data
import via the XML Import Module. For details of these considerations, refer to “Section 5 –
Operation and Maintenance” in the adjoining document entitled “How can I Import Weather Feed
Data into Power Monitoring Expert?”, or in the Appendix of this document.

6.2. Can I Edit Imported External Data?


When working with energy target or budget data, the Customer may want to update this data with
revised forecasts as the year progresses. The Customer may also want to correct an estimated
energy rate or production value with the actual value. In all cases, the Customer requires the
ability to edit external data.

Note: Power Monitoring Expert does not provide any user interface tools for editing logged data.
In addition, the ETL Engine’s Power Monitoring Expert Load task does not overwrite existing data
points.

© 2017 Schneider Electric All Rights Reserved. 31


7. Conclusion
This document provides a field-tested method for creating KPI Dashboards with external data
imported into Power Monitoring Expert via two main methods – XML Import or ETL Engine. This
KPI data is then available for use in Dashboards and Reports. Keep the following key points in
mind:

 Use the XML Import method for real-time data.

 Write the external data to standard and existing measurements when possible.

 It is recommended to review the measurement list in Power Monitoring Expert for existing
measurements before creating a new custom measurement.

 XML Import Method - Ensure you have a proper subscription to the XML feed if the data
comes from a third party service.

 Inform the customer of the potential unexpected results that may arise occasionally and
provide resolutions.

 Test the implementation with a Power Monitoring Expert instance in your facility before
implementing it on the customer site to account for regional or localized settings.

© 2017 Schneider Electric All Rights Reserved. 32


8. Appendix

8.1. Glossary
Please find below a list of relevant terms and corresponding definitions.

Term Description

KPI Key performance indicator – a business statistic that


can change over time and indicates the performance
of a situation/plan/equipment. Common KPI values
include:
 Energy Consumption compared to Expected
Energy
 Energy consumption compared to Ambient
temperature
 Energy cost
 Energy consumption per unit area
 Energy consumption per unit produced
 Greenhouse gas emissions

External data Data whose:


 Data source is “external” to the typical power
monitoring application;
 Data is not logged by a meter in Power
Monitoring Expert; and
 Value varies over time; and
 Is typically used to express an energy
management KPI.

Real-time data Logged data that is given a current timestamp (that is,
timestamp indicating “now”) when it is imported into
the Power Monitoring Expert system.

Historical data Data associated with specific timestamps in the past.

Future data Data associated with specific timestamps in the future.

© 2017 Schneider Electric All Rights Reserved. 33


ETL Engine An external tool that Extracts, Transforms, and Loads
data from an external source into Power Monitoring
Expert. The Transformation task is limited to
managing basic data quality.

ETL Job A set of extract, transform and load tasks that define a
specific path of data transfer.

Data calculation The necessary calculations and effort to convert raw


data into a KPI value. For example:
 The act of multiplying energy consumption
and cost per unit;
 The act of normalizing energy consumption by
total energy consumption for the month.

Data aggregation The necessary aggregation to convert raw energy


data into a single value per
hour/day/week/month/year, etc. For example:
 The act of calculating total energy
consumption for the month.

Logical Device A collection of measurements from physical and virtual


devices, and/or VIP that are grouped into a single
source for use in the system.

Source A term used in the Web Client to refer to a point where


measurements are available. This could be:

 Any device registered on the system


regardless of type - physical (serial, Ethernet,
OPC) or virtual (logical); or

 The VIP

 A point of data collection not linked to any real


device.

8.2. Steps referenced from External STN


Steps 1 to 4 in Sections 4.1 to 4.4 of the STN: “How can I Import Weather Feed Data into Power
Monitoring Expert?” was referenced in sections 5.1 and 5.2 of this document. That section has
been included here for your convenience.

© 2017 Schneider Electric All Rights Reserved. 34


Note: While the steps outlined in this Appendix are based on the STN: “How can I Import Weather
Feed Data into Power Monitoring Expert?”, some of the wording and screenshots have
changed from the original document based on input from testers in the Validation
process. Also, because third-party websites may be updated at any time, screenshots of
these web pages may become out-of-date.

Step 1 - Subscribe to a Weather Feed to retrieve data.

As stated in the Design section, there are several web services available on the internet to supply
weather data. It is important to research the available feeds, test out samples provided, and make
sure that you have reviewed the terms of service if you plan an application for commercial use.
The instructions that follow describe the use of the Weather Underground site.

Sign up for an API key with Weather Underground

Navigate to the Weather Underground site (http://wunderground.com), and then:

1. Scroll down to the bottom of the page to find and click the Weather API for Developers links.

2. Find and Click the Sign Up. After you sign up, you will be required to validate your email
address, and can then proceed to the next step.

© 2017 Schneider Electric All Rights Reserved. 35


3. You now need to “Purchase” a $0 (zero-dollar) Developer API Key (called a Stratus Plan at
the time of this publishing).

a. Click the Pricing link and the Stratus Plan should be selected by default.

b. Click Purchase Key.

4. When you submit the request, you will be required to fill out another form. Fill this form out
and then click Purchase Key.

5. The key appears. Your Key ID is used in URLs later, so copy it to a location where you can
quickly reference it.

© 2017 Schneider Electric All Rights Reserved. 36


Note: As an additional resource, the Weather Underground site provides Developers with API
documentation that is available if you wish to experiment with JSON in PHP or
Javascript. The link is http://www.wunderground.com/weather/api/d/docs.

Verify the Feed in your Browser

Once you have chosen a feed, and have an API Key, verify the results of the XML API call in your
browser as follows:

6. Enter the following string into the address bar in your browser:
http://api.wunderground.com/api/<<KEY_ID>>/conditions/q/CA/
San_Francisco.xml

a. Note that you will need to substitute your <KEY ID> into the string for this to function.

b. You can also use a different city if you want by substituting CA/San_Francisco with your
USState/City (/WA/Seattle), or country/city (France/Paris).

7. When you press Enter to submit the URL, an XML output similar to the following appears.
The first image shows the first tags in the response.

The second image shows some of the data tags that are returned.

8. If you don't see results similar to the images above, double-check the URL you have entered.

Note: Do not use spaces rather than underscores between words.

© 2017 Schneider Electric All Rights Reserved. 37


Note: There is a limit to the number of API calls you can make with your API Key on any day. While
testing, make sure to monitor your traffic, or a Feed provider could deny you service.
Weather Underground will track the API calls your key makes every day; this data is
available in the Analytics section of your Weather Underground user profile. Other
Weather Feed suppliers provide similar analytics.

Step 2 - Analyze the Weather Feed Response to create ‘Paths’

The next step is to locate the data you are interested in from the structured response that
appears in the browser. If you use the URL above, you will see the current conditions in San
Francisco. For this example, we are interested in only the temperature values in both degrees
Fahrenheit and Celsius.

To interpret what you will need to enter in the VIP later, you need to interpret the response above
and determine the path and tags of the temperature values.

Many internet feeds do not have “user-friendly” labels in their documentation. The Weather
Underground format uses <temp_f> and <temp_c> as tags for the Fahrenheit and Celsius
Temperatures.

<temp_f>62.1</temp_f>

<temp_c>16.7</temp_c>

XML is structured with a tree of values, much like the file system on a computer. Within the parent
tag of <response>, are a several layers of nested tags and values. Most modern browsers and
XML viewers will allow you to expand and collapse the parent tags to make it easier to analyze
the structure. When we collapse all the parent values we can, while keeping the temperature
values visible, the structured path to the temperature values is as follows:

<response>

<current_observation>

<temp_f>

<temp_c>

© 2017 Schneider Electric All Rights Reserved. 38


To translate XML to Paths

In order to create a path that defines these for the XML Import module, replace the '<' characters
with '/' characters, and remove all of the '>' characters. See the following examples:

XML tag tree Path

<yard> yard/house/kitchen/light
<house>
<kitchen>
<light>

<response> /response/current_observation/temp_f
<current_observation>
<temp_f>

After analyzing the XML from the Weather Underground feed, the tag tree is as follows:

<response>

<current_observation>

<temp_f>

<temp_c>

Therefore, the Paths are as follows:

Path 1 (for Fahrenheit)

/response/current_observation/temp_f

Path 2 (for Celsius)

/response/current_observation/temp_c

Step 3 - Configure the VIP

To set up the VIP, do the following:

 Create and configure an XML import module.

 Create a temporary External Pulse module and Vista diagram for testing.

 Create a Periodic Timer to define how frequently the weather data is fetched (i.e. what our
measurement intervals are).

Set up the XML Import Module

1. Open Designer, and under the File menu, click Open. Select and open the
VIP.<computer_name> node.

2. From the Options menu, click Show Toolbox if it is not already visible.

© 2017 Schneider Electric All Rights Reserved. 39


3. From the Toolbox, drag and drop the XML Import Module icon onto the opened
VIP.<computer_name> node.

4. Right-click the middle of the XML Import Module to access the Setup Registers, and
configure the following:

a. Double-click the “XIM1 URL” Setup Register to modify it, or select it and click Modify.
Enter the complete URL you used when you tested the XML feed in your browser above.

http://api.wunderground.com/api/<<KEY_ID>>/conditions/q/CA/
San_Francisco.xml

b. Modify the “xPath Query 1” Setup Register to match your Path 1 (degrees F) we
discovered earlier:

/response/current_observation/temp_f

c. Modify the xPath Query 2 (degrees C)

/response/current_observation/temp_c

5. Click OK to exit the Module Setup window.

© 2017 Schneider Electric All Rights Reserved. 40


Set up a test to verify that the XML import is working

Before proceeding further, it is important to verify that the data is available to the system. To do
so, set up and trigger data retrieval and display the result in Vista.

Set up a test framework in your VIP

Continue working in the same node in Designer, and do the following:

1. From the Toolbox, drag and drop the External Pulse Module icon onto the node.

2. Link the External Pulse Module’s Trigger output to the XML Import module’s Read Now input.

3. In the File menu, click the Send & Save to save the test framework.

Set up the Vista Test

1. Open Vista, then click File > New to create a new diagram.

2. From the Options menu, click Show Toolbox if the Toolbox is not already visible.

3. From the Toolbox, drag and drop Control Object onto the new diagram.

4. Right-click Control Object and configure it as follows:

a. Select the Link tab, then select the Custom radio button, and click the “Edit Link”
button.

b. Select the VIP.<computer_name> node from the Nodes list, then double-click it to open
the Managers list for the node.

c. In the Managers list, select and double-click Ext Pulse Modules, then do the same on
Ext Pulse 1 when it is displayed.

d. Finally, select the Trigger output register of the External Pulse module created above,
then click OK to exit the “Create Link” window. Click OK on the “Control Object

© 2017 Schneider Electric All Rights Reserved. 41


Configuration” dialog box to return to the diagram.

5. From the Toolbox, drag and drop Numeric Object onto the same diagram. Repeat to have
two Numeric Objects on the diagram.

6. Right-click the first Numeric Object on the diagram, and do the following:

a. Select the Link tab, click Custom, then click Edit Link.

b. Select VIP.<computer_name> node in the Nodes list, then select “XML Import
Modules” in the Managers list, double-click it, “XML Import 1” (assuming this is the first
such module you have configured) will show up in the Modules list, double-click “XML
Import 1”, and the “XIM Data 1” in the Output Registers list will be selected, which is the
Fahrenheit value. Click OK to exit the tab, then click OK on “Numeric Object
Configuration” dialog box.

c. Leave the Label as the default; you can change this label later when you set up logging.

7. Right-click the second Numeric Object added on the diagram, and repeat the steps above,
but select the XIM Data 2 Output Register for Celsius.

8. From the Edit menu, click Save current user diagram to save the Vista diagram.

Trigger the XML fetch, and display the values in Vista

1. Double-click the Control Object on the saved Vista diagram to activate it; both values of
Fahrenheit and Celsius will appear in the two Numeric Objects respectively.

2. Refresh the XML page; For example, enter


“http://api.wunderground.com/api/<KEY_ID>/conditions/q/CA/San_Francisco.xml” in your
web browser and compare the two temperature values of Fahrenheit and Celsius displayed

© 2017 Schneider Electric All Rights Reserved. 42


with the values displayed in the Vista diagram. Be sure and compare values quickly as the
values refresh often.

3. If the values are not the same, make sure that you have the same location specified in the
URL Setup Register in the “XML Import 1” module in the “VIP.<computer_name>” node in
Designer as the location specified in the URL in your web browser.

4. If no values of Fahrenheit and Celsius show up in the Vista diagram, check that you have
accurately followed the steps above. If no values appear, it may be that the VIP is not
authorized to access the feed. See the Validation section and the Appendix for a possible
cause and solution.

Step 4 – Log the Temperature Data

Now that you have imported the real time values from your weather feed, you can log these
values with data recorders, and use them in reports, and/or dashboards.

Adjust your Label names

In Power Monitoring Expert, there are standard quantities for temperatures in Fahrenheit and
Celsius. You will need to adjust the labels of the XML Import module’s outputs to match these
standard quantity names. These will then be logged in the ION Data database.

1. In Designer, open your VIP and enable the Toolbox.

2. Right click the XML Import module to display the ION Module Setup dialog box. Find the
Data 1 Output Register in the list of Output Registers, then double-click it to open the Modify
Label dialog box.

© 2017 Schneider Electric All Rights Reserved. 43


3. In the Modify Label dialog box, select Use Custom Label, and then change the label name
to: Weather Station Temperature (Fahrenheit).

4. Similarly, change the custom label for the Celsius Data 2 Output Register to: Weather Station
Temperature (Celsius).

Note: It is very important to use the above label names exactly. Do not use any extra spaces at the
end of the word, or change the case. This is the label that the database will recognize as
a standard temperature measurement. Copy and paste it from above if necessary.

5. Click OK on the “ION Module Setup” dialog box.

6. From the Edit menu, click Send Save Changes to Node to save the node.

Note: Label changes made in Designer may not appear immediately in Vista. You can force the
changes to appear by restarting Vista.

Create and Configure the Data Recorder

Create and Link a new Data Recorder module


1. In Designer, from the Toolbox, drag and drop Data Recorder Module onto the
VIP.<computer_name> node.
2. Right-click the middle of the Data Recorder Module, then double-click the Depth in the Setup
Registers list and set it to 1 from 0.
3. Click OK on the ION Module Setup dialog box.
4. Link the “Weather Station Temperature (Fahrenheit)” and “Weather Station Temperature
(Celsius)” outputs to the added Data Recorder Module as two new sources (Left-click the
right hand side arrow of the XML Import Module, select “Weather Station Temperature
(Fahrenheit)” in the “Outputs” dialog box, click Select, move the dotted line to the left-hand

© 2017 Schneider Electric All Rights Reserved. 44


side arrow of the Data Recorder Module and click it, and then select the “New Source” input
of the Data Recorder Module and click it.

5. Left-click the right hand side arrow of the XML Import Module, select Weather Station
Temperature (Celsius) in the Outputs dialog box, click Select, move the dotted line to the
left-hand side arrow of the Data Recorder Module and click it, and then select the “New
Source” input of the Data Recorder Module and click it.

6. Link the Load Complete output to the added Data Recorder Module’s Record input (Left-click
the right-hand side arrow of the XML Import Module, find and select Load Complete in the
Outputs dialog box, click Select, move the dotted line to the left-hand side arrow of the Data
Recorder Module and click it, and then select the “Record” input of the Data Recorder
Module and click it.

7. From the Edit menu, click Send Save Changes to Node to save the node.

Test the Data Recorder

1. Close the VIP node in Designer.

Note: Closing the VIP is necessary to unlock the VIP node and allow the ION Log Inserter
service unhindered access so that it can find the newly established data recording
framework.

2. Open Vista and then open the diagram you created above.

3. Add a new Data Log Viewer object and then right-click it. Click the Query tab, and click Edit
Query to enter the Query Wizard.

a. If Edit Query is not available (greyed-out), you will need to set up the Query Server:

i. Click the Query Server tab, then select the Custom Query Server option and click
Edit Link.

© 2017 Schneider Electric All Rights Reserved. 45


ii. In the Create Link window, double-click your server node, then Query Modules,
Query 1 and QM Query Register.

iii. Finally, click OK. You can now use the Edit Query button.

4. Select VIP.<COMPUTERNAME>, and click Add, and then click Next.


5. Select the Data Recorder you created, click Add, then click Next.

6. Under the Available columns, select the two Weather Station Temperature values, click Add,
and then click Finish. Click OK to exit the Data Log Viewer Configuration.

© 2017 Schneider Electric All Rights Reserved. 46


7. Double-click the Control Object created earlier to trigger a read of the weather feed. After
your values update on the Numeric Objects, double-click the new Data Log Viewer to see the
data.
8. You can also check the values against the Weather Underground web page.

Configure 15-minute Temperature Intervals

After you have confirmed that the weather feed data can be accessed and stored, set up a
periodic timer so that the data is recorded in regular 15-minute intervals.

To add and configure a Periodic Timer to Pulse your XML Import:

1. In Designer, Open the VIP diagram.

2. Create a new Periodic Timer module.

3. Link the Periodic Timer’s Trigger output to the Read Now input of the XML Import module
(Left-click the right hand side arrow of the Periodic Timer Module, select/click on Trigger and
move the dotted line to the left-hand side arrow of the XML Import Module, click it and then
click the “Read Now” input register.)

© 2017 Schneider Electric All Rights Reserved. 47


4. Right-click the middle of the Periodic Timer module and help ensure that the Period setup
register is set to 900 (seconds). This will pulse every 15 minutes.

Note: If you want to have more timely updates, read the Terms of Service of the provider you selected
to help ensure your license allows for more frequent API calls. Our Weather
Underground sample API calls are limited to 500 per day, so one API call every 15
minutes is well under the acceptable limit of transactions.

5. Send and Save your framework.

6. To verify that you are now logging the data in 15-minute intervals, you can either wait 15
minutes and check the Data Log Viewer in your Vista diagram, or proceed to the Dashboard
step below and verify values through the gadget you set up.

8.3. Operation and Maintenance referenced from External STN


Section 5, “Operation and Maintenance”, of the STN: “How can I Import Weather Feed Data into
Power Monitoring Expert?” was referenced in sections 6.1 of this document. That section has
been included here for your convenience.

The components that the XML Weather Feed import depends upon are mostly native to the
Power Monitoring Expert system, and therefore, the Operation and Maintenance does not require

© 2017 Schneider Electric All Rights Reserved. 48


anything more than normal system procedures. However, for the long-term import of the data,
note the following:

1. Disconnection from the XML feed

Gaps in the Weather Data will appear if the connection to the feed is lost during a scheduled
pulse. The longer the period is lost, the more data points will be missing. In the event this
happens:

a. Ensure the connection is reestablished.

b. If it is important to the customer to have the data points filled, you will need to determine
if the feed provider can supply historical records. For example, Weather Underground
can supply hourly historical data, but the data is not provided chronologically, nor is it
recorded on the top of the hour. In addition to determining the values, you will have to
manually enter the values into Power Monitoring Expert, the scope of which is beyond
this document.

Because connecting to the weather feed are usually unrelated to the Power Monitoring
Expert system, and are outside of the control of the system, it is recommended that the
commercial agreement not include the recovery of weather data.

2. Modification to the Weather Feed API

Organizations that provide APIs are expected to maintain the API against changes that
would affect their customers; however it is possible a change to an API could occur. If the
connection seems to be working but data logging is not working, check the connection string
in the browser to determine the following:

a. Results are being returned, and

b. The results are in the same format they were in previously.

© 2017 Schneider Electric All Rights Reserved. 49


9. Supplemental Information and Reference
Refer to the following documents for planning, designing and implementing your Solution:

 Power Monitoring Expert User Guide, document number 7EN02-0307-00

 VIP Modules

 Power Monitoring Expert ION Reference

 VIP XML Import Module

 Using XML Query Modules with an XML that has a namespace


http://www.powerlogic.com/kbarticle.cfm?myrequest=RESL202651

 Using the VIP XML Import Module to Import Data from an Excel Spreadsheet
http://www.powerlogic.com/kbarticle.cfm?myrequest=RESL186061

 Can “XML Import Module” in the VIP read CDATA (Character Data) elements from an
XML page?
http://www.powerlogic.com/kbarticle.cfm?myrequest=RESL186852

 For more information on the XML file format and terminology:


http://www.w3schools.com/xml/

 Power Monitoring Expert Productivity Toolkit

 How can I Import Weather Feed Data into Power Monitoring Expert?

 How to Expose Custom Measurements for Use in Web Client

 How to Import KPI Data into Power Monitoring Expert

© 2017 Schneider Electric All Rights Reserved. 50


StruxureWare and Schneider Electric are either trademarks or registered trademarks of Schneider Electric in
France, the USA, and other countries. Other trademarks used herein are the property of their respective owners.

Schneider Electric Industries SAS Due to evolution of standards and equipment,


Head Office characteristics indicated in texts and images in this
document are binding only after confirmation by our
35, rue Joseph Monier
departments.
92506 Rueil-Malmaison Cedex
FRANCE

www.schneider-electric.com

You might also like