Skip to content

Commit

Permalink
Merge pull request #163 from cimug-org/release-2.2.0
Browse files Browse the repository at this point in the history
Update release-notes.md
  • Loading branch information
tviegut authored Oct 2, 2024
2 parents 07f638b + 07132af commit 3d34b0f
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,38 @@ This section contains CIMTool release notes and can be used for quick reference
as those available on GitHub [here](https://github.com/cimug-org/CIMTool/releases), but contain more versions since this log pre-dates
GitHub being the version control system for CIMTool.

### Release 2.2.0 [01-Oct-2024]

**CIMTool 2.2.0** is a minor release with both enhancements and important defect fixes.

Enhancement [Issue #116](https://github.com/cimug-org/CIMTool/issues/116):
With the recent introduction of UUID and URI in CIM18 **CIMTool** was updated to support the new domain types.

Enhancement [Issue #141](https://github.com/cimug-org/CIMTool/issues/141):
**CIMTool** was updated to support Sparx EA IDs within the intermediary internal XML representation that it generates and makes available for use by custom XSLT transform builders. This update was a part of R&D work being done within the standards community as part of potential use of LinkML as a semantic representation. As a result the LinkML builder introduced in **CIMTool** 2.1.0 has been updated to include **ea_guid** in its generated output. This can be used for more direct traceability to the UML elements (classes, attributes, associations, etc.) as natively identified within a Sparx EA UML model. Note that ongoing work on the **IEC 61970-501 Ed 2.0** draft standard is currently exploring LinkML as a semantics representation for the CIM.

Enhancement [Issue #142](https://github.com/cimug-org/CIMTool/issues/142):
An alpha of a new **CIMTool** builder is introduced that generates IEC 61970-501 Ed 2.0 draft spec RDFS. This is for experimentation purposes only and will be updated across releases to reflect the latest development of Ed 2.0 of the 501 standard.

Enhancement [Issue #143](https://github.com/cimug-org/CIMTool/issues/143):
Introduced in this release is support for the generation of UML class diagrams for graphical representation of your profiles in **CIMTool**. PlantUML is used as the internal representation due to its ability to meet a wide variety of requirements within the CIM and IEC standards community. Amongst these requirements has includes research in leveraging [AsciiDoc](https://asciidoc.org/) for DevOps based standards publication generation. In addition, [PlantUML](https://en.wikipedia.org/wiki/PlantUML) diagrams can be included in [Draw.io](https://www.drawio.com/) (newly named Diagrams.net) diagrams. **PlantUML** can easily be integrated into [AsciiDoc](https://asciidoc.org/), [Markdown](https://www.markdownguide.org/), or in online contexts that leverage PlantML plugins to integrate diagrams.. This initial release includes PNG and SVG export capabilities of PlantUML diagrams along with real-time visualization of invalid or incomplete elements in your profile as you build it. Visit the [CIMTool website](https://cimtool.ucaiug.io/) for forthcoming instructional videos on how to utilize new features. The use of PlantUML class diagrams for validating a profile will be included.

![image](https://github.com/user-attachments/assets/894b180a-7080-436c-9d1c-bb9632c3e7cc)

Defect [Issue #154](https://github.com/cimug-org/CIMTool/issues/154):
The **CIMTool** RDFS2020 builder made available in the 2.0.0 release required additional development to both fix areas not in proper alignment with that generated by [CimConteXtor](https://www.cimcontextor.net/index.php/en/products/cimcontextor/cimcontextor). It should be noted that the builder currently generates RDFS2020 schema's with "flattened" CIMDatatypes (i.e. value, unit, multplier attributes note defined within the generated RDFS). The final development for generating the "unflattened" CIMDatatypes (i.e. that explicitly define value, unit, multiplier, etc.) will be in a future release.

Defect [Issue #156](https://github.com/cimug-org/CIMTool/issues/156):
A post **CIMTool** 2.1.0 release task was to extensively test and address known issues related to profiling custom extensions using the newly supported 64-bit EA 16.x .qea, .qeax, and '.feap' project file types introduced in 2.1.0. This was decided to allow for 2.1.0 to be released to end users that only needed to profile using normative CIM without extensions. The outcome of this effort allows for profiling using a single EA project file (e.g. `.qea` or `.eap`) as your schema via the use of the `baseuri` tagged value for specifying the namespaces for your extensions extensions with the `.eap`/`.qea` project file. The resulting behavior when profiling using these new schema formats is designed to mirror the same behavior observed when using `baseuri` with multiple `.xmi` files to model extensions.

Enhancement [Issue #155](https://github.com/cimug-org/CIMTool/issues/155):
An new radio button has been added to the namespace list on the "Import Schema" dialog. The option allows selection of the existing namespace schema to be selected when re-importing a new version of the same named schema. When selected the namespace field auto-populate with the existing namespace. This solves a usability issue for end users who are working against base CIM with custom extensions and who need iteratively to re-import schema changes as their model evolves. It eliminates end users exiting the dialog in order to copy the namespace in the preferences screen to be able to paste a custom namespace into the field.

![image](https://github.com/user-attachments/assets/7bbaae28-17c7-4077-8113-2422ca29a1d0)

NOTE: This release does not yet address the issues as reported in the 2.0.1 release notes. Fixes for custom extensions in RDFS XSLT builders is now targeted for the 2.3.0 release.


### Release 2.1.0 [09-Aug-2024]

CIMTool 2.1.0 is a minor release with some useful enhancements and an important defect fix.
Expand Down

0 comments on commit 3d34b0f

Please sign in to comment.