Open APIs

Expand all | Collapse all

TMF622 Product Ordering API

  • 1.  TMF622 Product Ordering API

    TM Forum Member
    Posted Feb 12, 2020 11:50
    Hi All,

    I am going through the TMF622 Product Ordering Management API REST Specification 19.0.1 and have the following queries:
    1) What is the scope/use of OrderItemActionType value 'noChange' ?
    2) How to handle data propagation requirements such as returning the 'Device MAC address' from provisioning back to the CRM/CX layer ?
    3) How are cross order dependencies/relationships represented?
    4) Looks like there is no provision to submit/pass-on an attachment(apart from notes) via product order. Is it true ?
    5) Order item state transition diagram is missing in the TMF622 API spec 19.0.1. Is this intentional ?

    Please share your inputs/thoughts.

    Thanks in advance for input from the community.

    Best Regards!


    ------------------------------
    Chandra Bommanaveni
    Oracle Corporation
    ------------------------------


  • 2.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted Feb 13, 2020 04:47
    Hello Chandra

    To provide you some answers:
    1) NoChange is usually use when you want to add/remove/change bundled product within a bundle or in relationship with existing product and you need to describe in the order this existing product. This product itself will not be changed by this order but need to be in the order to facilitate order management (providing context).
    2) You mean here how to have product characteristic value provided by the back end once order completed ? The straighforward path is to use the product inventory API using the product Id.
    3) We have for now only internal Order relationship. It could be a good idea to extend for cross product order. We have already implemented this pattern for Service Order. Could you share some UC to allow me add this feature for future release?
    4) Yes. BTW attachment could be defined within an referenced entity in the order like the Agreement.
    5) Not intentional - the order item state transition is present in our internal tool so probably something went wrong in the user guide/specification - I log an issue to fix this (for your info it is the same except partial state which is not defined for item).

    Hope it helps,

    Ludovic

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



  • 3.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted Feb 14, 2020 01:10
    Edited by Chandra Bommanaveni Feb 20, 2020 00:51
    ​Thanks Ludovic for the inputs/answers.
    For #3, there are several common use cases for cross order dependencies/relationships, these includes follow-on orders, child orders, in-flight revisions etc.
    Please note,  follow-on orders are used to make changes to items on an order that have not yet been completed but are past the point of no return.

    Thanks in advance!!

    ------------------------------
    Chandra Bommanaveni
    Oracle Corporation
    ------------------------------



  • 4.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted Feb 20, 2020 00:57
    ​Hello Ludovic,

    Good Morning !
    I updated my earlier response as following:
    For #3, there are several common use cases for cross order dependencies/relationships, these includes follow-on orders, child orders, in-flight revisions etc.
    Please note,  follow-on orders are used to make changes to items on an order that have not yet been completed but are past the point of no return.

    Please help me in understanding how the cross order dependencies/relationships are handled.

    Thanks in advance!


    ------------------------------
    Chandra Bommanaveni
    Oracle Corporation
    ------------------------------



  • 5.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted Feb 20, 2020 08:28
    Hi Chandra

    Probably an extension of the productOrder will be to add an orderRelationship structure:

      "orderRelationship": [
        {
          "id": "string",
          "href": "string",
          "relationshipType": "string",
          "@baseType": "string",
          "@schemaLocation": "string",
          "@type": "string",
          "@referredType": "string"
        }
      ],​

    The relationshipType  is used to provide the semantic of the relationship.

    I will raise a change request to add this feature.

    Hope it helps.

    Ludovic

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



  • 6.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted Feb 20, 2020 22:50
    Hi Ludovic,

    Yes, having a relationship type would definitely help.
    Thanks for raising a CR to add this feature.

    Regards!

    ------------------------------
    Chandra Bommanaveni
    Oracle Corporation
    ------------------------------



  • 7.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted 14 days ago
    Hi Ludovic,

    Is there any way for me to get visibility into when cross order dependencies will be introduced?

    thank you

    ------------------------------
    Lynn Dueck
    Oracle Corporation
    ------------------------------



  • 8.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted 13 days ago
    Hello Lynn

    This relationship strcuture has been lately introduced to service order API.
    We have to align this useful pattern for resourceOrder and productOrder (I do not see any roadblock to align).

    ProductOrder was one of the first API to migrate to v4.0 - it was some time ago - and we probably need to refresh this API. We have this task in mind but right now it is not yet started and probably not is very short term (but I will raise it in the team).

    Hope it helps,

    Ludovic

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



  • 9.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted 13 days ago
    Ludovic,

    I think an orderRelationship is of value but has limitations; in particular an order-order relationship is very coarse grained and would only work in the cases that the orders are fairly simple so that the effect of the orderRelationship on the products being ordered can be inferred from context. An explicit cross-order orderItemRelationship would allow much greater precision in expressing semantics. OrderItem ids are (from my reading of the spec) unique only within a single order.

    Adding optional order id and href to orderItemRelationship would let you indicate that a particular orderItem in one order is related to particular orderItem in another order. The orderRelationship is still useful for the cases we need to encode cross-order productRelationships, or the meaning in terms of products is obvious and implied relationships are enough.

    ------------------------------
    Alasdair MacLeod
    BT Group plc
    ------------------------------



  • 10.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted 13 days ago
    Hi Alasdair.

    Yes of course your point make sense.
    We have introduced this capability in service order (version 4.0) to describe relationship betwee service order item from distinct service order. You can take a look and check if it is corresponds to what you have in mind.
    Like for the previous point this is a pattern that we should add in productOrder (and resourceOrder).

    Hope it helps
    Ludovic

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



  • 11.  RE: TMF622 Product Ordering API

    TM Forum Member
    Posted 13 days ago
    Ludovic,

    Yes, the combination of xOrderItemRelationship and xOrderItemRef covers it.

    many thanks, Alasdair


    ------------------------------
    Alasdair MacLeod
    BT Group plc
    ------------------------------