Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
borderColorblack
borderWidth1
titleTable of Contents

Table of Contents


Panel

New MEF LSO Sonata SDK Release Candidate 5 (

RC5

hotfix 1) is out! Download!

The new hotfix Release Candidate of LSO Sonata SDK (RC5.1) was issued on July 31st 2020.

RC5 was originally planned for May, then for June. The reason the delay until end of July was to ensure that RC5 contains important updates from R4 which include:

  • MEF W87 - LSO Sonata Developer Guide for Product Offering Qualification + API specification update

The first of a series of developer guides that explain the details of MEF API usage, process flows and the pattern resulting from the combining of the TMF-based envelope with Product Specifications. It comes with the update of POQ API Specification.

  • MEF W106 - LSO Sonata Product Specification - Access E-Line - Requirements document and JSON product schemas
  • Update of all of LSO Sonata APIs:
    • Use of TM Forum tooling based on Domain Context Specialisation rules to ensure alignment with TM Forum APIs (see MEF-TMF-ONAP-Collaboration)
    • Introduction of envelope-payload and product characteristic patterns as described in MEF W87
    • Bug fixes and improvements

Please refer to the LSO Sonata SDK Release Candidate 5 (Production) to see more details of the coverage map and list of deliverables.

Please refer to LSO SDKs - Type of Release to see what a Release Candidate is in comparison to the Release.

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.


Panel

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


Panel

Source: LSO Sonata Graphics


Panel
titleLatest Release

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:



Panel
titleLSO 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 (Production)

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-RC5N/AN/AN/A


Site Query

MEF 79

MEF W79.0.1


geographicSiteManagement.api.yaml v5.0.0-RC5N/AN/AN/A


Product Offering Qualification (POQ)

MEF 79

MEF W79.0.1

MEF W87 (working-draft)

productOfferingQualificationManagement.api.yaml v5.0.0-RC5

productOfferingQualificationNotification.api.yaml v5.0.0-RC5

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

SonataBlendingTool


Quoting
MEF W80 Draft (R3)

quoteManagement.api.yaml v5.0.0-RC5

quoteNotification.api.yaml v5.0.0-RC5

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


Product Inventory

MEF 81

MEF 81.0.1

productInventoryManagement.api.yaml v5.0.0-RC5

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


Product Order
MEF 57.1

productOrderManagement.api.yaml v5.0.0-RC5

productOrderNotification.api.yaml v5.0.0-RC5

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 Candidate 6 (Planned)

Version: R6



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

MEF 79

MEF 79.0.1


(tick) GeographicAddressManagementN/AN/A


Amdocs (based on R2)
Site Query

MEF 79

MEF 79.0.1


(tick) GeographicSiteManagementN/AN/A


Amdocs (based on R2)
Product Offering Qualification (POQ)

MEF 79

MEF 79.0.1

MEF 87

(tick) ProductOfferingQualificationManagement

(tick) ProductOfferingQualificationNotification

MEF W106 Draft (R1)Access E-Line(znak wyboru)

(tick)


SonataBlendingToolAmdocs (based on R2)
Product Offering Qualification (POQ) On DemandMEF W110
(znak wyboru) OnDemandProductOfferingQualificationManagement

(tick)OnDemandProductOfferingQualificationNotification

(pytanie)(pytanie)



Quoting
MEF 80MEF W115

(tick) QuoteManagement

(tick) QuoteNotification

MEF W106 Draft (R1)Access E-Line(znak wyboru)

Amdocs (based on R2)
Quoting On DemandMEF W110

(znak wyboru) QuoteManagement

(znak wyboru) OnDemandQuoteNotification

(pytanie)(pytanie)



Product Inventory

MEF 81

MEF 81.0.1


(tick) ProductInventoryManagementMEF W106 Draft (R1)Access E-Line(znak wyboru)

Amdocs (based on R2)
Product Order
MEF W57.2 Draft (R2)

(tick) ProductOrderManagement

(tick) ProductOrderNotification

MEF W106 Draft (R1)

Access E-Line

(znak wyboru)

Amdocs (based on R2)
Trouble Ticketing
MEF W113 Draft (R1)
(tick) TroubleTicketing





Billing










Release Candidate 6 Deliverables

DeliverableDescription
MEF W57.2New, Draft (R1)
MEF 79.0.1New, Standard
MEF 80Draft (R3) => Standard
MEF 87Draft (R1) => Standard
MEF W106 + Product SpecsNew Draft (R1)
MEF W110New, Draft (R2)
MEF W113New, Draft (R1)
MEF W115New, Draft (R1)



Panel
titleHistorical

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









Panel
titleReference 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)
Note

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



Panel

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



Panel
titleStatus

Status
colourGreen
titlePUBLIC


Panel
titleLSO Developer Community

LSO Sonata SDK Community

LSO Developer Community Home Page


Panel
titleLSO Developer Community Manager

Michal Laczynski

Contact: community_manager@mef.net


Panel
titleLSO 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

Note

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.



Panel
titleCore Contributors

Ludovic Robert

Fahim Sabir

Dhurvas (Siva) Sivakumar


Note

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!



Panel
titleUseful Resources

API Developer Guides