MEF-LSO-Sonata-SDK - Billie Release

Theme: Ordering and Inventory

Download Link

Download the entire repository by clicking here

Introduction

This repository contains the MEF LSO Sonata SDK. It includes API definitions
for the following functional areas:

• Serviceability
  • Address
  • Site Retrieval
  • Product Offering Qualification Management
• Product Quote
• Product Order
• Product Inventory
• Trouble Ticket

It also provides Product Schemas for:

• Access E-Line
• EPL
• EPLAN
• EPTREE
• EVPL
• EVPLAN
• EVPTREE

High-level release notes

The theme of this release is Ordering and Inventory: it delivers full
coverage of Business Requirements, API and API Developer Guides for all above
mentioned Sonata API functions.

• All APIs have been reviewed and updated to follow their respective Business
  Requirements & Use Cases and Developer Guides documents
• All API definitions are provided in OAS 3.0 standard.
• New documents:
  • MEF W116 - LSO Cantata and LSO Sonata Product Inventory API - Developer
    Guide
  • MEF W123 - LSO Cantata and LSO Sonata Product Order Management API -
    Developer Guide
  • MEF W124 - LSO Sonata Trouble Ticketing API - Developer Guide
  • MEF W125 - LSO Cantata and LSO Sonata Product Specification - Subscriber
    Ethernet - Schema Guide

NOTE: Please note the Readme files in particular directories that provide
more detailed information about corresponding functionalities.

Maturity Level

The API files contained in this SDK are evolving and subject to change. They
are based on documents that are either ratified standards or draft standards
that have not yet completed the review cycles and approvals necessary to
achieve the status as a MEF standard. MEF is making these publicly available at
this time to invite wider industry review.

The maturity per functionality presents as follows:

• Address Validation, Site Query:
  • Business Requirements
    • MEF 79 - Published Standard
    • MEF 79.0.2 - Draft Release 2, Letter Ballot pending
  • Developer Guide/API
    • MEF W121 - LSO Sonata Address Management API - Developer Guide - work in progress - CfC#1 resolved
    • MEF W122 - LSO Sonata Site Management API - Developer Guide - work in progress - CfC#1 resolved
      
• Product Offering Qualification:
  • Business Requirements
    • MEF 79 - Published Standard
    • MEF 79.0.1 - Published Standard
  • Developer Guide/API - MEF W87 - work in progress - Draft Standard (R1), Ready for CfC#4
• Quote:
  • Business Requirements - MEF W80 - Draft Release 6, Letter Ballot pending
  • Developer Guide/API- MEF W115 - LSO Sonata Quote Management API - Developer
    Guide - work in progress, CfC#1 reviewed
• Order:
  • Business Requirements - MEF 57.2 - Draft Release 2
  • Developer Guide/API - work in progress - ready for CfC#1
• Inventory:
  • Business Requirements - MEF 81, MEF 81.0.1 Published Standard
  • Developer Guide/API - work in progress - ready fo CfC#1
• Trouble Ticket:
  • Business Requirements - MEF W113 - Draft Release 1
    
  • Developer Guide/API - work in progress - ready for CfC#1
• Product Specifications:
  • Access E-Line - MEF W106 work in progress, CfC#2 resolved
    
  • EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE - work in progress

Contents

This SDK contains the following items:

• COPYRIGHT - Copyright 2020 MEF Forum
• LICENSE - Contains a copy of the Apache 2.0 license
• README - This file
• productApi - Definitions of the API are found in this directory
  • inventory - Contains the API definitions necessary for inter-carrier
    retrieval of Product Inventory
  • order - Contains the API definitions for inter-carrier service ordering
    capability.
  • quote - Contains the API definitions for inter-carrier service quotation
    capability
  • serviceability - Contains the APIs that allow the Service Provider or
    Buyer to perform:
    • address - Retrieve Address information including exact formats for
      Addresses known to the Seller
    • offeringQualification - Determine whether it is feasible for the Seller
      to deliver a particular Product with a given configuration to a
      particular geographic location if applicable.
    • site - Retrieve Service Site information including exact formats for
      Service Sites known to the Seller
  • troubleTicket - Create and manage Trouble Tickets
• documentation - All related standards and Developer Guides.
  • productApi - API related documentation - Developer Guides
    • inventory - MEF W116 Developer Guide
    • order - MEF W123 Developer Guide
    • quote - MEF W115 Developer Guide
    • serviceability/address - MEF W121 Developer Guide
    • serviceability/offeringQualification - MEF W87 Developer Guide
    • serviceability/site - MEF W122 Developer Guide
    • troubleTicket - MEF W124 Developer Guide
  • productSchema - product related documentation
    • carrierEthernet - MEF W106 and MEF W125 Product Schema Guides
  • supportingStandards - The rest of documents and standards.
• ProductSchema - Product Specification schemas for:
  • carrierEthernet - Carrier Ethernet product Schemas
  • sonata/carrierEthernet/accessELine - Access E-Line
• generated/staticBinding/full - contains automatically generated (with help
  of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with all Product Specifications.

Issues, Questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback
should be asked either at
Sonata SDK Community
or directly to community_manager@mef.net.

NOTE: All artifacts included in this repository have line numbers. When
referring to specific content in any of these artifacts, please quote the line
numbers to which you are referring.

The MEF LSO Sonata SDK is released under the Apache 2.0 license.

BR&UC - Business Requirements & Use Cases

Underlined item indicates a release deliverable that is a delta from the previous SDK release.

LSO Sonata SDK Billie (Production)

Git Tag: billie

Date: 3rd June 2021

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2 (Draft Standard R2)	MEF 121 (CfC#1 resolved)	geographicAddressManagement (7.0.0-RC)	N/A	N/A
Site Query	MEF 79	MEF 122 (CfC#1 resolved)	geographicSiteManagement (7.0.0-RC)	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87 (CfC#3 resolved)	productOfferingQualificationManagement (7.0.0-RC) productOfferingQualificationNotification (7.0.0-RC)	MEF 106 (CfC#2 resolved) MEF W125 (working draft)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Quoting	MEF 80 (Draft Standard R6)	MEF W115 (CfC#1 resolved)	quoteManagement (7.0.0-RC) quoteNotification (7.0.0-RC)	MEF 106 (CfC#2 resolved) MEF W125 (working draft)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Product Inventory	MEF 81 MEF 81.0.1	MEF W116 (CfC#1 working draft)	productInventoryManagement (7.0.0-RC)	MEF 106 (CfC#2 resolved) MEF W125 (working draft)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Product Order	MEF W57.2 (Draft Standard R2)	MEF W123 (CfC#1 working draft)	productOrderManagement (7.0.0-RC) productOrderNotification (7.0.0-RC)	MEF 106 (CfC#2 resolved) MEF W125 (working draft)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Trouble Ticketing	MEF W113 (Draft Standard R1)	MEF W124 (working-draft, CfC#1 ready)	troubleTicketManagement (1.0.0-RC) troubleTicketNotification (1.0.0-RC)	N/A	N/A
Billing
Test Requirements	MEF W92.1 (Draft Standard R1)

Release Billie Deliverables

Bolded Deliverables are part of the release's theme: "Ordering"

LSO Sonata SDK Celine (Planned: November 2021)

(CfC#2)

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2	MEF 121	GeographicAddressManagement	N/A	N/A
Site Query	MEF 79	MEF 122	GeographicSiteManagement	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87	ProductOfferingQualificationManagement ProductOfferingQualificationNotification	MEF 106 (CfC#3) MEF 125 (CfC#2)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Quoting	MEF 80	MEF 115	QuoteManagement QuoteNotification	MEF 106 (CfC#3) MEF 125 (CfC#2)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Product Inventory	MEF 81 MEF 81.0.1	MEF W116		ProductInventoryManagement	MEF 106 (CfC#3) MEF 125 (CfC#2)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Product Order	MEF W57.2 Draft Standard (R3)	MEF W123 (CfC#2)	ProductOrderManagement ProductOrderNotification	MEF 106 (CfC#3) MEF 125 (CfC#2)	Access E-Line Subscriber Ethernet		SonataBlendingTool
Trouble Ticketing	MEF 113	MEF W124 (CfC#2)	troubleTicketManagement troubleTicketNotification	N/A	N/A
Billing
Test Requirements	MEF W92.1 Draft Standard (R2)

Release Celine DeliverablesBolded Deliverablesare part of the release's theme: ...

LSO Sonata SDK Dolly (Planned: May 2022)

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2	MEF 121	GeographicAddressManagement	N/A	N/A
Site Query	MEF 79	MEF 122	GeographicSiteManagement	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87	ProductOfferingQualificationManagement ProductOfferingQualificationNotification	MEF 106 MEF 125	Access E-Line Subscriber Ethernet		SonataBlendingTool
Quoting	MEF 80	MEF 115	QuoteManagement QuoteNotification	MEF 106 MEF 125	Access E-Line Subscriber Ethernet		SonataBlendingTool
Product Inventory	MEF 81 MEF 81.0.1	MEF W116	ProductInventoryManagement	MEF 106 MEF 125	Access E-Line Subscriber Ethernet		SonataBlendingTool
Product Order	MEF W57.2	MEF W123	ProductOrderManagement ProductOrderNotification	MEF 106 MEF 125	Access E-Line Subscriber Ethernet		SonataBlendingTool
Trouble Ticketing	MEF 113	MEF W124	troubleTicketManagement troubleTicketNotification	N/A	N/A
Product Catalog	MEF 127 Draft Standard (R1)
Billing
Test Requirements	MEF W92.1 Draft Standard (R3)

Release Dolly Deliverables

LSO Sonata SDK Aretha

Git Tag: aretha

Date: 22^nd December 2020

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2 (Draft Standard R1)	MEF 121 (working-draft, CfC#1 ready)	GeographicAddressManagement - 6.0.0-RC	N/A	N/A
Site Query	MEF 79	MEF 122 (working-draft, CfC#1 ready)	GeographicSiteManagement - 6.0.0-RC	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87 (working-draft, CfC#3 ready)	ProductOfferingQualificationManagement - 6.0.0-RC ProductOfferingQualificationNotification - 6.0.0-RC	MEF W106 (CfC#1 working-draft)	Access E-Line EPL		SonataBlendingTool
Quoting	MEF 80 (Draft Standard R5)	MEF W115 (working-draft, CfC#2 ready)	QuoteManagement - 6.0.0-RC QuoteNotification - 6.0.0-RC	MEF W106 (CfC#1 working-draft)	Access E-Line EPL		SonataBlendingTool
Product Inventory	MEF 81 MEF 81.0.1		ProductInventoryManagement - 6.0.0-RC	MEF W106 (CfC#1 working-draft)	Access E-Line EPL		SonataBlendingTool
Product Order	MEF W57.2 (Draft Standard R2)		ProductOrderManagement - 6.0.0-RC ProductOrderNotification - 6.0.0-RC	MEF W106 (CfC#1 working-draft)	Access E-Line EPL		SonataBlendingTool
Trouble Ticketing
Billing
Test Requirements	MEF W92.1 (working-draft)
Menu-driven POQ and Quote

Release Aretha Deliverables

Bolded Deliverables are part of the release's theme "Pre-order"

LSO Sonata SDK Release Candidate 5 (hotfix 1)

Git tag: RC5.1

Date: 16^th September 2020

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/rc5.1

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Postman scripts	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF W79.0.1		geographicAddressManagement.api.yaml v5.0.0-RC2	N/A	N/A	N/A
Site Query	MEF 79 MEF W79.0.1		geographicSiteManagement.api.yaml v5.0.0-RC	N/A	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF W79.0.1	MEF W87 (working-draft)	productOfferingQualificationManagement.api.yaml v5.0.0-RC2 productOfferingQualificationNotification.api.yaml v5.0.0-RC2	MEF W106 (working-draft)	Access E-Line			SonataBlendingTool
Quoting	MEF W80 Draft (R4)		quoteManagement.api.yaml v5.0.0-RC2 quoteNotification.api.yaml v5.0.0-RC2	MEF W106 (working-draft)	Access E-Line
Product Inventory	MEF 81 MEF 81.0.1		productInventoryManagement.api.yaml v5.0.0-RC	MEF W106 (working-draft)	Access E-Line
Product Order	MEF 57.1		productOrderManagement.api.yaml v5.0.0-RC2 productOrderNotification.api.yaml v5.0.0-RC2	MEF W106 (working-draft)	Access E-Line
Trouble Ticketing
Billing

Release Candidate 5.1 Deliverables

LSO Sonata SDK Release Candidate 5

Git tag: RC5

Date: 31^st July 2020

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/rc5

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Postman scripts	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF W79.0.1		geographicAddressManagement.api.yaml v5.0.0-RC	N/A	N/A	N/A
Site Query	MEF 79 MEF W79.0.1		geographicSiteManagement.api.yaml v5.0.0-RC	N/A	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF W79.0.1	MEF W87 (working-draft)	productOfferingQualificationManagement.api.yaml v5.0.0-RC productOfferingQualificationNotification.api.yaml v5.0.0-RC	MEF W106 (working-draft)	Access E-Line			SonataBlendingTool
Quoting	MEF W80 Draft (R3)		quoteManagement.api.yaml v5.0.0-RC quoteNotification.api.yaml v5.0.0-RC	MEF W106 (working-draft)	Access E-Line
Product Inventory	MEF 81 MEF 81.0.1		productInventoryManagement.api.yaml v5.0.0-RC	MEF W106 (working-draft)	Access E-Line
Product Order	MEF 57.1		productOrderManagement.api.yaml v5.0.0-RC productOrderNotification.api.yaml v5.0.0-RC	MEF W106 (working-draft)	Access E-Line
Trouble Ticketing
Billing

Release Candidate 5 Deliverables

LSO Sonata SDK Release 4

Git tag: R4

Date: Nov 2019

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r4

LSO Sonata SDK Release 3

Git tag: R3

Date: Jun 2019

SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r3

Function	BR&UC	IIS		Product specs		Postman scripts	Tooling	Example code
		Spec	Swagger specs	Spec	JSON
Address Validation	MEF 79 Draft (R2)		GeographicAddressManagement - v2.0.0	N/A	N/A
Site Query	MEF 79 Draft (R2)		GeographicSiteManagement - v2.0.0	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 Draft (R2)		ProductOfferingQualificationManagement - v2.0.0 ProductOfferingQualificationNotification - v1.0.0
Quoting	MEF 80 Draft (R2)		QuoteManagement - v2.0.0 QuoteNotification - v1.0.0
Product Inventory	MEF 81 Draft (R2)		ProductInventoryManagement - v2.0.0
Product Order	MEF 57.1		ProductOrderManagement - v2.0.0 ProductOrderNotification - v1.0.0		Access E-Line UNI
Trouble Ticketing
Billing

1. Example implementation of MEF LSO Sonata APIs on Buyer side provided by Amdocs. This example code is part of the solution between a Tier1 North American operator, Amdocs and a UK provider that was put into production in April 2019.
   
   https://github.com/MEF-GIT/Example-LSO-Sonata-Buyer-Implementation (MEF Members only)

Engagement Opportunities

1. Development and use of the MEF 3.0 Developer Workshop
2. Requirements for future releases of LSO Sonata
3. Information on how they integrate LSO Sonata into OSS/BSS systems, and information on how to manage versions of the APIs
4. Scoring of consumability of each release
5. Inclusion of LSO Sonata as a requirement in RFIs to partners
6. Active marketing of LSO Sonata releases
7. Assessment of testing/certification solutions around LSO Sonata