Download - Sensus Analytics Integration Guide - sensus-des.com · Sensus Analytics Data Flow ... the display_multiplier for any meter in Sensus Analytics is 1, ... Sensus Analytics Integration

Sensus AnalyticsVersion 1.1.8

Integration GuideAIT-10006-01

Revision HistoryRev No. Date Description

Rev 01 24-APR-17 Initial Release

CopyrightThis document, in whole or in part, (“Document”) includes confidential and proprietaryinformation belonging to Sensus USA Inc. and/or one of its subsidiaries or affiliates.Unauthorized use, reproduction, disclosure, distribution, or dissemination of this Documentis strictly prohibited. No party may use, reproduce, disclose, distribute, or disseminate thisDocument for any purpose without express written authorization from Sensus USA Inc.Any use, reproduction, disclosure, distribution, or dissemination of this Document doesnot transfer title to, license, or grant any patent, copyright, trademark, or other intellectualproperty rights. This Document, and any copies or derivatives thereof, must be returnedimmediately on demand. This Document is subject to any applicable non-disclosureagreement(s). Information in this Document is subject to change without notice and doesnot represent a commitment on the part of Sensus.

© Copyright 2017, Sensus. All Rights Reserved.

FlexNet™ and associated logos are trademarks of Sensus and its subsidiaries and affiliates.All other brand names may be trademarks of their respective owners.

Sensus

8601 Six Forks Road

Suite 700

Raleigh, NC 27615

1-800-638-3748

www.sensus.com

Document: Sensus Analytics Integration Guide

Document Number: AIT-10006-01

Revision History | ii

ContentsRevision History.......................................................................ii

Copyright................................................................................................ii

1 Integration Overview............................................................. 4Sensus Analytics Overview.................................................................... 4Sensus Analytics Data Flow.................................................................. 8

2 Enabling Sensus Analytics Functionality............................. 9VFLEX Integration Options.....................................................................9

VFLEX Sync File Option (Preferred)................................................... 9Billing Request (Limited VFLEX) Option............................................. 9

Utility Files and Formats...................................................................... 10VFLEX Sync File..............................................................................10Billing Export File.............................................................................12Billing Request File..........................................................................13AutoRead Integration...................................................................... 14

3 Sensus Analytics Integration Process................................18

4 Appendix A - Integration Questionnaire.............................20

5 Glossary............................................................................... 22

Contents | 3

1 Integration Overview

Sensus Analytics OverviewSensus Analytics (SA) is a software application that is delivered through a proprietary,secure, cloud-based platform. SA provides core business functionality so that you canstreamline operations through a suite of intuitive applications. Its powerful data managementtools aggregate information from multiple systems, including your billing software, andprovide information on your desktop, tablet, or smart phone.

Sensus Analytics applications deliver:

Billing interface toolsValidation toolsCustomer service toolsManagement toolsCloud-based storageWeb-based reportingGraphical mappingAutomated notificationUser-friendly application and dashboard

SA can store 3 years of data as a minimum; RNI stores data for only 60 days.

Sensus Analytics BundlesFor Water, Gas, and Electric utilities, Sensus Analytics offers two bundles: Essential andEnhanced.

The Essential bundle provides the basic applications that enable the utility toaccumulate reading and alarm data and export the reading data to the billing system.The Enhanced bundle has additional applications that provide greater usability in theareas of Alarms and Alarm Management.

Essential Applications

Admin: used for setup and configuration

1 Integration Overview | 4

Billing Access: used to preview and audit billing data

Device Access: used to access the detailed usage history


Report Access: used to generate reports on meter status

Meter Insight: monitors meter activity to help identify meter issues on the network


Enhanced ApplicationsIncludes everything in the Essential bundle, plus the following:

Alert Manager

Alarm Insight

Additional Apps

Transformer LoadingEnergy InsightService Management


Customer Portal

Sensus Analytics Data FlowThe data flow for billing integration begins with the collection of meter reads from theSmartPoint modules (endpoints).

The SmartPoint modules collect the meter reads, and then transmit to the Base Stationat scheduled intervals (every four hours, for example). The Base Station is responsible forretrieving data from the endpoints and passing the data to the Regional Network Interface(RNI). The RNI receives the data from the Base Station. Data is transmitted from the RNI toSensus Analytics; meter readings are transmitted hourly, and alert data is transmitted everyfive minutes.

Sensus Analytics requires a minimum RNI version of 3.x.


2 Enabling Sensus AnalyticsFunctionality

To enable Sensus Analytics functionality, Billing and Customer Information System (CIS)data is required. This section describes the file formats and interface specification related towater, gas, and electric endpoints for the SA integration with the utility CIS billing system.

VFLEX Integration OptionsThere are multiple options to integrate with Sensus Analytics.

Option AVFLEX

Option BBilling Request

VFLEX Sync File Option (Preferred)VFLEX is the name given to a data file that contains information such as meter, account,location, and customer data for each Advanced Metering Infrastructure (AMI) meter. TheVFLEX file is recommended to be scheduled as a daily automated extract from the utility'sbilling system. The VFLEX data is required in order to process meter data from the SAsystem as well as to enable meter reads for billing purposes.

When a utility sends a VFLEX Sync file, they get full Sensus Analytics capabilities:

Searching and grouping is enhanced by multiple criteria (if provided in the VFLEX file)View the Meter Insight dashboard, showing active meters and inactive metersEnable Billing Export functionality (if Billing Cycle data is provided)Reports contain metadata to increase their usefulnessVFLEX file is required in order to enable other SA applications such as TransformerLoading

Billing Request (Limited VFLEX) OptionThe Billing Request (limited VFLEX) option is typically used to leverage existing billinginterface files generated by the utility CIS as a limited VFLEX. This option offers a quickand easy way to enable Sensus Analytics; however, may not provide the full functionalityexpected.

If a utility uses the Billing Request as a limited VFLEX file, they might get limited SensusAnalytics capabilities:

Search and grouping capability is limited to mapped fields from the Billing Request fileLimited reports (Billing Request Mismatch, High/Low Exception Report if data isprovided)Limited Meter Insight – Orphaned Meters data onlyNo access to additional SA applications such as Transformer Loading

2 Enabling Sensus Analytics Functionality | 9

Utility Files and FormatsVFLEX Sync FileBilling Request FileBilling Export (Response) File

VFLEX Sync FileVFLEX Sync File is the preferred file format.

Note: In some cases, a Billing Request file can be used as a limited VFLEX file.

The purpose of the VFLEX file is to keep meter and account attribute data in sync betweenthe Billing System and Sensus Analytics.

Characteristics of a VFLEX file

Includes meter data fields such as name, address, account, meter size, and so onShould include all active AMI metersEach row should have a unique meter_idCan be delimited (CSV) or fixed-width file formatBilling Cycle field is required for Billing functionalityUtilities can include custom fields, which will be displayed in the Sensus Analytics UI andcan be passed through to Billing Export filesRecommend that the VFLEX file be transmitted daily to the Sensus SFTP site

Note: If you have a data sync file from another MDM system, SA can support it as a VFLEX sync file.Minor modifications may be required.

Work with your billing vendor to make the necessary modifications, and the Sensus teamwill map the file.

Note: If you do not have a VFLEX sync file and would like to create one, contact the SensusProfessional Services team.

VFLEX Data AttributesFor field definitions and valid values for the standard (Sensus Aware) fields, see the SensusAnalytics VFLEX Data Attributes Reference Guide.

The utility can specify custom fields in the VFLEX sync file in addition to the standard(Sensus Aware) fields.

Display Multiplier

By default, Sensus Analytics will leverage the meter’s programming to factor reading datato the appropriate base metric (such as gallons or kilowatt-hours). This factored read will bestored and used by SA for display, reporting, analysis, and billing.

In cases where this reading needs to be adjusted for the display of reading data, the utilitycan pass a “Display Multiplier” in the VFLEX file.

This multiplier is only applied to readings displayed in Device Access, Meter Insight, andReport Access on the Sensus Analytics UI. It will also apply to read data presented in the


SA Customer Portal. By default, the display_multiplier for any meter in Sensus Analytics is 1,unless otherwise specified by VFLEX.

The display_multiplier will not affect the actual billing read exported from SA.

Electric: If the utility wants to have CT/PT factors applied to the displayed reading in SA orCustomer Portal, a display multiplier can be used.

Note: The utility can specify either the Billing Multiplier or Display Multiplier, or both.

Billing Multiplier

In the Billing Export, Sensus Analytics will deliver the factored register read according to thebase metric (such as gallons or kilowatt-hours). If the scaled read is not acceptable by theutility billing system, the “Billing Multiplier” can be used to control the scaling of the read,either globally or on a meter-by-meter basis.

Global Billing Multiplier: If the utility chooses to return all read data for a specific commodityin a metric other than the base metric, then a global billing multiplier can be configuredin SA. For example, if read data needs to be converted from single gallons to ThousandGallons, then a global billing multiplier of 0.001 can be set for all water devices.

Assumption: All meters of the same commodity type have the same base metric.

VFLEX Billing Multiplier: The utility can specify device readings to be factored with a billingmultiplier via the billing_multiplier VFLEX field.

Special Case: Convert to Raw Scale reads:

As previously stated, because the stored reads in SA are factored to the base metric, theSA Billing Export will deliver a scaled read. If the utility billing system requires the read datato be unscaled, then the inverse value of the meter’s read resolution must be passed in theVFLEX file for each device. For example, if the SmartPoint is programmed with a resolutionof 0.1x Gallons to indicate measurement in tenths of gallons, then the “billing_multiplier”must be set to 10 in order to convert the read back to raw scale for billing.

Note: The utility can specify either the Billing Multiplier or Display Multiplier, or both.

GIS Coordinates

The collected Latitude and Longitude coordinates for the utility can be imported by SA. Ifthe Latitude and Longitude coordinates are not available, SA will use the coordinates fromthe RNI.

VFLEX File Naming ConventionsThese VFLEX file names are supported:

XXXX_VFLEX_W_yyyyMMddhhmmss.csv (for Water only utilities) - preferred

XXXX_VFLEX_WEG_yyyyMMddhhmmss.csv (for Water, Electric, and Gas) - preferred

where

XXXX = RNI short name (must be uppercase, such as TEST)yyyyMMddhhmmss = date when the file is generated in year, month, date, hour, minutes,seconds formatSample: TEST_VFLEX_W_20170413110000.csv

Note: If the file name is incorrect, it will impact the processing of the files.


These shorter VFLEX file names are also supported, but require setup by the SAdevelopment team:

XXXX_VFLEX_W.csvXXXX_VFLEX_WE.csvXXXX_VFLEX_WEG.csv

Note: This may be used by a utility who has a CIS/billing system that does not support providing thedate and time stamp in their VFLEX file.

File TransferAs part of the Sensus Analytics solution, Sensus will establish a secure FTP mechanism(“Drop Server” account) to enable the utility or billing vendor to transfer files between theserver running the utility billing software and the Analytics server. Credentials (URL/IPaddress, username, and password) will be provided which will enable access to specificfolders in which to place the VFLEX file.

It is not required that the transfer of files be automated. As an alternative, files can betransferred manually via an FTP client (FileZilla for example).

Note: It is the responsibility of the utility or billing vendor to set up the file transfers and scheduling.

If desired, Sensus Professional Services can automate the transfer of the VFLEX file tothe Sensus Analytics SFTP as an additional fee-based service. As a prerequisite, theutility is responsible for creating the file on a scheduled basis. To request a quote, [email protected].

Sensus Responsibility

1. Set up an SFTP drop server account for the utility (such as "test").2. Provide SFTP drop server name, login credentials (username and password), and

specific folder locations to which to submit the VFLEX file.

Daily STFP to the Incoming folder at the Sensus SFTP site (filedrop.sensus-analytics.com)Login: typically the RNI short name (lowercase, such as "test")Password: provided by Sensus Professional Services

3. After the first VFLEX file is submitted manually and verified successfully, then Sensus willcommunicate to the utility that it is okay to enable delivery of the VFLEX file to the SFTPfile drop server.

Utility Responsibility

1. Create VFLEX file and determine how to deliver to the SFTP drop server (recommenddaily and automated).

2. Submit VFLEX file (recommend daily and automated).

Note: The utility is responsible for SFTP file delivery to and retrieval from the specific folders on theSFTP drop server.

Billing Export FileThe Billing Export file, also called the Billing Response file, extracts the requested meterreadings from Sensus Analytics to be imported by the Billing/CIS System as input to theutility's billing process.


Characteristics of a Billing Export file

Billing Export data file (Generated in the Billing Access app)

Requires user action to create Billing Export files on the Sensus Analytics UI >Billing Access > Exports tab

Can be delimited or fixed-width

Requirement: Billing Cycle must be provided in the VFLEX sync file.

Note: If a Billing Request file is uploaded to Sensus Analytics, a Billing Export file is generatedaccording to the mapping configuration defined in SA.

Billing Export Data AttributesFor field definitions and valid values for the standard (Sensus Aware) fields, see the SensusAnalytics VFLEX Data Attributes Reference Guide.

Billing Export ConfigurationAny fields that are provided in the VFLEX file can be included in the Billing Export file,including custom fields.

The following fields are generated by SA and can be included in the Billing Export file:

Field Name Description Required in Export File

read Stored reading Yes

read_date Date of reading Yes

uom Unit of measure Optional

Utility Responsibility for Billing Export Data

If a Billing Export file is currently used, the utility must provide a sample Billing Export file tothe Sensus Professional Services team, along with definitions of field specifications.

If a Billing Export file is not currently used, the utility is responsible for the following:

1. Determine what VFLEX fields should be included in the Billing Export files.2. Determine what additional “Export Only” fields should be included in the Billing Export

files.3. Work with the CIS/billing vendor to determine the appropriate billing export file

specifications.

File Name

The Billing Export file will be exported as a text file with an export token ID.

File name format: Billing_Meter_Export_month_export token ID

Example: Billing_Meter_Export_APR_007366ce-5a3a-414b-b6a3-2330823b8469.txt

The file can be renamed according to the requirements of the Billing system after it isdownloaded from the Sensus Analytics UI.

Billing Request FileThe Billing Request file option is available to utilities who perform billing using a legacyimport/export (or download/upload) method. Sensus Analytics allows for a Billing Request


file to be uploaded to the Billing Access application in the Sensus Analytics UI, and willgenerate a Billing Export file containing read data for the devices requested.

Characteristics of a Billing Request file

Utility can upload Billing Request files on the Sensus Analytics UI > Billing Access >Billing Request tabCan be delimited or fixed-width

Utilities can also choose to use both VFLEX and Billing Request file processes.

Scenario 1A utility that uses VFLEX data that does not include a billing cycle number will need tosubmit a billing request file in addition to their VFLEX file.

Scenario 2Utility wants to include multiple billing cycles in a single Billing Export file.

Billing Request Data AttributesFor field definitions and valid values for the standard (Sensus Aware) fields, see the SensusAnalytics VFLEX Data Attributes Reference Guide.

Utility Responsibility for Billing Request DataProvide a Billing Request sample file with a definition of the field specifications.

AutoRead IntegrationIf you have the AutoRead software for reading meters via handheld devices or visualinspection, use the AutoRead tab. You can upload reads from the AutoRead software, andcan generate billing export files from Sensus Analytics with all read types (AMI, AMR, ormanual).

Benefits of leveraging an AutoRead integration are:

Managing a single billing export file to process reads in the billing systemAnalyzing read data from a historical perspective in Sensus Analytics along with AMI andAMR reads


AutoRead CBK FileTo leverage AutoRead integration in Sensus Analytics, the following fields are required in theVFLEX Sync file:

read_method – allowed values are AMI, AMR, and manualautoread_mxu_type – allowed values are B for RadioRead and C for FlexNet/FlexReadautoread_meter_type – allowed values are B for Sensus, P for Neptune as an example(refer to the AutoRead software manual for additional manufacturers)

In addition to the VFLEX updates, the following changes to the AutoRead CBK file arerequired to enable the processing of import and export files in Sensus Analytics. Notethat by applying these changes, the current AutoRead to CIS interface will be inoperable,requiring users to generate Billing export files from Sensus Analytics.

The following changes are needed in the AutoRead CBK file.

1. In order for the AutoRead application to accept the file that is generated from SensusAnalytics (Billing Access > AutoRead tab), the Import tab layout in AutoRead shouldmatch the following image.

Note: The Constant field can be used to override the default AutoRead out, if necessary. If theutility has a mixture of meters types (AMI and AMR) and meter manufacturers, then the VFLEXfile needs to include appropriate meter_manufacturer and meter_type fields (see the SensusAnalytics VFLEX Data Attributes Reference Guide for definitions of these fields).


2. In order for Sensus Analytics to accept the AutoRead read data file, the Export tablayout should match the following image.

With these changes in place, you can generate billing export files from Sensus Analyticsthat include manual readings.

Use the AutoRead Interface in SA

1. Generate a list of meters for AutoRead:

a) In the Billing Access application, click the AutoRead tab.b) Select the appropriate cycle number.c) To specify the billing window, enter a Start date and an End date.d) Click Get Meters.

2. Perform AutoRead operations:

a) Import the Meter List file from the previous step into the AutoRead application.b) Perform drive-by reading.


c) After meter reading is complete, upload the reads in AutoRead.

3. Upload the AutoRead read data file into Sensus Analytics:

a) In the Billing Access application, click the AutoRead tab.b) Select the appropriate cycle number.c) To specify the billing window, enter a Start date and an End date.d) Click Choose File, and select the file with reads (from AutoRead).e) Click Submit Reads.

4. Generate a Billing Export file:

a) In the Billing Access application, navigate to the Exports tab.b) Select the appropriate cycle.c) To specify the billing window, enter a Start date and an End date.d) Click Start Export.

Note: Billing Export file will include both FlexNet and AutoRead meters that are associated withthe desired billing cycle.


3 Sensus Analytics IntegrationProcess

1. Complete the SA QuestionnaireFor an example of the Sensus Analytics Standard Integration Questionnaire, seeAppendix A.

Email the completed questionnaire to [email protected]. After this isreceived and reviewed by Sensus Professional Services, an integration kickoff meetingwill be scheduled.

2. Attend Kickoff MeetingThe SA Integration kickoff meeting ensures that all stakeholders understand thenecessary steps, dependencies, and specifications for integrating SA with the billingsoftware.

3. Provide Sample FilesThe billing vendor develops the interface to create the applicable sample files (VFLEX,Billing Request, or both), and process the Billing Export (Response) file, per thefile specification in the Sensus Analytics VFLEX Data Attributes Reference Guide.After the interface is complete, email a sample VFLEX file and Billing Request file [email protected].

Note: A minimum of 10 rows of sample data is required.

3 Sensus Analytics Integration Process | 18

[email protected]

[email protected]

4. Review Sample Files

Sensus Professional Services will review the sample files, and provide feedback to theutility; repeat as necessary.

Note: If custom development is required, Sensus Professional Services can offer the additionalsupport as a fee-based service. To request a quote, email [email protected].

5. File MappingAfter the sample files have been validated, Sensus Professional Services maps the files.

6. Validate MappingSensus Professional Services will review and verify the mapping with the utility, and thenthe utility must sign off on the mapping.

7. Process Production VFLEX File

a) After the mapping is confirmed, the utility will provide Sensus Professional Serviceswith the production VFLEX file for processing.

b) Sensus Professional Services will process the production VFLEX file.8. Optional: Automate VFLEX File Creation and Delivery

The utility can automate and schedule the delivery of the VFLEX file to the SFTP dropserver.

9. Enable CMEP ProcessingSensus Professional Services will request to enable CMEP processing; the utility mustvalidate and accept the Sensus Analytics system. The request could take up to 2business days to complete.

Note: After the CMEP Processing is enabled, read data will be displayed in the Sensus Analyticssystem.

10. Generate Billing Export File

a) Sensus Professional Services will generate an initial Billing Export file, if applicable.b) The utility must validate and approve the Billing Export file.

Note: Sensus Professional Services team will work with the utility and billing vendor to resolveany issues that are encountered.

Note: When Sensus Professional Services performs the SA integration, they will conduct a 2-hour operational review and knowledge transfer conference call with the utility to review the SAfunctionality and common business processes.

11. Optional: Attend SA TrainingIf the utility purchased SA Training, Sensus Professional Services will work with the utilityto schedule the training session.

It is recommended that the utility perform a validation of the Sensus Analytics system toensure that Billing works end-to-end.

After the utility has signed off on the Sensus Analytics system, SA integration is consideredcomplete.

Note: Any additional changes to the mapping files after completion will be considered a re-integrationeffort and will require new SA Integration work.

3 Sensus Analytics Integration Process | 19

4 Appendix A - IntegrationQuestionnaire

4 Appendix A - Integration Questionnaire | 20

4 Appendix A - Integration Questionnaire | 21

5 Glossary

AMIAdvanced Metering Infrastructure, including the SmartPoints, Base Station, and RNI.

Base StationThe Base Station is a device which is responsible for retrieving data from the endpointsand passing the data to the RNI. It consists of an antenna, an RF receiver (one-wayendpoints) or RF transceiver (two-way endpoints), server, and either Ethernet, satellite, orphone line communications to the RNI. It serves as the interface between the FlexNetTMRF network and a traditional TCP data network (sometimes referred to as “backhaul”).

CISCustomer Information System

CMEPCalifornia Metering Exchange Protocol is an industry-standard data format fortransmitting metering information.

CSV FileA computer data file where fields are separated by a comma, and optionally enclosed byparentheses, and used to store tabular data (numbers and text) in plain-text form.

CT/PTFor electric metering, Current Transformers (CT) and Potential Transformers (PT) are usedto lower the magnitude of the current and voltage to be measured.

EndpointThe Sensus SmartPoint™ module that exchanges data between a meter or other remotedevice and the Base Station. When thinking of the radio devices as a network these maybe viewed as “endpoints.”

Fixed-Length FileA computer data file where each data element is assigned a specific starting position andlength.

FlexNetSensus Advanced Metering Infrastructure system

GISGeographical Information System used to capture, store, manipulate, analyze, manage,and present all types of geographical data.

GPSGlobal Positioning System. Each SmartPoint™ is programmed with a GPS locationduring activation.

MDMMeter Data Management is an application that performs long term data storage andmanagement for the data delivered by an AMI system. An MDM provides analytics,reporting, and Validation Estimating Editing (VEE) functions on meter data, as well assupporting the billing process.

MultiSpeakMultiSpeak is a specification which defines standardized interfaces among softwareapplications commonly used by utilities. It defines details of data that need to be

5 Glossary | 22

exchanged between software applications in order to support different processescommonly applied at utilities. Real time MultiSpeak interfaces use web services to defineand implement the data transport.

MV-RSMV-RS® is an Itron standard format for transferring route data to and from a hand helddevice.

MXUMeter Transceiver Unit (part of the Sensus Walk by/Drive by Radio Read solution). Similarin function to the SmartPoint Module for FlexNetTM Fixed Base solutions.

RFRadio Frequency, related to meter data transmission.

RNIRegional Network Interface (Sensus Head End). The RNI consists of a database server,web server, statistics server, map server, and network controller (NC) server. Theseservers are used to manage the underlying AMI infrastructure and interface with othercustomer applications. Its primary function is to acquire meter readings, and support thisby managing the RF network and digital components.

SFTPSecure File Transfer Protocol used to securely transfer files between computers on anetwork.

SmartPoint ModuleNew Sensus Radio Transceiver Module. Designed to replace the MXU as the radiocommunication device between the meter and a Base Station.

TCPTransmission Control Protocol

TGBTower Gateway Base station (now simply referred to as Base Station)

UIUser Interface is a term to refer to the way a user interacts with a computer application,including the menu selections, input fields, prompts, etc.

UOMUnit of Measure is the unit the meter measures in. For example, GAL (gallon), CF, (CubicFeet), KWH (Kilowatt Hours).

VFLEXVFLEX Data sync file is used to keep meter and account attribute data for each AMImeter in sync between the utility CIS/Billing system and Sensus Analytics.

Web ServicesA web service is a method of communication between two electronic devices over theWorld Wide Web. A web service is a software function provided at a network addressover the web.

5 Glossary | 23