Install an OpenWay Riva gas remote disconnect
This scenario describes how to install an OpenWay Riva Gas Remote Disconnect (OWR-GRD) at a service point. The OWR-GRD sends events to Collection Manager and allows Collection Manager to send two-way commands to the OWR-GRD. The OWR-GRD is a safety device that allows the utility to disconnect gas, either remotely or self-actuated, to avoid potentially harmful situations.
For more information about the device, see the OpenWay Riva Gas Remote Disconnect Installation Guide.
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.
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 |
---|---|---|---|---|---|
|
|
Required |
Required |
Required |
Required |
Required |
Required Note: This is used to anchor the device to a known point at the time of installation. |
Required |
Required |
||
|
|
Required |
Required |
||
|
Required |
Required |
Required |
||
|
|
Required |
Required |
||
|
Required |
Recommended |
Recommended |
||
|
Required |
Required |
Required |
||
|
|
|
|
Required |
Required |
|
|
Required |
Required |
||
|
|
Required |
Required |
||
|
|
Optional |
Optional |
||
|
|
Optional |
Optional |
||
|
|
Optional |
Optional |
||
|
|
Optional |
Optional |
||
|
|
|
|
Recommended |
Recommended |
|
|
Recommended |
Recommended |
||
|
|
Recommended |
Recommended |
||
|
|
Recommended |
Recommended |
||
|
|
Recommended |
Recommended |
||
|
|
|
|
Required |
Required |
|
|
Required |
Required |
||
|
|
Optional |
Optional |
||
|
|
Recommended |
Required |
Recommended |
Recommended |
Recommended |
Optional |
Recommended |
Recommended |
||
Recommended |
Optional |
Recommended |
Recommended |
||
Recommended |
Optional |
Recommended |
Recommended |
||
Recommended |
Optional |
Recommended |
Recommended |
||
|
|
Optional |
Optional |
||
Recommended |
Required |
Recommended |
Recommended |
||
Recommended |
Required |
Recommended |
Recommended |
||
|
|
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 |
|
|
Optional |
Optional |
||
|
|
Optional |
Optional |
||
Required |
Required |
Required. |
Required. |
||
|
|
Optional |
Optional |
||
Required |
Required |
Required |
Required |
||
|
|
Required |
Required |
||
|
|
Optional |
Optional |
||
Required |
Required |
Required |
Required |
||
|
Required |
Optional |
Optional |
||
|
|
Optional |
Optional |
||
|
|
Required |
|
Required |
Required |
Required |
|
Required. At least one channel must be configured for auto-channel creation. Set the |
Required. At least one channel must be configured for auto-channel creation. Set the |
||
Required |
|
Required |
Required |
||
|
|
Required |
Required |
||
|
|
Required |
Required |
Required |
Required |
|
|
|
|
||
Required |
Required |
Required |
Required |
||
|
|
Required |
Required |
Required |
Required |
Required |
Required |
Required |
Required |
||
Required |
Required |
Required |
Required |
||
Required |
Required |
Required |
Required |
||
|
|
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. |
Optional |
|
Optional |
Optional |
||
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. |
||
|
Optional |
Optional |
Optional |
Optional |
|
|
|
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. |
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. |
||
|
|
Recommended |
|
|
|
Recommended |
|
|
|
||
Recommended. |
|
|
|
XML sample: install a new gas remote disconnect device at a new service point
This scenario describes installing a new device at a new service point.
<?xml version="1.0" encoding="UTF-8"?> <MasterDataImport xmlns="http://www.itron.com/masterdata/2013/03" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SetServicePoint ServicePointId="OWRGRD_SP1" PrimaryCollectionSystem="OpenWayRiva" PremiseId="OWRGRD_Premise1" ServicePointStatus="Active" TimeZone="EasternUS" CommodityType="Gas"> <SetAccount AccountId="RivaGasAccount_0100001216" AccountNumber="RivaGasAccount_0100001216" RevenueClass="Residential" CustomerFirstName="Tom" CustomerLastName="Joad" BusinessName="New Deal Enterprises"> <BillingAddress StreetAddress="123 Oakie Road" City="Weedpatch Camp" State="CA" Zip="98000"/> <AccountLinkRange Start="BOT" End="EOT"/> </SetAccount> <Address StreetAddress="123 Oakie Road" City="Weedpatch Camp" State="CA" Zip="98000" Country="US" Longitude="-78.61531" Latitude="35.84071" /> <SetNonMeteringDevice DeviceType="105" DeviceId="2.16.840.1.114416.22.295" ChannelNumber="1"> <DeviceLinkRange End="EOT" Start="2018-01-26T09:32:03.717Z"/> <ApplicationGroups> <ApplicationGroup Name = "Group1"/> </ApplicationGroups> </SetNonMeteringDevice> <SetServicePointGroup GroupId="OWRGRDSector" GroupType="Sector" GroupName = "OWRGRDSector" /> </SetServicePoint> </MasterDataImport>
XML sample: install a new gas remote disconnect device at an existing service point
This scenario describes installing a new device at an existing service point.
<?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 = "RivaGasSP_0100001252" PrimaryCollectionSystem = "OpenWayRiva"> <SetNonMeteringDevice ChannelNumber="1" DeviceId="2.16.840.1.114416.22.1234567890" DeviceType="105"> <DeviceLinkRange Start="2017-01-02T09:32:03Z" End="EOT"/> <ApplicationGroups> <ApplicationGroup Name = "IDC_AppGrp_Gas"/> </ApplicationGroups> </SetNonMeteringDevice> <SetServicePointGroup GroupId="OWRGRDSector" GroupType="Sector" GroupName = "OWRGRDSector" /> </SetServicePoint> </MasterDataImport>