Versions Compared

Key

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


Panel
borderColorblack
borderWidth1
titleTable of Contents

Table of Contents


Panel
titleNew Release coming soon

The upcoming release of LSO Sonata SDK 5 Release (R5) is now scheduled to for the 31st of July 2020.

It R5 was originally planned in for May, then in for June. The reason behind those changes was to deliver the best possible added value and quality. Many important deliverables are being done these weeks that are worth waiting for to constitute a solid release that wouldn't have to be updated soon. This includesthe delay until end of July is to ensure that R5 contains important updates from R4 which include:

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

The first of a series of developer guides that

explains

explain the details of

the

MEF API usage, process flows and the pattern resulting from the combining of

combining

the TMF-based envelope with

MEF

Product

Specification

Specifications. It comes with the update of POQ API Specification.

  • Holing an additional Sonata dedicated MEF Interim Meeting on 20-23 July that is aimed to work on some of the SDK deliverables. MEF Members are welcomed to join.
  • Product Specification for Access E-Line (a part of schema part which is extracted from MEF W106 works)
  • Having the MEF-TMF-ONAP-Collaboration project work out the availability and rules of using TMF Tooling to generate the MEF APIs based on Domain Context Specialisation patterrules. By that MEF APIs will be TMF compliant.
  • currently under development)
  • Update of all of LSO Sonata APIs:
    • with the use of above tooling
    • to provide bugfixing and improvements
    • to introduce the 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

Note that the MEF membership will be holding an additional working session dedicated to LSO Sonata SDK R5 during the MEF Interim Meeting on 20-23 July. All members are encouraged to participate.

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


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 R4 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 4

Version: R4

This SDK release aligns the API schemas and definitions for Serviceability (Address Validation, Site Queries, Product Offering Qualification) and Product Inventory to the latest versions of MEF 79 and MEF 81 Draft Standards. In addition, the API schemas and definitions for Product Order are aligned with the new version of other Sonata APIs. The latest versions of MEF 79 and MEF 81 Draft Standards are included.

MEF LSO Sonata SDK core 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 holds Payload Descriptions for the following structures that are used with these APIs

  • JSON representations for Product Spec descriptions (initially for MEF Access E-Line services)
  • JSON representations for the UNI attributes (sourced from MEF 57.1)

SDK Repository

Core (public):

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

API release notes: https://github.com/MEF-GIT/MEF-LSO-Sonata-SDK/blob/r4/api/R4%20release%20notes.txt

SDK Contents

The SDK contains the following items:

  • COPYRIGHT - Copyright 2019 MEF Forum
  • LICENSE - Contains a copy of the Apache 2.0 license
  • payload_description - Common descriptors are found in this directory
    • ProductSpecDescription – Contains reference JSON schemas for product specification description.
  • api - Definitions of the API are found in this directory
    • Serviceability

      • address

        • GeographicAddressManagement - 3.0.0

      • offeringQualification
        • ProductOfferingQualificationManagement - 3.0.1

        • ProductOfferingQualificationNotification - 3.0.0

      • site
        • GeographicSiteManagement - 3.0.0

    • Product Quote

      • QuoteManagement - 2.0.0

      • QuoteNotification - 1.0.0

    • Product Order

      • ProductOrderManagement - 3.0.0

      • ProductOrderNotification - 3.0.0

    • Product Inventory

      • ProductInventoryManagement - 3.0.0

  • documentation - This contains the draft standards of the Business Requirements and Use Cases for
    • Address, Service Site, and Product Offering Qualification Management (MEF 79 Draft (R3))
    • Product Order Management (MEF 80 Draft (R2))
    • Product Inventory Management (MEF 81 Draft (R3))


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
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 4 (Production)


Version: R4

Date: Nov 2019

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


FunctionBR&UCDeveloper Guide
Product specsPostman
scripts
ToolingExample
code
SpecSwagger specsSpecJSON
Address Validation
(tick) MEF 79 Draft (R3)
(tick)GeographicAddressManagement - v3.0.0N/AN/A


Site Query
(tick) MEF 79 Draft (R3)
(tick)GeographicSiteManagement - v3.0.0N/AN/A


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

(tick)ProductOfferingQualificationManagement - v3.0.1

(tick) ProductOfferingQualificationNotification - v3.0.0






Quoting
(tick) MEF 80 Draft (R2)

(tick)QuoteManagement - v2.0.0

(tick) QuoteNotification - v1.0.0






Product Inventory
(tick) MEF 81 Draft (R3)
(tick)ProductInventoryManagement - v3.0.0




Product Order
(tick) MEF 57.1

(tick) ProductOrderManagement - v3.0.0

(tick) ProductOrderNotification - v3.0.0


(tick) Access E-Line

(tick) UNI




Trouble Ticketing








Billing










LSO Sonata SDK Release 5 (Planned)

Version: R5

Planned date: July 31st 2020


FunctionBR&UCDeveloper GuideProduct specsPostman
scripts
ToolingExample
code
SpecSwagger specsSpecJSON
Address Validation

MEF 79

MEF W79.0.1


GeographicAddressManagementN/AN/A


Amdocs (based on R2)
Site Query

MEF 79

MEF W79.0.1


GeographicSiteManagementN/AN/A


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

MEF 79

MEF W79.0.1

MEF W87 (working-draft)

ProductOfferingQualificationManagement

ProductOfferingQualificationNotification


Access E-Line(tick)

SonataBlendingTool


Amdocs (based on R2)
Quoting
MEF W80 Draft (R3)

QuoteManagement

QuoteNotification


Access E-Line


Amdocs (based on R2)
Product Inventory

MEF 81

MEF 81.0.1

ProductInventoryManagement
Access E-Line


Amdocs (based on R2)
Product Order
MEF 57.1

ProductOrderManagement

ProductOrderNotification


Access E-Line



Amdocs (based on R2)
Trouble Ticketing








Billing









Release 5 Deliverables

DeliverableDescription
MEF 79Draft #3 => Standard
MEF W79.0.1New, Draft (R1)
MEF W80Draft (R2) => Draft (R3)
MEF 81 Draft (R3) => Standard
MEF 81.0.1New, Standard
MEF W87 (Developer Guide + API Specs)New, Working-draft
Access E-Line - Product Specs only (Part of MEF W106)New schemas according to works in MEF W106
Site, Quote, Inventory, Order API Swagger SpecsUpdate to introduce:
  • bugfixing
  • new envelope-payload pattern
  • TMF compliance (usage of TMF Toolset and Domain Context Specialisation pattern to generate the schemas)
SonataBlendingToolNew. Tool that automates combining envelopes with payload.



LSO Sonata SDK Release 6 (Planned)

Version: R6



FunctionBR&UCDeveloper GuideProduct specsPostman
scripts
ToolingExample
code
SpecSwagger
specs
SpecJSON
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

(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

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

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

(tick) ProductOrderManagement

(tick) ProductOrderNotification

MEF W106 Draft (R1)

Access E-Line



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




Billing









Release 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 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

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