Open APIs

 View Only
  • 1.  TMF622: StateChangeNotification with error info

    TM Forum Member
    Posted Aug 04, 2022 09:35
    Hi,

    I'm using ProductOrderStateChange notification for sending order notifications to consuming system.
    In case the order is stuck in error, I need to send the notification along with error details (like error code, error message) but I'm not finding any placeholder in the schema of Product Order State Change Event.
    Please suggest if any way forwrd.

    Thanks,
    Paras Agrawal

    ------------------------------
    Paras Agrawal
    Infosys
    ------------------------------


  • 2.  RE: TMF622: StateChangeNotification with error info

    TM Forum Member
    Posted Aug 08, 2022 03:02
    Can I pls get some suggestions on this?

    Thanks!

    ------------------------------
    Paras Agrawal
    Infosys
    ------------------------------



  • 3.  RE: TMF622: StateChangeNotification with error info

    TM Forum Member
    Posted Aug 09, 2022 08:11
    Hi Paras,
    Indeed I have not found error defenition in the latest TMF622 product specification, however it is defined for service ordering in TMF641. I believe you should use similar approach and introduce error section on product order item lever. Here is the sample from documentation
    "serviceOrderItem": [
     {
     "id": "1",
     "action": "add",
     "state": "InProgress",
     "service": {
     "@type": "Service",
     "state": "active",
     "serviceType": "CFS",
     "serviceCharacteristic": [
     {
     "id": "452-gh6",
     "name": "vCPE",
     "valueType": "object",
     "value": {
     "@type": "vCPE",
     "@schemaLocation": "http://nbi/api/v4/serviceSpecification/ONAPvCPE_Spec/specificationInputSchema",
     "vCPE_IP": "193.218.236.21",
     "MaxTxRate": 300,
     "TransmitPower": "11 dBm",
     "maxTream": "OFF"
     }
     }
     ],
     "serviceSpecification": {
     "@type": "ONAPServiceSpecificationRef",
     "@schemaLocation": "http://my.schema/ONAPServiceSpecificationRef.json",
     "id": "ONAPvCPE_Spec",
     "href": "http://../serviceSpecification/ONAPvCPE_Spec",
    Service Ordering Management API User Guide
    © TM Forum 2021. All Rights Reserved Page 26 of 66
     "name": "vCPE",
     "version": "1",
     "invariantUUID": "456-852-357",
     "toscaModelURL": "http//..."
     }
     },
     "errorMessage": [
     {
     "code": "500",
     "message": "Resource Fallout",
     "reason": "IP address not available",
     "referenceError": "http://serverlocation:port/serviceOrdering/v4/errorMessage/500",
     "status": "ERROR-003",
     "timestamp": "2020-08-27T23:17:45.450Z",
     "@type": "ServiceOrderItemErrorMessage"
     }
     ],
     "@type": "ServiceOrderItem"
     }]
    ​


    Below is the link for your reference https://www.tmforum.org/resources/specification/tmf641-service-ordering-api-user-guide-v4-1-0/

    ------------------------------
    Mikhail Mamaev
    Netcracker Technology
    ------------------------------



  • 4.  RE: TMF622: StateChangeNotification with error info

    TM Forum Member
    Posted Aug 09, 2022 08:11
    Hi Paras,

    You can follow TMF641 service ordering approach and specify error section on produt order item level.
    Below is the spippet from documentation and link for you reference
    https://www.tmforum.org/resources/specification/tmf641-service-ordering-api-user-guide-v4-1-0/
    "serviceOrderItem": [
     {
     "id": "1",
     "action": "add",
     "state": "InProgress",
     "service": {
     "@type": "Service",
     "state": "active",
     "serviceType": "CFS",
     "serviceCharacteristic": [
     {
     "id": "452-gh6",
     "name": "vCPE",
     "valueType": "object",
     "value": {
     "@type": "vCPE",
     "@schemaLocation": "http://nbi/api/v4/serviceSpecification/ONAPvCPE_Spec/specificationInputSchema",
     "vCPE_IP": "193.218.236.21",
     "MaxTxRate": 300,
     "TransmitPower": "11 dBm",
     "maxTream": "OFF"
     }
     }
     ],
     "serviceSpecification": {
     "@type": "ONAPServiceSpecificationRef",
     "@schemaLocation": "http://my.schema/ONAPServiceSpecificationRef.json",
     "id": "ONAPvCPE_Spec",
     "href": "http://../serviceSpecification/ONAPvCPE_Spec",
    Service Ordering Management API User Guide
    © TM Forum 2021. All Rights Reserved Page 26 of 66
     "name": "vCPE",
     "version": "1",
     "invariantUUID": "456-852-357",
     "toscaModelURL": "http//..."
     }
     },
     "errorMessage": [
     {
     "code": "500",
     "message": "Resource Fallout",
     "reason": "IP address not available",
     "referenceError": "http://serverlocation:port/serviceOrdering/v4/errorMessage/500",
     "status": "ERROR-003",
     "timestamp": "2020-08-27T23:17:45.450Z",
     "@type": "ServiceOrderItemErrorMessage"
     }
     ],
     "@type": "ServiceOrderItem"
     }]
    ​

    Have a great day

    ------------------------------
    Mikhail Mamaev
    Netcracker Technology
    ------------------------------



  • 5.  RE: TMF622: StateChangeNotification with error info

    Posted Aug 10, 2022 11:02
    Thanks for this interesting information. Very useful for me.

    ------------------------------
    Just enjoy my life.
    ------------------------------