Open APIs

Expand all | Collapse all

TMF641 Notification models - callback URL's

  • 1.  TMF641 Notification models - callback URL's

    TM Forum Member
    Posted May 10, 2020 22:57
    Hi there,

     TMF 641, Release 18.5.1

    We have the following given below are notification models for service orders. I will really appreciate if someone could clarify the following:

    1. Is ServiceOrderCreateNotification associated with NEW service order creation ? If yes, Is it suppose to triggered upon the acceptance of the order or after completion?

    2. I understand that ServiceOrderStateChangeNotification is triggered whenever a Service Order state changes regardless of the type of order ( Add, Delete, modify, nochange). When is the ServiceOrderAttributeValueChangeNotification?

    3.  Does the event attribute capture the full service order response upon state changes? Can we include place holder for callback URL's?

    - ServiceOrderCreateNotification  -- > ActionOrderActionType = Add
    - ServiceOrderAttributeValueChangeNotification -->  ??
    - ServiceOrderStateChangeNotification -->  ??
    - ServiceOrderDeleteNotification -- > ActionOrderActionType = Delete

    { "eventId":"00001",
    "eventTime":"2015-11-16T16:42:25-04:00",
    "eventType":"ServiceOrderCreateNotification",
    "event": { "serviceOrder" : {-- SEE ServiceOrder RESOURCE SAMPLE --} }



    Regards,
    Nahfees

    ------------------------------
    Mohamed Nahfees
    SingTel Optus
    ------------------------------


  • 2.  RE: TMF641 Notification models - callback URL's

    TM Forum Member
    Posted May 11, 2020 01:23
    Hi Nahfees.

    We have implemented TMF-641, following is the inline responses for your questions.  Good luck !

    1. Is ServiceOrderCreateNotification associated with NEW service order creation ? If yes, Is it suppose to triggered upon the acceptance of the order or after completion?
    [KM] ServiceOrderCreateNotification is upon Order acceptance, not upon Completion.

    2. I understand that ServiceOrderStateChangeNotification is triggered whenever a Service Order state changes regardless of the type of order ( Add, Delete, modify, nochange). When is the ServiceOrderAttributeValueChangeNotification?
    [KM] You are right about ServiceOrderStateChangeNotification, and the ServiceOrderAttributeValueChangeNotification is in case an attribute value of running order gets changes during execution, for example additional information is available from a Service Provider to be communicated to BSS/Customer.

    3.  Does the event attribute capture the full service order response upon state changes? Can we include place holder for callback URL's?
    [KM] You can use the pattern of GET order with call back urls for orderitems.
    - ServiceOrderCreateNotification  -- > ActionOrderActionType = Add
    - ServiceOrderAttributeValueChangeNotification -->  ??
    - ServiceOrderStateChangeNotification -->  ??
    - ServiceOrderDeleteNotification -- > ActionOrderActionType = Delete

    { "eventId":"00001",
    "eventTime":"2015-11-16T16:42:25-04:00",
    "eventType":"ServiceOrderCreateNotification",
    "event": { "serviceOrder" : {-- SEE ServiceOrder RESOURCE SAMPLE --} }

    Best Regards,
    Kailash


    ------------------------------
    Kailash Mali
    Ericsson Inc.
    ------------------------------



  • 3.  RE: TMF641 Notification models - callback URL's

    TM Forum Member
    Posted May 12, 2020 06:22
    Hi Kailash,

    Thank you very much for your response.  The last question on event parameter:  does it return the full service_response object?.

    ------------------------------
    Mohamed Nahfees
    SingTel Optus
    ------------------------------



  • 4.  RE: TMF641 Notification models - callback URL's

    TM Forum Member
    Posted May 12, 2020 08:12
    Hi Nahfees,

    Both patterns are fine for Service Order Resource - a fully expanded resource or an url.

    We use the fully expanded resource because typically BSS is interested in other detailed information as States changes, and to avoid the multiple callbacks and performance reason we use an expanded version.

    BR,
    Kailash

    ------------------------------
    Kailash Mali
    Ericsson Inc.
    ------------------------------



  • 5.  RE: TMF641 Notification models - callback URL's

    TM Forum Member
    Posted Jun 02, 2020 01:08
    Hi @Kailash Mali,

    Thank you for your kind responses. In the standard specs v18.5.1 , I do not see call back url field in it. it is focused towards a pub/sub method on notification. Did you add a placeholder for callback in the orderItem section?​

    Thank you.

    ------------------------------
    Mohamed Nahfees
    SingTel Optus
    ------------------------------



  • 6.  RE: TMF641 Notification models - callback URL's

    TM Forum Member
    Posted Jun 22, 2020 23:41
    Hi @Mohamed Nahfees,

    We had used "href", its also present in the documentation.



    Sorry, I missed to reply your message earlier.

    BR,
    Kailash


    ------------------------------
    Kailash Mali
    Ericsson Inc.
    ------------------------------