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 'Dolly' 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 - Dolly 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:

• EPL
• EPLAN
• EPTREE
• EVPL
• EVPLAN
• EVPTREE
• Basic Internet Access
• Advanced Internet Access

High-level release notes

• Following APIs and their respective Developer Guides have been published as MEF Standards:
  • MEF 87 - LSO Cantata and LSO Sonata Product Offering Qualification API - Developer Guide
  • MEF 115 - LSO Cantata and LSO Sonata Quote Management API - Developer Guide
  • MEF 116 - LSO Cantata and LSO Sonata Product Inventory API - Developer Guide
  • MEF 121 - LSO Cantata and LSO Sonata Address Management API - Developer Guide
  • MEF 122 - LSO Cantata and LSO Sonata Site Management API - Developer Guide
• All APIs have been reviewed and updated to follow their respective Business Requirements & Use Cases and Developer Guides documents
• New documents:
  • MEF W134 - Invoice Business Requirements and Use Cases
  • MEF W137 - LSO Cantata and LSO Sonata Appointment Management API - Developer Guide
  • MEF W139 - Internet Access Product Schemas and Developer Guide
• New artifacts:
  • generated/security - A not normative version of the standard APIs including the security profiles as required by MEF 128. Provided for evaluation.

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:

• Address Validation, Site Query:
  • Business Requirements:
    • MEF 79 - Published Standard
    • *MEF 79.0.2 - Published Standard
  • Developer Guide/API:
    • *MEF W121 - Address Management - Published Standard
    • *MEF W122 - Site Management - Published Standard
• Product Offering Qualification:
  • Business Requirements:
    • MEF 79 - Published Standard
    • MEF 79.0.1 - Published Standard
  • Developer Guide/API:
    • *MEF W87 - Published Standard
• Quote:
  • Business Requirements:
    • *MEF 80 - Published Standard
  • Developer Guide/API:
    • *MEF W115: - Published Standard
• Order:
  • Business Requirements:
    • *MEF W57.2 - work in progress, Draft Release 4
  • Developer Guide/API:
    • *MEF W123 - work in progress - ready for CfC#3
• Inventory:
  • Business Requirements:
    • MEF 81, MEF 81.0.1 - Published Standard
  • Developer Guide/API
    • *MEF W116 - Published Standard
• Trouble Ticket:
  • Business Requirements:
    • *MEF W113 - work in progress, Draft Release 3
  • Developer Guide/API
    • *MEF W124 - Trouble Ticket - work in progress - ready for CfC#3
    • *MEF W137 - Appointment - work in progress - ready for CfC#1
• Product Specifications:
  • *MEF W125 - Subscriber Ethernet (EPL, EPLAN, EPTREE, EVPL, EVPLAN, EVPTREE) - work in progress, CfC#1 reviewed
  • *MEF W139 - Basic and Advanced Internet Access - work in progress - ready for CfC#1

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

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 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
  • troubleTicket - Create and manage Trouble Tickets
  • workforce - Manage Appointment and Work Orders
• documentation - All related standards and Developer Guides
  • productApi - API related documentation - Developer Guides
    • inventory - MEF 116 Developer Guide
    • order - MEF W123 Developer Guide
    • quote - MEF 115 Developer Guide
    • serviceability/address - MEF 121 Developer Guide
    • serviceability/offeringQualification - MEF 87 Developer Guide
    • serviceability/site - MEF 122 Developer Guide
    • troubleTicket - MEF W124 Developer Guide
    • workforce - MEF W137 Developer Guide
  • productSchema - product related documentation
    • carrierEthernet - MEF W106 and MEF W125 Product Schema Guides
    • ip - MEF W139 Product Schema Guide
  • supportingStandards - The rest of documents and standards.
• ProductSchema - Product Specification schemas for:
  • carrierEthernet - Carrier Ethernet product Schemas
  • ip - Basic and Advanced Internet Access product schemas
• generated/staticBinding - contains automatically generated (with help of the open source Sonata Blending Tool), not normative static bindings of envelope APIs with Product Specifications. The Address, Site and Trouble Ticket APIs are not included as they do not carry product information.
  • full - contains static binding of all available product schemas
  • carrierEthernet - contains static binding of only CarrierEthernet products
  • ip - contains static binding of only IP products

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.

The MEF LSO Cantata SDK is released under the Apache 2.0 license.

BR&UC - Business Requirements & Use Cases

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

LSO Cantata SDK Dolly (Production: June 8^th 2022)

Version: dolly

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 (1.0.1)	N/A	N/A
Site Query	MEF 79	MEF 122	GeographicSiteManagement (1.0.1)	N/A	N/A
Product Offering Qualification (POQ)	MEF 79 MEF 79.0.1	MEF 87	ProductOfferingQualificationManagement (1.0.1) ProductOfferingQualificationNotification (1.0.1)	MEF W125 (CfC#2) MEF W139 (CfC#1 Ready)	Subscriber Ethernet Internet Access		SonataBlendingTool
Quoting	MEF 80	MEF 115	QuoteManagement (2.0.1) QuoteNotification (2.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 (1.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 (4.0.0-RC) ProductOrderNotification (4.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)

Release Dolly Deliverables

Supporting artifacts:

• Example Dynamic Binding Implementation
• LSO Payload Handbook

LSO Sonata SDK Ella (Planned: December 2022)