Skip to content

MEF-LSO-Cantata-SDK - Dolly Release
Compare
Choose a tag to compare
@MichalLaczynskiAmartus MichalLaczynskiAmartus released this 08 Jun 16:13
· 12 commits to working-draft since this release
dolly
ab07849

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.

Copyright

© MEF Forum 2022. All Rights Reserved.

Disclaimer

The information in this publication is freely available for reproduction and use by any recipient and is believed to be accurate as of its publication date. Such information is subject to change without notice and MEF Forum (MEF) is not responsible for any errors. MEF does not assume responsibility to update or correct any information in this publication. No representation or warranty, expressed or implied, is made by MEF concerning the completeness, accuracy, or applicability of any information contained herein and no liability of any kind shall be assumed by MEF as a result of reliance upon such information.

The information contained herein is intended to be used without modification by the recipient or user of this document. MEF is not responsible or liable for any modifications to this document made by any other party.

The receipt or any use of this document or its contents does not in any way create, by implication or otherwise:

(a) any express or implied license or right to or under any patent, copyright, trademark or trade secret rights held or claimed by any MEF member which are or may be associated with the ideas, techniques, concepts or expressions contained herein; nor

(b) any warranty or representation that any MEF member will announce any product(s) and/or service(s) related thereto, or if such announcements are made, that such announced product(s) and/or service(s) embody any or all of the ideas, technologies, or concepts contained herein; nor

(c) any form of relationship between any MEF member and the recipient or user of this document.

Implementation or use of specific MEF standards, specifications, or recommendations will be voluntary, and no Member shall be obliged to implement them by virtue of participation in MEF Forum. MEF is a non-profit international organization to enable the development and worldwide adoption of agile, assured, and orchestrated network services. MEF does not, expressly or otherwise, endorse or promote any specific products or services.

Assets 3