Install an OpenWay Riva water module

This section explains how to create an MDI file to install an OpenWay Riva Water Module in an Itron OpenWay Riva solution.

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 endpoint and the meter at the time set in the DeviceLinkRange element's Start attribute.

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

Prerequisites

To be successfully installed on a meter in Collection Manager, the water module needs to first be provisioned using the shipping files from the factory. A provisioning file is sent with the water module. This file must be uploaded to tell Collection Manager that water modules contained within that file are now owned by the utility and are ready to be installed. These water modules 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 an water module is sent to the Collection Manager before the water module 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 OpenWay Riva Water Module to have been pre-provisioned to process the installation 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 ERT module 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.

The ERT module will register and start sending data even if the MDI file import is delayed. Collection Manager will collect the data, but because the MDI file has not been imported with the Unit and Decode information, the data will be stored as raw. When the MDI file is imported, Collection Manager will correct the raw data with the Unit and Decode values and will send the corrected data to the Itron Analytics and the MDM.

Related scenarios

The following scenarios are related to installing a water ERT module:

Best practices

When using the MDI file to install ERT modules into the Collection Manager, provision the ERT modules 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 ERT module is appearing as expected in Performance Manager and Itron Analytics, but is not appearing in Collection Manager, the ERT module 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 elements	Collection Manager	Performance Manager	Itron Analytics	Operations Optimizer
SetServicePoint		Required	Required	Required	Required
	ServicePointId	Required	Required	Required	Required
	EquipmentType		Optional	Optional	Optional
	CommodityUsageType			Optional	Optional
	CommodityType		Required	Required	Required
	TimeZone		Required	Recommended	Recommended
	BuildingType			Optional	Optional
	BuildingCode			Optional	Optional
	NumberOfResidents			Optional	Optional
	ServicePointStatus			Required	Required
	PremiseId		Required	Required	Required
	UtilityId			Optional	Optional
	PrimaryCollectionSystem			Required	Required
SetAccount				Required	Required
	AccountId			Required	Required
	AccountNumber			Required	Required
	RevenueClass			Optional	Optional
	CustomerFirstName			Optional	Optional
	CustomerLastName			Optional	Optional
	BusinessName			Optional	Optional
BillingAddress				Recommended	Recommended
	StreetAddress			Recommended	Recommended
	City			Recommended	Recommended
	State			Recommended	Recommended
	Zip			Recommended	Recommended
AccountLinkRange				Required	Required
	Start			Required	Required
	End			Optional	Optional
Address		Recommended	Optional	Recommended	Recommended
	StreetAddress	Recommended	Optional	Recommended	Recommended
	City	Recommended	Optional	Recommended	Recommended
	State	Recommended	Optional	Recommended	Recommended
	Zip	Recommended	Optional	Recommended	Recommended
	Country			Optional	Optional
	Latitude	Recommended	Required	Recommended	Recommended
	Longitude	Recommended	Required	Recommended	Recommended
	WeatherStation			Optional	Optional
SetMeter		Required: For Collection Manager, you must use one of the following SetMeter attributes: MeterId, MeterNumber, or MeterSerialNumber.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
	EndpointEnvironment			Optional	Optional
	MeterType			Optional	Optional
	MeterSerialNumber	Required	Required	Required.	Required.
	MeterCode			Optional	Optional
	MeterId	Required	Required	Required	Required
	MeterSize			Required	Required
	IsDistrictMeter			Optional	Optional
	MeterNumber	Required	Required	Required	Required
	MeterInstallationDate		Required	Optional	Optional
	EndpointInstallationDate			Optional	Optional
SetChannel		Required		Required	Required
	ChannelNumber	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.
	Unit	Required		Required	Required
	HasIntervalData			Required	Required
SetDevice		Required		Required	Required
	DeviceId	Required	Required	Required	Required
	DeviceType	Required	Required	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
	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.
DecodeType		Required		Required	Required
	DecodeType	Required
	BillingDeterminate			Optional	Optional
	Truncation	Required		Required	Required
	Multiplier	Required		Required	Required
	Dials	Required		Required	Required
ApplicationGroups		Optional	Optional	Optional	Optional
ApplicationGroup		Required when the ApplicationGroups element is included in the MDI file.	Required when the ApplicationGroups element is included in the MDI file.	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.	Required when the ApplicationGroups element is included in the MDI file.	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
	Start
	End
SetServicePointGroup		Recommended		Required	Required
	GroupId	Recommended		Required	Required
	GroupType	Recommended		Required	Required
	GroupName	Recommended		Required	Required
PremiseData				Optional	Optional
	BuildingSize			Optional	Optional
	BuildingFloor			Optional	Optional
	YearBuilt			Optional	Optional
	ElectricVehicleCount			Optional	Optional
	BuildingType			Optional	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 = "RivaWaterSP1"
		EquipmentType = "Endpoint"
		CommodityUsageType  = "RateA"
		CommodityType = "Water"
		TimeZone = "EasternUS"
		BuildingType = "Standard"
		BuildingCode = "BC101"
		NumberOfResidents  = "10"
		ServicePointStatus = "Active"
		PremiseId = "RivaWaterPremise1"
		UtilityId  = "018"
		PrimaryCollectionSystem = "OpenWayRiva">
		<SetAccount
			AccountId="RivaWaterAccount_0100001216"
			AccountNumber="RivaWaterAccount_0100001216"
			RevenueClass="Residential"
			CustomerFirstName="Selina"
			CustomerLastName="Kyle"
			BusinessName="Kyle Enterprises">
			<BillingAddress
				StreetAddress="123 Arkham Street"
				City="Gotham City"
				State="NJ"
				Zip="00001"/>
			<AccountLinkRange
				Start="BOT"
				End="EOT"/>
		</SetAccount>		
		<Address
			StreetAddress = "123 Arkham Street"
			City = "Gotham City"
			State = "NJ"
			Zip = "00001"
			Country = "US"
			Latitude = "39.745744 "
			Longitude = "-105.007708"
			WeatherStation="KXXP"/>
		<SetMeter
			MeterId = "ItronWaterMeterID1"
			MeterNumber = "0BLJAD05402"
			MeterSerialNumber = "0BLJAD05402"
			MeterInstallationDate = "2002-06-26T09:32:03Z"
			MeterSize = "50"
			MeterType = "Itron Flostar FLO50F"
			MeterCode = "IS"
			EndpointEnvironment = "Wet"
			EndpointInstallationDate = "2017-01-02T09:32:03Z"
			ConfinedSpaceFlag = "True"
			IsDistrictMeter = "False">			
			<SetChannel
				ChannelNumber = "1"
				Unit = "GAL"
				HasIntervalData = "True">
				<SetDevice
					DeviceId = "2.16.840.1.114416.17.120000001"
					DeviceType = "27">
					<DeviceLinkRange
						Start = "2017-01-02T09:32:03Z"
						End = "EOT"/>
					<DecodeType
						Truncation = "0"
						Multiplier = "1"
						Dials = "6"/>
					<ApplicationGroups>
						<ApplicationGroup Name = "Group2"/>
					</ApplicationGroups>
				</SetDevice>
			</SetChannel>
			<MeterLinkRange
				Start = "2016-08-26T09:32:03Z"
				End = "EOT"/>
		</SetMeter>
		<SetServicePointGroup
			GroupId = "000010"
			GroupType = "Sector"
			GroupName = "000010"/>
		<PremiseData
			BuildingSize = "1300"
			BuildingFloor = "1"
			YearBuilt = "2000"
			ElectricVehicleCount = "0"
			BuildingType = "Apartment"/>
	</SetServicePoint> 
</MasterDataImport>