Data Exchange

The Data Exchange page lets you upload Data Exchange files to synchronize BEACON with your billing and customer information systems. It also allows you to view and download previously imported files for troubleshooting purposes.

Click > to expand/collapse the Getting Started section. 

Use the Getting Started section to: 

• Download the BEACON Starter Spreadsheet 
• Jump to a Quick Start Guide that explains the Setup and Synchronization process 
• Read the Data Exchange FAQ. 
• Get a step-by-step guide to manually exchanging and syncing CIS data and BEACON. 

Use the Import Module

Use the Import module to provision meters and endpoints and update account and service details by doing one of the following:

• Drop a Data Exchange file onto the Drop Zone.

• Upload a file via the file picker.

When a file is submitted through the Drop Zone, BEACON displays the current import status directly in the Drop Zone:

• Queued — The file is in line and will begin processing shortly.

• Progress Bar — Displays the percentage of completion while the import is running.

Files uploaded through the Drop Zone are not listed in the Activity List until the initial dry run completes. After processing finishes, the file appears in the Activity List with the results of the dry run.

If you refresh your browser during a Drop Zone import, the Drop Zone reverts to its default prompt (Click or drag file to this area to upload). The dry run, however, will appear in the Activity List showing its current state (Queued or Progress Bar).

The System Updating state appears in the Activity List after an import has been approved and processing has begun. This indicates that BEACON is actively applying updates to the system.

Activity List

The Activity List is organized as a table that displays information related to each individual import, including file name, status, and completion results.

Import 

This portion of the Activity List table lets you see:  

• The import file name, displayed as a link that when clicked downloads the file.
• The name/email address of the user who imported the file.  
• The method used to update the system:  
  • Via UI–the data exchange file was imported through the user interface (UI), that is, the file was dropped onto the Assets>System Sync>Import module.  
  • Via API–the data exchange file was imported using the Data Exchange Import API. 

• See the type of import that was performed.
  • Accounts and Assets.  
  • Interval (Interval Meter Read).  
  • Billing (Historic Billing Read).  
  • Consumption (Consumption Targets).  
  • Transaction History (Transaction History). 

Additionally, you can:  

• Accept an import by clicking the Approve Import button. 
• Stop an import by clicking the Cancel Import button. 

Records/Exceptions
This part of the Activity List table shows; 

• The number warnings and errors triggered during the dry run/import validation process. 
• The progress of the import. 

Imported/Completed
This section of the Activity list displays real-time progress and completion status of your file imports.  

• Imported – Date and time the file was uploaded. 
• Approved – Date and time the import was approved. If the file was uploaded via API with Dry Run set to false, the date and time stamp will match the Imported date and time stamp. 
• Completed – Date and time the system finished updating all new and modified account, location, meter, and endpoint relationships.   

Activity List Filters
Click > to expand/collapse the Activity List Filters section. This action gives you access to the drop-down filters described below.  

Drop-down menus let you quickly filter the System Sync Activity List making it easy to find the exact import you’re looking for. Use the drop-down menus to filter by:

Import Mode – Display files based on the manner in which they were imported.

Normal – Data Exchange files imported via the UI or using an API.
Manual – Files automatically created by the system to reflect changes entered via one of the Manual provisioning pages (requires enabling by Badger Meter), e.g. Account, Location, Update, Provision, and Swap. NOTE: The Service page is not yet supported.
Manual Tag – Files automatically created by the system when tags are generated by way of the Tags button on a Monitor page meter card.
Other – Files that do not fit into the standard categories above.

Import Type – Display files based on the function they perform.

Account and Assets – Files used to provision and update meters, endpoints, accounts, and locations.
Billing Meter Reads – Files for importing current and historic billing reads.
Transaction History – Files that let you update account data related to payment and billing activity.
Interval Meter Reads – Files used to bring interval reads collected from AMR/AMI solutions from Badger Meter and third parties.
ID Updates – These files act as a global search and replace feature for changing account IDs, location IDs, service point IDs, and meter IDs.
Consumption Targets – Files that let you set water usage goals on a service by service basis.
Deep Links/Tags – Files used to directly link accounts in BEACON to the corresponding accounts in a third-party system. Can be uploaded or created by the system when deep links are created via the UI.
SSO Users – Files created automatically by the system when SSO users are created via the UI.

Import Source – Filter based on how an import was performed.

UI – Files uploaded via the System Sync Data Exchange page.
API – Files imported via the Import API.
FTP – Files uploaded to an FTP site.
Other – Files created automatically by the system when the Manual Provisioning functions are used. 

Click Reset Filters to clear the current selection of filters.

Use the Date Picker to select a date range by clicking a start date followed by an end date.
If you pick an end date that comes before the start date, the system automatically flips those dates.

TIP: To pick a single day, click that day twice. This action sets that day as both the start and end date.

The number of records found is displayed in the lower left corner of the page.

The pagination controls in the lower right corner of the page let you:  

• Step forward and backward one page at a time.
• Use a drop-down menu to select the number of records to display per page.
• Enter any page number In the Go to Page box and press RETURN to jump directly to that page.  

Email Notifications

Click Settings in the upper right corner to add or remove recipient email addresses. When added, users will receive an email notification when all tasks associated with an import are complete. This process can take up to 24 hours. 
 
Up to five recipient emails can be added. TIP: We recommend using a group or shared email address (for example, integration@yourcompany.com. This lets multiple recipients receive notification emails. Group or shared addresses must be managed by the utility. If an individual member of a group/shared email address wishes to unsubscribe, they must do so through the utility group email management process.

After clicking Settings, enter an email address in the Email box. While the system looks for a valid email schema, e.g. {name}@domain.{value}, it does not validate addresses. In other words, entering jdoe@eaxmle.com (an obvious typo for example.com) will not produce an error message. As a result, you must carefully review the values entered.

Repeat as needed until you reach a maximum of five email addresses.

To unsubscribe, delete the recipient’s email address.

Click the More Actions (three dot) menu to delete an email. TIP: If you need to change an email address, delete the existing entry and create a new recipient.