Table of Contents

New MEF LSO Sonata SDK Release Candidate 5 (hotfix 1) is out! Download!

The new hotfix Release Candidate of LSO Sonata SDK (RC5.1) was issued on September 17nd 2020.

It contains fixes to following list of issues: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/projects/6

It provides consistency alignment between POQ, Quote and Order to use MEFProductActionType.

It also provides several changes to Quote API introduced by the latest works on
MEF 80 - Quote Management Requirements and Use Cases.


Please visit:

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

for more details.


Introduction


LSO Sonata SDK is the complete set of deliverables developed by the CTO in order to

  1. Enable market adoption of LSO Sonata APIs in the current release of LSO Sonata SDK.
  2. Support of development of additional features for the upcoming release of LSO Sonata SDK.

The current release of LSO Sonata SDK is RC5 and is available on GitHub (see Latest Release section for details).

Any MEF member can participate in the development of each new release of LSO Sonata SDK:

  • Contact the LSO Developer Community Manager (Michal Laczynski) either via GitHub or by email to let him know of your interest and to ask questions

Latest Release

MEF LSO Sonata SDK Release Candidate 5 (hotfix 1)

The new hotfix Release Candidate of LSO Sonata SDK (RC5.1) was issued on September 17nd 2020.

It contains fixes to following list of issues: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/projects/6

It provides consistency alignment between POQ, Quote and Order to use MEFProductActionType.

It also provides several changes to Quote API introduced by the latest works on
MEF 80 - Quote Management Requirements and Use Cases.


Please visit:

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

for more details.

LSO Sonata SDK Release Candidate 5

Version: RC5

Overview

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

  • Serviceability (Address, Service Site, 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

SDK Repository

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

SDK 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
  • api - 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
  • doc - All related standards and Developer Guides.
    • product/carrierEthernet/accessELine - Contains the Requirement document for Access E-Line (MEF W106)
    • serviceability/offeringQualification - MEF W87 Developer Guide
    • standards - The rest of documents and standards.
    • uml - A collection of UML diagrams generated from all of the API files.
  • spec - hold product specifications
    • product/carrierEthernet/accessEline/ - Contains reference JSON schemas for Access E-Line delivered by MEF W106
  • 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:


LSO Sonata SDK Releases

BR&UC - Business Requirements & Use Cases

IIS - Interface Implementation Specification

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

Published standardDraft standardWork in progress

LSO Sonata SDK Release Candidate 5 (hotfix 1) (Production)

Version: RC5.1

Date: 16th September 2020

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


FunctionBR&UCLSO Sonata API
Product specificationBlended envelope + payload (OAS 3.0)Postman
scripts
Tooling
Developer GuideMEF branded TMF envelope API
RequirementsJSON Schema
Address Validation

MEF 79

MEF W79.0.1


geographicAddressManagement.api.yaml v5.0.0-RC2N/AN/AN/A


Site Query

MEF 79

MEF W79.0.1


geographicSiteManagement.api.yaml v5.0.0-RCN/AN/AN/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(znak wyboru)(tick)

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(znak wyboru)


Product Inventory

MEF 81

MEF 81.0.1

productInventoryManagement.api.yaml v5.0.0-RC

MEF W106 (working-draft)Access E-Line(znak wyboru)


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

(znak wyboru)


Trouble Ticketing








Billing









Release Candidate 5.1 Deliverables

DeliverableDescription

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 Aretha (Dec 2020)

Version:

FunctionBR&UCLSO Sonata APIProduct specificationBlended envelope + payload (OAS 3.0)Postman
scripts
Tooling
Developer GuideMEF branded TMF envelope APIRequirementsJSON Schema
Address Validation

MEF 79

MEF 79.0.2 (Draft Standard R1)

MEF ???

(CfC#1 working-draft)

(tick) GeographicAddressManagementN/AN/A


Site Query

MEF 79

MEF ???

(CfC#1 working-draft)

(tick) GeographicSiteManagementN/AN/A


Product Offering Qualification (POQ)

MEF 79

MEF 79.0.1

MEF 87 (Draft R1)

(tick) ProductOfferingQualificationManagement

(tick) ProductOfferingQualificationNotification

MEF W106 (CfC#1 working-draft)Access E-Line(znak wyboru)

(tick)


SonataBlendingTool
Quoting
MEF 80 (Draft Standard R5)

MEF W115

(CfC#1 working-draft)

(tick) QuoteManagement

(tick) QuoteNotification

MEF W106 (CfC#1 working-draft)Access E-Line(znak wyboru)

Product Inventory

MEF 81

MEF 81.0.1


(tick) ProductInventoryManagementMEF W106 (CfC#1 working-draft)Access E-Line(znak wyboru)

Product Order

MEF W57.2

(Draft Standard R2)


(tick) ProductOrderManagement

(tick) ProductOrderNotification

MEF W106 (CfC#1 working-draft)

Access E-Line

(znak wyboru)

Trouble Ticketing








Billing








Menu-driven POQ and Quote









Release Aretha Deliverables

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

DeliverableAssured delivery stateTentative

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 (CfC#1)
MEF W87 POQ DevGuide+APIDraft Standard R1
MEF W106 Access E-Line
Working Draft (CfC#1)Draft Standard R1
MEF ??? Address Dev Guide + APIWorking Draft (CfC#1)  (incl. 79.0.2)
MEF ??? Site Dev Guide + APIWorking Draft (CfC#1)
Order API5.0.0-RC2
updated to 57.2 Draft Standard (R2) (basic scope)

MEF W57.2 Order BR&UCDraft Standard R2 (basic scope)



LSO Sonata SDK Billie (May 2021)

Version:

FunctionBR&UCLSO Sonata APIProduct specificationBlended envelope + payload (OAS 3.0)Postman
scripts
Tooling
Developer GuideMEF branded TMF envelope APIRequirementsJSON Schema
Address Validation

MEF 79

MEF 79.0.2 (Draft R2)

MEF ??? (Draft Standard R1)(tick) GeographicAddressManagementN/AN/A


Site Query

MEF 79

MEF ??? (Draft Standard R1)(tick) GeographicSiteManagementN/AN/A


Product Offering Qualification (POQ)

MEF 79

MEF 79.0.1

MEF 87

(tick) ProductOfferingQualificationManagement

(tick) ProductOfferingQualificationNotification

MEF 106Access E-Line(znak wyboru)

(tick)


SonataBlendingTool
Quoting
MEF 80
MEF W115

(tick) QuoteManagement

(tick) QuoteNotification

MEF 106Access E-Line(znak wyboru)

Product Inventory

MEF 81

MEF 81.0.1

MEF W116 (Draft (R1)(tick) ProductInventoryManagementMEF 106Access E-Line(znak wyboru)

Product Order
MEF W57.2 Draft (R2)MEF ??? (CfC#1 working draft)

(tick) ProductOrderManagement

(tick) ProductOrderNotification

MEF 106

Access E-Line

(znak wyboru)

Trouble Ticketing
MEF W113 Draft (R1)






Billing








Menu-driven POQ and QuoteMEF W110 Draft (R1)


 






Release Billie Deliverables

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

DeliverableAssured delivery stateTentative
MEF W57.2 Order BR&UCDraft Standard (R2) (basic sope)

Draft Standard (R3) (full scope)

MEF W116 Inventory DevGuide+APIDraft Standard (R1)
MEF ??? Order DevGuide+API
Working Draft (CfC#1)
MEF W106 Access E-LineTO CHECKTO CHECK

MEF 79.0.2

79 Address amendment

Standard

MEF 80

Quote BR&UC

Standard
Standard

MEF 115

Quote DevGuide+API

Draft Standard (R2)Standard
MEF 87 POQ DevGuide + APIStandard
MEF ??? Address Dev Guide + APIDraft Standard (R1)
MEF ??? Site Dev Guide + APIDraft Standard (R1)
MEF W110 Menu-driven POQ, Quote BR&UCDraft Standard (R1)
MEF W113 Trouble TicketingDraft Standard (R1)


Historical

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


FunctionBR&UCLSO Sonata API
Product specificationBlended envelope + payload (OAS 3.0)Postman
scripts
Tooling
Developer GuideMEF branded TMF envelope API
RequirementsJSON Schema
Address Validation

MEF 79

MEF W79.0.1


geographicAddressManagement.api.yaml v5.0.0-RCN/AN/AN/A


Site Query

MEF 79

MEF W79.0.1


geographicSiteManagement.api.yaml v5.0.0-RCN/AN/AN/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(znak wyboru)(tick)

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(znak wyboru)


Product Inventory

MEF 81

MEF 81.0.1

productInventoryManagement.api.yaml v5.0.0-RC

MEF W106 (working-draft)Access E-Line(znak wyboru)


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

(znak wyboru)


Trouble Ticketing








Billing









Release Candidate 5 Deliverables

DeliverableDescription
MEF 79Draft #3 => Standard
MEF W79.0.1New, Draft (R1)
MEF W80Draft (R2) => Draft (R7)
MEF 81 Draft (R3) => Standard
MEF 81.0.1New, Standard
MEF W87 (Developer Guide + API Specs)New, Working-draft
MEF W106 Access E-Line - Product specificationNew, Started CfC#1
Site, Quote, Inventory, Order API Swagger SpecsUpdate to introduce:
  • bugfixing
  • new envelope-payload pattern
  • TMF compliance (usage of TMF Toolset to generate the schemas)
SonataBlendingToolNew



LSO Sonata SDK Release 4


Version: R4

Date: Nov 2019

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

FunctionBR&UCLSO Sonata API
Product specsPostman
scripts
ToolingExample
code
Developer GuideMEF branded TMF envelope APISpecJSON
Address Validation
MEF 79 Draft (R3)
GeographicAddressManagement - v3.0.0N/AN/A


Site Query
MEF 79 Draft (R3)
GeographicSiteManagement - v3.0.0N/AN/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

FunctionBR&UCIISProduct specsPostman
scripts
ToolingExample
code
SpecSwagger specsSpecJSON
Address Validation(tick) MEF 79 Draft (R2)
(tick) GeographicAddressManagement - v2.0.0N/AN/A


Site Query

(tick) MEF 79 Draft (R2)
(tick) GeographicSiteManagement - v2.0.0N/AN/A


Product Offering Qualification (POQ)(tick) MEF 79 Draft (R2)

(tick) ProductOfferingQualificationManagement - v2.0.0

(tick) ProductOfferingQualificationNotification - v1.0.0






Quoting(tick) MEF 80 Draft (R2)

(tick) QuoteManagement - v2.0.0

(tick) QuoteNotification - v1.0.0






Product Inventory(tick) MEF 81 Draft (R2)
(tick) ProductInventoryManagement - v2.0.0




Product Order(tick) MEF 57.1

(tick) ProductOrderManagement - v2.0.0

(tick) ProductOrderNotification - v1.0.0


(tick) Access E-Line

(tick) UNI




Trouble Ticketing







Billing







Reference Implementations
  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)

This example LSO Sonata implementation does not provide an executable or runnable project and it is based on the older APIs version.


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
Status

PUBLIC

LSO Developer Community Manager
LSO Sonata SDK @ GitHub

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.

Core Contributors

Ludovic Robert

Fahim Sabir

Dhurvas (Siva) Sivakumar


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!

Useful Resources