Translate to:
Please select
  • English (English)
  • French (Français)
  • German (Deutsch)
  • Indonesian (Bahasa Indonesia)
  • Italian (Italiano)
  • Portuguese (Português)
  • Russian (Русский)
  • Spanish (Español)
  • Thai (ไทย)
  • Turkish (Türkçe)
  • Vietnamese (Tiếng Việt)
Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Notifications
Login / Register
Community
Community
Notifications
close
  • Forums
  • Knowledge Center
  • Events & Webinars
  • Ideas
  • Blogs
Help
Help
  • Explore Community
  • Get Started
  • Ask the Community
  • How-To & Best Practices
  • Contact Support
Login / Register
Sustainability
Sustainability

We Value Your Feedback!
Could you please spare a few minutes to share your thoughts on Cloud Connected vs On-Premise Services. Your feedback can help us shape the future of services.
Learn more about the survey or Click here to Launch the survey
Schneider Electric Services Innovation Team!

DCE Sensor Mapping to ITA

For DCIM developers

EcoStruxure IT Advisor integrations for the advanced user

Enter a search word
    Turn off suggestions
    Enter a search word
      Turn off suggestions
      Enter a user name or rank
        Turn off suggestions
        Enter a search word
          Turn off suggestions
          Enter a search word
            Turn off suggestions
            cancel
            Turn on suggestions
            Showing results for 
            Show  only  | Search instead for 
            Did you mean: 
            Important Note
            • Home
            • Schneider Electric Community
            • EcoStruxure IT Help Center
            • EcoStruxure IT Help Center Categories
            • IT Advisor
            • For DCIM developers
            • For DCIM developers
            • DCE Sensor Mapping to ITA
            Options
            • Mark as New
            • Mark as Read
            • Bookmark
            • Subscribe
            • Email to a Friend
            • Printer Friendly Page
            • Report Inappropriate Content
            Invite a Co-worker
            Send a co-worker an invite to the portal.Just enter their email address and we'll connect them to register. After joining, they will belong to the same company.
            You have entered an invalid email address. Please re-enter the email address.
            This co-worker has already been invited to the Exchange portal. Please invite another co-worker.
            Please enter email address
            Send Invite Cancel
            Invitation Sent
            Your invitation was sent.Thanks for sharing Exchange with your co-worker.
            Send New Invite Close

            Related Forums

            • EcoStruxure IT forum

            • APC UPS Data Center & Enterprise Solutions Forum

            Previous Next

            Invite a Colleague

            Found this content useful? Share it with a Colleague!

            Invite a Colleague Invite

            EcoStruxure IT Support

            Submit a support request for additional assistance with EcoStruxure IT software.

            Request Support
            Back to For DCIM developers
            Options
            • Mark as New
            • Mark as Read
            • Bookmark
            • Subscribe
            • Email to a Friend
            • Printer Friendly Page
            • Report Inappropriate Content
            0 Likes
            1662 Views

            Link copied. Please paste this link to share this article on your social media post.

            Trying to translate this page to your language?
            Select your language from the translate dropdown in the upper right. arrow
            Translate to: English
            • (Français) French
            • (Deutsche) German
            • (Italiano) Italian
            • (Português) Portuguese
            • (Русский) Russian
            • (Español) Spanish

            DCE Sensor Mapping to ITA

            Picard EcoStruxureIT
            ‎2020-03-18 02:12 AM

            ITA uses the standard web services to query Data Center Expert for device and sensor related data.

            Device Information

            To get device information, this information from the DCE web interface /integration/services/ISXCentralDeviceService_v2_0?wsdl is used:

            <xsd:complexType name="ISXCDevice">
            <xsd:sequence>
            <xsd:element name="ISXCNamedElement" nillable="true" type="ns2:ISXCNamedElement"/>
            <xsd:element name="ISXCCommState" nillable="true" type="ns2:ISXCCommState"/>
            <xsd:element name="ISXCDeviceType" nillable="true" type="ns2:ISXCDeviceType"/>
            <xsd:element minOccurs="0" name="hostName" nillable="true" type="xsd:string"/>
            <xsd:element minOccurs="0" name="ipAddress" nillable="true" type="xsd:string"/>
            <xsd:element name="location" nillable="true" type="xsd:string"/>
            <xsd:element minOccurs="0" name="modelName" nillable="true" type="xsd:string"/>
            <xsd:element minOccurs="0" name="modelNumber" nillable="true" type="xsd:string"/>
            <xsd:element name="parentID" nillable="true" type="xsd:string"/>
            <xsd:element minOccurs="0" name="serialNumber" nillable="true" type="xsd:string"/>
            <xsd:element name="ISXCDeviceState" nillable="true" type="ns2:ISXCDeviceState"/>
            <xsd:element minOccurs="0" name="supplemental" nillable="true" type="xsd:string"/>
            </xsd:sequence>
            <xsd:attribute name="isPrivate" type="xsd:boolean"/>
            </xsd:complexType>

            Note

            The supplemental string is mandatory to understand the nature of the device.

            For example, for power related devices, phase and bank information is present in the supplemental string used in ITA to create an object of the device.

            Example of  PDU with 1 phase and 2 banks:

            <ns2:supplemental>InputPhaseCount="1";OutputPhaseCount="1";BankCount="2"</ns2:supplemental>

             


            Sensor Information

            A number of sensors are also used from the DCE web service interface /integration/services/ISXCentralSensorService_v2_0?wsdl

            To create an object to be used for the sensors, use:

            Note

            Index is being used to identify which module and phase are reporting data.

            That means index must be unique across sensorType on a given device

             

            It is NOT allowed to have e.g. 2 sensors of the same sensorType reporting same index. For example a single phase rack PDU with 2 banks and reporting phase information as well. Same sensorType having same index:

            This is NOT allowed

            <ns2:ISXCElementType>SENSOR</ns2:ISXCElementType>
            <ns2:id>B717125_nbSNMPEncEC23C4AA_RPDU_OUTPUT_POWER_BANK_1</ns2:id>
            <ns2:index>1</ns2:index>
            <ns2:ISXCSensorType>OUTPUT_POWER_WATTS</ns2:ISXCSensorType>


            <ns2:ISXCElementType>SENSOR</ns2:ISXCElementType>


            <ns2:id>B717125_nbSNMPEncEC23C4AA_RPDU_PHASE_OUTPUT_POWER_1</ns2:id>
            <ns2:index>1</ns2:index>
            <ns2:ISXCSensorType>OUTPUT_POWER_WATTS</ns2:ISXCSensorType>

            To get the above example right, the phase output power should be reported as OUTPUT_POWER_TOTAL_WATTS (which does not use index).

            Single phase devices with no banks should only use the OUTPUT_POWER_TOTAL_WATTS sensorType.

            From the ISXCSensorType, a subset of the sensors are mapped in ITA for temperature, humidity, and power.

            Temperature Sensors:

            EXTERNAL_TEMPERATURE

            SUPPLY_AIR_TEMPERATURE

            RETURN_AIR_TEMPERATURE

            INTEGRATED_TEMPERATURE

            RACK_INLET_TEMPERATURE

            UNIT_TEMPERATURE

            Humidity Sensors:

            EXTERNAL_HUMIDITY

            SUPPLY_AIR_HUMIDITY

            RETURN_AIR_HUMIDITY

            INTEGRATED_HUMIDITY

            UNIT_HUMIDITY

            Power Sensors:

            OUTPUT_POWER_WATTS

            OUTPUT_POWER_TOTAL_WATTS

            MODULE_OUTPUT_POWER or MODULE_BREAKER_POWER

            Amp Sensors:

            MODULE_BREAKER_CURRENT

            OUTPUT_CURRENT

            OUTPUT_CURRENT_TOTAL

            INPUT_CURRENT

             

            The SensorType is ignored when using sensor mapping functionality at PDU level.

            Tip

            Power sensors used for Modular PDU / Branch Circuit Monitoring

            For a modular PDU/Branch Circuit Monitoring, the MODULE_OUTPUT_POWER or MODULE_BREAKER_POWER are the sensors used to get power data from the device.

             

            An example of a modular PDU with 3 phases and 24 breaker modules:

            At device level, the "supplemental" string is used to specify number of phases and breaker modules.

             

            <ns2:supplemental>InputPhaseCount="3";OutputPhaseCount="3";BankCount="24"</ns2:supplemental>


            At sensor level, the sensorType is used to specify a modular PDU reporting data and the index is used to identify the phase reporting on a module. In this example breaker module 5, phase 3 (index 5,3):

            <ns2:ISXCSensorType>MODULE_OUTPUT_POWER</ns2:ISXCSensorType>
            <ns2:index>b,p</ns2:index> - e.g. <ns2:index>5,3</ns2:index>

            Data Collection

            The data collected from DCE via the power sensors is Peak and Average data. Peak and Average power data is queried for an interval of one day, 1 time/day. Additionally, peak power data is queried every 5 minutes since last time queried.

            We store the data and calculate Peak and Average values based on a setting in the ITA server (10, 20, 30 days).

             

            Summary

            The expected values used to specify and map the device in ITA:

            ISXCDevice - Supplemental ISXCSensor
            PhaseCount BankCount Index SensorType Device example
            1 1 Ignored OUTPUT_POWER_TOTAL_WATTS rack PDU
            1 >1 1 digit = Bank number OUTPUT_POWER_WATTS rack PDU with banks
            1 - Ignored OUTPUT_POWER_TOTAL_WATTS  
            3 1 1 digit = Phase number OUTPUT_POWER_WATTS UPS or (RM)PDU
            3 >1 2 digit = Module, Phase MODULE_OUTPUT_POWER Modular PDU
            3 - 1 digit = Phase number OUTPUT_POWER_WATTS  

             

            Note

            Supplemental is mandatory and must include phase information

            PhaseCount references InputPhaseCount and OutputPhaseCount which is expected to be the same number.

            DCE exposes information through various web services.

            For device information, ITA uses:

            getAllDeviceGroups

            getDevicesForGroupID

             

            For sensor information and data, ITA uses: 

            getSensorsByType

            getMultipleAverageSensorData

            getMultiplePeakSensorData

            Verifying DDFs with Soap-UI

            The walkthrough below is done with SoapUI 5.4.0. You can download the latest version here: https://www.soapui.org/

            When setting up a new project, chose the SOAP project type.

            Screenshot1_360006754317.pngScreenshot1_360006754317.png

            The initial WSDL link should be

            http://X.X.X.X/integration/services/ISXCentralDeviceService_v2_0?wsdl for the device endpoint.

            http://X.X.X.X/integration/services/ISXCentralSensorService_v2_0?wsdl for the sensor endpoint.

            Where X.X.X.X is ip address for the DCE server.

            Screenshot2_360006754317.pngScreenshot2_360006754317.png

            When prompted for the username and password, provide those used for logging into the DCE server.

            Running a request against the DCE server

            When running a request against the endpoint, first choose the endpoint in the list, and fold out so you can see the sample request.

            Screenshot3_360006754317.pngScreenshot3_360006754317.png

            Before running the request, you need to setup authentication:

            1. Chose 'Basic'
            2. Enter in the username and password for the DCE server

            Screenshot4_360006754317.pngScreenshot4_360006754317.png

            Then press play to run the request.

            Dependent on the request it might be necessary to fill in a number of parameters.

            When you have identified the correct device use the sensor end point to ensure that sensors with the correct type are available.

            Running requests to verify sensors with the correct type are available

            Getting the sensors for a specific device.

            Several of the end point are of interest, this is just an example on one why to do the verification.

            Given an ID for a device, all the sensors for the device can be gathered with the getSensorsForDevice request.

            Screenshot5_360006754317.pngScreenshot5_360006754317.png

            Fill in the ID for the device

            Screenshot6_360006754317.pngScreenshot6_360006754317.png

            Check that sensors with the types mentioned in the first part of this document are present. One example for the OUTPUT_POWER_WATTS sensor type is shown below.

            Screenshot7_360006754317.pngScreenshot7_360006754317.png

             

            Was this article helpful? Yes No
            No ratings

            Link copied. Please paste this link to share this article on your social media post.

            Didn't find what you are looking for? Ask our Experts
            To The Top!

            Forums

            • APC UPS Data Center Backup Solutions
            • EcoStruxure IT
            • EcoStruxure Geo SCADA Expert
            • Metering & Power Quality
            • Schneider Electric Wiser

            Knowledge Center

            Events & webinars

            Ideas

            Blogs

            Get Started

            • Ask the Community
            • Community Guidelines
            • Community User Guide
            • How-To & Best Practice
            • Experts Leaderboard
            • Contact Support
            Brand-Logo
            Welcome to Schneider Electric Community!
            Forum-Icon

            You have two options to continue your visit.

            LOGIN / Register

            Why logging in?
            • You enable the complete set of features available, such as posting, sharing, subscribing, private messaging and more.
            • You unlock the access to the whole content that Schneider Electric Community has to offer, including the gated items and the special events.
            And it’s free of charge!!!

            OR

            Continue as a guest

            Terms & Conditions Privacy Notice Change your Cookie Settings © 2025 Schneider Electric

            This is a heading

            With achievable small steps, users progress and continually feel satisfaction in task accomplishment.

            Usetiful Onboarding Checklist remembers the progress of every user, allowing them to take bite-sized journeys and continue where they left.

            of

            Translating the page…
            The page is currently translating. Please wait.
            Auto-suggest helps you quickly narrow down your search results by suggesting possible matches as you type.