Open APIs

 View Only
  • 1.  Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted Apr 09, 2018 13:53
    ​We're trying to expose an offering catalog through a TMF-compliant API but are debating whether we should use the entity catalog API (TMF662) or product catalog API (TMF620). Our use case is that we want to build and cache an extract of our entire offering catalog which will be made available via an interface. Our catalog has certain entities not described in the product catalog API such as rules, relations, and certain offering characteristics that we need so we are leaning towards the entity API which allows us to more generically describe them all. However, the entity API doesn't have the export operations that the product catalog API has for retrieving the entire catalog at once.  Looking for advise on which one to use and extend if needed.

    ------------------------------
    Sarah Ness
    TELUS
    ------------------------------


  • 2.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted Apr 10, 2018 13:25
    I would tend towards a Product Catalog API approach and work with TMF to extend the API as necessary or implement extensions in such a way that they can be transformed to the standard API approach.  That implies that there is a roadmap for extending the Product Catalog API to meet the needs you have (Characteristics,Rules, etc.)

    ------------------------------
    Greg Herringer
    IBM Canada
    ------------------------------



  • 3.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted Apr 11, 2018 04:02
    Sarah - I second Greg's view that the Product Catalog API is probably the best way to go. Exposing offerings is one of the business aims of this API.
    As the new lead for the Product Catalog API (after amazing work done by @Kamal Maghsoudlou in all the catalogs), I would be happy to ​hear suggestions for enhancements of this API. I have a backlog of improvements that I am starting to work on, such as:
    Since the API was recently published for 17.5, we are aiming at 18.5 (end of this calendar year) as the next release.

    So feel free to reach out to me directly by email to open a discussion.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    ------------------------------



  • 4.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted Apr 11, 2018 08:51
    ​Thank you for the input.  I will reach out to you directly to discuss.

    Sarah.

    ------------------------------
    Sarah Ness
    TELUS
    ------------------------------



  • 5.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted 11 days ago
    Hi Jonathan,

    Looking at TMF620 it appears we have not supported Characteristics for Product Offer. Think we should not support Characteristics at Product Offer level, don't want architecture or systems to change for every new Product Offer created.

    Can you please share use-case which cannot be delivered using Product Specification Characteristics. Which ODA component is expected to use Product Offer Characteristics?

    ------------------------------
    Srinivasa Vellanki
    Reliance Jio Infocomm Ltd
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of my employer or TM Forum.
    ------------------------------



  • 6.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted 10 days ago
    Offering Characteristics have been added in TMF620 as part of a tranche of enhancements for v4.2. The changes are currently in internal review so I don't have a final date for draft publication; hopefully some time in the next several weeks.
    Examples of offering characteristics might include warranty period for an extended warranty offering, for instance.

    ------------------------------
    Jonathan Goldberg
    Amdocs Management Limited
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of the TM Forum or my employer.
    ------------------------------



  • 7.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted 10 days ago
    Thank you @Jonathan Goldberg for sharing the usecases.

    Will analyze these usecases sometime down the line. Will revert back with any questions then.​

    ------------------------------
    Srinivasa Vellanki
    Reliance Jio Infocomm Ltd
    Any opinions and statements made by me on this forum are purely personal, and do not necessarily reflect the position of my employer or TM Forum.
    ------------------------------



  • 8.  RE: Entity Catalog API vs Product Catalog API

    TM Forum Member
    Posted Apr 11, 2018 08:52
    ​Thanks very much for the input.

    ------------------------------
    Sarah Ness
    TELUS
    ------------------------------