Child pages
  • 2021-06-25 IISOMI Meeting Minutes
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Date

Attendees

Apology

Agenda

  • Administrative
  • Gendoc output for Interfaces and Operations
  • Papyrus-Model2Doc further investigations?
  • Handling of the UML → YANG Mapping Tool in GitHub - Still TBD
  • Papyrus 5.0.0 Version (202106)
  • ExtendedComposite association end
  • Property names in UML comments not converted to Yang
  • Agenda of next call
  • AOB

Discussion items

#

Time

Item

Who

Notes

#

Time

Item

Who

Notes

15 minAdmin: Call planAll

 Leader Nigel Davis

 Leader Scott Mansfield

 Leader ; Hing-Kam Lam (Not available: Scott)

 CANCELLED (Not available: Scott, Italo, Andrea)

 Leader ; Bernd Zeuner (Not available: Scott, Andrea)

210  min

Admin: IISOMI Action Items status

All

IISOMI Action Items review (every meeting)

  • NOTE: Administration of IISOMI action items

    • New actions are added to the minutes of the current meeting and dated using the "task list" control
    • Do not copy actions from previous minutes, just add bullet version to reference the source minutes 
    • In every IISOMI meeting, check the action item list and check for tasks that have passed their due date
      • If the due date is past, determine if the issue is still active
        • If the task is active, mark the over-due task as completed, and create a new task with a new due date in the minutes
        • If the task is not active, (i.e. not going to be progressed at this time), simply close the task and make a note in the minutes that the task was closed.

Action item discussed

Action item updates: (no changes to action, just changing date)

  •  Extended Composite

_classB should not be defined in an ExtendedComposite association

  • Bernd Zeuner Update the Modelling Guidelines to cover "_classB should not be defined in an ExtendedComposite association (because it is abstract)."


  • Enum literal (propose allow 12.5GHz)
    • UML model guideline currently prevents "." (and other characters). This prevents "12.5GHz" from being an Enum literal.
    • Yang has exceptions to allow "well-known value" such as "Only lowercase letters, numbers, and dashes SHOULD be used in identifier names. Uppercase characters, the period character, and the underscore character MAY be used if the identifier represents a well-known value that uses these characters."
    • Scott noted that the tooling is not consistent. Some places the tooling converts to Yang format and in others it does not.
    • The tooling is not validating the UML naming convention. 
    • Tooling does no translation of Enum Literals.
    • Changing the guidelines are sufficient.
    • Nigel suggested that a stereotype to identify the rare case where a well known value is being used should be available (not to be used by the tooling). This was not accepted.
    • Agreed to not change the tooling.
    • Agreed to proceed with Enum literals in upper case in Yang (i.e., not strict Yang, but still essentially allowed by "well-known value").
    • Agreed to not add a stereotype.
    • Agreed that we would not follow RFC 8407 on the Enums.
    • Agreed to change the guideline rules to allow for well known terms to be used in the Enum name.
  •  Bernd Zeuner  Update the UML guidelines to reflect the agreements on Enum Literals.


330 minGendocAndrea

Is there a way to publish, in a tabular form, the stereotypes on associations?

For example, <<ExtendedComposite>> is used by the UML-Yang tool. There is no mechanism to publish this in the documentation (other than on the diagrams).

Discussed need for collection of Gendoc material.

415 min

Property names etc. in UML comments not converted to Yang

Nigel

UML comments often include construct name formatted according to the UML guidelines. When the UML is converted to Yang the construct names are then incorrectly formatted.

Agreed that this is an issue. 

It was suggested that:

  • The construct names be marked in some way so that tooling could identify the strings to convert. The marking could be two single quotes (e.g., ''xyz''), two curly brackets (e.g., {{xyz}}) or similar. The comment could be:
    • Processed by the UML-Yang tool
    • Post processed after Yang generation to generate a Yang with corrected comments
  • The reader will just have to deal with it
    • But a Yang reader will question the correctness of the comments
  • The construct names could be changed to be less rigorous, e.g., ConnectivityService becomes connectivity service (which is somewhere between the UML and Yang form (connectivity-service)
    • But both the UML reader and the Yang reader will question the correctness of the comments
  • Nigel Davis  Further updates on issue of "UML comments often include construct name formatted according to the UML guidelines. When the UML is converted to Yang the construct names are then incorrectly formatted."

Editor's note: Papyrus should enable comments to include links to class names etc. via xmi-id that should be selectable from list etc.

310 min

Gendoc 

Scott

June 11: Gendoc output for Interfaces and Operations

  • Reviewed the generated Interface and Operation table from Gendoc
  • Discussed table numbering
    • Table 1 Operation of AcAction
    • Table 1.1 Parameters for Operation createClientContext
  • Discussed case where there is no parameter  
    • Still have table for operation which does not have parameter, with a row for heading and the second row with N/A
  • Discussed Interface meta data to be displayed in the GenDoc output
    • Qualified name
    • Description
    • Abstract
    • Applied stereotype
  • Discussed columns 
    • Operation table
    • Parameter table


  • Action item recreated: GenDoc didn't generate constraint
    • Scott Mansfield  To investigate why none of the constraints is retrieved from the model.


E.g., 

3
Papyrus-Model2Doc feature

May 142021-05-14 IISOMI Meeting notes  

Scott Mansfield presented the Model2Doc feature from Papyrus

  • still in pre-release state
  • need to install Model2Doc tool integrated into Eclipse 2021-03 (nightly build) and Papyrus 5.1 (nightly) and Model2Doc (0.8.0 nightly)
  • requires Java version greater than 11
  • creates Word files
  • need to check if Model2Doc provides at least the functionality of Gendoc
  • Gendoc does not work with newer Papyrus versions (see below)
  • Further investigation is required
  • Work continues to create a model2doc template that produces the same material as the gendoc template (class/attribute/datatype/stereotype etc.)

GenDoc no longer work with Eclipse Papyrus 2020-06. 

May 282021-05-28 IISOMI Meeting notes

June 11: No discussion

4
UML → YANG mapping issues and enhancements

May 142021-05-14 IISOMI Meeting notes

Logged issues: https://github.com/OpenNetworkingFoundation/EagleUmlYang/issues

  • Issue: 
  • Finalize discussion on xmi2yang support of ExtendedComposite, StrictComposite
  • Check enumerations not following guidelines
  • Management of possible dedicated branch where to store new versions (UML → YANG Tool release process)
    • Dedicated call: 

June 11:

  • Action item recreated: Tool improvement
    • Scott Mansfield  Scott to improve the tool so that to minimize the manual fix
    • Scott Mansfield  Scott to create a private Github for xmi2yang modification
5
Papyrus 5.0.0 Version

June 11: No discussion

  •  
649 min

GenDoc Issues

May 142021-05-14 IISOMI Meeting notes

  • GenDoc didn't generate constraint
  • GenDoc didn't generate the Interface definitions
  • GenDoc didn't generate the Type of pointed external (imported) classes
  • GenDoc OstigOTtpSource::txti:EByte multiplicity [64] is not generated correctly
  • AI (5/28/2021): Scott Mansfield to look at all GenDoc issues above and try to find solutions

May 28:  2021-05-28 IISOMI Meeting notes

  • Discussed possible output formats of interfaces/operations.
7 5 min

ExtendedComposite association end

May 14: 2021-05-14 IISOMI Meeting notes

  •  AI (5/28/2021): Bernd Zeuner Update the Modelling Guidelines accordingly

June 11: No discussion

8


Property names in UML documentation converted to Yang

June 11: No discussion 

9
Agenda of next callAll
  • Administrative
  • Gendoc output for Interfaces and Operations
  • Papyrus-Model2Doc further investigations?
  • Handling of the UML → YANG Mapping Tool in GitHub - Still TBD
  • Papyrus 5.0.0 Version
  • Property names in UML documentation converted to Yang
  • Agenda of next call
  • AOB

Action items

  •  
  • No labels