Data Exchange Requirements

EOW

EyeOnWater (EOW) services give consumers direct access to their water consumption data and provides tools to help them manage their water use. EOW enables customer outreach and delivers information to them on the web and through mobile apps.  EyeOnWater also delivers leak alerts to customers through email messages.

To take advantage of this premium feature*, complete each of the following data fields in your Data Exchange files.

NOTE: To comply with privacy regulations, you must provide a Location_Zip (the ZIP or postal code of the service location) or a Billing_Zip (the ZIP or postal code of the billing address) to enable EyeOnWater account creation.

Account Information

Column Name Max Length Format Description
Account_ID 32 Text Identifier of the Account used for billing purposes.
Account_First_Name 64 Text First name of the account owner.
Account_Last_Name 64 Text Last name of the account owner.
Account_Full_Name 128 Text Full name of the account owner.

Location

Column Name Max Length Format Description
Location_ID 40 Text Unique identifier for the location where the service is being provided
Location_Name 64 Text Label for this location in cards and maps
Location_Address_Line1 64 Text Address line 1 for the service location
Location_Address_Line2 64 Text Address line 2 for the service location
Location_City 64 Text City of the service location
Location_State 2 Text State or Province of the service location
Location_Zip 10 Text ZIP+4 or postal code of the service location
Location_Latitude 15 Text Latitude position of the service location in decimal degrees.
Location_Longitude 15 Text Longitude position of the service location in decimal degrees.

Service Point

Column Name
(for Oracle CC&B)
Max Length Format Description
Service_Point_ID

(SP_ID)

20 Text An identifier used to distinguish between multiple service hookups at the same Location. The combination of Location ID and Service Point ID represents a single point to which a meter is to be attached.
Service_Point_Type
(SP_Type)
1 Text, W, S, G, E, F, I, R or Blank Type of service being read. Water ( W ), Sewer (S), Gas (G), Electric (E), Fire (F), Irrigation (I) and Reclaimed/Recycled (R). If not specified, the default is Water (W).
Service_Point_Cycle
(SP_Cycle)
12 Text An identifier used to denote the billing cycle name.
Service_Point_Route
(SP_Route)
12 Text Identifier of the route or book the metered service belongs to. It is used by BEACON to group accounts for loading into collection devices or running reports.
Service_Point_Class_Code
(SP_Class_Code)
24 Text Identifier for this service point’s billing classification/category in the billing system, e.g., residential, commercial, irrigation, etc.
Service_Point_Class_Code_Normalized
(SP_Class_Code_Normalized)
24 Text The standard BEACON class code that the billing system class code corresponds to. Must be one of ‘Commercial,’ ‘FireService,’ ‘Industrial,’ ‘Irrigation,’ ‘Sewer,’ ‘SingleFamilyResidential,’ ‘MultiFamilyResidential’ or ‘Vacant.’
Service_Point_Latitude
(SP_Latitude)
15 Text Latitude position of the Service Point in decimal degrees; provided separately from Location Latitude in case a more specific location for the service’s meter hookup is available
Service_Point_Longitude
(SP_Longitude)
15 Text Longitude position of the Service Point in decimal degrees; provided separately from Location Latitude in case a more specific location for the service’s meter hookup is available

Meter

Column Name Max Length Format Description
Meter_ID 40 Text Identifier of the meter. It must be unique and is required.
Meter_SN 64 Text Serial number of the meter or meter register. Used for information purposes.
Meter_Manufacturer 32 Text Manufacturer of the meter. (Badger, Sensus, Neptune, etc)
Meter_Model 64 Text Model of the meter. (M25, M55, T160, etc.)
Meter_Size 10 Number Numeric size of the meter. (5/8 = .625, 3/4 = .75, 1 1/2 = 1.5, etc.)
Meter_Continuous_Flow 1 Number, 1 or 0 1 if meter is expected to have continuous flow. If left blank, meter is assumed to have non-continuous flow.
Register_Number 1 Text, L, M, H or Blank Identifier of the high (H), mid (M), and low (L) register of a compound meter. Leave blank for single register meters. For compound meters, the Location_ID, Service_Point_ID, and Meter_ID are expected to be the same for all registers.
Register_Unit_Of_Measure 12 Text Unit that the meter measures in. (GAL, CUBIC_FEET, CUBIC_METER, IMP, LITER, AF)
Register_Resolution 6 Number Factor of the rightmost movable digit (0.01, 0.1, 1, 10, 100, 1000, etc). Taken together with the Register_Unit_Of_Measure this represents the smallest unit of change that the register can report.
Meter_Install_Date 10 YYYY-MM-DD The date the current meter was installed if a meter change out occurred, otherwise leave blank.
Meter_Removal_Date 10 YYYY-MM-DD The date the meter is removed from the associated Service Point; provide only if meter is being removed.

Service Agreement

Column Name Max Length Format Description
SA_Start_Date 10 YYYY-MM-DD Date service began. The combination of Account_ID, Service_Point_ID, and SA_Start_Date is a distinct, unique Service Agreement
SA_End_Date 10 YYYY-MM-DD Date service ends. If present, this record is interpreted as a termination of the service agreement for the specified Account_ID, Service_Point_ID, and SA_Start_Date.

Endpoint Configuration

Column Name Max Length Format Description
Endpoint_SN 20 Text Serial number of the endpoint paired with the specified meter
Endpoint_Type 1 Text, J (or 4), N (or 5), Z (or 6), g (or 7), G (or 8), L (or 3), K (or 3) and C A letter or number indicating the type of endpoint used to read the meter. ORION Cellular (J or 4), ORION ME (N or 5), ORION SE (N or 5), ORION CE (Z or 6), GALAXY TR3 (G or 8), GALAXY TR2 (g or 7), Magnetic Barnacle (L or 3), Pulse Barnacle (K or 3) and Manually Read Meter (C).
Endpoint_Install_Date 10 YYYY-MM-DD Date the endpoint was installed on the meter specified by Meter_ID.
Endpoint_Removal_Date 10 YYYY-MM-DD Date the endpoint was removed from the meter specified by Meter_ID. When this value is present this record is interpreted as an unpairing of the endpoint from the meter.

* An additional annual fee is required. Contact your BEACON AMA sales representative for details.

Get Support

Knowledge Base

User Guide
Follow via Email

Enter your email address to get new content notifications by email.