Sensus Analytics Integration Guide - sensus-des.com .Sensus Analytics Data Flow ... the...

download Sensus Analytics Integration Guide - sensus-des.com .Sensus Analytics Data Flow ... the display_multiplier

of 23

  • date post

    07-Jul-2018
  • Category

    Documents

  • view

    274
  • download

    8

Embed Size (px)

Transcript of Sensus Analytics Integration Guide - sensus-des.com .Sensus Analytics Data Flow ... the...

  • 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

    1 Integration Overview | 5

  • Report Access: used to generate reports on meter status

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

    1 Integration Overview | 6

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

    Alert Manager

    Alarm Insight

    Additional Apps

    Transformer LoadingEnergy InsightService Management

    1 Integration Overview | 7

  • 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.

    1 Integration Overview | 8

  • 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 meters 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