The LSO Cantata SDK is the complete set of deliverables developed by the MEF membership in order to

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

The latest release of LSO Cantata SDK is in the LSO API Release 'Ella' and is available on GitHub (see Latest Release section for details).

Any MEF member can participate in the development of each new release of the LSO Cantata 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

MEF-LSO-Cantata-SDK - Ella Release

Download Link

Download the entire repository by clicking here

Introduction

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

• Serviceability
  • Address
  • Site Retrieval
  • Product Offering Qualification Management
• Product Quote
• Product Order
• Product Inventory
• Trouble Ticket
  • Appointment
  • Work Order

It also provides Product Schemas for:

• Subscriber Carrier Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE)
• Internet Access

High-level release notes

• Documents published as MEF Standards:
  • MEF 57.2 - Product Order Management Requirements and Use Cases
  • MEF 113 - Trouble Ticketing Requirements and Use Cases
  • MEF 128 - LSO API Security Profile
• Following documents have their Letter Ballots open and will be likely shortly published as MEF standards:
  • MEF W123 - LSO Cantata and LSO Sonata Product Order Management API - Developer Guide
  • MEF W124 - LSO Cantata and LSO Sonata Trouble Ticket and Incident Management API - Developer Guide
  • MEF W137 - LSO Cantata and LSO Sonata Appointment Management API - Developer Guide
  • MEF W134 - Billing and Invoice Business Requirements and Use Cases
  • MEF W125 - LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide
• New documents:
  • MEF W141 - LSO Cantata and LSO Sonata Billing Management API - Developer Guide
  • MEF W125.0.1 - Amendment to MEF 125 LSO Cantata and LSO Sonata - Subscriber Ethernet Product Schemas and Developer Guide

The LSO Marketplace has introduced the possibility to blend the desired APIs with chosen Products. Thus the APIs blended with all products that were available in generated/staticBinding are no longer provided.

NOTE: Please note the Readme files in particular productApi directories to see detailed release notes per API.

Maturity Level

The API files contained in this SDK are evolving and subject to change. They are based on documents that are either ratified standards or draft standards that have not yet completed the review cycles and approvals necessary to achieve the status as a MEF standard. MEF is making these publicly available at this time to invite wider industry review.

The maturity per functionality presents as follows:

(*) is used to mark item that changes their maturity comparing to previous release.

• Address Validation, Site Query:
  • Business Requirements:
    • MEF 79 - Published Standard
    • MEF 79.0.2 - Published Standard
  • Developer Guide/API:
    • MEF 121 - Address Management - Published Standard
    • MEF 122 - Site Management - Published Standard
• Product Offering Qualification:
  • Business Requirements:
    • MEF 79 - Published Standard
    • MEF 79.0.1 - Published Standard
  • Developer Guide/API:
    • MEF 87 - Published Standard
• Quote:
  • Business Requirements:
    • MEF 80 - Published Standard
  • Developer Guide/API:
    • MEF 115: - Published Standard
• Order:
  • Business Requirements:
    • *MEF 57.2 - Published Standard
  • Developer Guide/API:
    • *MEF W123 - Letter Ballot
• Inventory:
  • Business Requirements:
    • MEF 81, MEF 81.0.1 - Published Standard
  • Developer Guide/API
    • MEF 116 - Published Standard
• Trouble Ticket:
  • Business Requirements:
    • *MEF 113 - Published Standard
  • Developer Guide/API
    • *MEF W124 - Trouble Ticket - Letter Ballot
    • *MEF W137 - Appointment - Letter Ballot
• Billing:
  • Business Requirements:
    • *MEF W134 - Letter Ballot
  • Developer Guide/API
    • *MEF W141 - work in progress - ready for CfC#1
• Product Specifications:
  • *MEF W125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - Letter Ballot
  • *MEF W125.0.1 - Amendment to Subscriber Ethernet - work in progress - ready for CfC#1
  • *MEF W139 - Basic and Advanced Internet Access - work in progress - ready for CfC#2
• Security:
  • MEF 128 - Published Standard

For details on the maturity map and the roadmap for future releases please refer to LSO Cantata SDK Home Page on the MEF WIKI.

Contents

This SDK contains the following items:

• COPYRIGHT - Copyright 2022 MEF Forum
• LICENSE - Contains a copy of the Apache 2.0 license
• README - This file
• productApi - Definitions of the APIs - yaml files with schemas
• documentation - All related standards and Developer Guides
  • productApi - API related documentation - API Developer Guides
  • productSchema - Product related documentation - Product schema guides
  • supportingStandards - The rest of documents and standards.
• ProductSchema - Product Specification schemas
• generated
  • staticBinding - No longer provided - please visit LSO Marketplace to use self-blending possibility.
  • security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.

Issues, Questions, and Feedback

Issues should be reported with the use of GitHub issues. Questions and feedback should be asked either at Cantata SDK Community or directly to community_manager@mef.net.

NOTE: All artifacts included in this repository have line numbers. When referring to specific content in any of these artifacts, please quote the line numbers to which you are referring.

BR&UC - Business Requirements & Use Cases

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

LSO Sonata SDK Ella (Production)

Git Tag: ella

Date: 4th January 2023

Release Ella Deliverables

Supporting artifacts:

• Example Dynamic Binding Implementation
• LSO Payload Handbook
• SonataBlendingTool

LSO Sonata SDK Fergie (Planned: June 2023)

Release Fergie Deliverables

LSO Sonata SDK Grace (Planned: December 2023)

Release Grace Deliverables

LSO Sonata SDK Haley (Planned: June 2024)

Release Haley Deliverables

LSO Sonata SDK Dolly

Git Tag: dolly

Date: 8th June 2022

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2	MEF 121	GeographicAddressManagement (7.0.1)	N/A	N/A
Site Query	MEF 79	MEF 122	GeographicSiteManagement (7.0.1)	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87	ProductOfferingQualificationManagement (7.0.1) ProductOfferingQualificationNotification (7.0.1)	MEF W125 (CfC#2) MEF W139 (CfC#1 Ready)	Subscriber Ethernet Internet Access		SonataBlendingTool
Quoting	MEF 80	MEF 115	QuoteManagement (8.0.1) QuoteNotification (8.0.1)	MEF W125 (CfC#2) MEF W139 (CfC#1 Ready)	Subscriber Ethernet Internet Access		SonataBlendingTool
Product Inventory	MEF 81 MEF 81.0.1	MEF 116	ProductInventoryManagement (7.0.2)	MEF W125 (CfC#2) MEF W139 (CfC#1 Ready)	Subscriber Ethernet Internet Access		SonataBlendingTool
Product Order	MEF W57.2 Draft Standard (R4)	MEF W123 (CfC#3)	ProductOrderManagement (9.0.0-RC) ProductOrderNotification (9.0.0-RC)	MEF W125 (CfC#2) MEF W139 (CfC#1 Ready)	Subscriber Ethernet Internet Access		SonataBlendingTool
Trouble Ticketing	MEF 113 Draft Standard (R3)	MEF W124 Trouble Ticket  (CfC#3) MEF W137 Appointment (CfC#1 Ready)	troubleTicketManagement (3.0.0-RC) troubleTicketNotification (3.0.0-RC) appointmentManagement (1.0.0-RC) appointmentNotification (1.0.0-RC) workorderManagement (1.0.0-RC) workorderNotification (1.0.0-RC)	N/A	N/A
Billing	MEF W134 Draft Standard (R1)
Test Requirements	MEF W92.1 Draft Standard (R2)
Security	MEF W128 Draft Standard (R2)

Release Dolly Deliverables

Supporting artifacts:

• Example Dynamic Binding Implementation
• LSO Payload Handbook

LSO Cantata SDK Celine (January 14^th, 2022)

Git Tag: celine

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2	MEF 121	GeographicAddressManagement v1.0.1	N/A	N/A
Site Query	MEF 79	MEF 122	GeographicSiteManagement v1.0.1	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87	ProductOfferingQualificationManagement v1.0.1 ProductOfferingQualificationNotification v1.0.1	MEF 125 (CfC#1)	Subscriber Ethernet		SonataBlendingTool
Quoting	MEF 80	MEF 115	QuoteManagement v2.0.0 QuoteNotification v2.0.0	MEF 125 (CfC#1)	Subscriber Ethernet		SonataBlendingTool
Product Inventory	MEF 81 MEF 81.0.1	MEF W116	ProductInventoryManagement v1.0.1	MEF 125 (CfC#1)	Subscriber Ethernet		SonataBlendingTool
Product Order	MEF W57.2 Draft Standard (R3)	MEF W123 (CfC#2)	ProductOrderManagement v3.0.0-RC ProductOrderNotification v3.0.0-RC	MEF 125 (CfC#1)	Subscriber Ethernet		SonataBlendingTool
Trouble Ticketing	MEF 113 Draft Standard (R2)	MEF W124 (CfC#2)	troubleTicketManagement v2.0.0-RC troubleTicketNotification v2.0.0-RC	N/A	N/A
Billing
Test Requirements	MEF W92.1 Draft Standard (R2)

Release Celine Deliverables

Supporting documentation:

• Example Dynamic Binding Implementation
• LSO Payload Handbook CfC#1
• MEF W128 - Draft Release 1 LSO API Security Profile – Implementer’s Guide

LSO Cantata SDK Billie (3rd June 2021)

Version: billie-final

Function	BR&UC	LSO Sonata API		Product specification		Blended envelope + payload (OAS 3.0)	Tooling
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation	MEF 79 MEF 79.0.2 (Draft Standard R2)	MEF 121 (CfC#1 resolved)	geographicAddressManagement (1.0.0-RC)	N/A	N/A
Site Query	MEF 79	MEF 122 (CfC#1 resolved)	geographicSiteManagement (1.0.0-RC)	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87 (CfC#3 resolved)	productOfferingQualificationManagement (1.0.0-RC) productOfferingQualificationNotification (1.0.0-RC)	MEF W125 (working draft)	Subscriber Ethernet		SonataBlendingTool
Quoting	MEF 80 (Draft Standard R6)	MEF W115 (CfC#1 resolved)	quoteManagement (1.0.0-RC) quoteNotification (1.0.0-RC)	MEF W125 (working draft)	Subscriber Ethernet
Product Inventory	MEF 81 MEF 81.0.1	MEF W116 (CfC#1 working draft)	productInventoryManagement (1.0.0-RC)	MEF W125 (working draft)	Subscriber Ethernet
Product Order	MEF W57.2 (Draft Standard R2)	MEF W123 (CfC#1 working draft)	productOrderManagement (2.0.0-RC) productOrderNotification (2.0.0-RC)	MEF W125 (working draft)	Subscriber Ethernet
Trouble Ticketing	MEF W113 (Draft Standard R1)	MEF W124 (working-draft, CfC#1 ready)	troubleTicketManagement (1.0.0-RC) troubleTicketNotification (1.0.0-RC)	N/A	N/A
Billing
Test Requirements	MEF W92.1 (Draft Standard R1)

Release Billie Deliverables

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

LSO Cantata SDK Aretha

Version: aretha

Date: 22^nd December 2020

Function	BR&UC	LSO Cantata API		Product specification		Blended envelope + payload (OAS 3.0)
		Developer Guide	MEF branded TMF envelope API	Requirements	JSON Schema
Address Validation				N/A	N/A
Site Query				N/A	N/A
Product Offering Qualification (POQ)
Quoting
Product Inventory
Product Order	MEF W57.2 (Draft Standard R2)		ProductOrderManagement - 1.0.0-RC ProductOrderNotification - 1.0.0-RC		EPL
Trouble Ticketing				N/A	N/A
Billing				N/A	N/A

Release Aretha Deliverables

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