The upcoming release of LSO Sonata SDK (R5) is now scheduled for the 31st July 2020.
R5 was originally planned for May, then for June. The reason the 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
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.
- Product Specification for Access E-Line (schema part which is extracted from MEF W106 currently under development)
- 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
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.
Introduction
LSO Sonata SDK is the complete set of deliverables developed by the CTO in order to
- Enable market adoption of LSO Sonata APIs in the current release of LSO Sonata SDK.
- 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 (Michał Łączyński) either via GitHub or by email to let him know of your interest and to ask questions
Source: LSO Sonata Graphics
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))
- 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.
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 standard | Draft standard | Work 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
Function | BR&UC | Developer Guide | Product specs | Postman scripts | Tooling | Example code | ||
---|---|---|---|---|---|---|---|---|
Spec | Swagger specs | 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 5 (Planned)
Version: R5
Planned date: July 31st 2020
Function | BR&UC | Developer Guide | Product specs | Postman scripts | Tooling | Example code | ||
---|---|---|---|---|---|---|---|---|
Spec | Swagger specs | Spec | JSON | |||||
Address Validation | MEF 79 MEF W79.0.1 | GeographicAddressManagement | N/A | N/A | Amdocs (based on R2) | |||
Site Query | MEF 79 MEF W79.0.1 | GeographicSiteManagement | N/A | N/A | Amdocs (based on R2) | |||
Product Offering Qualification (POQ) | MEF 79 MEF W79.0.1 | MEF W87 (working-draft) | ProductOfferingQualificationManagement ProductOfferingQualificationNotification | Access E-Line | 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
Deliverable | Description |
---|---|
MEF 79 | Draft #3 => Standard |
MEF W79.0.1 | New, Draft (R1) |
MEF W80 | Draft (R2) => Draft (R3) |
MEF 81 | Draft (R3) => Standard |
MEF 81.0.1 | New, 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 Specs | Update to introduce:
|
SonataBlendingTool | New. Tool that automates combining envelopes with payload. |
LSO Sonata SDK Release 6 (Planned)
Version: R6
Function | BR&UC | Developer Guide | Product specs | Postman scripts | Tooling | Example code | ||
---|---|---|---|---|---|---|---|---|
Spec | Swagger specs | Spec | JSON | |||||
Address Validation | MEF 79 MEF 79.0.1 | GeographicAddressManagement | N/A | N/A | Amdocs (based on R2) | |||
Site Query | MEF 79 MEF 79.0.1 | GeographicSiteManagement | N/A | N/A | Amdocs (based on R2) | |||
Product Offering Qualification (POQ) | MEF 79 MEF 79.0.1 | MEF 87 | ProductOfferingQualificationManagement ProductOfferingQualificationNotification | MEF W106 Draft (R1) | Access E-Line | SonataBlendingTool | Amdocs (based on R2) | |
Product Offering Qualification (POQ) On Demand | MEF W110 | OnDemandProductOfferingQualificationManagement OnDemandProductOfferingQualificationNotification | ||||||
Quoting | MEF 80 | MEF W115 | QuoteManagement QuoteNotification | MEF W106 Draft (R1) | Access E-Line | Amdocs (based on R2) | ||
Quoting On Demand | MEF W110 | QuoteManagement OnDemandQuoteNotification | ||||||
Product Inventory | MEF 81 MEF 81.0.1 | ProductInventoryManagement | MEF W106 Draft (R1) | Access E-Line | Amdocs (based on R2) | |||
Product Order | MEF W57.2 Draft (R2) | ProductOrderManagement ProductOrderNotification | MEF W106 Draft (R1) | Access E-Line | Amdocs (based on R2) | |||
Trouble Ticketing | MEF W113 Draft (R1) | TroubleTicketing | ||||||
Billing |
Release 6 Deliverables
Deliverable | Description |
---|---|
MEF W57.2 | New, Draft (R1) |
MEF 79.0.1 | New, Standard |
MEF 80 | Draft (R3) => Standard |
MEF 87 | Draft (R1) => Standard |
MEF W106 + Product Specs | New Draft (R1) |
MEF W110 | New, Draft (R2) |
MEF W113 | New, Draft (R1) |
MEF W115 | New, Draft (R1) |
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 |
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!