HAN Update AMIT/RMSHAN Update AMIT/RMS

April 2012

1

HAN Core Support TeamHAN

CoordinatorJay Foliano

OncorRobert Smith

CNPSteve

Mulroe

AEPJerry

Young

TNMPBobby

Roberts

PUCTRebecca

Reed

-RMS/AMIT – 03/12/12

Coordinators

Vendors/MFG

REPS/3rd Party

2

HAN Support Design

HANInitiatives

DocumentationJoselito

HAN Task Force

Jay

Market Awareness

Jay

National Standards

EnerNex - TBD

Call CenterScripts

Steve Ard

-RMS/AMIT – 02/22/11

TDSP’s ROR/REP/3rd Party/Mfg

3

HAN Project - Milestones

– Completed the HAN Support Model Workshop with the TDSP’s and Market:– Defined the detailed operational requirements and processes, issue resolution

scenarios and required customer information to capture – Developing the HAN SMT Call Center Scripts :

– Collaborative Effort with the SMT Call Center to Define the Template and Content Requirements, Q2 Phased Implementation

– HAN Task Force Initiative:– HAN Score Card Report, Next Steps meeting with the TDSP’s, 4/19:

– Finalize the report title– Define the frequency of updating/maintaining report content – Ownership/Gate-keeper of the Report– Where it will reside and access method – Review with the market participants for input and buy-in

– HAN Documentation milestones, status and next steps presented by:– Joselito Samoy

– Defined the Process and Procedures to support the on-going maintenance of the HAN Documentation :

– Joselito Samoy, IBM, will assume the HAN Documentation ownership

4

HAN Project – Next Steps

- AMIT, 4/24, present the initial version of the HAN documentation • Define the Process & Procedures for the On-Going

Maintenance/Updating of the Documentation – Define the future objectives of the HAN Roles & Permissions – Present the HAN Support Model Operational Details to the Market:

• Requirements & Processes• Call Center Objectives and Escalation Procedures• Issue Handling Scenarios• Issue Resolution & Notification

• Expectations of SLO’s• Phased Implementation Time-line, Q2

– HAN SMT Call Center Scripts Phased Implementation, Q2 5

HAN Guide HAN Guide PresentationPresentation

April 2012

6

HAN GuideHAN Guide is available to registered REPs and TDSPs in private SMT website

HAN Guide Sections

HAN Topics Interested Party Sections

HAN functionalities that are supported via the SMT User Interface Business Analysts Sections 2,

3 and 4

HAN Messaging Report Technical Analysts, Business Analysts

Section 4

HAN functionalities that are supported via the HAN API (Application Programming Interface

Technical Analysts, Business Analysts

Sections 5 and 6

HAN Messaging Technical Analysts, Business Analysts

Section 5

HAN Addressing of Messages Technical Analysts, Business Analysts

Section 5

Examples of HAN Messaging Technical Analysts, Business Analysts

Section 5

How to Integrate with SMT (HAN Integration with SMT) DataPower / API Technical Integration Team

Section 6

Technical Requirements to Interface with SMT DataPower / API Technical Integration Team

Section 7

Technical Requirements and Details on Authentication and Authorization

DataPower / API Technical Integration Team

Section 8

HAN Device Testing with TDSPs REPs of Records / HAN Vendors

Section 9

HAN Interoperability Report All Market Participants Section 9

HAN Device Reprovisioning during Meter Exchange All Market Participants Section 10

HAN Project Assumptions Business Analysts Section 11

Glossary of Terms All Market Participants Section 11

List of All HAN FunctionsUI / API HAN Functionalities

UI HAN UI (User Interface)

UI Account Management

UI Grant HAN Access

UI Revoke HAN Access

UI Provisioning/Deprovisioning

UI View Provisioning Status

UI Provisioning

UI Deprovisioning

UI Messaging

UI View Messaging History

API HAN API (Application Programming Interface)

API Provisioning/Deprovisioning/UEG

API Provisioning

API Deprovisioning

API Update Utility Enrollment Group

API Messaging

API Send Price Signal

API Send Simple Text/Display

API Cancel Simple Text/Display

API Send Load Control Event

API Cancel Load Control Event

API Cancel All Load Control Events

HAN Account Management Functional Specifications

The HAN Account Management processes describe how HAN Permissions are granted/revoked to users in the Portal. The HAN Account Management business rules describe how HAN Permissions are granted/revoked at the entity level.

HAN Account ManagementGrant HAN Access

Au

tom

ate

dA

uto

ma

ted

RE

P A

dm

in,

TD

SP

Ad

min

RE

P A

dm

in,

TD

SP

Ad

min

020.Navigate to My Account

060.Select a particular user

110.Check the HAN Control box

070.Conduct Search

100.Display User Account Details

Screen

090.Select a particular user

Save

010.Enter Portal through Private

URL

030.User Action?

2.0

Account Management

Processes

Authorized Meter

My Profile

Company Profile

040.Display Search Screen

050.Display list of users pending for

approval

Manage Users Pending Approval

080.Display Search Results

Edit Permissions

120.User Type=REP?

130.Enable View, Provisioning,

Deprovisioning, Messaging Rights

140.Enable View, Provisioning,Depro

visioning Rights

Yes

No

UI-2.11.3.b

UI-2.11.3.c

UI-2.11.3.c UI-2.11.3.b

HAN Device Provisioning and Deprovisioning Functional Specifications

The HAN Provisioning processes describe how authorized users provision and deprovision HAN Devices through the Portal and how the Portal handles the different statuses of a provisioned Device. The processes also describe how authorized users are able to view provisioning information through the portal.

HAN Device Status Descriptions

HAN Device Status Descriptions – Add a HAN Device

Status Status Description

Add Acknowledged A request to Add this HAN Device was sent by the Customer or by the Retail Electric Provider and has been received by SMT.

Add Pending The Add request has been sent by SMT and has been received by the TDSP.

Note: This status is applicable to CNP only.

Meter Ready The Smart Meter is ready to communicate with the HAN Device. The HAN Device is ready for action. You should advise the Customer to press the button on the HAN Device to establish communication between the HAN Device and the Smart Meter. You may also review the manufacturer’s instructions for the HAN Device to complete the Add Process.

Device Added The HAN Device has been successfully Added and is ready to display usage or receive messages.

NOTE: Functionality varies by HAN Device. Please consult the manufacturer’s guide for the specific HAN Device to learn more about the specific functions.

Add Failed The request to Add a HAN Device has failed. You may try to Add the Device again.

HAN Device Messaging History

This HAN Device Messaging History describes what the authorized user will be able to do through the UI, which is simply the ability to retrieve message acknowledgments (message log) for a particular message type, DUNS and message creation date.

HAN Device MessagingUser Experience

Message Log – Request Report

Messaging Report File Format

Element Required Description

TDSPDUNSNumber Yes DUNS Number

RequestID No Request ID generated by the Portal

MessageID No Message ID assigned by the REP

ESIID Yes

MeterSerialNumber No

DeviceMACAddr No Identifies the HAN Device if device-level status is available.

EventCategoryID Yes Allowed values are:

STM - SimpleMessage CSM - CancelSimpleMessage LCE - LCEvent CLE - CancelLCEvent CAL - CancelAllLCEvents PRM - PriceMessage,

StatusCode Yes Allowed values are:

RQA: Request Accepted and sent to TDSP ACK: Acknowledgment from TDSP that the message request has been received PEN – Pending CON – Confirmed STR – Request/Event Started OPT – Opt Out FLR – Failure

SNT – Message Sent COM – Completed CAN – Canceled

StatusDesc No Additional status description text provided by the TDSP

StatusTimestamp Yes The timestamp for the status information. Ideally, this is the timestamp derived from the meter/ESI.

HAN Application Programming Interface (API)

• Provisioning and Deprovisioning APIs

• Update Utility Enrollment Group API

• Messaging APIs

HAN Messaging API

• Addressing of Messages with ESIID

Load Control Message API• Request Information

Element Mandatory Type Description EventID Y Int Event identifier, unique within messages. REPS

assigned EventID StartTime Y dateTime The time at which the message becomes valid.

REP provided value. For “now”, use 2000-01-01T00:00:00Z

DurationTime Y Int As per SEP: allowed values are 1 to 1440 DeviceClass Y string(16) This is a bitmap value as related to Table D.2 in

Section D.2.2.3.1.1.1 in revision 15 of the Smart Energy Profile Spec (page 143). That table defines a bit map for Load Control the device class. Bit 0 (right-most bit) controls HVAC compressors or furnaces. Bit 1 controls Strip and baseboard heaters...... Bit 11 controls Generation systems. Bits 12-15 are reserved. The SMT API will accept a string(16) value. Counting characters from the right, characters 1-12 must be a "0" or a "1". ACK=FLR is returned if this value deviates from these rules.

UtilityEnrollmentGroup Y Int Per SEP: Range 0 - 255 CriticalityLevel Y Int Per SEP: Range of 1-9 CoolingTemperationOffset N Int Per SEP HeatingTemperatureOffset N Int Per SEP CoolingTemperationSetPoint N Int Per SEP, Range -27315 to 32766 & 32768 HeatingTemperatureSetPoint N Int Per SEP, Range -27315 to 32766 & 32768 AverageLoadAdjustPercent N Int As per SEP: Range of -100 to 100 or 128(0x80) which

indicates the field is not used. DutyCycle N Int As per SEP: Range of 0 to 100 & 255 for NULL EventControl Y Int Values are per Zigbee:

0 – do not randomize start time, do not randomize end time

1 – randomize start time, do not randomize end time

2 – do not randomize start time, randomize end time

3 – randomize start and end times

HAN Messaging Examples

• Load Control Messaging Temperature Set PointThe following example illustrates how to send a load control message to set the cooling temperature setpoint to 30 deg C (3000

in the example below) and the heating temperature setpoint to 15 deg C (1500 in the example below). Since the start time has been set to 2000-01-01T00:00:00Z, this load control event will be started immediately for a duration of 30 minutes. All HAN Devices, regardless of the utility enrollment group they are assigned to, will receive the event as the Utility Enrollment Group in the load control event has been set to 0.

Duty Cycle is 255 or NULL which means that the load control switches will not react to this load control event.

<LCMessageBlock> <EventID>12348911</EventID> <StartTime>2000-01-01T00:00:00Z</StartTime> <DurationTime>30</DurationTime> <DeviceClass>0000111111111111</DeviceClass> <UtilityEnrollmentGroup>0</UtilityEnrollmentGroup> <CriticalityLevel>1</CriticalityLevel> <CoolingTemperationSetPoint>3000</CoolingTemperationSetPoint> <HeatingTemperatureSetPoint>1500</HeatingTemperatureSetPoint> <DutyCycle>255</DutyCycle> <EventControl>0</EventControl> </LCMessageBlock>

HAN Device Messaging API

GroupID + ESI IDs

Message Request (API) (1 / 2)

SM

TxP

ES

BS

MT

xP E

SB

Au

tho

rize

d

RE

P (

AP

I)A

uth

ori

zed

R

EP

(A

PI)

NoYes

No

Yes Yes No

090.Receive Ack010.Send

Messaging Request

020.Receive Messaging

Request/Assign Request ID (DB)

140.Mix of Valid/Invalid

ESI IDs

080.Fail Request, Log Failure and

Send Ack

120.ESI ID/Meter ID Valid?

160.Accept Messaging

Request and Send Ack

130.REP Has Access to

these ESI IDs?

030.Contents of Address

Block?

Em

pty

On

ly G

rou

pID

070.> 10,000 ESI

IDs?

Only ESI IDs

150.Accept Messaging

Request and Send Partial Success

Ack

Yes

All Original ESI IDs are valid

B

200.Create Messaging

Request(s) for TDSPs

170.Validate Message Format/Block according to

Message Type

180.Message Format Valid?

Yes

No

190.Log failed messages, make available to be retrieved through the

Message Log Request

1

We will not filter for ESI IDs that have HAN Devices

No

A

A

B

065. Meter IDs with Request?

Yes

No

Note: When the address block has both GroupID and ESI ID populated, SMT will

validate the ESI ID list, but not the Group ID. Group ID is managed by the TDSP. After

validation, SMT will send the message request to the TDSP, and the TDSP will process the

message accordingly. Refer to HAN Messaging Section in the HAN Document.

HAN API Starter Kit

The HAN API Starter Kit is a soapUI-based tool that SMT has developed that Retail Electric Providers (REPs) can use for invoking the Smart Meter Texas (SMT) Home Area Networking (HAN) Web Service interface.

HAN API Starter Kit

Overview of Steps for using the Starter Kit

• Set up the Starter Kit• Configure SSL • Configure WS-Security• Invoke Web Services

HAN API Starter KitHAN Provisioning and Messaging WSDL FilesAfter the REPs have integrated with SMT HAN API’s using the API Starter Kit, the WSDL (Webservice description

language) files for HAN related services will be provided by SMT upon request. These files can be utilized to build client applications to consume the SMT services for HAN. SMT will provide the WSDL files for the HAN services listed below.

• HAN Device Provisioning / Deprovisioning• HAN Device Utility Enrollment Group• HAN Device Messaging which includes:

• Sending simple text message• Cancel simple text message• Sending price signal• Sending Load control event• Cancel a Load control event• Cancel all Load control events

• The REPs are expected to raise a request with the SMT help desk (Call 1-888-616-5859) to request these WSDL files. SMT technical team would provide the WSDL files in a compressed (.zip) file. The WSDL files can also be imported to SOAP UI tool to create and setup the project to access the service.

HAN Interface SecurityPrerequisites for Interfaces

· All communication to SMT from REPs and TDSPs will be over 2-Way Secure Sockets Layer (SSL). For each TDSP, a VPN channel has to be established between SMT and TDSP systems. In the case of TDSPs, SSL will be employed over a virtual private network (VPN).

· For API requests from TDSPs, SMT requires that a user credential be passed in a SAML token

that is part of SOAP header. The specific of SAML token is described in a later section. · For API requests from REPs, SMT requires that a user credential be passed in a UserName Tokenthat is part of SOAP header. SMT does not require password to be passed as part ofUsernameToken.

HAN API Authentication and Authorization

REP-API SMTxP-DataPower SMTxP-LDAPTDSPSMTxP-ESB

1: SMTxP Provisioning/Messaging Requests

2: Check UserToken

5: Validate REPs DUN with RequesterAuthenticationID in message element

6: Validate RequesterType of REP in message, matches with DUNS Number as REP

10: TDSP Provisioning/Messaging Status Responses

11: Check SAML Token

12: Validate System Account ID

7 : Validate XML Schema

13: Validate XML Schema

9: Send SOAP Faults

15: Send SOAP Faults

3: Validate System Account ID

4: Get REPs DUNS for System Account ID

8: Forward Request to ESB

14: Forward Request to ESB

HAN Device Testing Criteria

Note: Verify that TDSPs have processes in place to support HAN Device Testing with REPs and HAN Device vendors.

The TDSPs provide a standardized method of testing and verifying HAN Device functionality to ensure that HAN Devices function as designed within the specifications detailed in the Smart Energy Profile 1.0 when operated on TDSPs advanced metering system (AMS) network. The REPs and HAN Device vendors should contact the TDSPs to initiate request to perform HAN Device testing.

The HAN Device test cases that are executed during the ZigFest Interoperability events are the basis of

the test cases executed by the TDSPs in their HAN Device validation program. Some TDSPs have more test cases, and some have less, but all are based on the ZigFest test cases. These include provisioning, deprovisioning, and messaging (simple text, load control and pricing). The TDSPs record the testing results and provide feedbacks to the REPs and HAN Device vendors that requested the tests.

HAN Interoperability Report

• The HAN Device Interoperability Report contains information regarding HAN Devices that have passed testing at a particular TDSP. The reports are updated monthly and filed with each TDSP's Commission report. Each report contains the device name, version, meter firmware version, device configuration and date tested. Devices that are in testing or have failed testing are not on this list.

HAN Manufacturer Product

Device Type

HAN Device Firmware

Meter Configuration TDSP

For time period ending

HAN Device A Product name IHD HAN Device FW version

TDSP meter version AEP 29-Feb-12

HAN Device B Product name Thermostat HAN Device FW version

TDSP meter version TNMP 29-Feb-12

HAN Device C Product name GW HAN Device FW version

TDSP meter version CNP 29-Feb-12

HAN Device D Product name LC Switch HAN Device FW version

TDSP meter version ONCOR 29-Feb-12

HAN Device Reprovisioning During Meter Exchange

Step Description

1

TDSP sends meter exchange transactions with old meter id, new meter id and ESIID

2

SMT removes the HAN Devices from the old meter

3

SMT removes the old meter from the ESIID

4

SMT adds the new meter to the ESIID

5

SMT adds the HAN Devices to the new meter. (This is accomplished via the TDSP MeterHANSynch service and other TDSP-SMT processes)

6

SMT displays the HAN Devices in the UI

Next Steps• Working with Handbook and Education taskforces to review and fine-

tune the HAN Guide – Method to incorporate the HAN documentation into the HandBook – Going forward Process & Procedures to interface HAN documentation, future versions,

with both Task Forces group efforts– Education Process to advise the market of the HAN documentation availability, location

and access method– AMIT steering committee to determine who in the market can have access to the HAN

documentation– Will we provide a soft copy, hard copy or both available to the market

• Gather feedbacks and comments from the Market Participants, and include these in the next version of the HAN Guide

• Please send your feedbacks and comments to:

joselito@us.ibm.com (Joselito Samoy)