Roadmap to full mapping between UML models and XSD elements

[ronaldtse]

This is a complex topic that we now finally have a good grasp of.

The steps in developing a UML to XSD mapping is as follows:

Lutaml:

• Parse Enterprise Architect QEA into Uml::Document lutaml/lutaml#176
• Develop the "LutaML UML Repository" (LUR) package file for distribution and fast loading lutaml/lutaml#177
• Validation of LUR content to ensure internally consistent loading lutaml/lutaml#178
• Implement site generation code for LUR repository
• Update metanorma-plugin-lutaml to accept LUR repositories as input.

Lutaml-Klin:

• Implement ShapeChange rules such that we can reproduce the XSD output of URO and URF
• Accept a LUR file (that is validated) to run those ShapeChange rules (in a config) to output XSD
• Implement the Plateau Excel macro file as a new ShapeChange rule
• Create an updated ShapeChange config file to add the Plateau Excel macro
• Output identical XSD output to the original URO and URF.
• Create a mapping through this process from the original UML element to the XSD elements.
• Implement site generation code for LUR-LXR mappings

Lutaml-XSD:

• Implement LXR for XSD consistency
• Implement validation of LXR
• Implement site generation code for LXR repository
• Update metanorma-plugin-lutaml to accept LXR repositories as input.

[ReesePlews]

hello @ronaldtse thank you for your research work on this topic and for the enhancement roadmap. i will show this to the client and we will follow the tickets. what is Lutaml-Klin? the "Klin" part mean? when you are ready for feedback or testing, please let me know.

[ReesePlews]

hello @ronaldtse @kwkwan thank you for your work on this, just inquiring about the status of enhancement work and if there is anything we can check or test. do let me know. thank you.

[ronaldtse]

XSD packaging is being done here:

• feat: implement schema mapping lutaml/lutaml-xsd#23

UML ShapeChange behavior is done here:

• https://github.com/lutaml/lutaml-klin

UML packaging is being done here:

• Parsing QEA files and working with LUR packages lutaml/lutaml#179

The UML-XML auto-mapping will be completed as part of https://github.com/lutaml/lutaml-klin .

The situation is basically this:

1. We need to verify that LXR functionality works well. The lutaml-xsd now includes sample LXR files, and instructions on how to build an LXR file. The LXR file is important because we want to know that the XML XSD namespaces are all resolved and all elements/attributes can resolve to a type. For this it has now the ability to generate a site (SPA single page application) HTML that allows you to click and check.
2. In lutaml, we need to ensure the QEA parsing works, then ensure the QEA/XMI to LUR feature works.
3. ⁠In lutaml, the LUR SPA feature to enable us to know that the package contains everything. It is half done, and I plan to finish it.
4. ⁠In lutaml-klin, it does two things. It contains a port of ShapeChange, so (EA model + shapechange config => XSD). We need to verify the XSD generated (for URO, URF) is the same as the one that they have (I have included them in spec/fixtures).
5. ⁠In lutaml-klin, we need to create a SPA that links UML to XSD mapping. It is half done. It will require lutaml-klin to create a UML-to-XSD mapping when the XSD is generated. Then we feed this mapping to the SPA.
6. As a result, this chain will allow us to directly obtain the UML to XSD mapping through the (EA Model + ShapeChange config), with nothing more.

[ReesePlews]

hello @ronaldtse and @kwkwan , just checking in to see if there is any output from these enhancements for mn we can examine. thank you.