How can custom device measurements be made available in EcoStruxure Web Services (EWS)?

Search FAQs

Issue
When integrating Power Monitoring Expert (PME) with StruxureWare Building Operation (SBO) per the Integration Design Guide, measurements from custom device types must be exposed to EcoStruxure Web Services (EWS) through a different process than device types native to PME.

Product Line
Power Monitoring Expert 8.x
Power Monitoring Expert 7.2.x

Power Monitoring Expert 9.0

Power Monitoring Expert 2020

Power Monitoring Expert 2021

Power Monitoring Expert 2022

Power Monitoring Expert 2023

Environment
Management Console
Modbus Device Importer

Resolution
*Warning: Take backups of any files prior to modifying them. Ensure the backups are in a location that will not be overwritten (i.e. the Desktop).

For measurements from a custom device type to be available through EWS, the custom device type and its measurements need to be added to the measurement definitions for EWS. This is accomplished by adding a measurement definition extension file. To add an extension file, execute the following:

1) Create (if it doesn't exist yet) a folder named "Extensions" under $:\Program Files (x86)\Schneider Electric\Power Monitoring Expert\system\WebServices\ .
2) Copy the "Types.Measurements.Definition.xml" file into the Extensions folder.
3) Rename the copy of the file in the Extensions folder to something meaningful, e.g. <custom device type name>_Extension.xml - (Note: the name is not important).
4) Open the new extension file and delete all entries, except the ones for one type, e.g. the 3300 - (Note: the file was only copied to re-use the formatting, not the content).
5) Rename the appropriate device type related fields in the file to represent the custom type you want to add.
6) Change the measurement definitions in the file to reflect the measurements in the custom type you want to add. Delete any measurement definitions that are not needed.
7) Verify the "Format" and "Handle" properties contain the correct information for the measurements in the custom type.
8) Save the file.
9) Open Services from the Windows start menu and restart the ION Real Time Data Service service. Then open a command prompt running As Administrator and type iisreset to perform an IIS reset.
10) In Management Console, Navigate to Tools -> System, and click "Update EWS Server".

Note: If you have to make changes to the extension file after measurements for this device type have been requested through EWS, you need to restart IIS and the ION Realtime Service after saving the changes to the extension file. The information in the extension file (and the Types.Measurements.Definition.xml file) is cached the first time they are accessed which means changes to the files made after that point in time will not be detected until the services are restarted.