Open APIs

 View Only
  • 1.  TMF622 for asset operations

    TM Forum Member
    Posted Sep 28, 2022 15:17

    Dear all,

    I am looking for an API definition for placing ordens in a CRM System (mobile customers), some that fits all
    MACD product scenarios.

    Looking into the TMF622 (product ordering) specifications and examples, I am not completely sure if this is also designed for changing or inactivating some assets a customer owns. In the ProductOrderItem node, the description for "Id" property says it generally is a sequence number, however when talking about Assets Id References, this is not true.
    Any tips about that?



    ------------------------------
    Gustavo Luis Cimitan
    Salesforce
    ------------------------------


  • 2.  RE: TMF622 for asset operations

    TM Forum Member
    Posted Sep 29, 2022 15:40
    Hi Gustavo
    TMF622 is the API that you need. You will see that the product order item sub-entity includes an action, which could be change, suspend, terminate, etc.
    As a general rule, we suggest that arrays of sub-entities are addressable, hence the id field, which should be locally unique (and perhaps index would have been a better name).
    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.
    ------------------------------



  • 3.  RE: TMF622 for asset operations

    TM Forum Member
    Posted Sep 29, 2022 17:50

    Hi Jonathan,

    Yes, for sure it helped! 

    I also found another related posts where the guidance is the same.
    The only point I still have is if I define a solution where the Id field will sometime reference a Product Id or a Asset Reference Id depending on the scenario/action, or if we create some structures under ProductOrderItem like "Product" and "Asset" to address all scenarios.
    If you or some other guys have an opinion on that, would be great. 

    Thanks a lot



    ------------------------------
    Gustavo Luis Cimitan
    Salesforce
    ------------------------------



  • 4.  RE: TMF622 for asset operations

    Posted Oct 01, 2022 10:40
    Hello
    Within product order item there is a product item with an id and a serial number.
    Personally I would used that to identify the product to be changed, replaced or removed.

    So when we want to cease/delete a product we create a product order item like so

    "productOrderItem": [
            {
              "id": "100.1",
              "action": "delete",
              "product": {
                "id": "54c268fa-5e9d-4e5f-b21c-abb883d29fc0",
                "productOffering": {
                  "id": "E0000703"
                },
                "@type": "BTProductRefOrValue"
              },
              "@type": "BTProductOrderItem"
            },


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



  • 5.  RE: TMF622 for asset operations

    TM Forum Member
    Posted Oct 02, 2022 03:24
    Agree with Derrick. There's no need for a separate class for Asset - the Product class is flexible enough for all the use cases (remember the Product content is driven by the Product Specification and Offering from the catalog API TMF620). Order Item has a ref or value to the Product on which the item is taking action, as shown by Derrick's example here.

    ------------------------------
    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.
    ------------------------------



  • 6.  RE: TMF622 for asset operations

    TM Forum Member
    Posted Oct 03, 2022 11:50
    @Derrick Evans and @Jonathan Goldberg I now also agree ​​with you.

    Your answers were very helpful.

    Thank you a lot.

    ------------------------------
    Gustavo Luis Cimitan
    Salesforce
    ------------------------------