MEF-LSO-Sonata-SDK - Aretha Release
Theme: Pre-Ordering
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, and Product Offering Qualification Management)
- Product Quote
- Product Order
- Product Inventory
It also provides Product Specification for Access E-Line as delivered by MEF W106 and EPL
High-level release notes
The theme of this release is Pre-Ordering: it delivers full coverage of Business Requirements, API and API Developer Guides for Address, Site Retrieval, and Product Offering Qualification Management.
- All APIs have been reviewed and updated to follow their respective Business Requirements & Use Cases and Developer Guides documents
- New documents:
- MEF W115 - LSO Sonata Quote Management API - Developer Guide
- MEF W121 - LSO Sonata Address Management API - Developer Guide
- MEF W122 - LSO Sonata Site Management API - Developer Guide
- MEF W79.0.2 - Amendment to MEF 79: Address Validation, November 2020
- MEF W92.1: LSO Sonata Test Requirements, December 2020
- Updated Documents:
- MEF W106 - LSO Sonata Product Specification - Access E-Line
- MEF W87 - LSO Sonata Product Offering Qualification API - Developer Guide
- MEF 80 - Quote Management Requirements and Use Cases
- MEF 57.2 - Product Order Management Requirements and Use Cases
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 1
- Developer Guide/API
- MEF W121 - LSO Sonata Address Management API - Developer Guide - work in progress - Ready for CfC#1
- MEF W122 - LSO Sonata Site Management API - Developer Guide - work in progress - Ready for CfC#1
- Business Requirements
- Product Offering Qualification:
- Business Requirements
- MEF 79 - Published Standard
- MEF 79.0.1 - Published Standard
- Developer Guide/API - MEF W87 - work in progress - Ready for CfC#3/RfD
- Business Requirements
- Quote:
- Business Requirements - MEF W80 - Draft Release 5
- Developer Guide/API- MEF W115 - LSO Sonata Quote Management API - Developer Guide - work in progress, ongoing CfC#1 resolution
- Order:
- Business Requirements - MEF 57.2 - Draft Release 1
- Developer Guide - none
- API - work in progress - updated to match MEF 57.2
- Inventory:
- Business Requirements - MEF 81, MEF 81.0.1 Published Standard
- Developer Guide - none
- API - work in progress, updated
- Product Specifications:
- Access E-Line - MEF W106 work in progress, after CfC#1
- EPL - work in progress
For details on the maturity map and the roadmap for future releases please refer to LSO Sonata SDK Home Page on MEF WIKI.
Contents
This SDK contains the following items:
COPYRIGHT
- Copyright 2020 MEF ForumLICENSE
- Contains a copy of the Apache 2.0 licenseREADME
- This fileapi
- Definitions of the API are found in this directoryinventory
- Contains the API definitions necessary for inter-carrier retrieval of Product Inventoryorder
- Contains the API definitions for inter-carrier service ordering capability.quote
- Contains the API definitions for inter-carrier service quotation capabilityserviceability
- Contains the APIs that allow the Service Provider or Buyer to perform:address
- Retrieve Address information including exact formats for Addresses known to the SellerofferingQualification
- 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
doc
- All related standards and Developer Guides.cantata-sonata/carrierEthernet/epl
- automatically generated documentation for EPL Productsonata/carrierEthernet/accessELine
- Access E-Line Product Requirementsserviceability/offeringQualification
- MEF W87 Developer Guideserviceability/address
- MEF W121 Developer Guideserviceability/site
- MEF W122 Developer Guidequote
- MEF W115 Developer Guidestandards
- The rest of documents and standards.uml
- A collection of UML diagrams generated from all of the API files.
spec
- Product Specification schemas for:cantata-sonata/carrierEthernet/epl
- EPLsonata/carrierEthernet/accessELine
- Access E-Line
staticBinding
- Contains static bindings of envelope APIs with Product Specification payloads. It comes in OpenAPI 3.0.
NOTE: Please note the Readme files in particular directories that provide more detailed information about corresponding functionalities.
All superseded files can be found in the Git history if needed.
Standards
Any developer intending to use the materials in this repository should first thoroughly read, review, and understand the following materials:
- MEF 55: Lifecycle Service Orchestration (LSO): Reference Architecture and Framework This document is a ratified MEF standard.
- MEF 55.0.1: Amendment to MEF 55: Operational Threads This document is a ratified MEF standard.
- MEF 55.0.2: Amendment to MEF 55: TOSCA Services Templates This document is a ratified MEF standard.
- MEF 50.1: MEF Services Lifecycle Process Flows This document is a ratified MEF standard.
- MEF 57.2: Draft Release 1 Product Order Management Requirements and Use Cases Draft Release 1
- MEF 79: Address, Service Site, and Product Offering Qualification Management This document is a ratified MEF standard.
- MEF 79.0.1: Amendment to MEF 79 Address, Service Site, and Product Offering Qualification Management Requirements and Use Cases
- MEF 79.0.2: Amendment to MEF 79: Address Validation This document is a ratified MEF standard.
- MEF 80: Quote Management Draft Release 5
- MEF 81: Product Inventory Management
- MEF 81.0.1: Amendment to MEF81 Product Inventory Management
- MEF W87: LSO Sonata Product Offering Qualification API - Developer Guide
- MEF W106: LSO Sonata Product Specification - Access E-Line
- MEF W92.1: LSO Sonata Test Requirements
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.
Published standard | Draft standard | Work in progress |
---|
LSO Sonata SDK Aretha (Production)
Theme: Pre-ordering
Version: aretha
Date: 22nd 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 | 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 | ||
Product Inventory | MEF 81 MEF 81.0.1 | ProductInventoryManagement - 6.0.0-RC | MEF W106 (CfC#1 working-draft) | Access E-Line | |||
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 | |||
Trouble Ticketing | |||||||
Billing | |||||||
Menu-driven POQ and Quote |
Release Aretha Deliverables
Bolded Deliverables are part of the release's theme "Pre-ordering"
Deliverable | Maturity | Comment |
---|---|---|
MEF 79.0.1 79 POQ amendment | Published Standard | |
MEF 79.0.2 79 Address amendment | Draft Standard R1 | |
MEF 80 Quote BR&UC | Draft Standard R5 | |
MEF W115 Quote DevGuide+API | Working Draft (70% CfC#1 reviewed, ready for CfC#2) | |
MEF W87 POQ DevGuide+API | Working Draft (CfC#2 reviewed, ready for CfC#3) | |
MEF W106 Access E-Line | Working Draft (CfC#1 reviewed, ready for CfC#2) | |
MEF 121 Address Dev Guide + API | Working Draft (incl. 79.0.2) (ready for CfC#1) | |
MEF 122 Site Dev Guide + API | Working Draft (ready for CfC#1) | |
Order API | Working Draft updated to 57.2 Draft Standard (R2) (basic scope) | Basic scope = Create, Cancel, Get, List of Product Order |
MEF W57.2 Order BR&UC | Draft Standard R2 (basic scope) | Basic scope = Create, Cancel, Get, List of Product Order The Amend, Charge etc. will be part of Billie release. |
LSO Sonata SDK Billie (May 2021)
Theme: Ordering
Version: billie
Date: May 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 R2) | MEF 121 (Draft Standard R1) | GeographicAddressManagement | N/A | N/A | ||
Site Query | MEF 79 | MEF 122 (Draft Standard R1) | GeographicSiteManagement | N/A | N/A | ||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 | ProductOfferingQualificationManagement ProductOfferingQualificationNotification | MEF 106 | Access E-Line | SonataBlendingTool | |
Quoting | MEF 80 | MEF W115 | QuoteManagement QuoteNotification | MEF 106 | Access E-Line | ||
Product Inventory | MEF 81 MEF 81.0.1 | MEF W116 (Draft (R1) | ProductInventoryManagement | MEF 106 | Access E-Line | ||
Product Order | MEF W57.2 Draft (R3) | MEF 123 (CfC#1 working draft) | ProductOrderManagement ProductOrderNotification | MEF 106 | Access E-Line | ||
Trouble Ticketing | Draft Standard (R2) | ||||||
Billing | |||||||
Menu-driven POQ and Quote | MEF W110 Draft (R1) |
Release Billie Deliverables
Bolded Deliverables are part of the release's theme: "Ordering"
Deliverable | Assured delivery state | Tentative |
---|---|---|
MEF W57.2 Order BR&UC | Draft Standard (R3) (full scope) | |
MEF W116 Inventory DevGuide+API | Draft Standard (R1) | |
MEF 123 Order DevGuide+API | Working Draft (CfC#1) | |
MEF W106 Access E-Line | Standard | |
MEF 79.0.2 79 Address amendment | Standard | |
MEF 80 Quote BR&UC | Standard | |
MEF 115 Quote DevGuide+API | Standard | |
MEF 87 POQ DevGuide + API | Standard | |
MEF 121 Address Dev Guide + API | Draft Standard (R1) | |
MEF 122 Site Dev Guide + API | Draft Standard (R1) | |
MEF W110 Menu-driven POQ, Quote BR&UC | Draft Standard (R1) | Draft Standard (R2) |
MEF W113 Trouble Ticketing | Draft Standard (R2) | Standard |
LSO Sonata SDK C... (November 2021)
Version:
Date: November 2021
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 79.0.2 (Draft R2) | 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 | Access E-Line | SonataBlendingTool | ||
Quoting | MEF 80 | MEF W115 | QuoteManagement QuoteNotification | MEF 106 | Access E-Line | |||
Product Inventory | MEF 81 MEF 81.0.1 | MEF W116 | ProductInventoryManagement | MEF 106 | Access E-Line | |||
Product Order | MEF W57.2 | MEF 123 Draft Standard (R1) | ProductOrderManagement ProductOrderNotification | MEF 106 | Access E-Line | |||
Trouble Ticketing | MEF W113 Draft (R1) | |||||||
Billing | ||||||||
Menu-driven POQ and Quote | MEF 110 |
Release C... Deliverables
Bolded Deliverables are part of the release's theme: ...
Deliverable | Assured delivery state | Tentative |
---|---|---|
MEF W57.2 Order BR&UC | Standard | |
MEF W110 Menu-driven POQ, Quote BR&UC | Standard | |
MEF W116 Inventory DevGuide+API | Standard | |
MEF 123 Order DevGuide+API | Draft Standard (R1) | |
MEF W106 Access E-Line | TO CHECK | TO CHECK |
MEF 121 Address Dev Guide + API | Standard | |
MEF 122 Site Dev Guide + API | Standard | |
MEF W113 Trouble Ticketing | Standard |
LSO Sonata SDK Release Candidate 5 (hotfix 1)
Version: RC5.1
Date: 16th 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 | |||
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
Deliverable | Description |
---|---|
geographicAddressManagement.api.yaml v5.0.0-RC2 productOfferingQualificationManagement.api.yaml v5.0.0-RC2 productOfferingQualificationNotification.api.yaml v5.0.0-RC2 productOrderManagement.api.yaml v5.0.0-RC2 productOrderNotification.api.yaml v5.0.0-RC2 | bugfix and consistency fixes |
quoteManagement.api.yaml v5.0.0-RC2 quoteNotification.api.yaml v5.0.0-RC2 | bugfix and consistency fixes update to latest version of MEF 80 |
LSO Sonata SDK Release Candidate 5
Version: RC5
Date: 31st 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) | MEF W106 (working-draft) | Access E-Line | ||||
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
Deliverable | Description |
---|---|
MEF 79 | Draft #3 => Standard |
MEF W79.0.1 | New, Draft (R1) |
MEF W80 | Draft (R2) => Draft (R7) |
MEF 81 | Draft (R3) => Standard |
MEF 81.0.1 | New, Standard |
MEF W87 (Developer Guide + API Specs) | New, Working-draft |
MEF W106 Access E-Line - Product specification | New, Started CfC#1 |
Site, Quote, Inventory, Order API Swagger Specs | Update to introduce:
|
SonataBlendingTool | New |
LSO Sonata SDK Release 4
Version: R4
Date: Nov 2019
SDK Repository: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/releases/tag/r4
Function | BR&UC | LSO Sonata API | Product specs | Postman scripts | Tooling | Example code | ||
---|---|---|---|---|---|---|---|---|
Developer Guide | MEF branded TMF envelope API | Spec | JSON | |||||
Address Validation | MEF 79 Draft (R3) | GeographicAddressManagement - v3.0.0 | N/A | N/A | ||||
Site Query | MEF 79 Draft (R3) | GeographicSiteManagement - v3.0.0 | N/A | N/A | ||||
Product Offering Qualification (POQ) | MEF 79 Draft (R3) | ProductOfferingQualificationManagement - v3.0.1 ProductOfferingQualificationNotification - v3.0.0 | ||||||
Quoting | MEF 80 Draft (R2) | QuoteManagement - v2.0.0 QuoteNotification - v1.0.0 | ||||||
Product Inventory | MEF 81 Draft (R3) | ProductInventoryManagement - v3.0.0 | ||||||
Product Order | MEF 57.1 | ProductOrderManagement - v3.0.0 ProductOrderNotification - v3.0.0 | Access E-Line UNI | |||||
Trouble Ticketing | ||||||||
Billing |
LSO Sonata SDK Release 3
Version: 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 | ||||
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 |
- 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)
This example LSO Sonata implementation does not provide an executable or runnable project and it is based on the older APIs version.
Engagement Opportunities
- Development and use of the MEF 3.0 Developer Workshop
- Requirements for future releases of LSO Sonata
- Information on how they integrate LSO Sonata into OSS/BSS systems, and information on how to manage versions of the APIs
- Scoring of consumability of each release
- Inclusion of LSO Sonata as a requirement in RFIs to partners
- Active marketing of LSO Sonata releases
- Assessment of testing/certification solutions around LSO Sonata
PUBLIC
Core (public):
https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK
Extensions (MEF Members only):
https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK-extended
If you are a MEF Member, update your wiki profile with your GitHub account name. Access to the LSO Sonata SDK Extensions repository is periodically updated with provided GitHub accounts. Additionally contact the LSO Developer Community Manager to request the immediate access.
Are you a core contributor to this LSO SDK but not mentioned here? Please let the LSO SDK Community Manager know and we will add you!