Open APIs

Expand all | Collapse all

TMF620 - Notifications

  • 1.  TMF620 - Notifications

    TM Forum Member
    Posted Mar 15, 2021 17:21
    I have two doubts concerning notifications for TMF620:

    1) Are they mandatory?
    TMF620B document states them as mandatory but, they're not on the CTK tests.
    Also, for reference, TMF633 lists all notifications as optional elements.
    Can we assume this as an error in TMF620B document?

    2) How should be the resource Payload returned in the Event?
    By checking the examples in the specification, one can imagine that full payload of the element behind notification must be used to populate the notification payload.
    However, the Use Case 1 (UC1 presented on several specifications - such as TMF620, TMF633) give us impression that a notification with REF element would be enough to trigger a latter automatic synchronization.
    Question is: Can we assume that it is possible to choose which element format we can return back in the notification message?


    Marcos Donato da Silva
    Ericsson Inc.

  • 2.  RE: TMF620 - Notifications

    TM Forum Member
    Posted Mar 16, 2021 08:25
    Hi Marcos

    Thanks for your great questions.

    1) Events are mandatory as specified in each API's conformance profile. The fact that the CTK does not currently test this does not make a difference. In principle each API author decides which events are indeed mandatory and which are optional, and then an implementation of the API should honor this. Seems strange that the two catalog APIs have different approaches to raising events so perhaps we need to check this.

    2) We have two paradigms for events:
    * Point-to-point, using the hub mechanism. In this case, the event producer is explicitly aware of each consumer, and the consumer can set up a field restriction when creating the hub callback if it wants to reduce payload size. This described in the design guidelines TMF630.
    * Via a message broker, using the new Event API (TMF688, you'll find it in the early access table here). In this case, the event producer publishes the entire entity in the event payload.

    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.