Professional Documents
Culture Documents
How Can I Create A KPI Dashboard That Shows Daily Electric Consumption Vs Average Temperature For TH
How Can I Create A KPI Dashboard That Shows Daily Electric Consumption Vs Average Temperature For TH
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.
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.
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.
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.
Document
Author Version Date Comments
Version
2.0 Dana Davidson 2015-06-02 Updated for Power Monitoring Expert 8.0
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
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
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.
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
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:
Expose the new and external data to Power Monitoring Expert ’s Web Client; and
KPIs can be used to achieve the following results with a customer’s energy management system:
Energy efficiency
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:
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:
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 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.
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.
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.
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.
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
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
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
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.
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.
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.
The Power Monitoring Expert’s XML Import Module is the tool of choice when:
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.
The convenience of locating all KPI Dashboard measurements under one source.
As indicated in Table 2, a Logical Device Type for a Weather KPI could use a number of
measurements, including:
Weather temperature
In this Solution, we use Weather temperature twice for the Celsius measurement and for the
Fahrenheit measurement.
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
Weather Temperature °F
Weather Temperature °C
Weather Temperature °F
Weather Temperature °C
Weather Temperature °F
Weather Temperature °C
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
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.
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;
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.
a. Analyze the XML response to identify the xPath for each measurement you want to log.
i. Read the XML source (weather feed) via the XML Import module;
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.
2. Gaining access to the XML data for the relevant weather station; and
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.
2. Select Tools > Logical Device > Logical Device Type Editor
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.
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
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.
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.
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.
a. Expand the list under the VIP device type to reveal the list of VIP devices.
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.
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.
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.
g. Click OK.
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.
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:
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.
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:
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).
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.
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”.
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.
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.
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.
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.
8.1. Glossary
Please find below a list of relevant terms and corresponding definitions.
Term Description
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.
ETL Job A set of extract, transform and load tasks that define a
specific path of data transfer.
The VIP
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.
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.
a. Click the Pricing link and the Stratus Plan should be selected by default.
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.
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.
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>
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:
<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>
/response/current_observation/temp_f
/response/current_observation/temp_c
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).
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.
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
/response/current_observation/temp_c
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
iii. Finally, click OK. You can now use the Edit Query button.
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.
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.
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.)
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.
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.
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
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:
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.
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:
VIP Modules
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
How can I Import Weather Feed Data into Power Monitoring Expert?
www.schneider-electric.com