1 / 98

Prepared for Texas Competitive Electric Market

Functional Design Document for the 3 rd Party Pilot of the Common Advanced Metering System Web Portal and Data Repository Design, Build, Test, Deploy A-1 Release 3 Design Document for 3 rd Party Pilot. Draft. Prepared for Texas Competitive Electric Market

audra
Download Presentation

Prepared for Texas Competitive Electric Market

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Functional Design Document for the 3rd Party Pilotof theCommon Advanced Metering SystemWeb Portal and Data RepositoryDesign, Build, Test, DeployA-1 Release 3 Design Document for 3rd Party Pilot Draft Prepared for Texas Competitive Electric Market Transmission and Distribution Service Providers (TDSPs) IBM Confidential

  2. Document History • Revision History IBM Confidential

  3. 3rd Party Pilot:OVERVIEW IBM Confidential

  4. 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 Confidential

  5. 3rd Party Pilot Solution Overview • The SMT 3rd Party Pilot capability will allow the residential consumer to create and manage 3rd 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. 001 Consumer initiates 3rd Party relationship 005 3rd Party obtains SMT API access Smart Meter Texas Solution 006 3rd Party views existing 3rd Party relationships 002 Consumer views existing 3rd Party relationships 007 3rd Party terminates existing 3rd Party relationship 003 Consumer modifies existing 3rd Party relationships Consumer 3rd Party 008 3rd Party accesses data from one of its existing consumer relationships 004 Consumer terminates existing 3rd Party relationships 009 3rd Party provisions a HAN device for one of its existing relationships IBM Confidential

  6. 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 3rd 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 6 IBM Confidential IBM Confidential

  7. 3rd Party Pilot:BUSINESS REQUIREMENTS IBM Confidential

  8. Business Requirements (Page 1 of 2) • BR 3PP 1.0Provide 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.1Provide the ability for the Consumer to modify the end date of an existing 3rd Party relationship • BR 3PP 3.2Provide the ability for the Consumer to modify whether or not a 3rd Party can access usage data • BR 3PP 3.3Provide the ability for the Consumer to modify whether or not a 3rd Party can provision HAN devices • BR 3PP 4.0Provide the ability for the consumer to terminate an existing 3rd Party relationship IBM Confidential

  9. Business Requirements (Page 2 of 2) • BR 3PP 5.0Provide 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.0Provide 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 IBM Confidential

  10. 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 IBM Confidential

  11. 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 - 3rdpartypilot@smartmetertexas.com 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. IBM Confidential

  12. 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 3rd 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. IBM Confidential

  13. 3rd Party Pilot:FUNCTIONAL & TECHNICAL DESIGN IBM Confidential

  14. 3rd Party Pilot: 001Consumer initiates 3rd Party Relationship: FUNCTIONAL DESIGN IBM Confidential

  15. 001 Consumer initiates 3rd Party Relationship: Business Process UI 001.01 UI 001.02 UI 001.03 UI 001.03a UI 001.04 UI 001.04a UI 001.04b UI 001.05 UI 001.06 UI 001.06a UI 001.07 UI 001.08

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

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

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

  19. 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.04 Sub Header CR001.02 Help Text CR001.03 Overview Text 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. IBM Confidential

  20. 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 Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  21. 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 CR001.04 Sub Header CR001.04 Sub Header CR001.05 Explanatory Text CR001.08 Buttons Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  22. 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 Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  23. 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 Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  24. 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.04 Sub Header CR001.02 Help Text 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. IBM Confidential

  25. 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.04 Sub Header CR001.02 Help Text 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. IBM Confidential

  26. 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 Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  27. 001 Consumer initiates 3rd Party Relationship: User Interface Requirements: UI 001.7: Confirmation Email to 3rd Party Sent by: [admin@smartmetertexas.com] 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: 100011For questions on your existing relationships, please e-mail 3rdPartyPilot@smartmetertexas.com Regards,Smart Meter Texas Team  Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section.

  28. 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.04 Sub Header CR001.02 Help Text CR001.05 Explanatory Text Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

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

  30. 001 Consumer initiates 3rd Party Relationship: Content Requirements (Page 2 of 4) 30 IBM Confidential

  31. 001 Consumer initiates 3rd Party Relationship: Content Requirements (Page 3 of 4) 31 IBM Confidential

  32. 001 Consumer initiates 3rd Party Relationship: Content Requirements (Page 4 of 4) 32 IBM Confidential

  33. 001 Consumer initiates 3rd Party Relationship: Issues & Resolutions

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

  35. 002 Consumer Views existing 3rd Party Relationships: Business Process UI 002.01 IBM Confidential

  36. 002 Consumer Views existing 3rd Party Relationships: Functional Requirements • Consumer->SMT: [FR002.01] Navigates to SMT Home Page • Consumer->SMT: [FR002.02] Logs onto SMT account • SMT->SMT: [FR002.03] Authenticates consumer • 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

  37. 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.04 Sub Header CR001.02 Help Text CR001.03 Overview Text 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. IBM Confidential

  38. 002 Consumer Views existing 3rd Party Relationships: Content Requirements

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

  40. 3rd Party Pilot: 003 Consumer Modifies 3rd Party Relationships: FUNCTIONAL DESIGN IBM Confidential

  41. 003 Consumer Modifies 3rd Party Relationships Business Processes UI 003.01 UI 003.02 UI 003.03 UI 003.04 IBM Confidential

  42. 003 Consumer Modifies 3rd Party Relationships: Functional Requirements • Consumer->SMT: [FR003.01] Navigates to SMT Home Page • Consumer->SMT: [FR003.02] Logs into SMT • SMT->SMT: [FR003.03] Authenticates consumer • 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

  43. 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.04 Sub Header CR001.02 Help Text CR001.03 Overview Text 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. IBM Confidential

  44. 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.04 Sub Header CR001.02 Help Text CR001.06 Column Headings CR001.05 Explanatory Text CR001.08 Buttons Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  45. 003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.02a: Error if user selects “No” for both access conditions CR001.07 Error Conditions Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  46. 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 Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  47. 003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.03 : Confirmation e-mail to 3rd Party and consumer. Sent by: [admin@smartmetertexas.com] 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). 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 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 3rdPartyPilot@smartmetertexas.com Regards,Smart Meter Texas Team  Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  48. 003 Consumer Modifies 3rd Party Relationships: User Interface RequirementsUI 003.04 : Success message CR001.01 Header CR001.04 Sub Header CR001.02 Help Text CR001.05 Explanatory Text Note: The text on this slide is illustrative. All detailed content and associated edits are captured in the Content Requirements section. IBM Confidential

  49. 003 Consumer Modifies 3rd Party Relationships: Content Requirements (Page 1 of 3) 49 IBM Confidential

  50. 003 Consumer Modifies 3rd Party Relationships: Content Requirements (Page 2 of 3) 50 IBM Confidential

More Related