TM Forum Community

 View Only
  • 1.  TMF638

    Posted 12 days ago

    I am implementing TMF638; however facing challenges in understanding terminology :

    what is service, serviceType,serviceCharacteristic,serviceRelationship,serviceSpecification,supportingService. Swagger and Document do not clear basic terminology and jump straight into detailed explanations. 

    if anyone has simple example which can explain this , would be very helpful. 


    #General

    ------------------------------
    Keshav jha
    Cisco Systems
    ------------------------------


  • 2.  RE: TMF638

    Posted 12 days ago

    Hi Keshav

    Take a look at the IG1163 Information Framework Clarifications Document (downloadable from this site).

    Good luck!



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



  • 3.  RE: TMF638

    TM Forum Member
    Posted 12 days ago

    And here's the short summary for those who find documents too tiresome :) 

    A Service is basically the implementation of a Product, typically in the network (for a communications Product, but it could also be in other infrastructure elements, such as virtual machine, storage, etc.).

    A Service typically has characteristics with values that determine the behavior of a service. For example bandwidth for a connectivity service, size for a virtual storage service, etc. Characteristic values may be set as part of the service order creation (mapping from the product order), or by fixed values from the service catalog, or by business rules, or even manually by technicians during the course of the provisioning of the service.

    Services may be related to other services, so for example a 4K TV service could have a dependency relationship on a high-bandwidth fiber broadband connectivity service.

    Service Specification is a definition of the service in a Service Catalog; a recipe, if you like, of how to instantiate the service. The spec defines the characteristics and the relationships that the service has.

    I'm afraid I don't know what is meant by serviceType :( .

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



  • 4.  RE: TMF638

    Posted 12 days ago
    Edited by Keshav jha 12 days ago

    Thank you for explaining it 



    ------------------------------
    Keshav jha
    Cisco Systems
    ------------------------------



  • 5.  RE: TMF638

    Posted 11 days ago
    Edited by Keshav jha 11 days ago


    Hi @Jonathan Goldberg


    A follow up question on 

    If we have a list of services to be displayed as services catalogues in TMF638 response list we cannot do it in the present format because we can put list of services in service-characteristic object because list is not characteristic but itself a service. 
    For example, if I have various different virtual storage services, each one with a different size or additional properties, how can I show all different virtual storage services as one catalogue response?

    Response 1:
    {
    "@type": "Service",
    "href": "http://6abb04fbd0fe:8088/serviceinventory/api/v1/service/65cc2eee4112d0238dcba42a",
    "name": "Packages",
    "relatedParty": [
    {
    "_id": "1",
    "name": "operator1",
    "referredType": "PartyRole"
    }
    ],
    "serviceCharacteristic": [
    {
    "_id": "DS-113",
    "name": "packages",
    "valueType": "array",
    "value": [
    {
    "packageName": "AdvAutomationPkg01",
    "serviceType": "Advanced Automation",
    "ids": [],
    "status": "A"
    },
    {
    "packageName": "Ad_for_IMEI1",
    "serviceType": "Advanced",
    "ids": [
    1222
    ],
    "status": "A"
    },
    {
    "packageName": "810_test_ET_01",
    "serviceType": "Enterprise Training",
    "ids": [],
    "status": "A"
    }
    ]
    }
    ],
    "serviceOrderItem": [
    {
    "itemId": "2",
    "serviceOrderHref": "http://490ff3783d15:8078/serviceordering/api/v1/serviceorder/65cc2eee3ae51e725f1c2bfb",
    "serviceOrderId": "65cc2eee3ae51e725f1c2bfb",
    "itemAction": "ADD",
    "resourceRef": [
    {
    "_id": {"$oid": "65cc2eee89773238e083bd33"},
    "href": "http://40cdaffa02da:8095/ccresourceadapter/api/v1/resource/65cc2eee89773238e083bd33",
    "name": "Packages"
    }
    ]
    }
    ],
    "serviceSpecification": {
    "_id": {"$oid": "654a2a281efd305468cc3f72"},
    "name": "a"
    },
    "serviceType": "Packages",
    "startDate": {"$date": "2024-02-14T03:09:34.850Z"},
    "state": "ACTIVE"
    }

    response 2: 
    have each 
    "@type": "Service",
    "href": "http://6abb04fbd0fe:8088/serviceinventory/api/v1/service/65cc2eee4112d0238dcba42a",
    "name": "Packages",
    "relatedParty": [
    {
    "_id": "1",
    "name": "operator1",
    "referredType": "PartyRole"
    }
    ],
    "serviceCharacteristic": [
    {
    "_id": "DS-113",
    "name": "packages",
    "valueType": "array",
    "value": [
    {
    "packageName": "AdvAutomationPkg01",
    "serviceType": "Advanced Automation",
    "acctIds": [],
    "status": "A"
    },
    {
    "packageName": "Ad_for_IMEI1",
    "serviceType": "Advanced",
    "acctIds": [
    130237803
    ],
    "status": "A"
    },
    {
    "packageName": "810_test_ET_01",
    "serviceType": "Enterprise Training",
    "acctIds": [],
    "status": "A"
    }
    ]
    }
    ],
    "serviceOrderItem": [
    {
    "itemId": "2",
    "serviceOrderHref": "http://490ff3783d15:8078/serviceordering/api/v1/serviceorder/65cc2eee3ae51e725f1c2bfb",
    "serviceOrderId": "65cc2eee3ae51e725f1c2bfb",
    "itemAction": "ADD",
    "resourceRef": [
    {
    "_id": {"$oid": "65cc2eee89773238e083bd33"},
    "href": "http://40cdaffa02da:8095/ccresourceadapter/api/v1/resource/65cc2eee89773238e083bd33",
    "name": "Packages"
    }
    ]
    }
    ],
    "serviceSpecification": {
    "_id": {"$oid": "654a2a281efd305468cc3f72"},
    "name": "a"
    },
    "serviceType": "Packages",
    "startDate": {"$date": "2024-02-14T03:09:34.850Z"},
    "state": "ACTIVE"
    }



    Response 2 : have list of service exposed 

    [{
    "id": "6638d6088b71b97f6b8c187b",
    "href": "http://6abb04fbd0fe:8088/serviceinventory/api/v1/service/65cc2eee4112d0238dcba42a",
    "category": null,
    "description": null,
    "endDate": null,
    "hasStarted": null,
    "isBundle": null,
    "isServiceEnabled": null,
    "isStateful": null,
    "name": "AdvAutomationPkg",
    "serviceDate": null,
    "serviceType": "Packages v2",
    "startDate": null,
    "startMode": null,
    "feature": null,
    "note": null,
    "place": null,
    "relatedEntity": null,
    "relatedParty": null,
    "serviceCharacteristic": [
    {
    "id": "DS-113",
    "name": "packageName",
    "valueType": "string",
    "characteristicRelationship": null,
    "value": "AdvAutomationPkg",
    "@baseType": null,
    "@schemaLocation": null,
    "@type": null
    },
    {
    "id": "DS-114",
    "name": "serviceType",
    "valueType": "string",
    "characteristicRelationship": null,
    "value": "Advanced Automation",
    "@baseType": null,
    "@schemaLocation": null,
    "@type": null
    },
    {
    "id": "DS-116",
    "name": "status",
    "valueType": "string",
    "characteristicRelationship": null,
    "value": "A",
    "@baseType": null,
    "@schemaLocation": null,
    "@type": null
    }
    ]

    }

    ]

     



    ------------------------------
    Keshav jha
    Cisco Systems
    ------------------------------



  • 6.  RE: TMF638

    TM Forum Member
    Posted 11 days ago

    I'm a little confused by your question. There are multiple APIs involved in the Service domain. For example:

    • TMF633 - Service Catalog - deals with service specifications and other relevant entities
    • TMF638 - Service Inventory - deals with instantiated services that are (typically) implementing products for customers

    It's not clear to me what you are trying to retrieve.



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



  • 7.  RE: TMF638

    TM Forum Member
    Posted 10 days ago

    Hi Keshav, 

    In addition to what Jonathan and Dan kindly shared, I suggest taking a look at the use cases within the scope of IG1228 'How to Use ODA.' There, you'll find examples of how these assets are applied in real-world scenarios, helping you understand their actual meaning.

    Hope it helps.

    Best regards,



    ------------------------------
    Abel Ruiz Huerta
    alvatross
    ------------------------------