Install an OpenWay Riva Intelis gas meter

This scenario explains how to create an MDI file to install an OpenWay Riva Intelis Gas 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.

Prerequisites

To be installed successfully at a service point in Collection Manager, the Intelis Gas meter first needs to 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 Intelis Gas meter to have been pre-provisioned to process the installation MDI.

Source of the MDI gile

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 created.
The MDI file is imported into Collection Manager.
Collection Manager automatically sends the MDI file to Itron Analytics.
Collection Manager also sends 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 meter 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 Itron Analytics and the MDM.

Related scenarios

Uninstall an OpenWay Riva Intelis Gas Meter
Swap an OpenWay Riva Intelis Gas Meter

Best practices

When using the MDI file to install Intelis Gas 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 Intelis Gas meter is appearing as expected in Performance Manager and Itron Analytics, but is not appearing in Collection Manager, the Intelis Gas Meter 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	Attributes/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	Required	Required
	BuildingType			Optional	Optional
	BuildingCode			Optional	Optional
	NumberOfResidents			Optional	Optional
	ServicePointStatus			Optional (default is Active)	Optional (default is Active)
	PremiseId		Required	Required	Required
	UtilityId			Optional	Optional
	PrimaryCollectionSystem			Required	Required
SetAccount				Optional (Required for the CSR and Customer Portal)	Optional (Required for the CSR and Customer Portal)
	AccountId			Optional (Required for the CSR and Customer Portal)	Optional (Required for the CSR and Customer Portal)
	AccountNumber			Optional (Required for the CSR and Customer Portal)	Optional (Required for the CSR and Customer Portal)
	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			Required	Required
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 for maps)	Recommended (required for maps)	Recommended (required for maps)	Recommended (required for maps)
	Longitude	Recommended (required for maps)	Recommended (required for maps)	Recommended (required for maps)	Recommended (required for maps)
	WeatherStation			Optional (required to display weather)	Optional (required to display weather)
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	Required	Required
	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	Optional		Optional	Optional
	DeviceType	Required	Required if the SetDevice element is included in the file.	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	Recommended		Required	Required
	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
	BillingDeterminate
	Truncation	Optional Decode information is no longer required for Intelis Gas meters unless you want to export data in CCF.		Optional	Optional
	Multiplier	Optional Decode information is no longer required for Intelis Gas meters unless you want to export data in CCF.		Optional	Optional
	Dials	Optional Decode information is no longer required for Intelis Gas meters unless you want to export data in CCF.		Optional	Optional
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	Required
	Start	Required	Required	Required	Required
	End	Required	Required	Required	Required
SetServicePointGroup		Recommended (for sector read rate reporting)		Optional	Optional
	GroupId	Recommended		Optional	Optional
	GroupType	Recommended		Optional	Optional
	GroupName	Recommended		Optional	Optional
PremiseData				Optional	Optional
	BuildingSize			Optional	Optional
	BuildingFloor			Optional	Optional
	YearBuilt			Optional	Optional
	ElectricVehicleCount			Optional	Optional
	BuildingType			Optional	Optional
SetPressureCompensation				Optional	Optional
	PressureCompensationFactor			Optional	Optional
	PressureCompensationLinkRange			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 = "RivaIntelisGasSP1"
		EquipmentType = "Endpoint"
		CommodityType = "Gas"
		TimeZone = "EasternUS"
		BuildingType = "Standard"
		BuildingCode = "BC102"
		NumberOfResidents = "3"
		ServicePointStatus = "Active"
		PremiseId = "RivaIntelisGasPremises1"
		UtilityId = "018"
		PrimaryCollectionSystem = "OpenWayRiva">
		<SetAccount
			AccountId = "GasAccountID1"
			AccountNumber = "WaterEvent_acno"
			RevenueClass = "Residential"
			CustomerFirstName = "Roger"
			CustomerLastName = "Rabbit"
			BusinessName = "Baby Herman Show">
			<BillingAddress
				StreetAddress = "123 Toon Street"
				City = "Toontown"
				State = "CA"
				Zip = "90038"/>
			<AccountLinkRange
				Start = "BOT"
				End = "EOT"/>
		</SetAccount>
		<Address
			StreetAddress = "123 Toon Road"
			City = "Hollywood"
			State = "CA"
			Zip = "90038"
			Country = "US"
			Latitude = "47.674702"
			Longitude = "-117.091245"
			WeatherStation = "KXXP"/>
		<SetMeter
			MeterId = "CustomerSN_123456789"
			MeterNumber = "CustomerSN_123456789"
			MeterSerialNumber = "8382GT67"
			MeterInstallationDate = "2016-08-27T09:32:03Z"
			MeterType = "Intelis Gas">			
			<SetChannel
				ChannelNumber = "1"
				Unit = "CCF"
				HasIntervalData = "True">
				<SetDevice
					DeviceId = "2.16.840.1.114416.21.318836348"
					DeviceType = "220">
					<DeviceLinkRange
						Start = "2016-08-27T09:32:03Z"
						End = "EOT"/>
					<DecodeType
						Truncation = "2"
						Multiplier = "1"
						Dials = "5"/>
					<ApplicationGroups>
						<ApplicationGroup 
							Name = "IntelisGasAppGroup1"/>
					</ApplicationGroups>
				</SetDevice>
			</SetChannel>
			<MeterLinkRange
				Start = "2016-08-27T09:32:03Z"
				End = "EOT"/>
		</SetMeter>
		<SetServicePointGroup
			GroupId = "000016"
			GroupType = "Sector"
			GroupName = "000016"/>
		<PremiseData
			BuildingSize = "1300"
			BuildingFloor = "3"
			YearBuilt = "2003"
			ElectricVehicleCount = "1"
			BuildingType = "House"/>
		<SetPressureCompensation
			PressureCompensationFactor = "1.0">
			<PressureCompensationLinkRange
				End = "EOT"
				Start = "BOT"/>
		</SetPressureCompensation>
	</SetServicePoint>
</MasterDataImport>