Install a Gen5 Riva Singlephase/Polyphase electricity meter

This section explains how to create an MDI file to install an electric meter into the App Platform. The example and details that follow are for installing a Gen5 Riva Singlephase Electricity meter. To create an MDI file for the Gen5 Riva Polyphase Electricity meter, you only have to change the DeviceType value in the MDI file.

In the XML file, a new relationship is created between the meter and device combination and the service point at the time set in the MeterLinkRange element's Start attribute.

In the field, a new meter is installed at the service point location.

The following table shows the DeviceType values to use for each type of electric meter. This device type information can also be found in Device types.

Device	DeviceType	Example ESN
Gen5 Riva Singlephase Electricity Meter	315	2.16.840.1.114416.34.0155209919
Gen5 Riva Polyphase Electricity Meter	318	2.16.840.1.114416.34.0155209919

Prerequisites

It is a best practice to first provision the meter in AMM (Advanced Metering Manager) before installing it to a service point in the App Platform. This provisioning is done using the device ship file as described in the AMM documentation. These ship files come from the factory with each shipment of meters. This file is imported into AMM to tell the head end that meters contained within that file are now owned by the utility and are ready to be installed.

The App Platform does not require the meter to have been pre-provisioned to process the install MDI, but best practice is that the provisioning in AMM is assumed to have been done.

Source of the MDI file

Customer work order system
Customer information system

Workflow

Provisioning (i.e. device ship) files are imported into AMM.
The field service representative (FSR) goes to the physical location to install the meter at a customer premises.
The AMM device location file is imported into AMM to install the meter at the premises in AMM.
The MDI file is imported into the App Platform to install the meter at the premises in the App Platform.
App Platform imports the MDI file and will report if the file imports successfully or if there are any errors during the import.

Best practices

The App Platform provides a detailed MDI file import monitoring user interface that can be used to troubleshoot issues during import. This is documented as part of the product documentation.

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.

Element	Attribute/child element	App Platform
SetServicePoint		Required
	ServicePointId	Required
	EquipmentType	Required
	CommodityType	Required
	TimeZone	Required
	UtilityId	Required
	ServicePointStatus	Required
	PrimaryCollectionSystem	Optional
SetAccount		Required
	AccountId	Required
	AccountNumber	Required
	RevenueClass	Optional
	CustomerFirstName	Optional
	CustomerLastName	Optional
	BusinessName	Optional
BillingAddress		Recommended
	StreetAddress	Recommended
	City	Recommended
	State	Recommended
	Zip	Recommended
AccountLinkRange		Required
	Start	Required
	End	Optional
Address		Required
	StreetAddress	Optional
	City	Optional
	State	Optional
	Zip	Optional
	Country	Optional
	Latitude	Required
	Longitude	Required
SetMeter		Required
	MeterId	Required
	MeterSerialNumber	Optional
	MeterNumber	Required
	MeterInstallationDate	Optional
	IsDistrictMeter	Required
	PhaseCount	Required
SetChannel		Required
	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.
	PowerFlowDirection	Required
	Unit	Required
	HasIntervalData on page 1	Required
SetDevice		Required
	DeviceId	Required
	DeviceType	Required
	Active	Required
DeviceLinkRange		Required
	Start	Required
	End	Required
MeterLinkRange		Required
	Start	Required
	End	Required
SetServicePointGroup		Optional
	GroupId	Required
	GroupType	Required
	GroupName	Optional

XML sample

<?xml version="1.0" encoding="utf-8"?>
<MasterDataImport
	xmlns:xsd = "http://www.w3.org/2001/XMLSchema"
	xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
	xmlns = "http://www.itron.com/masterdata/2013/03">
	<SetServicePoint
		ServicePointId = "Gen5HW42SP1"
		EquipmentType = "Endpoint"
		CommodityType = "Electric"
		TimeZone = "CentralUSNoDst"
		ServicePointStatus = "Active"
		UtilityId = "ABC"
	  PrimaryCollectionSystem = "GenX">
		<SetAccount
			AccountId = "ElectricEvent_acid"
			AccountNumber = "ElectricEvent_acno"
			RevenueClass = "Residential"
			CustomerFirstName = "Bullwinkle"
			CustomerLastName = "Moose"
			BusinessName = "Upsidaisium Enterprises">
			<BillingAddress
				StreetAddress = "3040 Excelsior Blvd"
				City = "Minneapolis"
				State = "MN"
				Zip = "55416"/>
			<AccountLinkRange
				Start = "BOT"
				End = "EOT"/>
		</SetAccount>
		<Address
			StreetAddress="3040 Excelsior Blvd"
			City ="Minneapolis"
			State="MN"
			Zip="55416"
			Country="US"
			Latitude="44.9476"
			Longitude="-93.321" />
		<SetMeter
			MeterId = "EI0155209919"
			IsDistrictMeter = "False"
			MeterNumber="0155209919"
			PhaseCount = "1"
			MeterSerialNumber = "0155209919"
			MeterInstallationDate="2015-12-01T00:00:00Z"
			MeterType="Gen5 Riva Singlephase Electricity Meter">			
			<SetChannel
				ChannelNumber = "1"
				HasIntervalData = "True"
				PowerFlowDirection = "Delivered"
				Unit = "WH">
				<SetDevice
					DeviceId = "2.16.840.1.114416.34.0155209919"
					DeviceType = "315"
					Active = "True">
					<DeviceLinkRange
						Start = "2016-08-27T09:32:03Z"
						End = "EOT"/>
					</SetDevice>
			</SetChannel>
			<MeterLinkRange
				Start = "2016-08-27T09:32:03Z"
				End = "EOT"/>
		</SetMeter>
		<SetServicePointGroup
			GroupId = "Group1"
			GroupType = "Region"
			GroupName = "Group1" />
	</SetServicePoint>
</MasterDataImport>