Open APIs

 View Only
  • 1.  TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 06, 2021 05:21

    Hello Community,
    I am looking at the TMF645 v4.0.1 API. In the past, we have already implemented v3 once in our environment.

    I have to be honest, I haven't really understood the difference between a CheckServiceQualification and QueryServiceQualification. Does anyone dare to give me concrete examples of when to use what and where the difference lies? Reading the related API guide hasn't worked for me yet :-/

    Thanks and regards,

    Jan



    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------


  • 2.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 06, 2021 07:56
    Hi Jan
    I would characterize the distinction as follows:
    • Check allows me to pass in a specific service configuration and see if this can be provisioned at the service address (and if not, what are feasible alternatives). It's quite possible that this will take time, i.e. there won't be an immediate synchronous response. Additionally, the check might need more information (an event will be raised if so).
    • Query allows me to get a list of possible services for a service address, without supplying a configuration up-front. It's more likely to give an immediate response (although it can be asynchronous as well).
    Hope it helps, @Ludovic Robert might want to add more perspectives.​

    ------------------------------
    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: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 06, 2021 08:14
    Hello Jan,

    Adding to my TMF colleague answer....
    CheckServiceQualification intend is to manage a precise request for (or a group) a service configuration. In the response, a qualification result will be provided but also some additional information :
    • if the configuration is not qualified, reason could be provided
    • Alternate eligible service configuration could be pass also in the response
    QueryServiceQualification did not offer this depth... here you provide more generic information (example a service category & a place) and in the response you have only the list of services available here (not mention to service not eligible in the response).

    As stated by Jonathan, server side could be able - or not - to provide synchronous response.

    Depending on your UC you can implement one or both.

    Hope it helps

    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 4.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 06, 2021 09:20

    Hi @Ludovic Robert and @Jonathan Goldberg

    Thanks for your insights.

    In my use case, the requestor has a Place, a specific ServiceSpecification (in our case an InternetLeasedLine) and a bandwidth demand.
    Did I understand correctly that in this case the CheckServiceQualification would be a good fit?​​

    /Jan



    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------



  • 5.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 06, 2021 09:38
    Jan,
    Yes !....and in case available bandwidth inferior to requested one you'll be able to pass available one in the response ;)

    Ludovic

    ------------------------------
    Ludovic Robert
    Orange
    My answer are my own & don't represent necessarily my company or the TMF
    ------------------------------



  • 6.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 07, 2021 08:46
    Edited by Sri-Jagadish(Jag) Baddukonda Jul 07, 2021 08:47
    The context of triggering these interfaces is also important.
    Query Service Qualification:  Used during Pre-Ordering for Look up available Services and is usually an instant response (preferably Synchronous) and the capability is usually exposed by the Commercial catalog where location to Offer rules can be built. Or this can be extended into a Service availability check which is a different capability. 
    Check Service Qualification: Used during the Ordering / Quotation process where the Service Location details are passed to the target system and the response will be Bandwidth values, the available Last mile Access, the local access point corresponding to the Service Location etc. The capability is exposed by the Network Inventory & Management stack 

    Depending on the services i.e. Retail Wireline or Enterprise B2B we may use one of the above. 

    Regards,


    ------------------------------
    Sri Jagadish Baddukonda
    CSGI
    ------------------------------



  • 7.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 31, 2024 05:29

    Hi @Jonathan Goldberg

    Its was really helpful to clear our understanding.  

    We are referring TMF swagger for this API and getting various operations<POST, GET,PATCH,GET-ID,DELETE> under each resource <queryServiceQaulification and checkServiceQualification>.

    We are getting below information<use operations to retrieve information> in all the operations.  Can you please guide, when should we use POST and GET operation for both resources? Will POST operation use to create any entry in database because description is saying to use for retrieving services?



    ------------------------------
    Chetan Hirpara
    Tech Mahindra Limited
    ------------------------------



  • 8.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 31, 2024 06:05

    Hi Chetan

    Both of these entities are Task entities, see the TMF630 Design Guidelines for full details of what a Task entity is.

    In short, to carry out the Task, you POST a task entity, e.g. CheckServiceQualification entity with all the relevant information populated in the request.

    Depending on the implementation (and definitely if the task is performed asynchronously), the task will be persisted as part of the POST (201 returned), and in this case you can use GET to retrieve the task. Typically you would listen to a status change event on the task entity, and do the GET only when the task reports completed.

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



  • 9.  RE: TMF645 - Differences between CheckServiceQualification and QueryServiceQualification

    Posted Jul 31, 2024 06:24

    Thanks a lot. Now its clear for me.



    ------------------------------
    Chetan Hirpara
    Tech Mahindra Limited
    ------------------------------