Open APIs

Expand all | Collapse all

OpenAPIs and SID Mapping

  • 1.  OpenAPIs and SID Mapping

    Posted May 10, 2019 11:37
    Edited by Mohamed Abdelhadi Mohamed Ibrahim May 10, 2019 13:21
    Hello Guys,


    I have quick question, does the OpenAPI has a different version of SID, like extended version of SID that is vary from the original one ?. This has came in on of the discussion that I was having today.

    My understanding OpenAPIs and SID goes hand in hand and SID is always kept up-to date with all ABE/entities to support the OpenAPIs and there is no such separate SID for OpenAPIs that is different from the original one.


    BR///
    Mohamed Abdelhadi
    Ericsson Inc.
    ------------------------------
    DT America


  • 2.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 12, 2019 00:29
    The information model used in the Open API is based on the SID, with some simplifications, flattening, denormalization, etc., to make the model more suitable for an API implementation.
    We have published several mapping documents for specific TMF Open APIs, the document numbers take the form TMF<xxx>A.
    Currently, however, due to other priorities, we are not continuing the mapping document.
    Feel free to reach out to @Cecile Ludwichowski , SID leader, who also coordinated the mapping effort.
    Hope it helps.​

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

    DT America


  • 3.  RE: OpenAPIs and SID Mapping

    Posted May 13, 2019 12:56
    Thanks Jonathan  for your response. I have tried to respond to you yesterday, but not sure if you received my response.

    My point was if any organization needs to adopt the OpenAPIs this mapping  is very much required, not only in the APIs but also to create their CDM(Canonical data model).  Therefor, I am very interested to understand to which extend this mapping has been completed.

    Anyhow thanks again I will in touch with @Cecile Ludwichowski for better understanding.

    BR///
    Mohamed,

    ------------------------------
    Mohamed Abdelhadi Mohamed Ibrahim
    Ericsson Inc.
    ------------------------------

    DT America


  • 4.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 15, 2019 02:26
    The SID is a logical information model for the CSP business. I don't think it was intended to be used as an underlying data persistence model (especially not relational/SQL, perhaps a document-based persistence could be closer to the SID). From a practical perspective, you need to consider how to map your (Open-API-based) functional exposure (APIs) into the underlying persistence layer (relational, object, whatever) that best meets your business needs.

    This is my opinion (only) - SID leaders ( @Michel Besson and​​ @Cecile Ludwichowski) may have different views :).​

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

    DT America


  • 5.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 16, 2019 11:21
    I'd also be interested in the mapping between SID and the OpenAPI's - particularly surrounding the Logical/Physical Resource ABEs.    Is there somewhere this mapping is being tracked?  or available for contribution?

    ------------------------------
    Jason Masters
    TELUS
    ------------------------------

    DT America


  • 6.  RE: OpenAPIs and SID Mapping

    Posted May 17, 2019 05:58
    Maybe I was not very clear Jonathan. Yes I understand this and I was looking into this topic from a CSP context. And as part of compliance with TMF OpenAPIs, we are looking to define our data model and align it with SID based on the mapping between OpenAPis and SID. And I understood from you earlier that, the mapping between  OpenAPIs and SID is not complete, so I wanted to understand more on this subject(what existing so far and what still needs to be define) 

    BR///
    Mohamed,

    ------------------------------
    Mohamed Abdelhadi

    ------------------------------

    DT America


  • 7.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 19, 2019 16:12
    Best to reach out to @Cecile Ludwichowski to get up-to-date status of the mapping exercise.
    The published mappings can be found in https://projects.tmforum.org/wiki/display/PUB/ - you will have to look into each release sub-tree to find the mappings for that release. The release documents have the document number TMF<APID>A, so for example in R18.5 the published mappings include the mapping for Service Catalog was published as TMF633A - Service Catalog Mapping.​
    Hope it helps

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

    DT America


  • 8.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 22, 2019 09:03
    Hi Mohamed,
    At Sparx Services North America we have created a complete interconnected model of all the Frameworx, including SID, OpenAPI, ODA, eTOM, TAM, DMM and so on. See below an examplepart of SSNA frameworx content pack
    At DTW we have presented the result of over 1,000 hours of work as content packs for the modeling tool Sparx Enterprise Architect.
    The complete mapping between SID and OpenAPI is still ongoing, because the source material is vague about this, but we have included all the available relationships and we plan to complete the mapping in the next weeks.

    ------------------------------
    Giuseppe Platania
    Principal Enterprise Architect
    Sparx Services North America
    ------------------------------

    DT America


  • 9.  RE: OpenAPIs and SID Mapping

    Posted May 27, 2019 08:03
    Thanks Giuseppe, that is really great work. I will have a look on that.

    ------------------------------
    Mohamed Abdelhadi Mohamed Ibrahim
    Ericsson Inc.
    ------------------------------

    DT America


  • 10.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 21, 2019 09:00
    There are , of course, TMForum published guidelines on how to convert from the information model to an 'underlying data persistence model'. See https://www.tmforum.org/sid-how-to-guides/

    ------------------------------
    Paul Jordan
    BT Group plc
    ------------------------------

    DT America


  • 11.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 22, 2019 09:03
    Logically the OpenAPi should be a technical realization (PSM) of the logical data model (PIM) that is SID. However If we look at the definitions we see that they are only superficially connected. Maybe it's because the OpenAPi team is working with a different set of tools, with little support for access to the original SID model ....

    ------------------------------
    Giuseppe Platania
    Principle Enterprise Architect
    Sparx Services North America
    ------------------------------

    DT America


  • 12.  RE: OpenAPIs and SID Mapping

    TM Forum Member
    Posted May 24, 2019 09:07
    The Open API team is well aware of the underlying SID model, and the Open API model is strongly based on the SID. Deviations can occur  the following reasons (for example, this is not a full list):
    • Flattening inheritance structures - SID has a very deep inheritance structure, which would be very awkward in an API model. So the API model often uses only the final concrete classes. For example BusinessInteraction is not realized in the API, only concrete instantiations such as ProductOrder.
    • Simplifying entities - SID is strictly normalized, which means (for example) that fields derivable from other fields would not be appropriate. The API model relaxes this so as to give easier access to such fields.
    • Collapsing multiple entity types - where SID has chosen to define differentiated concrete classes the Open API sometimes decides to have a single class for this, with attributes that may be superfluous for some cases. For example, SID has AppliedCustomerBillingRate as an abstract class for charges and credits on a bill, and a complex inheritance structure to reach concrete classes for usage charges, credits, and more. The Open API chose to have a single concrete AppliedCustomerBillingRate.
    • Scoping out unused entities - in some cases the Open API does not have the full functional coverage that was foreseen by the SID model
    • Priority APIs - in cases of requests by members to give priority to new Open API (or modifications), it is possible that the Open API model would be developed (or modified) first and then SID would have to "catch up".

    Hope it helps.

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

    DT America


  • 13.  RE: OpenAPIs and SID Mapping

    Posted May 27, 2019 08:01
    Thanks Jonathan and all for the fruitful discussion. I will have a look on the references mentioned.

    ------------------------------
    Mohamed Abdelhadi Mohamed Ibrahim
    Ericsson Inc.
    ------------------------------

    DT America