Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for visualizing UML class diagrams for a profile definition. #143

Closed
admin-cimug opened this issue Sep 25, 2024 · 1 comment
Closed
Assignees
Labels
cimtool-builders-website-updates-required Requires that the CIMTool Builders repo and website be updated. documentation Improvements or additions to documentation enhancement New feature or request

Comments

@admin-cimug
Copy link
Member

admin-cimug commented Sep 25, 2024

There has been a long standing need to be able to provide some type of UML Class diagram that reflect a graphical view of a profile definition within CIMTool. Additionally, it would be ideal to be able to make such a view available as a .png, .svg, or other format that could be utilized outside the context of CIMTool such as in IEC publications, custom documentation or in GitHub sites where such a view would be useful depending on the repository and its purpose.

We know that as part of our long range DevOp discussions that we would like to leverage AsciiDoc in future workflows for generating publications for various purposes. It would be beneficial if CIMTool could produce artifacts beneficial towards this end and the long range vision. PlantUML/Ditaa are a couple of options that would fit this objective.

What this issue is intended to track is the following proposed enhancements to CIMTool:

  1. Minimally, create an implementation of a PlantUML builder (NOTE: this would be one of a number of potential options but the first one with which we will experiment)
  2. Support annotations to hide a class, an association, all of a class's attributes, or just the individual attributes for a class and to hide such elements from what is finally displayed within the profile's visualized diagram generated by CIMTool. These annotations should be for internal purposes only and should not be relevant in any other context.
  3. Explore potential export options in SVG, PNG, JPG, etc. and determine initially what we might be able to support in a "first round" of enhancements in this area.
  4. Explore as part of this development effort if we can integrate within CIMTool a new tab for dynamically visualizing the current state of a profile as it is being built out. This is more of a wish list and may not be necessarily possible in this "first pass".
@admin-cimug admin-cimug added documentation Improvements or additions to documentation enhancement New feature or request cimtool-builders-website-updates-required Requires that the CIMTool Builders repo and website be updated. labels Sep 25, 2024
@admin-cimug admin-cimug self-assigned this Sep 25, 2024
@admin-cimug admin-cimug moved this to Backlog in CIMTool 2.2.0 Sep 25, 2024
@admin-cimug admin-cimug moved this from Backlog to Ready in CIMTool 2.2.0 Sep 25, 2024
@admin-cimug admin-cimug moved this from Ready to In progress in CIMTool 2.2.0 Sep 25, 2024
@Sveino
Copy link
Collaborator

Sveino commented Sep 27, 2024

I have looked a the PlantUML before, and it looks very promising. I think it is a great idea. It would be good if we are enabling some basic editing possibility and create the functionality of generating diagram and export them as SVG, PNG, JPG as serviced that we can use as part of DevOps. We do not necessary need to develop all relevant UML support, but focus on what we are doing. Another topic is that we might consider including Draw.io as part of CIMTool so that one installation can support everything we need to develop the CIM standard. We have then one version to be aligned with, the CIMTool version :-)

@tviegut tviegut moved this from In progress to In review in CIMTool 2.2.0 Oct 1, 2024
@tviegut tviegut closed this as completed by moving to Done in CIMTool 2.2.0 Oct 1, 2024
tviegut added a commit that referenced this issue Oct 1, 2024
tviegut added a commit that referenced this issue Oct 1, 2024
The hideOnDiagrams stereotype was added as part of support for PlantUML.  Additionally, spaces were removed from the OntResource labels of the stereotypes which is not considered valid in UML.
tviegut added a commit that referenced this issue Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cimtool-builders-website-updates-required Requires that the CIMTool Builders repo and website be updated. documentation Improvements or additions to documentation enhancement New feature or request
Projects
No open projects
Status: Done
Development

No branches or pull requests

3 participants