Install an OpenWay Riva electric meter

This section explains how to create an MDI file to install an electric meter in an Itron OpenWay Riva solution. The example and details that follow are for installing an OpenWay Riva CENTRON SinglePhase meter. To create an MDI file for the CENTRON PolyPhase or the OpenWay Riva IEC SinglePhase or PolyPhase, you only have to change the DeviceType value. This scenario is also applicable to installation of an EDMI Electric Meter as the only change to the XML is the device type for the EDMI meter.

For all installation scenarios, the SetAccount element should be included in the XML sample. If you do not have the account information when you import the installation MDI file, you can import the account information later in a separate MDI file. See Add or update account information in OpenWay Riva.

In the XML file, a new relationship is created between the meter 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
OpenWay Riva CENTRON Singlephase	283	2.16.840.1.114416.14.317224090
OpenWay Riva CENTRON Polyphase	284	2.16.840.1.114416.14.318836349
OpenWay Riva IEC Singlephase	270	2.16.840.1.114416.14.315466859
OpenWay Riva IEC Polyphase	281	2.16.840.1.114416.14.317447732
OpenWay Riva EDMI	311	2.16.840.1.114416.14.319447831

Prerequisites

To be successfully installed in Collection Manager, the electric meter needs to first be provisioned using the shipping files from the factory. A provisioning file is sent with the meter. This file must be uploaded to tell Collection Manager that meters contained within that file are now owned by the utility and are ready to be installed. These meters will exist in the Collection Manager database, but they are not connected to any service points and their status is not active. If an MDI file adding a meter is sent to the Collection Manager before the meter has been added to the Collection Manager via the factory provisioning file, the file will fail to load and will log an error.

Performance Manager and Itron Analytics do not require the meter to have been pre-provisioned to process the install MDI.

Source of the MDI file

Customer work order system or FDM work orders
CIS
MDM
For Itron Analytics, the MDI file should always come from OpenWay Operations Center - Collection Manager.

Workflow

Provisioning files are imported into Collection Manager.
The field service representative (FSR) goes to the physical location and programs the meter if necessary.
The MDI file is imported into Collection Manager.
Collection Manager automatically sends the MDI file to Itron Analytics using secure FTP.
Collection Manager also send the MDI file data to Performance Manager.
Itron Analytics imports the MDI file. Itron Analytics will report if the file imports successfully or if there are any errors during the import.
Performance Manager imports the MDI file data. Success or failure of the data import will appear in the Performance Manager user interface.

Best practices

When using the MDI file to install meters into the Collection Manager, provision the meters by importing the factory provisioning file before importing the MDI installation file.

Troubleshooting

If you have imported the MDI file into your OpenWay Riva solution and the meter is appearing as expected in Performance Manager and Itron Analytics, but is not appearing in Collection Manager, the provisioning file from the factory may not have been imported first. Make sure the factory provisioning file is imported without errors, then import the MDI file again.

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 = The application does not use this element and any value in it will be ignored.

Element	Attribute/child element	Collection Manager	Performance Manager	Itron Analytics	Operations Optimizer
SetServicePoint		Required	Required	Required	Required
	ServicePointId	Required	Required	Required	Required
	EquipmentType		Optional	Required	Required
	CommodityType		Required	Required	Required
	TimeZone		Required	Required	Required
	UtilityId		Optional	Required	Required
	ServicePointStatus		Optional	Required	Required
	PrimaryCollectionSystem		Optional	Optional	Optional
	BillingCycleName	Optional	Optional	Optional	Optional
SetAccount			Optional	Optional	Optional
	AccountId		Required	Required	Required
	AccountNumber		Required	Required	Required
	RevenueClass		Not used	Optional	Optional
	CustomerFirstName		Not used	Optional	Optional
	CustomerLastName		Not used	Optional	Optional
	BusinessName		Not used	Optional	Optional
BillingAddress			Not used	Recommended	Recommended
	StreetAddress		Not used	Recommended	Recommended
	City		Not used	Recommended	Recommended
	State		Not used	Recommended	Recommended
	Zip		Not used	Recommended	Recommended
AccountLinkRange			Not used	Optional	Optional
	Start		Not used	Required	Required
	End		Not used	Optional	Optional
Address		Recommended	Optional	Required	Required
	StreetAddress	Recommended	Optional	Optional	Optional
	City	Recommended	Optional	Optional	Optional
	State	Recommended	Optional	Optional	Optional
	Zip	Recommended	Optional	Optional	Optional
	Country			Optional	Optional
	Latitude	Recommended	Required	Required	Required
	Longitude	Recommended	Required	Required	Required
SetMeter		Required: For Collection Manager, you must use one of the following SetMeter attributes: MeterId, MeterNumber, or MeterSerialNum ber. It is not necessary to use more than one of these attributes. Whichever attribute you choose to use should be used consistently.	Required	Required	Required
	MeterId	Required	Required	Required	Required
	IsDistrictMeter		Optional	Required	Required
	MeterNumber	Optional	Optional	Required	Required
	PhaseCount		Optional	Required	Required
	MeterInstallationDate		Optional	Optional	Optional
	MeterSerialNumber		Optional	Optional	Optional
	CTRatio Important This attribute is used only in MDIv14 and later.			Optional	Optional
	PTRatio Important This attribute is used only in MDIv14 and later.			Optional	Optional
SetChannel		Required	Required	Required	Required
	ChannelNumber	Required	Required	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.
	PowerFlowDirection		Optional	Required	Required
	Unit	Required. Must be set to WH	Optional	Required	Required
	HasIntervalData on page 1		Optional	Required	Required
SetDevice		Required	Required	Required	Required
	DeviceId	Required	Required	Required	Required
	DeviceType	Required	Required	Required	Required
	Active		Optional	Required	Required
DeviceLinkRange		Required if the SetDevice element is included in the file.	Required if the SetDevice element is included in the file.	Required if the SetDevice element is included in the file.	Required if the SetDevice element is included in the file.
	Start	Optional		Optional	Optional
	End	Required if the SetDevice element is included in the file.	Required if the SetDevice element is included in the file.	Required if the SetDevice element is included in the file.	Required if the SetDevice element is included in the file.
ApplicationGroups		Optional	Not used	Optional	Optional
ApplicationGroup		Required when the ApplicationGroups element is included in the MDI file.	Not used	Required when the ApplicationGroups element is included in the MDI file.	Required when the ApplicationGroups element is included in the MDI file.
ApplicationGroup	Name	Required when the ApplicationGroups element is included in the MDI file.	Not used	Required when the ApplicationGroups element is included in the MDI file.	Required when the ApplicationGroups element is included in the MDI file.
MeterLinkRange		Required	Required	Required	Required
	Start	Required	Required	Required	Required
	End	Required	Required	Required	Required
SetServicePointGroup		Recommended	Not used	Optional	Optional
	GroupId	Required	Not used	Required	Required
	GroupType	Required	Not used	Required	Required

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 = "RivaBaselineSP30"
		EquipmentType = "Endpoint"
		CommodityType = "Electric"
		TimeZone = "CentralUSNoDst"
		ServicePointStatus = "Active"
		UtilityId = "ABC"
		PrimaryCollectionSystem = "OpenWayRiva"
		BillingCycleName = "15Sept2020">
		<SetAccount
			AccountId = "ElectricEvent_acid"
			AccountNumber = "ElectricEvent_acno"
			RevenueClass = "Residential"
			CustomerFirstName = "Nathaniel"
			CustomerLastName = "Bumppo"
			BusinessName = "Hawkeye Enterprises">
			<BillingAddress
				StreetAddress = "123 Sample Road"
				City = "Upstate"
				State = "NY"
				Zip = "00001"/>
			<AccountLinkRange
				Start = "BOT"
				End = "EOT"/>
		</SetAccount>
		<Address
			StreetAddress="123 Sample Road"
			City ="Upstate"
			State="NY"
			Zip="00001"
			Country="US"
			Latitude="47.674702"
			Longitude="-117.091245" />
		<SetMeter
			MeterId = "111000030"
			IsDistrictMeter = "False"
			MeterNumber="318SMH836348"
			PhaseCount = "1"
			MeterSerialNumber = "318SMH836348"
			MeterInstallationDate="2015-12-01T00:00:00Z"
			MeterType="AMI OpenWay"
			CTRatio="1.0"  
			PTRatio="10.0"> 
					<!-- CTRatio is only used in MDIv14 and later. -->
					<!-- PTRatio is only used in MDIv14 and later. -->		
			<SetChannel
				ChannelNumber = "1"
				HasIntervalData = "True"
				PowerFlowDirection = "Delivered"
				Unit = "WH">
				<SetDevice
					DeviceId = "2.16.840.1.114416.14.111000030"
					DeviceType = "283"
					Active = "True">
					<DeviceLinkRange
						Start = "2016-08-27T09:32:03Z"
						End = "EOT"/>
					<ApplicationGroups>
						<ApplicationGroup Name = "Group1"/>
					</ApplicationGroups>
				</SetDevice>
			</SetChannel>
			<MeterLinkRange
				Start = "BOT"
				End = "EOT"/>
		</SetMeter>
		<SetServicePointGroup
			GroupId = "MDISector99"
			GroupType = "Sector"
			GroupName = "MDISector99" />
	</SetServicePoint>
</MasterDataImport>