Add a compound meter for water

These samples show a compound meter with a small meter and a large meter. A compound meter is two meters that are part of a meter set where MeterSetType is CompoundMeter. Compound meters allow you to specify different values for meter properties such as MeterNumber for each part of the compound meter. Compound meters also allow you to define a separate ERT for each part, with separate SetDevice elements. However, the address and account information is applied to both devices.

The MeterSetMemberType attribute indicates which meter is measuring the large versus small flow in the compound meter.

  • Each meter has a unique MeterId.
  • The decoding instructions are provided by the Dials, Multiplier, and Truncation attributes of the DecodeType element.
  • Each meter has a different set of RegisterDisplayInfo attribute values.

Caution: Both MeterSetType and MeterSetMember are required for operations on a compound meter. If an operation occurs without both explicitly declared, the system could interpret this as a change back to a single meter.

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.

ement

Attribute/Child Element

Itron Analytics

ChoiceConnect Fixed Network

SetServicePoint

ServicePointId

Required

Required

EquipmentType

Optional

Required

CommodityType

Required

Required

PremiseId

Required

Required

PrimaryCollectionSystem

Required

Required

DeviceWillSupportTwoWay

 

Required

SetAccount

AccountId

Required

Required

AccountNumber

Optional

Optional

RevenueClass

Optional

Optional

CustomerFirstName

Optional

Optional

CustomerLastName

Optional

Optional

BusinessName

Optional

Optional

BillingAddress

StreetAddress

Optional

Optional

City

Optional

Optional

State

Optional

Optional

Zip

Optional

Optional

AccountLinkRange

Start

Optional

Optional

End

Optional

Optional

Address

WeatherStation

Optional

Optional

StreetAddress

Recommended

Recommended

City

Recommended

Recommended

State

Recommended

Recommended

Zip

Recommended

Recommended

Latitude

Recommended

Recommended

Longitude

Recommended

Recommended

SetMeter

MeterSetType

Required

Required

MeterSetMemberType

Required

Optional

EndpointEnvironment

Optional

Optional

MeterType

Optional

Optional

MeterSerialNumber

Optional

Optional

MeterRegisterSerialNumber

Optional

Optional

EndpointInstallationDate

Optional

Optional

MeterRegisterId

Optional

Optional

MeterInstallationDate

Optional

Optional

MeterCode

Optional

Optional

MeterId

Required

Required

MeterSize

Optional

Optional

IsDistrictMeter

Optional

Optional

MeterNumber

Optional

Optional

SetChannel

ChannelNumber

Required

Required

HasIntervalData

Required

Required

PowerFlowDirection

Required

Required

Unit

Required

Required

SetDevice

DeviceId

Required

Required

DeviceType

Required

Required

Active

Required

Required

DeviceLinkRange

 

Required

Required

DecodeType

DecodeType

Optional

Required

Dials

Optional

Optional

Multiplier

Optional

Optional

Truncation

Optional

Optional

RegisterDisplayInfo

LeftDigits

Optional

Optional

RightDigits

Optional

Optional

PaintedDigits

Optional

Optional

BlackDials

Optional

Optional

MeterLinkRange

Start

Required

Required

End

Required

Required

SetServicePointGroup

GroupId

Required

Required

GroupType

Required

Required

GroupName

Required

Required

XML sample 1

This sample has one SetServicePoint element for the two meters on this compound meter.

<?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="QQ301"
	EquipmentType="Endpoint"
	CommodityType="Water"
	TimeZone="PacificUS"
	BuildingType="SFH"
	BuildingCode="SFH01"
	NumberOfResidents="5"
	ServicePointStatus="Active"
	PremiseId="QQ301"
	UtilityId="Itron"
	PrimaryCollectionSystem="FixedNetwork">
	<SetAccount
		AccountId="QQ301"
		AccountNumber="QQ301AN"
		RevenueClass="Commercial"
		CustomerFirstName="John"
		CustomerLastName="Smith"
		BusinessName="Smith Enterprises, Ltd">
		<BillingAddress
			StreetAddress="1604 QQ301 BLVD"
			City="Oakland"
			State="CA"
			Zip="94602"/>
		<AccountLinkRange
			Start="BOT"
			End="EOT"/>
	</SetAccount>
	<Address
		WeatherStation="KSFF"
		Longitude="-122.271114"
		Latitude="37.804364"
		StreetAddress="1604 QQ301 BLVD"
		City="Oakland"
		State="CA"
		Zip="94602"/>
	<SetMeter
		MeterSetType="CompoundMeter"
		MeterSetMemberType="Small"
		EndpointEnvironment="Wet"
		MeterType="100W"
		MeterSerialNumber="QQ301S"
		MeterRegisterSerialNumber="QQ301S"
		EndpointInstallationDate="1985-08-21T00:00:00+00:00"
		MeterRegisterId="QQ301S"
		MeterInstallationDate="2001-11-21T00:00:00+00:00"
		MeterCode="5"
		MeterId="QQ301S"
		MeterSize="10K"
		IsDistrictMeter="False"
		MeterNumber="QQ301S">
		<SetChannel 
			ChannelNumber="1"
			HasIntervalData="True"
			PowerFlowDirection="Delivered"
			Unit="GAL">
			<SetDevice
				DeviceId="301"
				DeviceType="171"
				Active="True">
				<DeviceLinkRange
					Start="BOT"
					End="EOT"/>
				<DecodeType 
					DecodeType="163"
					Dials="7"
					Multiplier="1"
					Truncation="2"/>
			</SetDevice>
			<RegisterDisplayInfo 
				LeftDigits="4"
				RightDigits="2"
				PaintedDigits="0"
				BlackDials="2"/>
		</SetChannel>
		<MeterLinkRange
			Start="BOT"
			End="EOT"/>
	</SetMeter>
	<SetMeter
		MeterSetType="CompoundMeter"
		MeterSetMemberType="Large"
		EndpointEnvironment="Wet"
		MeterType="100W"
		MeterSerialNumber="QQ301L"
		MeterRegisterSerialNumber="QQ301L"
		EndpointInstallationDate="1985-08-21T00:00:00+00:00"
		MeterRegisterId="QQ301L"
		MeterInstallationDate="2001-11-21T00:00:00+00:00"
		MeterCode="7"
		MeterId="QQ301L"
		MeterSize="20L"
		IsDistrictMeter="False"
		MeterNumber="QQ301L"
		ConfinedSpaceFlag="True">
		<SetChannel
			ChannelNumber="1"
			HasIntervalData="True"
			PowerFlowDirection="Delivered"
			Unit="GAL">
			<SetDevice
				DeviceId="302"
				DeviceType="171"
				Active="True">
				<DeviceLinkRange
					Start="BOT"
					End="EOT"/>
				<DecodeType
					DecodeType="163"
					Dials="8"
					Multiplier="1"
					Truncation="2"/>
			</SetDevice>
			<RegisterDisplayInfo
				LeftDigits="6"
				RightDigits="0"
				PaintedDigits="0"
				BlackDials="0"/>
		</SetChannel>
		<MeterLinkRange
			Start="BOT"
			End="EOT"/>
	</SetMeter>
	<SetServicePointGroup
		GroupType="Route"
		GroupId="RW"
		GroupName="RW"/>
	<SetServicePointGroup
		GroupType="District"
		GroupId="DW"
		GroupName="DW"/>
	<SetServicePointGroup
		GroupType="PressureZone"
		GroupId="PW"
		GroupName="PW"/>
</SetServicePoint>
</MasterDataImport>

XML sample 2

This sample has a separate SetServicePoint element for each meter on the compound meter.

<?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="QQ301"
	EquipmentType="Endpoint"
	CommodityType="Water"
	TimeZone="PacificUS"
	BuildingType="SFH"
	BuildingCode="SFH01"
	NumberOfResidents="5"
	ServicePointStatus="Active"
	PremiseId="QQ301"
	UtilityId="Itron"
	PrimaryCollectionSystem="FixedNetwork">
	<SetAccount
		AccountId="QQ301"
		AccountNumber="QQ301AN"
		RevenueClass="Commercial"
		CustomerFirstName="John"
		CustomerLastName="Smith"
		BusinessName="Smith Enterprises, Ltd">
		<BillingAddress
			StreetAddress="1604 QQ301 BLVD"
			City="Oakland"
			State="CA"
			Zip="94602"/>
		<AccountLinkRange
			Start="BOT"
			End="EOT"/>
	</SetAccount>
	<Address
		WeatherStation="KSFF"
		Longitude="-122.271114"
		Latitude="37.804364"
		StreetAddress="1604 QQ301 BLVD"
		City="Oakland"
		State="CA"
		Zip="94602"/>
	<SetMeter
		MeterSetType="CompoundMeter"
		MeterSetMemberType="Small"
		EndpointEnvironment="Wet"
		MeterType="100W"
		MeterSerialNumber="QQ301S"
		MeterRegisterSerialNumber="QQ301S"
		EndpointInstallationDate="1985-08-21T00:00:00+00:00"
		MeterRegisterId="QQ301S"
		MeterInstallationDate="2001-11-21T00:00:00+00:00"
		MeterCode="5"
		MeterId="QQ301S"
		MeterSize="10K"
		IsDistrictMeter="False"
		MeterNumber="QQ301S">
		<SetChannel
			ChannelNumber="1"
			HasIntervalData="True"
			PowerFlowDirection="Delivered"
			Unit="GAL">
			<SetDevice
				DeviceId="301"
				DeviceType="171"
				Active="True">
				<DeviceLinkRange 
					Start="BOT" 
					End="EOT"/>
				<DecodeType
					DecodeType="163"
					Dials="7"
					Multiplier="1"
					Truncation="2"/>
			</SetDevice>
			<RegisterDisplayInfo
				LeftDigits="4"
				RightDigits="2"
				PaintedDigits="0"
				BlackDials="2"/>
		</SetChannel>
		<MeterLinkRange
			Start="BOT"
			End="EOT"/>
	</SetMeter>
	<SetServicePointGroup
		GroupType="Route"
		GroupId="RW"
		GroupName="RW"/>
	<SetServicePointGroup
		GroupType="District"
		GroupId="DW"
		GroupName="DW"/>
	<SetServicePointGroup
		GroupType="PressureZone"
		GroupId="PW"
		GroupName="PW"/>
</SetServicePoint>
<SetServicePoint
	ServicePointId="QQ301"
	EquipmentType="Endpoint"
	CommodityType="Water"
	TimeZone="PacificUS"
	BuildingType="SFH"
	BuildingCode="SFH01"
	NumberOfResidents="5"
	ServicePointStatus="Active"
	PremiseId="QQ301"
	UtilityId="Itron"
	PrimaryCollectionSystem="FixedNetwork">
	<SetAccount
		AccountId="QQ301"
		AccountNumber="QQ301AN"
		RevenueClass="Commercial"
		CustomerFirstName="John"
		CustomerLastName="Smith"
		BusinessName="Smith Enterprises, Ltd">
		<BillingAddress
			StreetAddress="1604 QQ301 BLVD"
			City="Oakland"
			State="CA"
			Zip="94602"/>
		<AccountLinkRange
			Start="BOT"
			End="EOT"/>
	</SetAccount>
	<Address
		WeatherStation="KSFF"
		Longitude="-122.271114"
		Latitude="37.804364"
		StreetAddress="1604 QQ301 BLVD"
		City="Oakland"
		State="CA"
		Zip="94602"/>
	<SetMeter
		MeterSetType="CompoundMeter"
		MeterSetMemberType="Large"
		EndpointEnvironment="Wet"
		MeterType="100W"
		MeterSerialNumber="QQ301L"
		MeterRegisterSerialNumber="QQ301L"
		EndpointInstallationDate="1985-08-21T00:00:00+00:00"
		MeterRegisterId="QQ301L"
		MeterInstallationDate="2001-11-21T00:00:00+00:00"
		MeterCode="7"
		MeterId="QQ301L"
		MeterSize="20L"
		IsDistrictMeter="False"
		MeterNumber="QQ301L"
		ConfinedSpaceFlag="True">
		<SetChannel
			ChannelNumber="1"
			HasIntervalData="True"
			PowerFlowDirection="Delivered"
			Unit="GAL">
			<SetDevice
				DeviceId="302"
				DeviceType="171"
				Active="True">
				<DeviceLinkRange
					Start="BOT"
					End="EOT"/>
				<DecodeType
					DecodeType="163"
					Dials="8"
					Multiplier="1"
					Truncation="2"/>
			</SetDevice>
			<RegisterDisplayInfo
				LeftDigits="6"
				RightDigits="0"
				PaintedDigits="0"
				BlackDials="0"/>
		</SetChannel>
		<MeterLinkRange
			Start="BOT"
			End="EOT"/>
	</SetMeter>
	<SetServicePointGroup
		GroupType="Route"
		GroupId="RW"
		GroupName="RW"/>
	<SetServicePointGroup
		GroupType="District"
		GroupId="DW"
		GroupName="DW"/>
	<SetServicePointGroup
		GroupType="PressureZone"
		GroupId="PW"
		GroupName="PW"/>
	</SetServicePoint>
</MasterDataImport>