Open APIs

 View Only

  • 1.  TMF 622 Product Ordering - Product Order Information Required Event

    Posted Jun 29, 2022 11:16
    Hello All,

    I am looking to clarify my understanding of how the "Product Order Information Required Event" is intended to work.

    I get that occasionally a CSP will require more information from a customer in order to successfully complete an order.

    What I am not clear on with this API is how one communicates what that additional information actually is?

    I see notes in various parts of the information model but that could be used for any number of random things.

    Does anyone have any good examples as to how they have used this event type?

    Thanks

    ------------------------------
    Derrick Evans
    ------------------------------


  • 2.  RE: TMF 622 Product Ordering - Product Order Information Required Event

    Posted Jun 30, 2022 03:45
    Hello Derrick,

    Have you noticed the fieldPath attribute in the event structure? You can use it to specify which attribute(s) need to be filled.
    We are working on improving this structure & providing examples for the event in the coming v5 version.
    Here a glimpse of this (please note this is work in progress and could change) but it could provide a good idea:

    Here it is for a quote and the agreement id & contact medium information are missing. Of course once validated same pattern will aplly for productOrder. 
    (in v4 you have only the fieldPath and not the operation)

    {
  "correlationId": "qs1-k33",
  "description": "QuoteInformationRequiredEvent illustration",
  "domain": "Commercial",
  "eventId": "966",
  "eventTime": "2021-09-27T07:43:59.059Z",
  "eventType": "QuoteInformationRequiredEvent",
  "priority": "1",
  "timeOcurred": "2021-09-27T07:43:59.059Z",
  "title": "QuoteInformationRequiredEvent",
  "event": {
    "quote": {
      "id": "5252",
      "href": "https://host:port/quoteManagement/v4/quote/5252",
      "@type": "EntityRef",
      "@referredtype": "Quote"
    },
    "informationRequired": {
      "informationRequiredPath": [
        {
          "op": "add",
          "path": "agreement.id"
        },
        {
          "op": "add",
          "path": "contactMedium"
        }
      ]
    }
  },
  "reportingSystem": {
    "id": "123",
    "name": "CRM app",
    "@type": "ReportingResource",
    "@referredType": "LogicalResource"
  },
  "source": {
    "id": "123",
    "name": "CRM app",
    "@type": "ReportingResource",
    "@referredType": "LogicalResource"
  },
  "@baseType": "Event",
  "@type": "QuoteInformationRequiredEvent"
}​
     
    Hope it helps,

    Ludovic

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

    Original Message


  • 3.  RE: TMF 622 Product Ordering - Product Order Information Required Event

    Posted Jun 30, 2022 13:32
    Hello Ludovic
    Thanks for the prompt reply. Very useful and interesting.
    I was looking at the published TMF622 spec and saw the following

    {
         "eventId":"00001",
         "eventTime":"2015-11-16T16:42:25-04:00",
         "eventType":"ProductOrderInformationRequiredEvent",
              "event": {
                 "productOrder" :
                    {-- SEE ProductOrder RESOURCE SAMPLE --}
               }
    }

    And couldn't see how this would work. Your example makes it clear.

    The interesting thing is in B2B2X applications if the API is a TMF622 representation/transformation of something like an internal Salesforce/Vlocity API.
    The point would be that the originating system of the event might not know about the format of the ProductOrder resource as exposed in order to use the appropriate path.
    So one would need some smarts to present the correct information.



    ------------------------------
    Derrick Evans
    ------------------------------

    Original Message


Related Content