Open APIs

Expand all | Collapse all

TMF622 OrderTerm vs ProductTerm

  • 1.  TMF622 OrderTerm vs ProductTerm

    TM Forum Member
    Posted Aug 26, 2021 17:26
    Hello,

    TMF622 describes two term objects:
    orderItem/itemTerm
    orderItem/product/productTerm
    Are there conventions for when each is used? The spec doesn't say much. There is no "role" or other discriminator in these blocks.



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


  • 2.  RE: TMF622 OrderTerm vs ProductTerm

    TM Forum Member
    Posted 30 days ago
    Hello Alasdair,
    As you probably noticed, we have the complete Product representation with ProductOrder.ProductOrderItem. This pattern allows to describe the 'future' product as product order requester wants it. So, the orderItem/product/productTerm is the term has it will be/is represented in the inventory.  There is no convention, but probably good to have a recommendation in your organization because this could be a bit confusing. In my organization, we recommend in the product order to manage the 'ordered' term at orderItem level (and not in orderItem/product/productTerm). Then, of course, we find it in product/productTerm in the inventory.
    Hope it helps
    Ludovic

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



  • 3.  RE: TMF622 OrderTerm vs ProductTerm

    TM Forum Member
    Posted 30 days ago
    Ludovic,

    Thanks for this, useful to know the situation. I can see pros and cons with each approach, consistency with the "show to-be" approach used elsewhere in the payload vs. a very explicit separation of as-is from to-be. One for some internal discussion and pondering.

    I think it would be useful to include your commentary in the spec, so implementers are aware there is a choice to be made.

    Thanks, Alasdair

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



  • 4.  RE: TMF622 OrderTerm vs ProductTerm

    TM Forum Member
    Posted 27 days ago
    The conventions for this are not imposed by TMF in the current state of the openAPI.

    This is my take on this:
    • orderItem/itemTerm: used for terms that are relevant for the fulfillment process only e.g. expectCustomsClearanceDelay
    • orderItem/product/productTerm: used for terms that have a lasting effect on the product: minimumContractDuration, terminationNoticePeriod.
    But any other convention could be as good as mine.

    ------------------------------
    Koen Peeters
    Ciminko Luxembourg
    ------------------------------