Open APIs

Expand all | Collapse all

Error management in TMF APIs

  • 1.  Error management in TMF APIs

    TM Forum Member
    Posted Jul 16, 2020 12:11
    Hi,

    we are in the process of implementing a complete provisioning chain using TMF 641, 640, 638 and 633.
    We are looking into a way to handle error management so that wherever an error occurs in the chain related to a service order or service instance, we will be able to associate the error to the above mentioned entity and later retrieve it. Basically, we want to easily access comprehensive information about what failed and for which reason...
    From what we can see in the different APIs, only a state attribute exists to specify that something went wrong without additional information (apart from the error that can be thrown by the API).

    Is there something available in the API portfolio that we can use as interface to such error management system or some commonly accepted guidelines/best practices? If not, do you have experience with existing (preferably open source) systems that would fit the bill?

    Best regards,
    Frederic

    ------------------------------
    Frederic Thise
    Proximus SA
    ------------------------------


  • 2.  RE: Error management in TMF APIs

    TM Forum Member
    Posted Jul 19, 2020 01:17
    Hi Frederic
    Thanks for raising this issue.
    It would seem that there is a case, perhaps, for explicitly adding error information to our order structures in the Open API, this would go a long way to answering your requirements. Of course the underlying implementations would need to honor this.
    Adding @Ludovic Robert - perhaps a discussion point for upcoming team meetings?
    ​​

    ------------------------------
    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.
    ------------------------------



  • 3.  RE: Error management in TMF APIs

    TM Forum Member
    Posted Jul 23, 2020 03:28
    Hi Jonathan,

    thanks for your reply. In the meantime, I guess we'll have to implement our own solution while messing as little as possible (and still being compliant) with the official APIs...

    Best regards,
    Frederic

    ------------------------------
    Frederic Thise
    Proximus SA
    ------------------------------



  • 4.  RE: Error management in TMF APIs

    TM Forum Member
    Posted Jul 23, 2020 05:41
    Hi Frederic
    Stop Press - I learned this week that work is going on in the API team to define error structures within orders.
    I will see if I can make contact with the responsible lead for that, so that you will be able to understand the direction. But I cannot promise anything.

    ------------------------------
    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.
    ------------------------------



  • 5.  RE: Error management in TMF APIs

    TM Forum Member
    Posted 23 days ago
    Hi Jonathan

    Are you aware of any progress on this?

    Thanks

    Lynne​

    ------------------------------
    Lynne Gregory
    SSE Electricity Ltd
    ------------------------------



  • 6.  RE: Error management in TMF APIs

    TM Forum Member
    Posted 22 days ago
    Hi
    TMF641 (Service Order) is definitely being updated with this error structure, but as far as I can tell no assets have yet been published (swagger, user guide). Perhaps @Kamal Maghsoudlou can update you with the status, since he was leading this work.
    Hope it helps​

    ------------------------------
    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.
    ------------------------------