Swap an OpenWay Riva water module

This section explains how to create an MDI file when replacing an OpenWay Riva Water Module with a new one. In this scenario, an existing endpoint is being removed from a service point and a new one is being installed.

In the XML file, the relationship between the existing endpoint and the meter is ended at the time set in the DeviceLinkRange element's Start attribute. The new endpoint's relationship with the meter begins at the same time set in this Start attribute.

Important! When a swap is performed to replace only the device (and not the meter), the elements in the SetDevice element that are not specified will not be retained in the OpenWay Operations Center for the new device. For example, if the ApplicationsGroups sub element was assigned under the original device's SetDevice element but is not specified under the new device's SetDevice element, then the device will not appear in an application group.

In the field, the old endpoint is uninstalled from the meter location and the new endpoint is installed.

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.

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
	PrimaryCollectionSystem			Required	Required
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
	MeterId	Required	Required	Required	Required
	MeterNumber	Required	Required	Required	Required
	MeterSerialNumber	Required	Required	Required.	Required.
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
	HasIntervalData			Required	Required
SetDevice		Required		Required	Required
	DeviceId	Required: In this scenario, this is the new endpoint's ID. the endpoint being removed does not need to be referenced.	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	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.
DecodeType
	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.
	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
	End	Required	Required	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 = "RivaWaterSP1"
		PrimaryCollectionSystem = "OpenWayRiva">
		<SetMeter
			MeterId = "ItronWaterMeterID1"
			MeterNumber = "0BLJAD05402"
			MeterSerialNumber = "0BLJAD05402">			
			<SetChannel
				ChannelNumber = "1"
				Unit = "GAL"
				HasIntervalData = "true">
				<SetDevice
					DeviceId = "2.16.840.1.114416.17.87000001"
					DeviceType = "27"
					Active = "true">
					<DeviceLinkRange 
						Start = "2017-02-14T13:00:00Z"
						End = "EOT"/>
					<DecodeType
						Truncation = "0"
						Multiplier = "1"
						Dials = "6"/>
						<ApplicationGroups>
							<ApplicationGroup
								Name = "WaterModuleGroup"/>

						</ApplicationGroups>
				</SetDevice>
			</SetChannel>
				<MeterLinkRange
					Start = "2018-01-26T09:32:03Z"
					End = "EOT"/>
		</SetMeter>
	</SetServicePoint>
</MasterDataImport>