Open APIs

 View Only
  • 1.  TMF622 Product Ordering v5 seems to have a creationDate instead of the v4 orderDate

    Posted 30 days ago
    Edited by Dan d'Albuquerque 30 days ago

    Hi All

    Does anyone know the reason why the orderDate from the TMF622 ProductOrder entity has been replaced with a creationDate instead?  The other ordering APIs are still using orderDate and there now seems to be a lack of consistency between the APIs.

    Perhaps it was relating to the SubmitProductOrder TASK resource which has now been removed?

    Thanks



    ------------------------------
    Dan d'Albuquerque
    Individual
    ------------------------------



  • 2.  RE: TMF622 Product Ordering v5 seems to have a creationDate instead of the v4 orderDate

    TM Forum Member
    Posted 27 days ago

    I'm not entirely sure why they decided to change the attribute name, but here's a guess:

    It was likely to bring more consistency and reduce subjective choices in naming attributes.

    The entity name itself should provide enough context to indicate what is created. For example, entityName -> xxxxDate : ProductOrder -> creationDate, completionDate.

    One advantage is having a single, unified definition that works across all entities and APIs, making things more streamlined.

    Another benefit comes when applying polymorphism. The term "creationDate" is neutral, it simply indicates when the entity was created, making it adaptable for any @Type. On the other hand, "orderDate" is more specific, tied to the creation of an order, and therefore less flexible for reuse.

    for order, polyphormism is not going to be a big advantage, but for party, where you have many types of party, you want a generic date field, not customer, prospect, partner.. something date.

    PS:

    I can just picture the API owners at TMForum, sitting up on Mount Olympus like Greek Gods, watching us, mere mortals, struggle to figure out how to use the divine tools and assets they've bestowed upon us.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 3.  RE: TMF622 Product Ordering v5 seems to have a creationDate instead of the v4 orderDate

    Posted 25 days ago

    LOL... thanks Matthieu for the Friday humour.

    The only concern with the creationDate for the ProductOrder entity is that the draft mode is still supported, only the removal of the SubmitProductOrder TASK resource has occurred.  I am presuming that the creation date would be the date that the entity was created, e.g. in draft state.  This means that when the order is transitioned to acknowledged, i.e. when the order is placed, this (order) date is no longer available.



    ------------------------------
    Dan d'Albuquerque
    Individual
    ------------------------------



  • 4.  RE: TMF622 Product Ordering v5 seems to have a creationDate instead of the v4 orderDate

    TM Forum Member
    Posted 24 days ago

    Yes, it was meant as humour, but it also highlights a concern: it feels as though TMF and TMF API owners aren't engaging with this community. It's discouraging to see an organisation create a product, such as the API, without offering sufficient support. We used to prioritise TMF APIs when acquiring software, but that's no longer the case. Personally, I'm considering stepping back from the community, as it has become less rewarding and impactful.



    ------------------------------
    Kind regards,

    Matthieu Hattab
    Lyse Platform
    ------------------------------



  • 5.  RE: TMF622 Product Ordering v5 seems to have a creationDate instead of the v4 orderDate

    TM Forum Member
    Posted 22 days ago

    Hi @Matthieu Hattab and @Dan d'Albuquerque

    sorry, I was sitting up on Mount Olympus, trying to watching mortals, but there was fog, I couldn't see anything since several months. Today it's a bit better, I can see you.

    My colleagues Anh-Tuan Nguyen and Jacob Avraham, sitting up on Mount Olympus next to me, say that it has been decided in 2021 ([AP-1313] Standard to "tracking" fields - TM Forum JIRA) to align some attribute names accross all API (creationDate, lastUpdate at least).

    So yes regarding ProductOrder, we are missing the acknowledgementDate, and all "stateDate", and lastUpdate. I create a JIRA to look at this for next version.

    It's also possible to use the history pattern coming on next Guidelines version to retrieve the full history.

    And by the way the /submitProductOrder has never existed in a stable version of the API (at least in v4 and v5). But I reopened a JIRA to ask again for this task to appear in the API specification because ODA components need this task.



    ------------------------------
    Olivier Arnaud
    Orange
    ------------------------------