Smart Meter Texas © Copyright IBM Corporation 2010 1 IBM Confidential Functional Design Document...

Smart Meter Texas

© Copyright IBM Corporation 20101 IBM Confidential

Functional Design Document for the 3rd Party Pilot

of theCommon

Advanced Metering SystemWeb Portal and Data Repository

Design, Build, Test, Deploy

A-1 Release 3 Design Document for 3rd Party Pilot

Prepared forTexas Competitive Electric Market

Transmission and Distribution Service Providers (TDSPs)

Dra

ft

Smart Meter Texas


Document History

Revision History

Revision Number

Revision Date

Revision By Summary of Changes Changes marked

v1 9/19/2011 Ikroop Kaur Functional design No

v2 9/22/2011 Ikroop Kaur Michael Dittmer’s comments addressed No

Smart Meter Texas


3rd Party Pilot:OVERVIEW

Smart Meter Texas

© Copyright IBM Corporation 2010

3rd Party Pilot Guiding Principles

Quickly deliver a 3rd Party Pilot by leveraging

as much existing SMT capabilities as possible

Delivery as little “throw away” work as

possible

Develop the pilot to be robust enough to roll

through the pilot and into permanent product

Develop the pilot to have as little need for

placing constraints on 3rd Party Pilot

participation as possible.

Will be based on existing Friends capabilities

for portal and existing REP Rebranding and

HAN Provisioning APIs

No throw away work for the pilot, may need

enhancements and modifications as learnings

from the pilot are applied for final solution

Consumer experience and APIs framework

will be mature enough for production, may

need some adjustments, 3rd Party may need

additional capabilities.

No limits for Residential consumers will be

needed. JDOA & AMIT committees can

decide how many 3rd Parties should

participate

IBM Confidential4

Smart Meter Texas


3rd Party Pilot Solution Overview

The SMT 3rd Party Pilot capability will allow the residential consumer to create and manage 3 rd Party relationships in a self-service manner via the SMT portal.

Third Parties will be able to request usage data from and provision HAN devices for residential consumers via SMT APIs

Third Parties will be able to request a list of their existing consumer relationships from SMT by email.

Smart Meter Texas Solution

Smart Meter Texas Solution

3rd Party3rd Party ConsumerConsumer

001 Consumer initiates 3rd Party relationship

002 Consumer views existing 3rd Party relationships

003 Consumer modifies existing 3rd Party relationships

004 Consumer terminates existing 3rd Party relationships

005 3rd Party obtains SMT API access

006 3rd Party views existing 3rd Party relationships

007 3rd Party terminates existing 3rd Party relationship

008 3rd Party accesses data from one of its existing consumer relationships

009 3rd Party provisions a HAN device for one of its existing relationships

Smart Meter Texas

© Copyright IBM Corporation 2010 IBM Confidential6 IBM Confidential

3rd Party Pilot Solution Overview

Use cases 001-004 leverage existing SMT Friends functionality as a baseline.

Use case 005 will be managed using the standard process for providing API access to SMT

Use case 006 will allow the Web Host Admin to run a report that can be emailed to the 3 rd Party

Use case 007 the 3rd Party will choose to no longer pull consumer data if the business relationship is dissolved

Use case 008 & 009 will leverage the existing REP Rebranding and HAN Provisioning APIs as the currently exist but modified to accommodate the 3rd Party agreement model

Smart Meter Texas


3rd Party Pilot:BUSINESS REQUIREMENTS

Smart Meter Texas


Business Requirements (Page 1 of 2)

BR 3PP 1.0 Provide the ability for the Consumer to form a relationship with a 3rd Party within SMT

BR 3PP 2.0 Provide the ability for the Consumer to view their existing relationships with 3rd Parties

BR 3PP 3.0 Provide the ability for the Consumer to modify their existing relationships with 3rd Parties- BR 3PP 3.1 Provide the ability for the Consumer to modify the end date of an existing 3 rd Party

relationship- BR 3PP 3.2 Provide the ability for the Consumer to modify whether or not a 3 rd Party can access

usage data- BR 3PP 3.3 Provide the ability for the Consumer to modify whether or not a 3 rd Party can provision

HAN devices

BR 3PP 4.0 Provide the ability for the consumer to terminate an existing 3rd Party relationship

Smart Meter Texas


Business Requirements (Page 2 of 2)

BR 3PP 5.0 Provide the ability for the 3rd Party to obtain SMT API access- This requirement is satisfied with existing processes and procedures for providing entities API

access to SMT

BR 3PP 6.0 Provide the ability for 3rd Parties to view their existing 3rd Party relationships

BR 3PP 7.0 Provide the ability for 3rd Parties to terminate existing Consumer relationships- This requirement is not addressed in the 3rd Party Pilot. If a 3rd Party terminates a business

relationship with a Consumer, they will choose to cease pulling that consumer’s data from SMT of their own volition.

BR 3PP 8.0 Provide the ability for 3rd Parties to access data from one of their existing Consumer Relationships

BR 3PP 9.0 Provide the ability for 3rd Parties to provision or de-provision HAN devices for one of their existing Consumer Relationships

Smart Meter Texas


Business Rules (Page 1 of 2)

Rule 3PP 1.0: The relationship between the meter and the 3rd Party will be bound by the relationship between the consumer and the 3rd Party.

Rule 3PP 2.0: The participating Consumer must be registered with SMT as a Residential account to grant 3rd Party access to their ESI ID(s).

Rule 3PP 3.0 : The Consumer must log-in to their new account using the temporary password within 14 days, or the account will be deleted, which will also terminate any 3rd Party relationships with that Consumer.

Rule 3PP 4.0 : The 3rd Party will have to provide the consumer with an e-mail address which the consumer will enter into the My 3rd Party area

Rule 3PP 5.0 : 3rd Party Agreements have a 1-1 relationship with ESI IDs

Rule 3PP 6.0 : User accounts may have up to a maximum of five 3rd Party Agreements per SMT user account

Smart Meter Texas


Business Rules (Page 2 of 2)

Rule 3PP 7.0 : The default date for each 3rd Party Agreement is 90 days.

Rule 3PP 8.0 : 3rd Party Agreement may be extended to a maximum of 1 year (start date +364 days).

Rule 3PP 9.0 : 3rd Party Agreement allows for granting access to usage and/or HAN provisioning rights for the related ESIID.

Rule 3PP 10.0 : The SMT Production Support Team will establish and monitor a new e-mail ID - [email protected] for the Pilot. The SMT Production Support Team will be responsible for regularly checking the inbox for this e-mail ID.

Rule 3PP 11.0 : The 3rd Party will use the REP Branding API to access the consumer data and the SMT HAN API to provision or de-provision HAN devices.

Rule 3PP 12.0 : The 3rd Party will access to 40 days of historical data prior to the start date of the agreement.

Smart Meter Texas


Assumptions

A 3PP 1.0: The 3rd Party has registered for access to Smart Meter Texas API and has successfully performed integration testing.

A 3PP 2.0 : Any required business relationships between the 3rd Party and the Consumer are already in place and are managed outside of any Smart Meter Texas processes.

A 3PP 3.0 : The participating Consumer’s meter must be a Smart Meter that is provisioned and sending usage data to SMT

A 3PP 4.0 : An AMS meter(s) must be attached to a SMT user’s web account.

A 3PP 5.0 : The Consumer has access to their ESI ID and meter number information via their electric bill.

A 3PP 6.0 : The 3rd Party Pilot Portlet will have English content only.

A 3PP 7.0 : As part of the 3rd Party Pilot, the public content and FAQs on the SMT site will not be updated.

A 3PP 8.0: As part of the 3rd Party Pilot, user guides for SMT will not be updated. However, 2 new user guides for 3 rd Parties based on existing HAN API and REP Branding API user guides.

A 3PP 9.0: Regardless of who provides the HAN device for an ES ID, it can be provisioned by the 3rd Party, ROR and the consumer.

Smart Meter Texas


3rd Party Pilot:FUNCTIONAL & TECHNICAL DESIGN

Smart Meter Texas


3rd Party Pilot: 001Consumer initiates 3rd Party Relationship: FUNCTIONAL DESIGN

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: Business Process

UI 001.01

UI 001.02

UI 001.03

UI 001.03a

UI 001.05

UI 001.06

UI 001.07

UI 001.08

UI 001.04

UI 001.04b

UI 001.06a

UI 001.04a

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: Functional Requirements

3rd Party->Consumer: [FR001.01] Provides 3rd Party e-mail address to consumer

Consumer->SMT: [FR001.02] Navigates to SMT Home Page

Consumer->SMT: [FR001.03] Logs into SMT

SMT->SMT: [FR001.04] Authenticates consumer

SMT->Consumer: [FR001.05] Presents the authenticated landing page to Consumer

Consumer->SMT: [FR001.06] Navigates to My 3rd Parties (beta) area

SMT-> Consumer: [FR001.07] Displays page with existing 3rd party relationships

Consumer->SMT: [FR001.08] Clicks on “Add 3rd Party”

SMT-> Consumer: [FR001.09] Presents consumer a page to enter the 3rd Party’s e-mail address

Consumer->SMT: [FR001.10] Enters the e-mail address provided by the 3rd Party and clicks "Next"

SMT->Consumer: [FR001.11] Presents consumer a page to choose ESI ID and grant usage data access and/or HAN provisioning access

Consumer->SMT: [FR001.12] Specifies options and clicks “Submit”

SMT->Consumer: [FR001.13] Creates 3rd Party Grant ID

SMT->3rd Party: [FR001.14] Emails Grant ID to the 3rd Party

SMT->Consumer: [FR001.15] Displays 3rd Party Agreement created confirmation page

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.01: Consumer logs onto SMT (exists, no changes)

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.02 : SMT presents the authenticated landing page (exists, no changes)

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.03: Consumer navigates to My 3rd Parties area and clicks on “Add 3rd Party”

CR001.01 Header

CR001.02 Help Text

CR001.03 Overview

Text

CR001.04 Sub Header

CR001.05 Explanatory

Text

CR001.06 Column

Headings

CR001.08 Buttons

Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section.

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.03a: Consumer with one ESI ID and an existing 3rd Party relationship navigates to My 3rd Parties area and clicks on “Add 3rd Party”

CR001.07 Error

Condition


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.04: Consumer adds e-mail address provided by 3rd party

CR001.01 Header

CR001.02 Help Text


Text

CR001.08 Buttons

CR001.04 Sub HeaderCR001.04

Sub Header


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.04a: Error 1 if the re-enter e-mail does not match the first address

CR001.07 Error

Conditions


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.04b: Error 2 if e-mail is in invalid format

CR001.07 Error

Conditions


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.05: If consumer account only has 1 ESI ID, the ESI ID is assigned by default and the consumer only specifies if allowing data access, HAN provisioning or both

CR001.01 Header

CR001.02 Help Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.06: If consumer account has multiple ESI IDs, the consumer specifies both ESI ID and if allowing data access, HAN provisioning or both

CR001.01 Header

CR001.02 Help Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.06a:If options are not selected the Submit button will be grayed out

CR001.07 Error

Conditions


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.7: Confirmation Email to 3rd Party

Sent by: [[email protected]] Sent to: [3rd Party e-mail address]

*** Please do not reply -- this email was sent by a service machine.*** For help on this or other topics, please visit our website at www.smartmetertexas.com/

Thank you for your interest in Smart Meter Texas (SMT).

An existing SMT account has created a 3rd Party Agreement with you. You [have/ do not have] access to the consumer’s usage data. You [have/have not] been granted access to provision the consumer’s HAN device. The agreement is currently effective though [12/10/2011].

You have been invited by Consumer with ESI ID: xxxxxxx-[1666]Your Grant ID is: 100011

For questions on your existing relationships, please e-mail [email protected]

Regards,Smart Meter Texas Team


Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI001.8: Consumer gets a success message if all conditions are valid

CR001.01 Header

CR001.02 Help Text

CR001.04 Sub Header


Text


Smart Meter Texas

© Copyright IBM Corporation 2010 IBM Confidential29

001 Consumer initiates 3rd Party Relationship: Content Requirements (Page 1 of 4)

UI001.01 UI001.02 UI001.03

CR001.01 Header Exists

No changes to be made to public content or authenticated FAQs

Exists 3rd Parties/ My 3rd Parties

CR001.02 Help Text Help: You may grant access to view your Smart Meter data and/ or provision your HAN devices to up to five 3rd Parties.•If you have more than one Smart Meter attached to your account, you can decide which of those meters to grant access to the 3rd Party to by specifying the meter through ESI ID number during the Add 3rd Party process . •Adding a 3rd Party will cause a notification e-mail to be sent to the 3rd Party. The e-mail will include a Grant ID and details of the agreement. •If you remove the 3rd Party and terminate the agreement, you will still have access to your Smart Meter data but the 3rd Party will not.[Hide help]

CR001.03 Overview Text

About My 3rd Party - Beta

CR001.04 Sub Header My 3rd Parties

CR001.05 Explanatory Text

This is a list of 3rd Parties that you have invited to view your Smart Meter Data and/ or Provision your HAN devices. You may have a maximum of five 3rd Party relationships.

CR001.06 Column Headings

• Grant• 3rd Party e-mail ID• Agreement Start Date• Agreement End Date• ESI ID • Usage Data Status• HAN Provisioning Status

CR001.07 Error Conditions

• You already have an existing 3rd Party Agreement. To create a new agreement, please End your existing agreement

CR001.08 Buttons •Add a 3rd Party•Edit Agreement•End Agreement

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: Content Requirements (Page 2 of 4) UI 001.04

CR001.01 Header 3rd Parties/ My 3rd Parties/ Add a 3rd Party Step 1

CR001.02 Help Text Help: Enter the email address for the 3rd Party you want to add. This e-mail address should be provided to you by the 3rd Party. Once you create an agreement with the 3rd Party, an e-mail will be sent to the 3rd Party. The e-mail will include a Grant ID and details of the agreement.[Hide help]

CR001.03 Overview Text N/A

CR001.04 Sub Header Add 3rd PartyStep 1 of 2

CR001.05 Explanatory Text Please enter the 3rd Party’s e-mail address

* Indicates required field * 3rd Party E-mail Address* Re-enter Email address

CR001.06 Column Headings N/A

CR001.07 Error Conditions • E-mail address and confirmation e-mails address should be the same• E-mail address is invalid. Please enter a valid e-mail address.

CR001.08 Buttons • Next • Cancel

Smart Meter Texas



UI 001.05 UI 001.06

CR001.01 Header 3rd Parties/ My 3rd Parties/ Add a 3rd Party Step 2

CR001.02 Help Text

Help: If you do not select the "Submit" button the Add a 3rd party process is not complete and the 3rd Party will not receive an e-mail. Your agreement will be for a default time of 90 days. You can modify the agreement at any time after you have added the 3rd Party:•From the left navigation menu select "My 3rd Parties"; the list of your 3rd Party agreements will be displayed•Select the 3rd Party Agreement that you want to modify•Select "Edit Agreement"•Edit the end date of the agreement from a default of 90 days or change the access conditions[Hide help]


N/A N/A

CR001.04 Sub Header

Add 3rd PartyStep 2 of 2


There is one Smart Meter associated with your account and that will be added to this agreement.Showing 1 of 1

You can allow a 3rd Party to either access your usage data and/or provision HAN devices. Please check Yes for atleast 1 box below.* Indicates required field*Allow access to usage data* Allow HAN provisioning

This is the list of the Smart Meters that are associated to your account. You need to select which Smart Meter the 3rd Party will be able to see. You need to select only one Smart Meter from the list. Showing 1-2 of 2



•Description•Service Address•State•ESI ID•Meter Number


N/A

CR001.08 Buttons

•Submit•Cancel

Smart Meter Texas



UI 001.7 UI 001.8

CR001.01 Header N/A 3rd Parties/ My 3rd Parties/ Add a 3rd Party Confirmation

CR001.02 Help Text N/A Help: Please visit the My 3rd Parties – Beta for details on your agreement. •You can use My 3rd Parties on SMT to extend this agreement to a maximum of 1 year. •You can also terminate your agreement at any time. [Hide help]


Confirmation e-mail Add My 3rd Party

CR001.04 Sub Header

N/A N/A


*** Please do not reply -- this email was sent by a service machine.*** For help on this or other topics, please visit our website at www.smartmetertexas.com/Thank you for your interest in Smart Meter Texas (SMT). An existing SMT account has created a 3rd Party Agreement with you. You [have/ do not have] access to the consumer’s usage data. You [have/have not] been granted access to provision the consumer’s HAN device. The agreement is currently effective though [12/10/2011].You have been invited by Consumer with ESI ID: xxxxxxx-[1666]Your Grant ID is: 100011For questions on your existing relationships, please e-mail [email protected]


You have successfully added a 3rd Party to your account. The Grant ID for this agreement is 55667788.

Your agreement with the 3rd Party will be for 90 days.


N/A N/A


N/A N/A

CR001.08 Buttons N/A N/A

Smart Meter Texas


001 Consumer initiates 3rd Party Relationship: Issues & Resolutions

Issue Resolution1. Once the user has created an agreement on SMT, an e-mail will be sent to the 3rd Party with a Grant ID from SMT. How will the 3rd Party be able to correlate that this Grant ID belongs to the a specific user?

Smart Meter Texas


3rd Party Pilot: 002 Consumer Views existing 3rd Party Relationships: FUNCTIONAL DESIGN

Smart Meter Texas


002 Consumer Views existing 3rd Party Relationships: Business Process

UI 002.01

Smart Meter Texas


002 Consumer Views existing 3rd Party Relationships: Functional Requirements


Consumer->SMT: [FR002.02] Logs onto SMT account


SMT->Consumer: [FR002.04] Presents the authenticated landing page to the Consumer

Consumer->SMT: [FR002.05] Navigates to My 3rd Parties (beta) area

SMT->Consumer: [FR002.06] Displays page with existing 3rd party relationships

Smart Meter Texas


002 Consumer Views existing 3rd Party Relationships: User Interface RequirementsUI 002.01: Consumer navigates to My 3rd Parties area on SMT to view relationships

CR001.01 Header

CR001.02 Help Text

CR001.03 Overview

Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


002 Consumer Views existing 3rd Party Relationships: Content Requirements

UI 002.01

CR001.01 Header 3rd Parties/ My 3rd Parties

CR001.02 Help Text Help: You may grant access to view your Smart Meter data and/ or provision your HAN devices to up to five 3rd Parties.•If you have more than one Smart Meter attached to your account, you can decide which of those meters to grant access to the 3rd Party to by either 1) specifying the meter through ESI ID number during the Add 3rd Party process or 2) by editing the ESI ID by selecting an existing 3rd Party Agreement and clicking Edit Agreement.•Adding a 3rd Party will cause an invitation to be sent to the 3rd Party. The invitation will include a Grant ID and instructions that the 3rd Party will use to accept the agreement. You will be notified via e-mail when the 3rd Party accepts. If the 3rd Party does not respond within 14 days, the invitation will expire.•If you remove the 3rd Party and terminate the agreement, you will still have access to your Smart Meter data but the 3rd Party will not.[Hide help]

CR001.03 Overview Text About My 3rd Party – BetaText TBD

CR001.04 Sub Header N/A

CR001.05 Explanatory Text N/A

CR001.06 Column Headings • Grant ID• 3rd Party e-mail• Agreement Start Date• Agreement End Date• ESI ID• Usage Data Status• HAN Provisioning Status

CR001.07 Error Conditions N/A

CR001.08 Buttons • Add 3rd Party• Edit Agreement• End Agreement

Smart Meter Texas


002 Consumer Views existing 3rd Party Relationships: Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 003 Consumer Modifies 3rd Party Relationships: FUNCTIONAL DESIGN

Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships Business Processes

UI 003.01

UI 003.02

UI 003.03

UI 003.04

Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: Functional Requirements


Consumer->SMT: [FR003.02] Logs into SMT


SMT->Consumer: [FR003.04] Presents the authenticated landing page to Consumer

Consumer->SMT: [FR003.05] Navigates to My 3rd Parties area on SMT

SMT->Consumer: [FR003.06] Displays page with existing 3rd party relationships

Consumer->SMT: [FR003.07] Checks existing relationship and clicks on "Edit Agreement"

SMT->Consumer: [FR003.08] Presents the Edit Agreement page to the Consumer

Consumer->SMT: [FR003.09] Edits the end date of the agreement or the level of access and clicks on “Accept”

SMT->Consumer: [FR003.10] Presents a success page to the Consumer

SMT->3rd Party: [FR003.11] Sends an e-mail to the 3rd Party with details of the modified relationship

Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.01: Consumer navigates to My 3rd Parties area on SMT and clicks on “Edit Agreement”

CR001.01 Header

CR001.02 Help Text

CR001.03 Overview

Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.02: Consumer prompted to enter a valid end date and/or change access options

CR001.01 Header

CR001.02 Help Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.02a: Error if user selects “No” for both access conditions

CR001.07 Error

Conditions


Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.02b: Error if user selects an end date less than the start date, end date less than the current date or more than 1 year from the start date

CR001.07 Error

Conditions


Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.03 : Confirmation e-mail to 3rd Party and consumer.

Sent by: [[email protected]]

Sent to: [3rd Party e-mail address]

*** Please do not reply -- this email was sent by a service machine.*** For help on this or other topics, please visit our website at www.smartmetertexas.com/


One of your existing 3rd Party relationships has been modified.

The relationship has been modified by Consumer with ESI ID: xxxxxxx-[1666]The Grant ID for this relationship is: 100011

You [have/ do not have] access to the consumer’s usage data. You [have/have not] been granted access to provision the consumer’s HAN device.The agreement end date [has/has not] been changed [to 12/10/2011].

If you are a consumer , you can view your existing relationships through the My 3 rd Parties – Beta area by logging into your SMT account.

If you are a 3rd Party with questions on your existing relationships, please e-mail [email protected]



Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.04 : Success message

CR001.01 Header

CR001.02 Help Text

CR001.04 Sub Header


Text


Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: Content Requirements (Page 1 of 3) UI003.01CR001.01 Header 3rd Parties/ My 3rd Parties


CR001.03 Overview Text About My 3rd Party - Beta


CR001.05 Explanatory Text This is a list of 3rd Parties that you have invited to view your Smart Meter Data and/ or Provision your HAN devices. You may have a maximum of five 3rd Party relationships.

CR001.06 Column Headings • Grant ID• 3rd Party e-mail• Agreement Start Date• Agreement End Date• ESI ID• Usage Data Status• HAN Provisioning Status

CR001.07 Error Conditions N/A


Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: Content Requirements (Page 2 of 3)

UI003.02CR001.01 Header 3rd Parties/ My 3rd Parties/ Edit 3rd Party Agreement

CR001.02 Help Text Help: Shown here is the information associated with your 3rd Party agreement.•You can change the end date of your agreement. You can choose an end data maximum of 1 year from the start date of your agreement.•You can also remove the 3rd Party’s access to your Usage Data or HAN Provisioning by checking the boxes below. However, you cannot terminate access to both using this page.[Hide help]

CR001.03 Overview Text N/A

CR001.04 Sub Header Edit 3rd Parties

CR001.05 Explanatory Text The start date for your Agreement is listed below. You can change the end date of your Agreement below.


CR001.06 Column Headings • Grant ID• Agreement Start Date• Agreement End Date

CR001.07 Error Conditions • You cannot select ‘No’ for both access conditions• The end date you have selected is not valid

CR001.08 Buttons •Accept•Cancel

Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: Content Requirements (Page 3 of 3) UI003.03 UI003.04

CR001.01 Header N/A 3rd Parties/ My 3rd Parties/ Edit 3rd Party Agreement - Confirmation

CR001.02 Help Text N/A Help: Please visit the My 3rd Parties – Beta for details on your agreement. •You can use My 3rd Parties on SMT to extend this agreement to a maximum of 1 year. •You can also terminate your agreement at any time. [Hide help]

CR001.03 Overview Text Confirmation e-mail Edit 3rd Parties

CR001.04 Sub Header N/A N/A

CR001.05 Explanatory Text *** Please do not reply -- this email was sent by a service machine.*** For help on this or other topics, please visit our website at www.smartmetertexas.com/Thank you for your interest in Smart Meter Texas (SMT). One of your existing 3rd Party relationships has been modified. The relationship has been modified by Consumer with ESI ID: xxxxxxx-[1666]The Grant ID for this relationship is: 100011You [have/ do not have] access to the consumer’s usage data. You [have/have not] been granted access to provision the consumer’s HAN device.The agreement end date [has/has not] been changed [to 12/10/2011].If you are a consumer , you can view your existing relationships through the My 3rd Parties – Beta area by logging into your SMT account.If you are a 3rd Party with questions on your existing relationships, please e-mail [email protected],Smart Meter Texas Team

You have successfully changed your agreement with Grant ID 10011. The 3rd Party will be notified of this change via e-mail

CR001.06 Column Headings N/A N/ACR001.07 Error Conditions N/A N/ACR001.08 Buttons N/A N/A

Smart Meter Texas


003 Consumer Modifies 3rd Party Relationships: Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 004 Consumer Terminates 3rd Party Relationships: FUNCTIONAL DESIGN

Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships: Business Process

UI 004.01

UI 004.02

UI 004.03

UI 004.04

Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships : Functional Requirements


Consumer->SMT: [FR004.02] Logs SMT

SMT->SMT: [FR004.03] Authenticates Consumer

SMT->Consumer: [FR004.04] Presents the authenticated landing page

Consumer->SMT: [FR004.05] Navigates to My 3rd Parties area on SMT

Consumer->SMT: [FR004.06] Checks existing relationship and clicks on “End Agreement”

SMT->Consumer: [FR004.07] Displays pop-up box asking for confirmation of relationship termination

Consumer->SMT: [FR004.08] Consumer checks “Yes” to terminate relationship

SMT->SMT: [FR004.09] Terminates the existing 3rd Party Relationship

SMT->Consumer: [FR004.10] Sends confirmation of termination by email

SMT->Consumer: [FR004.11] Displays termination confirmation page

SMT->3rd Party: [FR004.12] Sends notification of termination by email

Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships: User Interface Requirements UI 004.01 : Consumer navigates to My 3rd Parties area and checks Agreement box and clicks End Agreement

CR001.01 Header

CR001.02 Help Text

CR001.03 Overview

Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships: User Interface Requirements UI 004.02: Consumer gets a confirmation pop-up box

CR001.01 Header

CR001.02 Help Text

CR001.03 Overview

Text

CR001.04 Sub Header


Text

CR001.06 Column

Headings

CR001.08 Buttons


Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships: User Interface Requirements UI 004.03: E-mail to 3rd Party and to Consumer

Sent by: [[email protected]]

Sent to: [consumer SMT email address] and [3rd Party e-mail address]

*** Please do not reply -- this email was sent by a service machine. *** For help on this or other topics, please visit our website at www.smartmetertexas.com


The following 3rd Party Agreement has been removed: Grant ID: [10011]Customer ESI ID: xxxxxxxxx – [1666]3rd Party: [[email protected]]

The Agreement was removed by the Customer.

If you are the Customer, you will still have access to your own Smart Meter data but the 3 rd Party will no longer have access to your data and will not be able to provision your HAN device.

If you are the 3rd Party, you will no longer have access to the Customer’s usage data associated with this ESI ID. You will also not be able to provision the Customer’s HAN device.

Regards, Smart Meter Texas Team


Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships: User Interface Requirements UI 004.04: Consumer gets success message

CR001.01 Header

CR001.02 Help Text

CR001.04 Sub Header


Text


Smart Meter Texas


UI004.01CR001.01 Header 3rd Parties/ My 3rd Parties



CR001.04 Sub HeaderMy 3rd Parties




• Grant ID• 3rd Party e-mail• Agreement Start Date• Agreement End Date• ESI ID• Usage Data Status• HAN Provisioning Status


N/A


004 Consumer Terminates 3rd Party Relationships: Content Requirements (Page 1 of 3)

Smart Meter Texas


UI004.02

CR001.01 Header 3rd Parties/ My 3rd Parties/ End 3rd Party Agreement






Pop-Up Text:Are you sure you want to end this Agreement?


• Grant ID• 3rd Party e-mail• Agreement Start Date• Agreement End Date• ESI ID• Usage Data Status• HAN Provisioning Status


N/A

CR001.08 Buttons • Add a 3rd Party• Edit Agreement• End Agreement


Smart Meter Texas


UI 004.03UI 004.04

CR001.01 Header N/A 3rd Parties/ My 3rd Parties/ Edit 3rd Party Agreement - Confirmation

CR001.02 Help Text N/A Help: Please visit the My 3rd Parties – Beta for details on your existing agreements.[Hide help]

CR001.03 Overview Text Email to Consumer Edit 3rd Parties



*** Please do not reply -- this email was sent by a service machine. *** For help on this or other topics, please visit our website at www.smartmetertexas.comThank you for your interest in Smart Meter Texas (SMT). The following 3rd Party Agreement has been removed: Grant ID: [10011]Customer ESI ID: xxxxxxxxx – [1666]3rd Party: [[email protected]]The Agreement was removed by the Customer. If you are the Customer, you will still have access to your own Smart Meter data but the 3rd Party will no longer have access to your data and will not be able to provision your HAN device.If you are the 3rd Party, you will no longer have access to the Customer’s usage data associated with this ESI ID. You will also not be able to provision the Customer’s HAN device.Regards, Smart Meter Texas Team

You have successfully ended your agreement with Grant ID 10011. The 3rd Party will be notified of this change via e-mail


N/A N/A


N/A N/A

CR001.08 Buttons N/A N/A


Smart Meter Texas


004 Consumer Terminates 3rd Party Relationships : Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 005 3rd Party Obtains API AccessFUNCTIONAL DESIGN

Smart Meter Texas


005 3rd Party Obtains API Access: Business Process

Note: This is an existing manual process for gaining system level access to SMT APIs

Smart Meter Texas


005 3rd Party Obtains API Access : Functional Requirements

Pilot Reg Body->Prod Spt Team: [FR005.01] E-mails confirmation of 3rd Party’s registration

Prod Spt Team->SMT: [FR005.02] Adds 3rd Party into SMT API security model

Prod Spt Team->3rd Party: [FR005.03] E-mails 3rd Party an instruction manual on connecting via API

3rd Party->3rd Party: [FR005.04] Sets up connectivity on their system

3rd Party->Prod Spt Team: [FR005.05] Sends e-mail to schedule testing

3rd Party->SMT: [FR005.06] Tests API

3rd Party->Prod Spt Team: [FR005.08] E-mails trouble-shooting requests (as needed)

Prod Spt Team->3rd Party: [FR005.09] Sends trouble-shooting instructions (as needed)

3rd Party->SMT: [FR005.10] Tests API after implementing trouble-shooting instructions (as needed)

3rd Party->Prod Spt Team: [FR005.11] Sends confirmation of API access e-mail

Smart Meter Texas


005 3rd Party Obtains API Access: User Interface Requirements

Not Applicable

Smart Meter Texas


005 3rd Party Obtains API Access: Content Requirements

Instructional manual

Access e-mail

Acknowledgement e-mail

SMT API Access Manual

Smart Meter Texas


005 3rd Party Obtains API Access: Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 006 3rd Party views existing consumer relationshipsFUNCTIONAL DESIGN

Smart Meter Texas


006 3rd Party views existing consumer relationships: Business Process

Smart Meter Texas


006 3rd Party views existing consumer relationships: Functional Requirements

3rd Party->Prod Support Team: [FR006.01] Sends an e-mail to [email protected] requesting records of existing consumer relationships

Prod Support Team->SMT: [FR006.02] Logs into Web Host Admin Prod Support Team->SMT: [FR006.03] Enters e-mail address provided by 3rd Party

SMT->SMT: [FR006.04] Runs a query on the given 3rd Party e-mail address

SMT->Prod Support Team: [FR006.05] Generates a report that lists all consumer relationships associated with the given 3rd Party e-mail address

Prod Support Team->3rd Party: [FR006.06] E-mails the report to the 3rd Party

Smart Meter Texas


006 3rd Party views existing consumer relationships : User Interface RequirementsUI006.01: 3rd Party sends a request e-mail

The 3rd Party e-mail must be send from the e-mail address associated with the consumer relationship in SMT

The 3rd Party e-mail at the least should contain:

3rd Party e-mail

Information requested – details of existing consumer relationships on the 3 rd Party Pilot

Smart Meter Texas


006 3rd Party views existing consumer relationships : User Interface RequirementsUI006.01: 3rd Party sends a request e-mail

The 3rd Party e-mail should:

Be sent from the 3rd Party e-mail address associated with the consumer relationship in SMT

Be sent to [email protected]

The e-mail should contain

3rd Party e-mail

Information requested – details of existing consumer relationships on the 3 rd Party Pilot

Smart Meter Texas


006 3rd Party views existing consumer relationships : User Interface RequirementsUI006.02: SMT transmits requested data back to 3rd Party

Dra

ft

Sent by: [email protected]

Sent to: [3rd Party e-mail address]

*** For help on this or other topics, please visit our website at www.smartmetertexas.com/

Thank you for your interest in Smart Meter Texas (SMT) 3 rd Party Pilot.

Attached is the information on your existing consumer relationships as of date [09/25/2011]. The attachment includes the following data regarding your relationships:•Grant ID•Last 4 digits of associated ESI ID•Start date of relationship•End date of relationship•Your access to consumer’s usage data•Your access to consumer’s HAN devices.

For questions on your existing relationships, please e-mail [email protected]


Smart Meter Texas


006 3rd Party views existing consumer relationships: Content Requirements UI006.01 UI006.02

CR001.01 Header N/A N/A

CR001.02 Help Text N/A

CR001.03 Overview Text N/A N/A


CR001.05 Explanatory Text To be supplied by 3rd Parties *** For help on this or other topics, please visit our website at www.smartmetertexas.com/Thank you for your interest in Smart Meter Texas (SMT) 3rd Party Pilot.Attached is the information on your existing consumer relationships as of date [09/25/2011]. The attachment includes the following data regarding your relationships:•Grant ID•Last 4 digits of associated ESI ID•Start date of relationship•End date of relationship•Your access to consumer’s usage data•Your access to consumer’s HAN devices.

For questions on your existing relationships, please e-mail [email protected],Smart Meter Texas Team

CR001.06 Column Headings N/A N/ACR001.07 Error Conditions N/A N/ACR001.08 Buttons N/A N/A

Smart Meter Texas


006 3rd Party views existing consumer relationships : Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 007 3rd Party terminates existing consumer relationshipFUNCTIONAL DESIGN

Smart Meter Texas


007 3rd Party terminates existing consumer relationship : Business Process

Smart Meter Texas


007 3rd Party terminates existing consumer relationship : Functional Requirements

3rd Party->SMT: [FR007.01] Stops accessing the consumer’s data via API

Smart Meter Texas


007 3rd Party terminates existing consumer relationship : User Interface Requirements

Not Applicable

Smart Meter Texas


007 3rd Party terminates existing consumer relationship : Content Requirements

Not Applicable

Smart Meter Texas


007 3rd Party terminates existing consumer relationship : Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 008 3rd Party access data from a consumer relationshipFUNCTIONAL DESIGN

Smart Meter Texas


008 3rd Party access data from a consumer relationship : Business Process

Smart Meter Texas


008 3rd Party access data from a consumer relationship : Functional Requirements

3rd Party->SMT: [FR008.01] Sends a data request for a consumer’s usage data via API

SMT->3rd Party: [FR008.02] Acknowledges request

SMT->SMT: [FR008.03] Validates Grant ID

SMT->SMT: [FR008.04] Validates API Parameters

SMT->3rd Party: [FR008.05] Returns requested data via API

Smart Meter Texas


008 3rd Party access data from a consumer relationship : API Interface Requirements

3rd Party initiates an API request to retrieve the following Usage info :

- Interval (15 mins) read,

- Daily Register read or

- Monthly billed usage data

Each request should contain:

- Only 1 Grant ID for which usage is requested (each Grant ID is associated with a unique ESI ID)

- Last 4 digits of the ESI ID

- E-mail address of requester

- End date for request

- Report Type (Interval, Daily or Monthly Data)

SMT validates parameters and returns the relevant data in XML form via API:

- For Daily and Interval Read – upto 40 days of usage data

- For Monthly Usage Data – upto 24 months of usage data

If these conditions are not met, SMT will generate an error message

Smart Meter Texas


008 3rd Party access data from a consumer relationship : User Interface Requirements

Not Applicable

Smart Meter Texas


008 3rd Party access data from a consumer relationship : Content Requirements

3rd Party Usage API Guide

Microsoft Office Word 2007 Document

Smart Meter Texas


008 3rd Party access data from a consumer relationship : Issues & Resolutions

Issue Resolution

Smart Meter Texas


3rd Party Pilot: 009 3rd Party provision HAN device for a consumer relationshipFUNCTIONAL & TECHNICAL DESIGN

Smart Meter Texas


009 3rd Party provision HAN device for a consumer relationship : Business Process

Smart Meter Texas


009 3rd Party provision HAN device for a consumer relationship : Functional Requirements

3rd Party->SMT: [FR009.01] Sends a provisioning request via API

SMT->3rd Party: [FR009.02] Acknowledges request

SMT->SMT: [FR009.03] Validates Grant ID

SMT->SMT: [FR009.04] Validates API Parameters

SMT->TDSP: [FR009.05] Sends provisioning request to TDSP

TDSP->SMT: [FR009.06] Acknowledges request

TDSP->TDSP: [FR009.07] Processes request

TDSP->SMT: [FR009.08] Returns success message

SMT->SMT: [FR009.09] Processes success message

SMT->3rd Party: [FR009.10] Returns a success message

Smart Meter Texas


009 3rd Party provision HAN device for a consumer relationship : API Interface Requirements

3rd Party initiates an API request to :

- Provision HAN device,

- De-provision HAN device, or

- Send Zigbee SEP 1.0 messages to HAN devices (currently only supported by CNP)

Each request should contain:

- Only 1 Grant ID for which usage is requested (each Grant ID is associated with a unique ESI ID)

- Last 4 digits of the ESI ID

- E-mail address of requester

- Requester Type Indicator (3 for Third Party)

- Request type (provision, de-provision or messaging)

SMT assumes that all time value input through API are in Central Standard time

SMT validates :

- 3rd Party is authorized to provision / de-provisioning devices to ESI ID (as identified by the associated Grant ID)

- Device is not already provisioned/ de-provisioned or a provisioning/ de-provisioning request is pending

If validations are not met, an error message is returned. If they are met, the request is assigned a unique identifier and transmitted to the TDSPSs. An acknowledgement is sent to the 3rd Party

Smart Meter Texas


009 3rd Party provision HAN device for a consumer relationship : User Interface Requirements

Not Applicable

Smart Meter Texas


009 3rd Party provision HAN device for a consumer relationship : Content Requirements

• 3rd Party HAN Provisioning API Guide

Wo

rk In

Pro

gre

ss

Microsoft Office Word 2007 Document

Smart Meter Texas


009 3rd Party provision HAN device for a consumer relationship : Issues & Resolutions

Issue Resolution

Smart Meter Texas


Glossary

WPS : WebSphere Process Server

WPF: WebSphere Portlet Factory

WP: WebSphere Portal Server

ESB: Electronic Service Bus

MQ: Message Queue

DB: Database (Oracle)

DP: Data power

WPG: WebSphere Partner Gateway

ETL: Extract, Transform and Load

TAM: Tivoli Access Manager

TIM: Tivoli Identity Manager

Infosphere DataStage

Smart Meter Texas © Copyright IBM Corporation 2010 1 IBM Confidential Functional Design Document...

Documents

Transcript of Smart Meter Texas © Copyright IBM Corporation 2010 1 IBM Confidential Functional Design Document...