New Release Candidate 5 (RC5) is out! Download!

The new Release Candidate of LSO Sonata SDK (RC5) was issued on July 31^st 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.

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 (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 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:

• 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.1: Ethernet Ordering Technical Standard - Business Requirements and Use Cases This document is a ratified MEF standard.
• MEF 79: Address, Service Site, and Product Offering Qualification Management This document is a ratified MEF standard.
• MEF 79.0.1 (LB) - Amendment to MEF 79 Address, Service Site, and Product Offering Qualification Management Requirements and Use Cases
• MEF 80 Draft (R7): Quote Management
• 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

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.

LSO Sonata SDK Release Candidate 5 (Production)

Version: RC5

Date: 31^st 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-RC5	N/A	N/A	N/A
Site Query	MEF 79 MEF W79.0.1		geographicSiteManagement.api.yaml v5.0.0-RC5	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-RC5 productOfferingQualificationNotification.api.yaml v5.0.0-RC5	MEF W106 (working-draft)	Access E-Line			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
Product Inventory	MEF 81 MEF 81.0.1		productInventoryManagement.api.yaml v5.0.0-RC5	MEF W106 (working-draft)	Access E-Line
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
Trouble Ticketing
Billing

Release Candidate 5 Deliverables

LSO Sonata SDK Release Candidate 6 (Planned)

Version: R6

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Postman scripts	Tooling	Example code
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
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 Candidate 6 Deliverables

LSO Sonata SDK Release 4

Version: R4

Date: Nov 2019

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

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
Site Query	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

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)

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