Add a cathodic protection device

This sample shows how to add and configure a Cathodic Protection device. In Itron Analytics, Cathodic Protection devices can be monitored using the Cathodic Protection application. Cathodic Protection devices are modeled like service points, with the exception that they are not associated with an account.

The sample XML does the following:

  • Creates a new service point, SPCP1, similar to other service points.
  • Sets service point SPCP1's commodity type to other using CommodityType="Other".
  • Assigns a weather station, latitude data, and longitude data to service point SPCP1 using <Address WeatherStation="KSFF" Longitude="-116.3180675" Latitude="48.25338341"/>.

    Note: Assigning a weather station allows Itron Analytics users to view precipitation data.

  • Creates meter MCPA under service point SPCP1, similar to other meters.
  • Creates a channel under meter MCPA for DC voltage using <SetChannel ChannelNumber="1" HasIntervalData="True" PowerFlowDirection="Delivered" Unit="V">.
  • Identifies the device as a cathodic protection device using the DeviceClass="2" and DeviceClass="2" attributes.
  • Creates a channel under meter MCPA for AC voltage using <SetChannel ChannelNumber="2" HasIntervalData="True" PowerFlowDirection="Delivered" Unit="V">.
  • Identifies the device as a cathodic protection device using the DeviceClass="2" and DeviceClass="2" attributes.

Elements and attributes

For information about the use of special characters, see Special characters.

The following table shows the elements and attributes included in the XML sample.

  • Required = This element/attribute is required for this specific scenario. It may not be required in other scenarios.
  • Recommended = Itron recommends that you use this element/attribute in this particular scenario.
  • Optional = This element/attribute is optional for this scenario and is only required if you want a specific outcome described in the element/attribute definition. To see the element/attribute description, click on the element/attribute in the table or in the XML sample.
  • Blank = Ignored. This element or attribute is ignored by the application.

Element

Attribute/child element

Itron Analytics

Operations Optimizer

ChoiceConnect Fixed Network

SetServicePoint

ServicePointId

Required

Required

Required

EquipmentType

Optional

Optional

Required

ServicePointStatus

Optional

Required

Required

Address

WeatherStation

Recommended

Recommended

Optional

Latitude

Recommended

Recommended

Recommended

Longitude

Recommended

Recommended

Recommended

SetMeter

MeterId

Required

Required

Required

MeterInstallationDate

Optional

Optional

Optional

EndpointInstallationDate

Optional

Optional

Optional

IsDistrictMeter

Optional

Optional

Optional

SetChannel

ChannelNumber

Required. At least one channel must be configured for auto-channel creation. Set the ChannelNumber value to 1 when creating a dummy channel. For more information, see Auto-channel creation.

Required. At least one channel must be configured for auto-channel creation. Set the ChannelNumber value to 1 when creating a dummy channel. For more information, see Auto-channel creation.

Required: if meter has multiple channels

HasIntervalData

Required

Required

Required

PowerFlowDirection

Required

Required

Required

Unit

Required

Required

Required

SetDevice

DeviceId

Required

Required

Required

DeviceType

Required

Required

Required

DeviceClass

Required

Required

 

Active

 

 

Required

MeterLinkRange

Start

Optional

Optional

Optional

End

Required

Required

Required

XML sample

<?xml version="1.0" encoding="utf-8"?>
<MasterDataImport 
	xmlns="http://www.itron.com/masterdata/2013/03"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<SetServicePoint
		ServicePointId="SPCP1" 
		EquipmentType="Endpoint" 
		CommodityType="Other" 
		ServicePointStatus="Active">
		<Address
			WeatherStation="KSFF" 
			Longitude="-116.3180675" 
			Latitude="48.25338341"/>
		<SetMeter
			MeterId="MCPA"
			MeterInstallationDate="2001-11-21T00:00:00+00:00"
			EndpointInstallationDate="1985-08-21T00:00:00+00:00"
			IsDistrictMeter="False">
			<SetChannel
				ChannelNumber="1"
				HasIntervalData="True"
				PowerFlowDirection="Delivered"
				Unit="V">
				<SetDevice
					DeviceId="3864034"
					DeviceType="73"
					DeviceClass="2"
					Active="True"/>
			</SetChannel>
			<SetChannel
				ChannelNumber="2"
				HasIntervalData="True"
				PowerFlowDirection="Delivered"
				Unit="V">
				<SetDevice
					DeviceId="3864034"
					DeviceType="73"
					DeviceClass="2"
					Active="True"/>
			</SetChannel>
			<MeterLinkRange
				Start="BOT"
				End="EOT"/>
		</SetMeter>
	</SetServicePoint>
</MasterDataImport>