Open APIs

 View Only
  • 1.  TMF633 Service Catalog API | Missing rangeStep attribute

    TM Forum Member
    Posted Jan 25, 2022 05:40

    Hello community,
    while analyzing the current TMF633v4 I noticed that the component "CharacteristicValueSpecification" does not have an attribute "rangeStep".

    If you look at the SID entity "CharacteristicSpecValue", there is a corresponding attribute "rangeStep" there.

    See link: http://casewise.tmforum.org/evolve/statics/frameworx/index.html#/cwtype=single&cwview=entity&cwid=2830&cwtabid=tab1

    In my opinion an extension of the API Spec would be very interesting here. I know we could extend the API spec as a custom extension but I think this might be interesting for more than one company. It is unclear to me how I could "officially" submit such a proposal now. Can someone give me some hints on this?

    Or maybe there are other ideas and suggestions how to define a step size for a CharacsteristicSpecValue?

    Regards,
    Jan



    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------


  • 2.  RE: TMF633 Service Catalog API | Missing rangeStep attribute

    TM Forum Member
    Posted Jan 25, 2022 12:27
    Thanks for the feedback, Jan.
    I take it that you consider this something general to all characteristic specifications, not just in the service domain?
    If you are a member of the Open API project, you can open a CR directly in the project JIRA https://projects.tmforum.org/jira/browse/AP-3782?jql=project%20%3D%20AP
    If not, we can discuss further.
    Either way I'd like more understanding of the business meaning of rangeStep, with real example if possible.

    ------------------------------
    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: TMF633 Service Catalog API | Missing rangeStep attribute

    TM Forum Member
    Posted Jan 26, 2022 03:11

    Hi Jonathan,

    exactly. Since the "rangeStep" is used within the SID Common Domain I guess it make sense to extend all TMF OpenAPIs that are using some sort of CharacteristicValueSpecification. So far I'm currently working more within the Service Domain but after a quick lookup it seems Product Catalog API is also missing this attribute.

    I like to give an example:

    The production group within our company has specified a CFSspec for an e-mail inbox. This specification has a characteristic called "storageSize" with the following properties:

    • rangeInterval: open
    • unitOfMeasure: MB
    • valueFrom: 500
    • valueTo: 12000

    Now what we would like to define is the fact that the storageSize characteristic needs to be increased in steps of 100MB only. This is where "rangeStep" has its appearance. We would define "rangeStep: 100" which means a Product Manager can use this service with 500, 600, 700... 12000 MB.

    I'll try to create a new CR.

    Regards,

    Jan



    ------------------------------
    Jan Lemmermann
    OSS Lead Architect
    EWE TEL GmbH
    ------------------------------



  • 4.  RE: TMF633 Service Catalog API | Missing rangeStep attribute

    TM Forum Member
    Posted Jan 26, 2022 14:12
    Hi Jan
    I understand the use case. However I would submit that it is simpler just to create a list of valid values for the characteristic. It's a much cleaner interface, you're not relying on the consumer understanding how to construct the step values. Additionally, it doesn't address the situation where the valid values are not equally separated (500, 700, 1000, 12000). And finally, at least in the Product domain, by having the list of valid values explicitly in the specification means that you can then use the char use entity to limit the values in particular offerings - e.g. in a Student Broadband offering you might allow only 500 and 600, whereas in Premium Broadband you could allow all the values.
    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.
    ------------------------------